naming

Documentation

Index

• Constants
• func ClusterLabels(c *scyllav1alpha1.Cluster) map[string]string
• func DatacenterLabels(c *scyllav1alpha1.Cluster) map[string]string
• func FindScyllaContainer(containers []corev1.Container) (int, error)
• func HeadlessServiceNameForCluster(c *scyllav1alpha1.Cluster) string
• func ImageToVersion(image string) (string, error)
• func IndexFromName(n string) (int32, error)
• func NamespacedName(name, namespace string) client.ObjectKey
• func NamespacedNameForObject(obj metav1.Object) client.ObjectKey
• func PVCNameForPod(podName string) string
• func RackLabels(r scyllav1alpha1.RackSpec, c *scyllav1alpha1.Cluster) map[string]string
• func RackSelector(r scyllav1alpha1.RackSpec, c *scyllav1alpha1.Cluster) labels.Selector
• func SelectorForSeeds(clusterName string) string
• func ServiceAccountNameForMembers(c *scyllav1alpha1.Cluster) string
• func StatefulSetNameForRack(r scyllav1alpha1.RackSpec, c *scyllav1alpha1.Cluster) string
• func StatefulSetPodLabel(name string) map[string]string

Constants

const (
	// SeedLabel determines if a member is a seed or not.
	SeedLabel = "scylla/seed"

	// DecommissionLabel expresses the intent to decommission
	// the specific member. The presence of the label expresses
	// the intent to decommission. If the value is true, it means
	// the member has finished decommissioning.
	// Values: {true, false}
	DecommissionLabel = "scylla/decommissioned"

	LabelValueTrue  = "true"
	LabelValueFalse = "false"
)

These labels are only used on the ClusterIP services acting as each member's identity (static ip). Each of these labels is a record of intent to do something. The controller sets these labels and each member watches for them and takes the appropriate actions.

See the sidecar design doc for more details.

const (
	ClusterNameLabel    = "scylla/cluster"
	DatacenterNameLabel = "scylla/datacenter"
	RackNameLabel       = "scylla/rack"

	AppName         = "scylla"
	OperatorAppName = "scylla-operator"

	PrometheusScrapeAnnotation = "prometheus.io/scrape"
	PrometheusPortAnnotation   = "prometheus.io/port"
)

Generic Labels used on objects created by the operator.

const (
	EnvVarEnvVarPodName = "POD_NAME"
	EnvVarPodNamespace  = "POD_NAMESPACE"
	EnvVarCPU           = "CPU"
)

Environment Variables

const (
	// SuccessSynced is used as part of the Event 'reason' when a Cluster is
	// synced.
	SuccessSynced = "Synced"
	// ErrResourceExists is used as part of the Event 'reason' when a
	// Cluster fails to sync due to a resource of the same name already
	// existing.
	ErrSyncFailed = "ErrSyncFailed"
)

Recorder Values

const (
	ScyllaContainerName = "scylla"

	PVCTemplateName = "data"

	SharedDirName = "/mnt/shared"

	ScyllaConfigDirName          = "/mnt/scylla-config"
	ScyllaAgentConfigDirName     = "/mnt/scylla-agent-config"
	ScyllaAgentConfigDefaultFile = "/etc/scylla-manager-agent/scylla-manager-agent.yaml"
	ScyllaClientConfigDirName    = "/mnt/scylla-client-config"
	ScyllaClientConfigFileName   = "scylla-client.yaml"
	ScyllaConfigName             = "scylla.yaml"
	ScyllaRackDCPropertiesName   = "cassandra-rackdc.properties"

	DataDir = "/var/lib/scylla"

	ReadinessProbePath = "/readyz"
	LivenessProbePath  = "/healthz"
	ProbePort          = 8080
)

Configuration Values

Functions

func ClusterLabels

func ClusterLabels(c *scyllav1alpha1.Cluster) map[string]string

ClusterLabels returns a map of label keys and values for the given Cluster.

func DatacenterLabels

func DatacenterLabels(c *scyllav1alpha1.Cluster) map[string]string

DatacenterLabels returns a map of label keys and values for the given Datacenter.

func FindScyllaContainer

func FindScyllaContainer(containers []corev1.Container) (int, error)

func HeadlessServiceNameForCluster

func HeadlessServiceNameForCluster(c *scyllav1alpha1.Cluster) string

func ImageToVersion

func ImageToVersion(image string) (string, error)

func IndexFromName

func IndexFromName(n string) (int32, error)

IndexFromName attempts to get the index from a name using the naming convention <name>-<index>.

func NamespacedName

func NamespacedName(name, namespace string) client.ObjectKey

func NamespacedNameForObject

func NamespacedNameForObject(obj metav1.Object) client.ObjectKey

func PVCNameForPod

func PVCNameForPod(podName string) string

func RackLabels

func RackLabels(r scyllav1alpha1.RackSpec, c *scyllav1alpha1.Cluster) map[string]string

RackLabels returns a map of label keys and values for the given Rack.

func RackSelector

func RackSelector(r scyllav1alpha1.RackSpec, c *scyllav1alpha1.Cluster) labels.Selector

RackSelector returns a LabelSelector for the given rack.

func SelectorForSeeds

func SelectorForSeeds(clusterName string) string

func ServiceAccountNameForMembers

func ServiceAccountNameForMembers(c *scyllav1alpha1.Cluster) string

func StatefulSetNameForRack

func StatefulSetNameForRack(r scyllav1alpha1.RackSpec, c *scyllav1alpha1.Cluster) string

func StatefulSetPodLabel

func StatefulSetPodLabel(name string) map[string]string

StatefulSetPodLabel returns a map of labels to uniquely identify a StatefulSet Pod with the given name