ScyllaCluster (scylla.scylladb.com/v1)

APIVersion: scylla.scylladb.com/v1

Kind: ScyllaCluster

PluralName: scyllaclusters

SingularName: scyllacluster

Scope: Namespaced

ListKind: ScyllaClusterList

Served: true

Storage: true

Description

ScyllaCluster defines a Scylla cluster.

Specification

Property	Type	Description
apiVersion	string	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
kind	string	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
:ref:`metadata<api-scylla.scylladb.com-scyllaclusters-v1-.metadata>`	object
:ref:`spec<api-scylla.scylladb.com-scyllaclusters-v1-.spec>`	object	spec defines the desired state of this scylla cluster.
:ref:`status<api-scylla.scylladb.com-scyllaclusters-v1-.status>`	object	status is the current status of this scylla cluster.

.metadata

Description

Type

Property	Type	Description
secretName	string	secretName references a kubernetes.io/tls type secret containing the TLS cert and key.

.spec.backups[]

Description

Type

object

Property	Type	Description
cron	string	cron specifies the task schedule as a cron expression. It supports an extended syntax including @monthly, @weekly, @daily, @midnight, @hourly, @every X[h\|m\|s].
dc	array (string)	dc is a list of datacenter glob patterns, e.g. 'dc1,!otherdc*' used to specify the DCs to include or exclude from backup.
interval	string	interval represents a task schedule interval e.g. 3d2h10m, valid units are d, h, m, s. Deprecated: please use cron instead.
keyspace	array (string)	keyspace is a list of keyspace/tables glob patterns, e.g. 'keyspace,!keyspace.table_prefix_*' used to include or exclude keyspaces from repair.
location	array (string)	location is a list of backup locations in the format [<dc>:]<provider>:<name> ex. s3:my-bucket. The <dc>: part is optional and is only needed when different datacenters are being used to upload data to different locations. <name> must be an alphanumeric string and may contain a dash and or a dot, but other characters are forbidden. The only supported storage <provider> at the moment are s3 and gcs.
name	string	name specifies the name of a task.
numRetries	integer	numRetries indicates how many times a scheduled task will be retried before failing.
rateLimit	array (string)	rateLimit is a list of megabytes (MiB) per second rate limits expressed in the format [<dc>:]<limit>. The <dc>: part is optional and only needed when different datacenters need different upload limits. Set to 0 for no limit (default 100).
retention	integer	retention is the number of backups which are to be stored.
snapshotParallel	array (string)	snapshotParallel is a list of snapshot parallelism limits in the format [<dc>:]<limit>. The <dc>: part is optional and allows for specifying different limits in selected datacenters. If The <dc>: part is not set, the limit is global (e.g. 'dc1:2,5') the runs are parallel in n nodes (2 in dc1) and n nodes in all the other datacenters.
startDate	string	startDate specifies the task start date expressed in the RFC3339 format or now[+duration], e.g. now+3d2h10m, valid units are d, h, m, s.
timezone	string	timezone specifies the timezone of cron field.
uploadParallel	array (string)	uploadParallel is a list of upload parallelism limits in the format [<dc>:]<limit>. The <dc>: part is optional and allows for specifying different limits in selected datacenters. If The <dc>: part is not set the limit is global (e.g. 'dc1:2,5') the runs are parallel in n nodes (2 in dc1) and n nodes in all the other datacenters.

.spec.datacenter

Description

datacenter holds a specification of a datacenter.

Type

object

Property	Type	Description
name	string	name is the name of the scylla datacenter. Used in the cassandra-rackdc.properties file.
:ref:`racks<api-scylla.scylladb.com-scyllaclusters-v1-.spec.datacenter.racks[]>`	array (object)	racks specify the racks in the datacenter.

.spec.datacenter.racks[]

Description

RackSpec is the desired state for a Scylla Rack.

Type

object

Property	Type	Description
:ref:`agentResources<api-scylla.scylladb.com-scyllaclusters-v1-.spec.datacenter.racks[].agentResources>`	object	agentResources specify the resources for the Agent container.
:ref:`agentVolumeMounts<api-scylla.scylladb.com-scyllaclusters-v1-.spec.datacenter.racks[].agentVolumeMounts[]>`	array (object)	AgentVolumeMounts to be added to Agent container.
members	integer	members is the number of Scylla instances in this rack.
name	string	name is the name of the Scylla Rack. Used in the cassandra-rackdc.properties file.
:ref:`placement<api-scylla.scylladb.com-scyllaclusters-v1-.spec.datacenter.racks[].placement>`	object	placement describes restrictions for the nodes Scylla is scheduled on.
:ref:`resources<api-scylla.scylladb.com-scyllaclusters-v1-.spec.datacenter.racks[].resources>`	object	resources the Scylla container will use.
scyllaAgentConfig	string	Scylla config map name to customize scylla manager agent
scyllaConfig	string	Scylla config map name to customize scylla.yaml
:ref:`storage<api-scylla.scylladb.com-scyllaclusters-v1-.spec.datacenter.racks[].storage>`	object	storage describes the underlying storage that Scylla will consume.
:ref:`volumeMounts<api-scylla.scylladb.com-scyllaclusters-v1-.spec.datacenter.racks[].volumeMounts[]>`	array (object)	VolumeMounts to be added to Scylla container.
:ref:`volumes<api-scylla.scylladb.com-scyllaclusters-v1-.spec.datacenter.racks[].volumes[]>`	array (object)	Volumes added to Scylla Pod.

.spec.datacenter.racks[].agentResources

Description

agentResources specify the resources for the Agent container.

Type

object

Property	Type	Description
:ref:`claims<api-scylla.scylladb.com-scyllaclusters-v1-.spec.datacenter.racks[].agentResources.claims[]>`	array (object)	Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. This field is immutable. It can only be set for containers.
:ref:`limits<api-scylla.scylladb.com-scyllaclusters-v1-.spec.datacenter.racks[].agentResources.limits>`	object	Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
:ref:`requests<api-scylla.scylladb.com-scyllaclusters-v1-.spec.datacenter.racks[].agentResources.requests>`	object	Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

.spec.datacenter.racks[].agentResources.claims[]

Description

ResourceClaim references one entry in PodSpec.ResourceClaims.

Type

object

Property	Type	Description
name	string	Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.

.spec.datacenter.racks[].agentResources.limits

Description

Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

Type

object

.spec.datacenter.racks[].agentResources.requests

Description

Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

Type

.spec.datacenter.racks[].placement.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector

Description

A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.

Type

object

Property	Type	Description
:ref:`matchExpressions<api-scylla.scylladb.com-scyllaclusters-v1-.spec.datacenter.racks[].placement.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector.matchExpressions[]>`	array (object)	matchExpressions is a list of label selector requirements. The requirements are ANDed.
:ref:`matchLabels<api-scylla.scylladb.com-scyllaclusters-v1-.spec.datacenter.racks[].placement.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector.matchLabels>`	object	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

.spec.datacenter.racks[].placement.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector.matchExpressions[]

Description

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Type

object

Property	Type	Description
key	string	key is the label key that the selector applies to.
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
values	array (string)	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

.spec.datacenter.racks[].placement.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector.matchLabels

Description

matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

Type

.spec.datacenter.racks[].placement.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector

Description

A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.

Type

object

Property	Type	Description
:ref:`matchExpressions<api-scylla.scylladb.com-scyllaclusters-v1-.spec.datacenter.racks[].placement.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.matchExpressions[]>`	array (object)	matchExpressions is a list of label selector requirements. The requirements are ANDed.
:ref:`matchLabels<api-scylla.scylladb.com-scyllaclusters-v1-.spec.datacenter.racks[].placement.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.matchLabels>`	object	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

.spec.datacenter.racks[].placement.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.matchExpressions[]

Description

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Type

object

Property	Type	Description
key	string	key is the label key that the selector applies to.
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
values	array (string)	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

.spec.datacenter.racks[].placement.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.matchLabels

Description

matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

Type

.spec.datacenter.racks[].placement.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector

Description

A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.

Type

object

Property	Type	Description
:ref:`matchExpressions<api-scylla.scylladb.com-scyllaclusters-v1-.spec.datacenter.racks[].placement.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector.matchExpressions[]>`	array (object)	matchExpressions is a list of label selector requirements. The requirements are ANDed.
:ref:`matchLabels<api-scylla.scylladb.com-scyllaclusters-v1-.spec.datacenter.racks[].placement.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector.matchLabels>`	object	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

.spec.datacenter.racks[].placement.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector.matchExpressions[]

Description

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Type

object

Property	Type	Description
key	string	key is the label key that the selector applies to.
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
values	array (string)	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

.spec.datacenter.racks[].placement.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector.matchLabels

Description

matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

Type

.spec.datacenter.racks[].placement.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector

Description

A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.

Type

object

Property	Type	Description
:ref:`matchExpressions<api-scylla.scylladb.com-scyllaclusters-v1-.spec.datacenter.racks[].placement.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.matchExpressions[]>`	array (object)	matchExpressions is a list of label selector requirements. The requirements are ANDed.
:ref:`matchLabels<api-scylla.scylladb.com-scyllaclusters-v1-.spec.datacenter.racks[].placement.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.matchLabels>`	object	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

.spec.datacenter.racks[].placement.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.matchExpressions[]

Description

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Type

object

Property	Type	Description
key	string	key is the label key that the selector applies to.
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
values	array (string)	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

.spec.datacenter.racks[].placement.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.matchLabels

Description

matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

Type

Property	Type	Description
capacity	string	capacity describes the requested size of each persistent volume.
:ref:`metadata<api-scylla.scylladb.com-scyllaclusters-v1-.spec.datacenter.racks[].storage.metadata>`	object	metadata controls shared metadata for the volume claim for this rack. At this point, the values are applied only for the initial claim and are not reconciled during its lifetime. Note that this may get fixed in the future and this behaviour shouldn't be relied on in any way.
storageClassName	string	storageClassName is the name of a storageClass to request.

.spec.datacenter.racks[].storage.metadata

Description

metadata controls shared metadata for the volume claim for this rack. At this point, the values are applied only for the initial claim and are not reconciled during its lifetime. Note that this may get fixed in the future and this behaviour shouldn't be relied on in any way.

Type

object

Property	Type	Description
:ref:`annotations<api-scylla.scylladb.com-scyllaclusters-v1-.spec.datacenter.racks[].storage.metadata.annotations>`	object	annotations is a custom key value map that gets merged with managed object annotations.
:ref:`labels<api-scylla.scylladb.com-scyllaclusters-v1-.spec.datacenter.racks[].storage.metadata.labels>`	object	labels is a custom key value map that gets merged with managed object labels.

.spec.datacenter.racks[].storage.metadata.annotations

Description

annotations is a custom key value map that gets merged with managed object annotations.

Type

object

.spec.datacenter.racks[].storage.metadata.labels

Description

labels is a custom key value map that gets merged with managed object labels.

Type

.spec.datacenter.racks[].volumes[].downwardAPI

Description

downwardAPI represents downward API about the pod that should populate this volume

Type

object

Property	Type	Description
defaultMode	integer	Optional: mode bits to use on created files by default. Must be a Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
:ref:`items<api-scylla.scylladb.com-scyllaclusters-v1-.spec.datacenter.racks[].volumes[].downwardAPI.items[]>`	array (object)	Items is a list of downward API volume file

.spec.datacenter.racks[].volumes[].downwardAPI.items[]

Description

DownwardAPIVolumeFile represents information to create the file containing the pod field

Type

object

Property	Type	Description
:ref:`fieldRef<api-scylla.scylladb.com-scyllaclusters-v1-.spec.datacenter.racks[].volumes[].downwardAPI.items[].fieldRef>`	object	Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.
mode	integer	Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
path	string	Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'
:ref:`resourceFieldRef<api-scylla.scylladb.com-scyllaclusters-v1-.spec.datacenter.racks[].volumes[].downwardAPI.items[].resourceFieldRef>`	object	Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.

.spec.datacenter.racks[].volumes[].downwardAPI.items[].fieldRef

Description

Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.

Type

object

Property	Type	Description
apiVersion	string	Version of the schema the FieldPath is written in terms of, defaults to "v1".
fieldPath	string	Path of the field to select in the specified API version.

.spec.datacenter.racks[].volumes[].downwardAPI.items[].resourceFieldRef

Description

Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.

Type

object

Property	Type	Description
containerName	string	Container name: required for volumes, optional for env vars
divisor		Specifies the output format of the exposed resources, defaults to "1"
resource	string	Required: resource to select

.spec.datacenter.racks[].volumes[].emptyDir

Description

emptyDir represents a temporary directory that shares a pod's lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir

Type

object

Property	Type	Description
medium	string	medium represents what type of storage medium should back this directory. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir
sizeLimit		sizeLimit is the total amount of local storage required for this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers in a pod. The default is nil which means that the limit is undefined. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir

.spec.datacenter.racks[].volumes[].ephemeral

Description

ephemeral represents a volume that is handled by a cluster storage driver. The volume's lifecycle is tied to the pod that defines it - it will be created before the pod starts, and deleted when the pod is removed.: Use this if: a) the volume is only needed while the pod runs, b) features of normal volumes like restoring from snapshot or capacity tracking are needed, c) the storage driver is specified through a storage class, and d) the storage driver supports dynamic volume provisioning through a PersistentVolumeClaim (see EphemeralVolumeSource for more information on the connection between this volume type and PersistentVolumeClaim). Use PersistentVolumeClaim or one of the vendor-specific APIs for volumes that persist for longer than the lifecycle of an individual pod. Use CSI for light-weight local ephemeral volumes if the CSI driver is meant to be used that way - see the documentation of the driver for more information. A pod can use both types of ephemeral volumes and persistent volumes at the same time.

Type

object

Property	Type	Description
:ref:`volumeClaimTemplate<api-scylla.scylladb.com-scyllaclusters-v1-.spec.datacenter.racks[].volumes[].ephemeral.volumeClaimTemplate>`	object	Will be used to create a stand-alone PVC to provision the volume. The pod in which this EphemeralVolumeSource is embedded will be the owner of the PVC, i.e. the PVC will be deleted together with the pod. The name of the PVC will be <pod name>-<volume name> where <volume name> is the name from the PodSpec.Volumes array entry. Pod validation will reject the pod if the concatenated name is not valid for a PVC (for example, too long). An existing PVC with that name that is not owned by the pod will not be used for the pod to avoid using an unrelated volume by mistake. Starting the pod is then blocked until the unrelated PVC is removed. If such a pre-created PVC is meant to be used by the pod, the PVC has to updated with an owner reference to the pod once the pod exists. Normally this should not be necessary, but it may be useful when manually reconstructing a broken cluster. This field is read-only and no changes will be made by Kubernetes to the PVC after it has been created. Required, must not be nil.

.spec.datacenter.racks[].volumes[].ephemeral.volumeClaimTemplate

Description

Will be used to create a stand-alone PVC to provision the volume. The pod in which this EphemeralVolumeSource is embedded will be the owner of the PVC, i.e. the PVC will be deleted together with the pod. The name of the PVC will be <pod name>-<volume name> where <volume name> is the name from the PodSpec.Volumes array entry. Pod validation will reject the pod if the concatenated name is not valid for a PVC (for example, too long).: An existing PVC with that name that is not owned by the pod will not be used for the pod to avoid using an unrelated volume by mistake. Starting the pod is then blocked until the unrelated PVC is removed. If such a pre-created PVC is meant to be used by the pod, the PVC has to updated with an owner reference to the pod once the pod exists. Normally this should not be necessary, but it may be useful when manually reconstructing a broken cluster. This field is read-only and no changes will be made by Kubernetes to the PVC after it has been created. Required, must not be nil.

Type

object

Property	Type	Description
:ref:`metadata<api-scylla.scylladb.com-scyllaclusters-v1-.spec.datacenter.racks[].volumes[].ephemeral.volumeClaimTemplate.metadata>`	object	May contain labels and annotations that will be copied into the PVC when creating it. No other fields are allowed and will be rejected during validation.
:ref:`spec<api-scylla.scylladb.com-scyllaclusters-v1-.spec.datacenter.racks[].volumes[].ephemeral.volumeClaimTemplate.spec>`	object	The specification for the PersistentVolumeClaim. The entire content is copied unchanged into the PVC that gets created from this template. The same fields as in a PersistentVolumeClaim are also valid here.

.spec.datacenter.racks[].volumes[].ephemeral.volumeClaimTemplate.metadata

Description

May contain labels and annotations that will be copied into the PVC when creating it. No other fields are allowed and will be rejected during validation.

Type

.spec.datacenter.racks[].volumes[].ephemeral.volumeClaimTemplate.spec.resources.requests

Description

Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

Type

.spec.datacenter.racks[].volumes[].fc

Description

fc represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod.

Type

object

Property	Type	Description
fsType	string	fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. TODO: how do we prevent errors in the filesystem from compromising the machine
lun	integer	lun is Optional: FC target lun number
readOnly	boolean	readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
targetWWNs	array (string)	targetWWNs is Optional: FC target worldwide names (WWNs)
wwids	array (string)	wwids Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously.

.spec.datacenter.racks[].volumes[].flexVolume

Description

flexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.

Type

object

Property	Type	Description
driver	string	driver is the name of the driver to use for this volume.
fsType	string	fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script.
:ref:`options<api-scylla.scylladb.com-scyllaclusters-v1-.spec.datacenter.racks[].volumes[].flexVolume.options>`	object	options is Optional: this field holds extra command options if any.
readOnly	boolean	readOnly is Optional: defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
:ref:`secretRef<api-scylla.scylladb.com-scyllaclusters-v1-.spec.datacenter.racks[].volumes[].flexVolume.secretRef>`	object	secretRef is Optional: secretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts.

.spec.datacenter.racks[].volumes[].flexVolume.options

Description

options is Optional: this field holds extra command options if any.

Type

Property	Type	Description
:ref:`clusterTrustBundle<api-scylla.scylladb.com-scyllaclusters-v1-.spec.datacenter.racks[].volumes[].projected.sources[].clusterTrustBundle>`	object	ClusterTrustBundle allows a pod to access the .spec.trustBundle field of ClusterTrustBundle objects in an auto-updating file. Alpha, gated by the ClusterTrustBundleProjection feature gate. ClusterTrustBundle objects can either be selected by name, or by the combination of signer name and a label selector. Kubelet performs aggressive normalization of the PEM contents written into the pod filesystem. Esoteric PEM features such as inter-block comments and block headers are stripped. Certificates are deduplicated. The ordering of certificates within the file is arbitrary, and Kubelet may change the order over time.
:ref:`configMap<api-scylla.scylladb.com-scyllaclusters-v1-.spec.datacenter.racks[].volumes[].projected.sources[].configMap>`	object	configMap information about the configMap data to project
:ref:`downwardAPI<api-scylla.scylladb.com-scyllaclusters-v1-.spec.datacenter.racks[].volumes[].projected.sources[].downwardAPI>`	object	downwardAPI information about the downwardAPI data to project
:ref:`secret<api-scylla.scylladb.com-scyllaclusters-v1-.spec.datacenter.racks[].volumes[].projected.sources[].secret>`	object	secret information about the secret data to project
:ref:`serviceAccountToken<api-scylla.scylladb.com-scyllaclusters-v1-.spec.datacenter.racks[].volumes[].projected.sources[].serviceAccountToken>`	object	serviceAccountToken is information about the serviceAccountToken data to project

.spec.datacenter.racks[].volumes[].projected.sources[].clusterTrustBundle

Description

ClusterTrustBundle allows a pod to access the .spec.trustBundle field of ClusterTrustBundle objects in an auto-updating file.: Alpha, gated by the ClusterTrustBundleProjection feature gate. ClusterTrustBundle objects can either be selected by name, or by the combination of signer name and a label selector. Kubelet performs aggressive normalization of the PEM contents written into the pod filesystem. Esoteric PEM features such as inter-block comments and block headers are stripped. Certificates are deduplicated. The ordering of certificates within the file is arbitrary, and Kubelet may change the order over time.

Type

object

Property	Type	Description
:ref:`labelSelector<api-scylla.scylladb.com-scyllaclusters-v1-.spec.datacenter.racks[].volumes[].projected.sources[].clusterTrustBundle.labelSelector>`	object	Select all ClusterTrustBundles that match this label selector. Only has effect if signerName is set. Mutually-exclusive with name. If unset, interpreted as "match nothing". If set but empty, interpreted as "match everything".
name	string	Select a single ClusterTrustBundle by object name. Mutually-exclusive with signerName and labelSelector.
optional	boolean	If true, don't block pod startup if the referenced ClusterTrustBundle(s) aren't available. If using name, then the named ClusterTrustBundle is allowed not to exist. If using signerName, then the combination of signerName and labelSelector is allowed to match zero ClusterTrustBundles.
path	string	Relative path from the volume root to write the bundle.
signerName	string	Select all ClusterTrustBundles that match this signer name. Mutually-exclusive with name. The contents of all selected ClusterTrustBundles will be unified and deduplicated.

.spec.datacenter.racks[].volumes[].projected.sources[].clusterTrustBundle.labelSelector

Description

Select all ClusterTrustBundles that match this label selector. Only has effect if signerName is set. Mutually-exclusive with name. If unset, interpreted as "match nothing". If set but empty, interpreted as "match everything".

Type

object

Property	Type	Description
:ref:`matchExpressions<api-scylla.scylladb.com-scyllaclusters-v1-.spec.datacenter.racks[].volumes[].projected.sources[].clusterTrustBundle.labelSelector.matchExpressions[]>`	array (object)	matchExpressions is a list of label selector requirements. The requirements are ANDed.
:ref:`matchLabels<api-scylla.scylladb.com-scyllaclusters-v1-.spec.datacenter.racks[].volumes[].projected.sources[].clusterTrustBundle.labelSelector.matchLabels>`	object	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

.spec.datacenter.racks[].volumes[].projected.sources[].clusterTrustBundle.labelSelector.matchExpressions[]

Description

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Type

object

Property	Type	Description
key	string	key is the label key that the selector applies to.
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
values	array (string)	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

.spec.datacenter.racks[].volumes[].projected.sources[].clusterTrustBundle.labelSelector.matchLabels

Description

matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

Type

.spec.exposeOptions.cql.ingress.labels

Description

labels is a custom key value map that gets merged with managed object labels.

Type

object

.spec.exposeOptions.nodeService

Description

nodeService controls properties of Service dedicated for each ScyllaCluster node.

Type

object

Property	Type	Description
allocateLoadBalancerNodePorts	boolean	allocateLoadBalancerNodePorts controls value of service.spec.allocateLoadBalancerNodePorts of each node Service. Check Kubernetes corev1.Service documentation about semantic of this field.
:ref:`annotations<api-scylla.scylladb.com-scyllaclusters-v1-.spec.exposeOptions.nodeService.annotations>`	object	annotations is a custom key value map that gets merged with managed object annotations.
externalTrafficPolicy	string	externalTrafficPolicy controls value of service.spec.externalTrafficPolicy of each node Service. Check Kubernetes corev1.Service documentation about semantic of this field.
internalTrafficPolicy	string	internalTrafficPolicy controls value of service.spec.internalTrafficPolicy of each node Service. Check Kubernetes corev1.Service documentation about semantic of this field.
:ref:`labels<api-scylla.scylladb.com-scyllaclusters-v1-.spec.exposeOptions.nodeService.labels>`	object	labels is a custom key value map that gets merged with managed object labels.
loadBalancerClass	string	loadBalancerClass controls value of service.spec.loadBalancerClass of each node Service. Check Kubernetes corev1.Service documentation about semantic of this field.
type	string	type is the Kubernetes Service type.

.spec.exposeOptions.nodeService.annotations

Description

annotations is a custom key value map that gets merged with managed object annotations.

Type

object

.spec.exposeOptions.nodeService.labels

Description

labels is a custom key value map that gets merged with managed object labels.

Type

.spec.podMetadata.labels

Description

labels is a custom key value map that gets merged with managed object labels.

Type

object

.spec.readinessGates[]

Description

PodReadinessGate contains the reference to a pod condition

Type

object

Property	Type	Description
conditionType	string	ConditionType refers to a condition in the pod's condition list with matching type.

.spec.repairs[]

Description

Type

object

Property	Type	Description
cron	string	cron specifies the task schedule as a cron expression. It supports an extended syntax including @monthly, @weekly, @daily, @midnight, @hourly, @every X[h\|m\|s].
dc	array (string)	dc is a list of datacenter glob patterns, e.g. 'dc1', '!otherdc*' used to specify the DCs to include or exclude from backup.
failFast	boolean	failFast indicates if a repair should be stopped on first error.
host	string	host specifies a host to repair. If empty, all hosts are repaired.
intensity	string	intensity indicates how many token ranges (per shard) to repair in a single Scylla repair job. By default this is 1. If you set it to 0 the number of token ranges is adjusted to the maximum supported by node (see max_repair_ranges_in_parallel in Scylla logs). Valid values are 0 and integers >= 1. Higher values will result in increased cluster load and slightly faster repairs. Changing the intensity impacts repair granularity if you need to resume it, the higher the value the more work on resume. For Scylla clusters that do not support row-level repair, intensity can be a decimal between (0,1). In that case it specifies percent of shards that can be repaired in parallel on a repair master node. For Scylla clusters that are row-level repair enabled, setting intensity below 1 has the same effect as setting intensity 1.
interval	string	interval represents a task schedule interval e.g. 3d2h10m, valid units are d, h, m, s. Deprecated: please use cron instead.
keyspace	array (string)	keyspace is a list of keyspace/tables glob patterns, e.g. 'keyspace,!keyspace.table_prefix_*' used to include or exclude keyspaces from repair.
name	string	name specifies the name of a task.
numRetries	integer	numRetries indicates how many times a scheduled task will be retried before failing.
parallel	integer	parallel is the maximum number of Scylla repair jobs that can run at the same time (on different token ranges and replicas). Each node can take part in at most one repair at any given moment. By default the maximum possible parallelism is used. The effective parallelism depends on a keyspace replication factor (RF) and the number of nodes. The formula to calculate it is as follows: number of nodes / RF, ex. for 6 node cluster with RF=3 the maximum parallelism is 2.
smallTableThreshold	string	smallTableThreshold enable small table optimization for tables of size lower than given threshold. Supported units [B, MiB, GiB, TiB].
startDate	string	startDate specifies the task start date expressed in the RFC3339 format or now[+duration], e.g. now+3d2h10m, valid units are d, h, m, s.
timezone	string	timezone specifies the timezone of cron field.

.status

Description

status is the current status of this scylla cluster.

Type

object

Property	Type	Description
availableMembers	integer	availableMembers is the number of ScyllaDB members in all racks that are available.
:ref:`backups<api-scylla.scylladb.com-scyllaclusters-v1-.status.backups[]>`	array (object)	backups reflects status of backup tasks.
:ref:`conditions<api-scylla.scylladb.com-scyllaclusters-v1-.status.conditions[]>`	array (object)	conditions hold conditions describing ScyllaCluster state. To determine whether a cluster rollout is finished, look for Available=True,Progressing=False,Degraded=False.
managerId	string	managerId contains ID under which cluster was registered in Scylla Manager.
members	integer	members is the number of ScyllaDB members in all racks.
observedGeneration	integer	observedGeneration is the most recent generation observed for this ScyllaCluster. It corresponds to the ScyllaCluster's generation, which is updated on mutation by the API Server.
rackCount	integer	rackCount is the number of ScyllaDB racks in this cluster.
:ref:`racks<api-scylla.scylladb.com-scyllaclusters-v1-.status.racks>`	object	racks reflect status of cluster racks.
readyMembers	integer	readyMembers is the number of ScyllaDB members in all racks that are ready.
:ref:`repairs<api-scylla.scylladb.com-scyllaclusters-v1-.status.repairs[]>`	array (object)	repairs reflects status of repair tasks.
:ref:`upgrade<api-scylla.scylladb.com-scyllaclusters-v1-.status.upgrade>`	object	upgrade reflects state of ongoing upgrade procedure.

.status.backups[]

Description

Type

object

Property	Type	Description
cron	string	cron reflects the task schedule as a cron expression.
dc	array (string)	dc reflects a list of datacenter glob patterns, e.g. 'dc1,!otherdc*' used to specify the DCs to include or exclude from backup.
error	string	error holds the task error, if any.
id	string	id reflects identification number of the repair task.
interval	string	interval reflects a task schedule interval.
keyspace	array (string)	keyspace reflects a list of keyspace/tables glob patterns, e.g. 'keyspace,!keyspace.table_prefix_*' used to include or exclude keyspaces from repair.
location	array (string)	location reflects a list of backup locations in the format [<dc>:]<provider>:<name> ex. s3:my-bucket.
name	string	name reflects the name of a task.
numRetries	integer	numRetries reflects how many times a scheduled task will be retried before failing.
rateLimit	array (string)	rateLimit reflects a list of megabytes (MiB) per second rate limits expressed in the format [<dc>:]<limit>.
retention	integer	retention reflects the number of backups which are to be stored.
snapshotParallel	array (string)	snapshotParallel reflects a list of snapshot parallelism limits in the format [<dc>:]<limit>.
startDate	string	startDate reflects the task start date expressed in the RFC3339 format
timezone	string	timezone reflects the timezone of cron field.
uploadParallel	array (string)	uploadParallel reflects a list of upload parallelism limits in the format [<dc>:]<limit>.

.status.conditions[]

Description

Condition contains details for one aspect of the current state of this API Resource. --- This struct is intended for direct use as an array at the field path .status.conditions. For example,: type FooStatus struct{ // Represents the observations of a foo's current state. // Known .status.conditions.type are: "Available", "Progressing", and "Degraded" // +patchMergeKey=type // +patchStrategy=merge // +listType=map // +listMapKey=type Conditions []metav1.Condition json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions" // other fields }

Type

object

Property	Type	Description
lastTransitionTime	string	lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.
message	string	message is a human readable message indicating details about the transition. This may be an empty string.
observedGeneration	integer	observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.
reason	string	reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.
status	string	status of the condition, one of True, False, Unknown.
type	string	type of condition in CamelCase or in foo.example.com/CamelCase. --- Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be useful (see .node.status.conditions), the ability to deconflict is important. The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)

.status.racks

Description

racks reflect status of cluster racks.

Type

object

.status.repairs[]

Description

Type

object

Property	Type	Description
cron	string	cron reflects the task schedule as a cron expression.
dc	array (string)	dc reflects a list of datacenter glob patterns, e.g. 'dc1', '!otherdc*' used to specify the DCs to include or exclude from repair.
error	string	error holds the task error, if any.
failFast	boolean	failFast indicates if a repair should be stopped on first error.
host	string	host reflects a host to repair.
id	string	id reflects identification number of the repair task.
intensity	string	intensity indicates how many token ranges (per shard) to repair in a single Scylla repair job. By default this is 1.
interval	string	interval reflects a task schedule interval.
keyspace	array (string)	keyspace reflects a list of keyspace/tables glob patterns, e.g. 'keyspace,!keyspace.table_prefix_*' used to include or exclude keyspaces from repair.
name	string	name reflects the name of a task.
numRetries	integer	numRetries reflects how many times a scheduled task will be retried before failing.
parallel	integer	parallel reflects the maximum number of Scylla repair jobs that can run at the same time (on different token ranges and replicas).
smallTableThreshold	string	smallTableThreshold reflects whether small table optimization for tables, of size lower than given threshold, are enabled.
startDate	string	startDate reflects the task start date expressed in the RFC3339 format
timezone	string	timezone reflects the timezone of cron field.

.status.upgrade

Description

upgrade reflects state of ongoing upgrade procedure.

Type

object

Property	Type	Description
currentNode	string	currentNode node under upgrade. DEPRECATED.
currentRack	string	currentRack rack under upgrade. DEPRECATED.
dataSnapshotTag	string	dataSnapshotTag is the snapshot tag of data keyspaces.
fromVersion	string	fromVersion reflects from which version ScyllaCluster is being upgraded.
state	string	state reflects current upgrade state.
systemSnapshotTag	string	systemSnapshotTag is the snapshot tag of system keyspaces.
toVersion	string	toVersion reflects to which version ScyllaCluster is being upgraded.

Files

scyllaclusters.rst

Latest commit

History

scyllaclusters.rst

File metadata and controls

ScyllaCluster (scylla.scylladb.com/v1)

Description

Specification

.metadata

Description

Type

.spec

Description

Type

.spec.alternator

Description

Type

.spec.alternator.servingCertificate

Description

Type

.spec.alternator.servingCertificate.operatorManagedOptions

Description

Type

.spec.alternator.servingCertificate.userManagedOptions

Description

Type

.spec.backups[]

Description

Type

.spec.datacenter

Description

Type

.spec.datacenter.racks[]

Description

Type

.spec.datacenter.racks[].agentResources

Description

Type

.spec.datacenter.racks[].agentResources.claims[]

Description

Type

.spec.datacenter.racks[].agentResources.limits

Description

Type

.spec.datacenter.racks[].agentResources.requests

Description

Type

.spec.datacenter.racks[].agentVolumeMounts[]

Description

Type

.spec.datacenter.racks[].placement

Description

Type

.spec.datacenter.racks[].placement.nodeAffinity

Description

Type

.spec.datacenter.racks[].placement.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[]

Description

Type

.spec.datacenter.racks[].placement.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference

Description

Type

.spec.datacenter.racks[].placement.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchExpressions[]

Description

Type

.spec.datacenter.racks[].placement.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchFields[]

Description

Type

.spec.datacenter.racks[].placement.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution

Description

Type

.spec.datacenter.racks[].placement.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[]

Description

Type

.spec.datacenter.racks[].placement.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchExpressions[]

Description

Type

.spec.datacenter.racks[].placement.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchFields[]

Description