naming

Documentation

Index

• Constants
• func ClusterLabels(c *scyllav1.ScyllaCluster) map[string]string
• func CrossNamespaceServiceNameForCluster(c *scyllav1.ScyllaCluster) string
• func DatacenterLabels(c *scyllav1.ScyllaCluster) map[string]string
• func FindScyllaContainer(containers []corev1.Container) (int, error)
• func HeadlessServiceNameForCluster(c *scyllav1.ScyllaCluster) string
• func ImageToVersion(image string) (string, error)
• func IndexFromName(n string) (int32, error)
• func ManagerClusterName(c *scyllav1.ScyllaCluster) string
• func ManagerSelector() labels.Selector
• func MemberServiceName(r scyllav1.RackSpec, c *scyllav1.ScyllaCluster, idx int) string
• func NamespacedName(name, namespace string) client.ObjectKey
• func NamespacedNameForObject(obj metav1.Object) client.ObjectKey
• func PVCNameForPod(podName string) string
• func RackLabels(r scyllav1.RackSpec, c *scyllav1.ScyllaCluster) map[string]string
• func RackSelector(r scyllav1.RackSpec, c *scyllav1.ScyllaCluster) labels.Selector
• func ScyllaImage(containers []corev1.Container) (string, error)
• func SelectorForSeeds(clusterName string) string
• func ServiceAccountNameForMembers(c *scyllav1.ScyllaCluster) string
• func ServiceDNSName(service string, c *scyllav1.ScyllaCluster) string
• func ServiceNameFromPod(pod *corev1.Pod) string
• func StatefulSetNameForRack(r scyllav1.RackSpec, c *scyllav1.ScyllaCluster) 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"

	// ReplaceLabel express the intent to replace pod under the specific member.
	ReplaceLabel = "scylla/replace"

	// NodeMaintenanceLabel means that node is under maintenance.
	// Readiness check will always fail when this label is added to member service.
	NodeMaintenanceLabel = "scylla/node-maintenance"

	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"
	ManagerAppName  = "scylla-manager"

	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
	MetricsPort        = 8081
)

Configuration Values

Functions

func ClusterLabels

func ClusterLabels(c *scyllav1.ScyllaCluster) map[string]string

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

func CrossNamespaceServiceNameForCluster

func CrossNamespaceServiceNameForCluster(c *scyllav1.ScyllaCluster) string

func DatacenterLabels

func DatacenterLabels(c *scyllav1.ScyllaCluster) 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 *scyllav1.ScyllaCluster) 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 ManagerClusterName

func ManagerClusterName(c *scyllav1.ScyllaCluster) string

func ManagerSelector

func ManagerSelector() labels.Selector

func MemberServiceName

func MemberServiceName(r scyllav1.RackSpec, c *scyllav1.ScyllaCluster, idx int) string

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 scyllav1.RackSpec, c *scyllav1.ScyllaCluster) map[string]string

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

func RackSelector

func RackSelector(r scyllav1.RackSpec, c *scyllav1.ScyllaCluster) labels.Selector

RackSelector returns a LabelSelector for the given rack.

func ScyllaImage

func ScyllaImage(containers []corev1.Container) (string, error)

ScyllaImage returns version of Scylla container.

func SelectorForSeeds

func SelectorForSeeds(clusterName string) string

func ServiceAccountNameForMembers

func ServiceAccountNameForMembers(c *scyllav1.ScyllaCluster) string

func ServiceDNSName

func ServiceDNSName(service string, c *scyllav1.ScyllaCluster) string

func ServiceNameFromPod

func ServiceNameFromPod(pod *corev1.Pod) string

func StatefulSetNameForRack

func StatefulSetNameForRack(r scyllav1.RackSpec, c *scyllav1.ScyllaCluster) 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