diff --git a/deploy/crds/db.orange.com_cassandrabackups_crd.yaml b/deploy/crds/db.orange.com_cassandrabackups_crd.yaml index e8fa8e463..9a2474b4f 100644 --- a/deploy/crds/db.orange.com_cassandrabackups_crd.yaml +++ b/deploy/crds/db.orange.com_cassandrabackups_crd.yaml @@ -35,7 +35,7 @@ spec: to the cloud. Format supported is \d+[KMG] case insensitive. You can use values like 10M (meaning 10MB), 1024, 1024K, 2G, etc... type: string - cassandracluster: + cassandraCluster: description: Name of the CassandraCluster to backup type: string concurrentConnections: @@ -79,7 +79,7 @@ spec: description: URI for the backup target location e.g. s3 bucket, filepath type: string required: - - cassandracluster + - cassandraCluster - datacenter - snapshotTag - storageLocation diff --git a/deploy/crds/v1beta1/db.orange.com_cassandrabackups_crd.yaml b/deploy/crds/v1beta1/db.orange.com_cassandrabackups_crd.yaml deleted file mode 100644 index 480ec3e85..000000000 --- a/deploy/crds/v1beta1/db.orange.com_cassandrabackups_crd.yaml +++ /dev/null @@ -1,102 +0,0 @@ -apiVersion: apiextensions.k8s.io/v1beta1 -kind: CustomResourceDefinition -metadata: - name: cassandrabackups.db.orange.com -spec: - group: db.orange.com - names: - kind: CassandraBackup - listKind: CassandraBackupList - plural: cassandrabackups - singular: cassandrabackup - scope: Namespaced - validation: - openAPIV3Schema: - description: Defines a backup operation and its details - properties: - apiVersion: - description: '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' - type: string - kind: - description: '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' - type: string - metadata: - type: object - spec: - properties: - bandwidth: - description: Specify the bandwidth to not exceed when uploading files - to the cloud. Format supported is \d+[KMG] case insensitive. You can - use values like 10M (meaning 10MB), 1024, 1024K, 2G, etc... - type: string - cassandracluster: - description: Name of the CassandraCluster to backup - type: string - concurrentConnections: - description: Maximum number of threads used to download files from the - cloud. Defaults to 10 - format: int32 - type: integer - datacenter: - description: Cassandra DC name to back up, used to find the cassandra - nodes in the CassandraCluster - type: string - duration: - description: Specify a duration the backup should try to last. See https://golang.org/pkg/time/#ParseDuration - for an exhaustive list of the supported units. You can use values - like .25h, 15m, 900s all meaning 15 minutes - type: string - entities: - description: Database entities to backup, it might be either only keyspaces - or only tables prefixed by their respective keyspace, e.g. 'k1,k2' - if one wants to backup whole keyspaces or 'ks1.t1,ks2.t2' if one wants - to restore specific tables. These formats are mutually exclusive so - 'k1,k2.t2' is invalid. An empty field will backup all keyspaces - type: string - schedule: - description: Specify a schedule to assigned to the backup. The schedule - doesn't enforce anything so if you schedule multiple backups around - the same time they would conflict. See https://godoc.org/github.com/robfig/cron - for more information regarding the supported formats - type: string - secret: - type: string - snapshotTag: - type: string - storageLocation: - description: URI for the backup target location e.g. s3 bucket, filepath - type: string - required: - - cassandracluster - - datacenter - - snapshotTag - - storageLocation - type: object - status: - properties: - coordinatorMember: - description: name of pod / node - type: string - progress: - description: Progress shows the percentage of the operation done - type: string - state: - description: State shows the status of the operation - type: string - required: - - coordinatorMember - - progress - - state - type: object - required: - - spec - type: object - version: v1alpha1 - versions: - - name: v1alpha1 - served: true - storage: true diff --git a/deploy/crds/v1beta1/db.orange.com_cassandraclusters_crd.yaml b/deploy/crds/v1beta1/db.orange.com_cassandraclusters_crd.yaml deleted file mode 100644 index b3fb04db9..000000000 --- a/deploy/crds/v1beta1/db.orange.com_cassandraclusters_crd.yaml +++ /dev/null @@ -1,1692 +0,0 @@ -apiVersion: apiextensions.k8s.io/v1beta1 -kind: CustomResourceDefinition -metadata: - name: cassandraclusters.db.orange.com -spec: - group: db.orange.com - names: - kind: CassandraCluster - listKind: CassandraClusterList - plural: cassandraclusters - singular: cassandracluster - scope: Namespaced - validation: - openAPIV3Schema: - description: CassandraCluster is the Schema for the cassandraclusters API - properties: - apiVersion: - description: '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' - type: string - kind: - description: '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' - type: string - metadata: - type: object - spec: - properties: - autoPilot: - description: AutoPilot defines if the Operator can fly alone or if we - need human action to trigger Actions on specific Cassandra nodes If - autoPilot=true, the operator will set labels pod-operation-status=To-Do - on Pods which allows him to automatically triggers Action If autoPilot=false, - the operator will set labels pod-operation-status=Manual on Pods which - won't automatically triggers Action - type: boolean - autoUpdateSeedList: - description: AutoUpdateSeedList defines if the Operator automatically - update the SeedList according to new cluster CRD topology by default - a boolean is false - type: boolean - backRestSidecar: - description: BackRestSidecar defines details about cassandra-sidecar - to load along with each C* pod - properties: - image: - description: 'Image of backup/restore sidecar, default : "gcr.io/cassandra-operator/cassandra-sidecar:2.0.0-alpha8"' - type: string - imagePullPolicy: - description: ImagePullPolicy define the pull policy for backrest - sidecar docker image - type: string - resources: - description: 'Kubernetes object : https://godoc.org/k8s.io/api/core/v1#ResourceRequirements' - properties: - limits: - additionalProperties: - anyOf: - - type: integer - - type: string - pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ - x-kubernetes-int-or-string: true - description: 'Limits describes the maximum amount of compute - resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/' - type: object - requests: - additionalProperties: - anyOf: - - type: integer - - type: string - pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ - x-kubernetes-int-or-string: true - 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. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/' - type: object - type: object - type: object - bootstrapImage: - description: Image used for bootstrapping cluster (use the form base:version) - type: string - cassandraImage: - description: Image + version to use for Cassandra - type: string - configMapName: - description: Name of the ConfigMap for Cassandra configuration (cassandra.yaml) - If this is empty, operator will uses default cassandra.yaml from the - baseImage If this is not empty, operator will uses the cassandra.yaml - from the Configmap instead - type: string - dataCapacity: - description: Define the Capacity for Persistent Volume Claims in the - local storage - pattern: ^([+-]?[0-9.]+)([eEinumkKMGTP]*[-+]?[0-9]*)$ - type: string - dataStorageClass: - description: Define StorageClass for Persistent Volume Claims in the - local storage. - type: string - debug: - description: Debug is used to surcharge Cassandra pod command to not - directly start cassandra but starts an infinite wait to allow user - to connect a bash into the pod to make some diagnoses. - type: boolean - deletePVC: - description: DeletePVC defines if the PVC must be deleted when the cluster - is deleted it is false by default - type: boolean - gcStdout: - description: 'GCStdout set the parameter CASSANDRA_GC_STDOUT which configure - the JVM -Xloggc: true by default' - type: boolean - hardAntiAffinity: - description: HardAntiAffinity defines if the PodAntiAffinity of the - statefulset has to be hard (it's soft by default) - type: boolean - imageJolokiaSecret: - description: JMX Secret if Set is used to set JMX_USER and JMX_PASSWORD - properties: - name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, uid?' - type: string - type: object - imagePullSecret: - description: Name of the secret to uses to authenticate on Docker registries - If this is empty, operator do nothing If this is not empty, propagate - the imagePullSecrets to the statefulsets - properties: - name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, uid?' - type: string - type: object - imagepullpolicy: - description: ImagePullPolicy define the pull policy for C* docker image - type: string - initContainerCmd: - description: Command to execute in the initContainer in the targeted - image - type: string - initContainerImage: - description: Image used in the initContainer (use the form base:version) - type: string - livenessFailureThreshold: - description: 'LivenessFailureThreshold defines failure threshold for - the liveness probe of the main cassandra container : https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#configure-probes' - format: int32 - type: integer - livenessHealthCheckPeriod: - description: 'LivenessHealthCheckPeriod defines health check period - for the liveness probe of the main cassandra container : https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#configure-probes' - format: int32 - type: integer - livenessHealthCheckTimeout: - description: 'LivenessHealthCheckTimeout defines health check timeout - for the liveness probe of the main cassandra container : https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#configure-probes' - format: int32 - type: integer - livenessInitialDelaySeconds: - description: 'LivenessInitialDelaySeconds defines initial delay for - the liveness probe of the main cassandra container : https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#configure-probes' - format: int32 - type: integer - livenessSuccessThreshold: - description: 'LivenessSuccessThreshold defines success threshold for - the liveness probe of the main cassandra container : https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#configure-probes' - format: int32 - type: integer - maxPodUnavailable: - format: int32 - type: integer - noCheckStsAreEqual: - type: boolean - nodesPerRacks: - description: 'Number of nodes to deploy for a Cassandra deployment in - each Racks. Default: 1. If NodesPerRacks = 2 and there is 3 racks, - the cluster will have 6 Cassandra Nodes' - format: int32 - type: integer - pod: - description: PodPolicy defines the policy for pods owned by CassKop - operator. - properties: - annotations: - additionalProperties: - type: string - description: Annotations specifies the annotations to attach to - headless service the CassKop operator creates - type: object - tolerations: - description: Tolerations specifies the tolerations to attach to - the pods the CassKop operator creates - items: - description: The pod this Toleration is attached to tolerates - any taint that matches the triple using the - matching operator . - properties: - effect: - description: Effect indicates the taint effect to match. Empty - means match all taint effects. When specified, allowed values - are NoSchedule, PreferNoSchedule and NoExecute. - type: string - key: - description: Key is the taint key that the toleration applies - to. Empty means match all taint keys. If the key is empty, - operator must be Exists; this combination means to match - all values and all keys. - type: string - operator: - description: Operator represents a key's relationship to the - value. Valid operators are Exists and Equal. Defaults to - Equal. Exists is equivalent to wildcard for value, so that - a pod can tolerate all taints of a particular category. - type: string - tolerationSeconds: - description: TolerationSeconds represents the period of time - the toleration (which must be of effect NoExecute, otherwise - this field is ignored) tolerates the taint. By default, - it is not set, which means tolerate the taint forever (do - not evict). Zero and negative values will be treated as - 0 (evict immediately) by the system. - format: int64 - type: integer - value: - description: Value is the taint value the toleration matches - to. If the operator is Exists, the value should be empty, - otherwise just a regular string. - type: string - type: object - type: array - type: object - readOnlyRootFilesystem: - description: Make the pod as Readonly - type: boolean - readinessFailureThreshold: - description: 'ReadinessFailureThreshold defines failure threshold for - the readiness probe of the main cassandra container : https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#configure-probes' - format: int32 - type: integer - readinessHealthCheckPeriod: - description: 'ReadinessHealthCheckPeriod defines health check period - for the readiness probe of the main cassandra container : https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#configure-probes' - format: int32 - type: integer - readinessHealthCheckTimeout: - description: 'ReadinessHealthCheckTimeout defines health check timeout - for the readiness probe of the main cassandra container : https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#configure-probes' - format: int32 - type: integer - readinessInitialDelaySeconds: - description: 'ReadinessInitialDelaySeconds defines initial delay for - the readiness probe of the main cassandra container : https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#configure-probes' - format: int32 - type: integer - readinessSuccessThreshold: - description: 'ReadinessSuccessThreshold defines success threshold for - the readiness probe of the main cassandra container : https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#configure-probes' - format: int32 - type: integer - resources: - description: Pod defines the policy for pods owned by cassandra operator. - This field cannot be updated once the CR is created. Pod *PodPolicy `json:"pod,omitempty"` - properties: - limits: - properties: - cpu: - pattern: ^([+-]?[0-9.]+)([eEinumkKMGTP]*[-+]?[0-9]*)$ - type: string - memory: - pattern: ^([+-]?[0-9.]+)([eEinumkKMGTP]*[-+]?[0-9]*)$ - type: string - required: - - cpu - - memory - type: object - requests: - properties: - cpu: - pattern: ^([+-]?[0-9.]+)([eEinumkKMGTP]*[-+]?[0-9]*)$ - type: string - memory: - pattern: ^([+-]?[0-9.]+)([eEinumkKMGTP]*[-+]?[0-9]*)$ - type: string - required: - - cpu - - memory - type: object - type: object - restartCountBeforePodDeletion: - description: RestartCountBeforePodDeletion defines the number of restart - allowed for a cassandra container allowed before deleting the pod to - force its restart from scratch. if set to 0 or omit, no action will - be performed based on restart count. - format: int32 - type: integer - runAsUser: - description: RunAsUser define the id of the user to run in the Cassandra - image - format: int64 - minimum: 1 - type: integer - service: - description: ServicePolicy defines the policy for headless service owned - by CassKop operator. - properties: - annotations: - additionalProperties: - type: string - description: Annotations specifies the annotations to attach to - headless service the CassKop operator creates - type: object - type: object - serviceAccountName: - type: string - shareProcessNamespace: - description: 'When process namespace sharing is enabled, processes in - a container are visible to all other containers in that pod. https://kubernetes.io/docs/tasks/configure-pod-container/share-process-namespace/ - Optional: Default to false.' - type: boolean - sidecarConfigs: - description: SidecarsConfig defines additional sidecar configurations - items: - description: A single application container that you want to run within - a pod. - properties: - args: - description: 'Arguments to the entrypoint. The docker image''s - CMD is used if this is not provided. Variable references $(VAR_NAME) - are expanded using the container''s environment. If a variable - cannot be resolved, the reference in the input string will be - unchanged. The $(VAR_NAME) syntax can be escaped with a double - $$, ie: $$(VAR_NAME). Escaped references will never be expanded, - regardless of whether the variable exists or not. Cannot be - updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell' - items: - type: string - type: array - command: - description: 'Entrypoint array. Not executed within a shell. The - docker image''s ENTRYPOINT is used if this is not provided. - Variable references $(VAR_NAME) are expanded using the container''s - environment. If a variable cannot be resolved, the reference - in the input string will be unchanged. The $(VAR_NAME) syntax - can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references - will never be expanded, regardless of whether the variable exists - or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell' - items: - type: string - type: array - env: - description: List of environment variables to set in the container. - Cannot be updated. - items: - description: EnvVar represents an environment variable present - in a Container. - properties: - name: - description: Name of the environment variable. Must be a - C_IDENTIFIER. - type: string - value: - description: 'Variable references $(VAR_NAME) are expanded - using the previous defined environment variables in the - container and any service environment variables. If a - variable cannot be resolved, the reference in the input - string will be unchanged. The $(VAR_NAME) syntax can be - escaped with a double $$, ie: $$(VAR_NAME). Escaped references - will never be expanded, regardless of whether the variable - exists or not. Defaults to "".' - type: string - valueFrom: - description: Source for the environment variable's value. - Cannot be used if value is not empty. - properties: - configMapKeyRef: - description: Selects a key of a ConfigMap. - properties: - key: - description: The key to select. - type: string - name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' - type: string - optional: - description: Specify whether the ConfigMap or its - key must be defined - type: boolean - required: - - key - type: object - fieldRef: - description: 'Selects a field of the pod: supports metadata.name, - metadata.namespace, metadata.labels, metadata.annotations, - spec.nodeName, spec.serviceAccountName, status.hostIP, - status.podIP, status.podIPs.' - properties: - apiVersion: - description: Version of the schema the FieldPath - is written in terms of, defaults to "v1". - type: string - fieldPath: - description: Path of the field to select in the - specified API version. - type: string - required: - - fieldPath - type: object - resourceFieldRef: - description: 'Selects a resource of the container: only - resources limits and requests (limits.cpu, limits.memory, - limits.ephemeral-storage, requests.cpu, requests.memory - and requests.ephemeral-storage) are currently supported.' - properties: - containerName: - description: 'Container name: required for volumes, - optional for env vars' - type: string - divisor: - anyOf: - - type: integer - - type: string - description: Specifies the output format of the - exposed resources, defaults to "1" - pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ - x-kubernetes-int-or-string: true - resource: - description: 'Required: resource to select' - type: string - required: - - resource - type: object - secretKeyRef: - description: Selects a key of a secret in the pod's - namespace - properties: - key: - description: The key of the secret to select from. Must - be a valid secret key. - type: string - name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' - type: string - optional: - description: Specify whether the Secret or its key - must be defined - type: boolean - required: - - key - type: object - type: object - required: - - name - type: object - type: array - envFrom: - description: List of sources to populate environment variables - in the container. The keys defined within a source must be a - C_IDENTIFIER. All invalid keys will be reported as an event - when the container is starting. When a key exists in multiple - sources, the value associated with the last source will take - precedence. Values defined by an Env with a duplicate key will - take precedence. Cannot be updated. - items: - description: EnvFromSource represents the source of a set of - ConfigMaps - properties: - configMapRef: - description: The ConfigMap to select from - properties: - name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, uid?' - type: string - optional: - description: Specify whether the ConfigMap must be defined - type: boolean - type: object - prefix: - description: An optional identifier to prepend to each key - in the ConfigMap. Must be a C_IDENTIFIER. - type: string - secretRef: - description: The Secret to select from - properties: - name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, uid?' - type: string - optional: - description: Specify whether the Secret must be defined - type: boolean - type: object - type: object - type: array - image: - description: 'Docker image name. More info: https://kubernetes.io/docs/concepts/containers/images - This field is optional to allow higher level config management - to default or override container images in workload controllers - like Deployments and StatefulSets.' - type: string - imagePullPolicy: - description: 'Image pull policy. One of Always, Never, IfNotPresent. - Defaults to Always if :latest tag is specified, or IfNotPresent - otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images' - type: string - lifecycle: - description: Actions that the management system should take in - response to container lifecycle events. Cannot be updated. - properties: - postStart: - description: 'PostStart is called immediately after a container - is created. If the handler fails, the container is terminated - and restarted according to its restart policy. Other management - of the container blocks until the hook completes. More info: - https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks' - properties: - exec: - description: One and only one of the following should - be specified. Exec specifies the action to take. - properties: - command: - description: Command is the command line to execute - inside the container, the working directory for - the command is root ('/') in the container's filesystem. - The command is simply exec'd, it is not run inside - a shell, so traditional shell instructions ('|', - etc) won't work. To use a shell, you need to explicitly - call out to that shell. Exit status of 0 is treated - as live/healthy and non-zero is unhealthy. - items: - type: string - type: array - type: object - httpGet: - description: HTTPGet specifies the http request to perform. - properties: - host: - description: Host name to connect to, defaults to - the pod IP. You probably want to set "Host" in httpHeaders - instead. - type: string - httpHeaders: - description: Custom headers to set in the request. - HTTP allows repeated headers. - items: - description: HTTPHeader describes a custom header - to be used in HTTP probes - properties: - name: - description: The header field name - type: string - value: - description: The header field value - type: string - required: - - name - - value - type: object - type: array - path: - description: Path to access on the HTTP server. - type: string - port: - anyOf: - - type: integer - - type: string - description: Name or number of the port to access - on the container. Number must be in the range 1 - to 65535. Name must be an IANA_SVC_NAME. - x-kubernetes-int-or-string: true - scheme: - description: Scheme to use for connecting to the host. - Defaults to HTTP. - type: string - required: - - port - type: object - tcpSocket: - description: 'TCPSocket specifies an action involving - a TCP port. TCP hooks not yet supported TODO: implement - a realistic TCP lifecycle hook' - properties: - host: - description: 'Optional: Host name to connect to, defaults - to the pod IP.' - type: string - port: - anyOf: - - type: integer - - type: string - description: Number or name of the port to access - on the container. Number must be in the range 1 - to 65535. Name must be an IANA_SVC_NAME. - x-kubernetes-int-or-string: true - required: - - port - type: object - type: object - preStop: - description: 'PreStop is called immediately before a container - is terminated due to an API request or management event - such as liveness/startup probe failure, preemption, resource - contention, etc. The handler is not called if the container - crashes or exits. The reason for termination is passed to - the handler. The Pod''s termination grace period countdown - begins before the PreStop hooked is executed. Regardless - of the outcome of the handler, the container will eventually - terminate within the Pod''s termination grace period. Other - management of the container blocks until the hook completes - or until the termination grace period is reached. More info: - https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks' - properties: - exec: - description: One and only one of the following should - be specified. Exec specifies the action to take. - properties: - command: - description: Command is the command line to execute - inside the container, the working directory for - the command is root ('/') in the container's filesystem. - The command is simply exec'd, it is not run inside - a shell, so traditional shell instructions ('|', - etc) won't work. To use a shell, you need to explicitly - call out to that shell. Exit status of 0 is treated - as live/healthy and non-zero is unhealthy. - items: - type: string - type: array - type: object - httpGet: - description: HTTPGet specifies the http request to perform. - properties: - host: - description: Host name to connect to, defaults to - the pod IP. You probably want to set "Host" in httpHeaders - instead. - type: string - httpHeaders: - description: Custom headers to set in the request. - HTTP allows repeated headers. - items: - description: HTTPHeader describes a custom header - to be used in HTTP probes - properties: - name: - description: The header field name - type: string - value: - description: The header field value - type: string - required: - - name - - value - type: object - type: array - path: - description: Path to access on the HTTP server. - type: string - port: - anyOf: - - type: integer - - type: string - description: Name or number of the port to access - on the container. Number must be in the range 1 - to 65535. Name must be an IANA_SVC_NAME. - x-kubernetes-int-or-string: true - scheme: - description: Scheme to use for connecting to the host. - Defaults to HTTP. - type: string - required: - - port - type: object - tcpSocket: - description: 'TCPSocket specifies an action involving - a TCP port. TCP hooks not yet supported TODO: implement - a realistic TCP lifecycle hook' - properties: - host: - description: 'Optional: Host name to connect to, defaults - to the pod IP.' - type: string - port: - anyOf: - - type: integer - - type: string - description: Number or name of the port to access - on the container. Number must be in the range 1 - to 65535. Name must be an IANA_SVC_NAME. - x-kubernetes-int-or-string: true - required: - - port - type: object - type: object - type: object - livenessProbe: - description: 'Periodic probe of container liveness. Container - will be restarted if the probe fails. Cannot be updated. More - info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes' - properties: - exec: - description: One and only one of the following should be specified. - Exec specifies the action to take. - properties: - command: - description: Command is the command line to execute inside - the container, the working directory for the command is - root ('/') in the container's filesystem. The command - is simply exec'd, it is not run inside a shell, so traditional - shell instructions ('|', etc) won't work. To use a shell, - you need to explicitly call out to that shell. Exit - status of 0 is treated as live/healthy and non-zero - is unhealthy. - items: - type: string - type: array - type: object - failureThreshold: - description: Minimum consecutive failures for the probe to - be considered failed after having succeeded. Defaults to - 3. Minimum value is 1. - format: int32 - type: integer - httpGet: - description: HTTPGet specifies the http request to perform. - properties: - host: - description: Host name to connect to, defaults to the - pod IP. You probably want to set "Host" in httpHeaders - instead. - type: string - httpHeaders: - description: Custom headers to set in the request. HTTP - allows repeated headers. - items: - description: HTTPHeader describes a custom header to - be used in HTTP probes - properties: - name: - description: The header field name - type: string - value: - description: The header field value - type: string - required: - - name - - value - type: object - type: array - path: - description: Path to access on the HTTP server. - type: string - port: - anyOf: - - type: integer - - type: string - description: Name or number of the port to access on the - container. Number must be in the range 1 to 65535. Name - must be an IANA_SVC_NAME. - x-kubernetes-int-or-string: true - scheme: - description: Scheme to use for connecting to the host. - Defaults to HTTP. - type: string - required: - - port - type: object - initialDelaySeconds: - description: 'Number of seconds after the container has started - before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes' - format: int32 - type: integer - periodSeconds: - description: How often (in seconds) to perform the probe. - Default to 10 seconds. Minimum value is 1. - format: int32 - type: integer - successThreshold: - description: Minimum consecutive successes for the probe to - be considered successful after having failed. Defaults to - 1. Must be 1 for liveness and startup. Minimum value is - 1. - format: int32 - type: integer - tcpSocket: - description: 'TCPSocket specifies an action involving a TCP - port. TCP hooks not yet supported TODO: implement a realistic - TCP lifecycle hook' - properties: - host: - description: 'Optional: Host name to connect to, defaults - to the pod IP.' - type: string - port: - anyOf: - - type: integer - - type: string - description: Number or name of the port to access on the - container. Number must be in the range 1 to 65535. Name - must be an IANA_SVC_NAME. - x-kubernetes-int-or-string: true - required: - - port - type: object - timeoutSeconds: - description: 'Number of seconds after which the probe times - out. Defaults to 1 second. Minimum value is 1. More info: - https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes' - format: int32 - type: integer - type: object - name: - description: Name of the container specified as a DNS_LABEL. Each - container in a pod must have a unique name (DNS_LABEL). Cannot - be updated. - type: string - ports: - description: List of ports to expose from the container. Exposing - a port here gives the system additional information about the - network connections a container uses, but is primarily informational. - Not specifying a port here DOES NOT prevent that port from being - exposed. Any port which is listening on the default "0.0.0.0" - address inside a container will be accessible from the network. - Cannot be updated. - items: - description: ContainerPort represents a network port in a single - container. - properties: - containerPort: - description: Number of port to expose on the pod's IP address. - This must be a valid port number, 0 < x < 65536. - format: int32 - type: integer - hostIP: - description: What host IP to bind the external port to. - type: string - hostPort: - description: Number of port to expose on the host. If specified, - this must be a valid port number, 0 < x < 65536. If HostNetwork - is specified, this must match ContainerPort. Most containers - do not need this. - format: int32 - type: integer - name: - description: If specified, this must be an IANA_SVC_NAME - and unique within the pod. Each named port in a pod must - have a unique name. Name for the port that can be referred - to by services. - type: string - protocol: - description: Protocol for port. Must be UDP, TCP, or SCTP. - Defaults to "TCP". - type: string - required: - - containerPort - type: object - type: array - x-kubernetes-list-map-keys: - - containerPort - - protocol - x-kubernetes-list-type: map - readinessProbe: - description: 'Periodic probe of container service readiness. Container - will be removed from service endpoints if the probe fails. Cannot - be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes' - properties: - exec: - description: One and only one of the following should be specified. - Exec specifies the action to take. - properties: - command: - description: Command is the command line to execute inside - the container, the working directory for the command is - root ('/') in the container's filesystem. The command - is simply exec'd, it is not run inside a shell, so traditional - shell instructions ('|', etc) won't work. To use a shell, - you need to explicitly call out to that shell. Exit - status of 0 is treated as live/healthy and non-zero - is unhealthy. - items: - type: string - type: array - type: object - failureThreshold: - description: Minimum consecutive failures for the probe to - be considered failed after having succeeded. Defaults to - 3. Minimum value is 1. - format: int32 - type: integer - httpGet: - description: HTTPGet specifies the http request to perform. - properties: - host: - description: Host name to connect to, defaults to the - pod IP. You probably want to set "Host" in httpHeaders - instead. - type: string - httpHeaders: - description: Custom headers to set in the request. HTTP - allows repeated headers. - items: - description: HTTPHeader describes a custom header to - be used in HTTP probes - properties: - name: - description: The header field name - type: string - value: - description: The header field value - type: string - required: - - name - - value - type: object - type: array - path: - description: Path to access on the HTTP server. - type: string - port: - anyOf: - - type: integer - - type: string - description: Name or number of the port to access on the - container. Number must be in the range 1 to 65535. Name - must be an IANA_SVC_NAME. - x-kubernetes-int-or-string: true - scheme: - description: Scheme to use for connecting to the host. - Defaults to HTTP. - type: string - required: - - port - type: object - initialDelaySeconds: - description: 'Number of seconds after the container has started - before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes' - format: int32 - type: integer - periodSeconds: - description: How often (in seconds) to perform the probe. - Default to 10 seconds. Minimum value is 1. - format: int32 - type: integer - successThreshold: - description: Minimum consecutive successes for the probe to - be considered successful after having failed. Defaults to - 1. Must be 1 for liveness and startup. Minimum value is - 1. - format: int32 - type: integer - tcpSocket: - description: 'TCPSocket specifies an action involving a TCP - port. TCP hooks not yet supported TODO: implement a realistic - TCP lifecycle hook' - properties: - host: - description: 'Optional: Host name to connect to, defaults - to the pod IP.' - type: string - port: - anyOf: - - type: integer - - type: string - description: Number or name of the port to access on the - container. Number must be in the range 1 to 65535. Name - must be an IANA_SVC_NAME. - x-kubernetes-int-or-string: true - required: - - port - type: object - timeoutSeconds: - description: 'Number of seconds after which the probe times - out. Defaults to 1 second. Minimum value is 1. More info: - https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes' - format: int32 - type: integer - type: object - resources: - description: 'Compute Resources required by this container. Cannot - be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/' - properties: - limits: - additionalProperties: - anyOf: - - type: integer - - type: string - pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ - x-kubernetes-int-or-string: true - description: 'Limits describes the maximum amount of compute - resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/' - type: object - requests: - additionalProperties: - anyOf: - - type: integer - - type: string - pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ - x-kubernetes-int-or-string: true - 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. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/' - type: object - type: object - securityContext: - description: 'Security options the pod should run with. More info: - https://kubernetes.io/docs/concepts/policy/security-context/ - More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/' - properties: - allowPrivilegeEscalation: - description: 'AllowPrivilegeEscalation controls whether a - process can gain more privileges than its parent process. - This bool directly controls if the no_new_privs flag will - be set on the container process. AllowPrivilegeEscalation - is true always when the container is: 1) run as Privileged - 2) has CAP_SYS_ADMIN' - type: boolean - capabilities: - description: The capabilities to add/drop when running containers. - Defaults to the default set of capabilities granted by the - container runtime. - properties: - add: - description: Added capabilities - items: - description: Capability represent POSIX capabilities - type - type: string - type: array - drop: - description: Removed capabilities - items: - description: Capability represent POSIX capabilities - type - type: string - type: array - type: object - privileged: - description: Run container in privileged mode. Processes in - privileged containers are essentially equivalent to root - on the host. Defaults to false. - type: boolean - procMount: - description: procMount denotes the type of proc mount to use - for the containers. The default is DefaultProcMount which - uses the container runtime defaults for readonly paths and - masked paths. This requires the ProcMountType feature flag - to be enabled. - type: string - readOnlyRootFilesystem: - description: Whether this container has a read-only root filesystem. - Default is false. - type: boolean - runAsGroup: - description: The GID to run the entrypoint of the container - process. Uses runtime default if unset. May also be set - in PodSecurityContext. If set in both SecurityContext and - PodSecurityContext, the value specified in SecurityContext - takes precedence. - format: int64 - type: integer - runAsNonRoot: - description: Indicates that the container must run as a non-root - user. If true, the Kubelet will validate the image at runtime - to ensure that it does not run as UID 0 (root) and fail - to start the container if it does. If unset or false, no - such validation will be performed. May also be set in PodSecurityContext. If - set in both SecurityContext and PodSecurityContext, the - value specified in SecurityContext takes precedence. - type: boolean - runAsUser: - description: The UID to run the entrypoint of the container - process. Defaults to user specified in image metadata if - unspecified. May also be set in PodSecurityContext. If - set in both SecurityContext and PodSecurityContext, the - value specified in SecurityContext takes precedence. - format: int64 - type: integer - seLinuxOptions: - description: The SELinux context to be applied to the container. - If unspecified, the container runtime will allocate a random - SELinux context for each container. May also be set in - PodSecurityContext. If set in both SecurityContext and - PodSecurityContext, the value specified in SecurityContext - takes precedence. - properties: - level: - description: Level is SELinux level label that applies - to the container. - type: string - role: - description: Role is a SELinux role label that applies - to the container. - type: string - type: - description: Type is a SELinux type label that applies - to the container. - type: string - user: - description: User is a SELinux user label that applies - to the container. - type: string - type: object - windowsOptions: - description: The Windows specific settings applied to all - containers. If unspecified, the options from the PodSecurityContext - will be used. If set in both SecurityContext and PodSecurityContext, - the value specified in SecurityContext takes precedence. - properties: - gmsaCredentialSpec: - description: GMSACredentialSpec is where the GMSA admission - webhook (https://github.com/kubernetes-sigs/windows-gmsa) - inlines the contents of the GMSA credential spec named - by the GMSACredentialSpecName field. - type: string - gmsaCredentialSpecName: - description: GMSACredentialSpecName is the name of the - GMSA credential spec to use. - type: string - runAsUserName: - description: The UserName in Windows to run the entrypoint - of the container process. Defaults to the user specified - in image metadata if unspecified. May also be set in - PodSecurityContext. If set in both SecurityContext and - PodSecurityContext, the value specified in SecurityContext - takes precedence. - type: string - type: object - type: object - startupProbe: - description: 'StartupProbe indicates that the Pod has successfully - initialized. If specified, no other probes are executed until - this completes successfully. If this probe fails, the Pod will - be restarted, just as if the livenessProbe failed. This can - be used to provide different probe parameters at the beginning - of a Pod''s lifecycle, when it might take a long time to load - data or warm a cache, than during steady-state operation. This - cannot be updated. This is a beta feature enabled by the StartupProbe - feature flag. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes' - properties: - exec: - description: One and only one of the following should be specified. - Exec specifies the action to take. - properties: - command: - description: Command is the command line to execute inside - the container, the working directory for the command is - root ('/') in the container's filesystem. The command - is simply exec'd, it is not run inside a shell, so traditional - shell instructions ('|', etc) won't work. To use a shell, - you need to explicitly call out to that shell. Exit - status of 0 is treated as live/healthy and non-zero - is unhealthy. - items: - type: string - type: array - type: object - failureThreshold: - description: Minimum consecutive failures for the probe to - be considered failed after having succeeded. Defaults to - 3. Minimum value is 1. - format: int32 - type: integer - httpGet: - description: HTTPGet specifies the http request to perform. - properties: - host: - description: Host name to connect to, defaults to the - pod IP. You probably want to set "Host" in httpHeaders - instead. - type: string - httpHeaders: - description: Custom headers to set in the request. HTTP - allows repeated headers. - items: - description: HTTPHeader describes a custom header to - be used in HTTP probes - properties: - name: - description: The header field name - type: string - value: - description: The header field value - type: string - required: - - name - - value - type: object - type: array - path: - description: Path to access on the HTTP server. - type: string - port: - anyOf: - - type: integer - - type: string - description: Name or number of the port to access on the - container. Number must be in the range 1 to 65535. Name - must be an IANA_SVC_NAME. - x-kubernetes-int-or-string: true - scheme: - description: Scheme to use for connecting to the host. - Defaults to HTTP. - type: string - required: - - port - type: object - initialDelaySeconds: - description: 'Number of seconds after the container has started - before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes' - format: int32 - type: integer - periodSeconds: - description: How often (in seconds) to perform the probe. - Default to 10 seconds. Minimum value is 1. - format: int32 - type: integer - successThreshold: - description: Minimum consecutive successes for the probe to - be considered successful after having failed. Defaults to - 1. Must be 1 for liveness and startup. Minimum value is - 1. - format: int32 - type: integer - tcpSocket: - description: 'TCPSocket specifies an action involving a TCP - port. TCP hooks not yet supported TODO: implement a realistic - TCP lifecycle hook' - properties: - host: - description: 'Optional: Host name to connect to, defaults - to the pod IP.' - type: string - port: - anyOf: - - type: integer - - type: string - description: Number or name of the port to access on the - container. Number must be in the range 1 to 65535. Name - must be an IANA_SVC_NAME. - x-kubernetes-int-or-string: true - required: - - port - type: object - timeoutSeconds: - description: 'Number of seconds after which the probe times - out. Defaults to 1 second. Minimum value is 1. More info: - https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes' - format: int32 - type: integer - type: object - stdin: - description: Whether this container should allocate a buffer for - stdin in the container runtime. If this is not set, reads from - stdin in the container will always result in EOF. Default is - false. - type: boolean - stdinOnce: - description: Whether the container runtime should close the stdin - channel after it has been opened by a single attach. When stdin - is true the stdin stream will remain open across multiple attach - sessions. If stdinOnce is set to true, stdin is opened on container - start, is empty until the first client attaches to stdin, and - then remains open and accepts data until the client disconnects, - at which time stdin is closed and remains closed until the container - is restarted. If this flag is false, a container processes that - reads from stdin will never receive an EOF. Default is false - type: boolean - terminationMessagePath: - description: 'Optional: Path at which the file to which the container''s - termination message will be written is mounted into the container''s - filesystem. Message written is intended to be brief final status, - such as an assertion failure message. Will be truncated by the - node if greater than 4096 bytes. The total message length across - all containers will be limited to 12kb. Defaults to /dev/termination-log. - Cannot be updated.' - type: string - terminationMessagePolicy: - description: Indicate how the termination message should be populated. - File will use the contents of terminationMessagePath to populate - the container status message on both success and failure. FallbackToLogsOnError - will use the last chunk of container log output if the termination - message file is empty and the container exited with an error. - The log output is limited to 2048 bytes or 80 lines, whichever - is smaller. Defaults to File. Cannot be updated. - type: string - tty: - description: Whether this container should allocate a TTY for - itself, also requires 'stdin' to be true. Default is false. - type: boolean - volumeDevices: - description: volumeDevices is the list of block devices to be - used by the container. - items: - description: volumeDevice describes a mapping of a raw block - device within a container. - properties: - devicePath: - description: devicePath is the path inside of the container - that the device will be mapped to. - type: string - name: - description: name must match the name of a persistentVolumeClaim - in the pod - type: string - required: - - devicePath - - name - type: object - type: array - volumeMounts: - description: Pod volumes to mount into the container's filesystem. - Cannot be updated. - items: - description: VolumeMount describes a mounting of a Volume within - a container. - properties: - mountPath: - description: Path within the container at which the volume - should be mounted. Must not contain ':'. - type: string - mountPropagation: - description: mountPropagation determines how mounts are - propagated from the host to container and the other way - around. When not set, MountPropagationNone is used. This - field is beta in 1.10. - type: string - name: - description: This must match the Name of a Volume. - type: string - readOnly: - description: Mounted read-only if true, read-write otherwise - (false or unspecified). Defaults to false. - type: boolean - subPath: - description: Path within the volume from which the container's - volume should be mounted. Defaults to "" (volume's root). - type: string - subPathExpr: - description: Expanded path within the volume from which - the container's volume should be mounted. Behaves similarly - to SubPath but environment variable references $(VAR_NAME) - are expanded using the container's environment. Defaults - to "" (volume's root). SubPathExpr and SubPath are mutually - exclusive. - type: string - required: - - mountPath - - name - type: object - type: array - workingDir: - description: Container's working directory. If not specified, - the container runtime's default will be used, which might be - configured in the container image. Cannot be updated. - type: string - required: - - name - type: object - type: array - storageConfigs: - description: StorageConfig defines additional storage configurations - items: - description: StorageConfig defines additional storage configurations - properties: - mountPath: - description: Mount path into cassandra container - type: string - name: - description: Name of the pvc - pattern: '[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*' - type: string - pvcSpec: - description: Persistent volume claim spec - properties: - accessModes: - description: 'AccessModes contains the desired access modes - the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1' - items: - type: string - type: array - dataSource: - description: 'This field can be used to specify either: * - An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot - - Beta) * An existing PVC (PersistentVolumeClaim) * An existing - custom resource/object that implements data population (Alpha) - In order to use VolumeSnapshot object types, the appropriate - feature gate must be enabled (VolumeSnapshotDataSource or - AnyVolumeDataSource) If the provisioner or an external controller - can support the specified data source, it will create a - new volume based on the contents of the specified data source. - If the specified data source is not supported, the volume - will not be created and the failure will be reported as - an event. In the future, we plan to support more data source - types and the behavior of the provisioner may change.' - properties: - apiGroup: - description: APIGroup is the group for the resource being - referenced. If APIGroup is not specified, the specified - Kind must be in the core API group. For any other third-party - types, APIGroup is required. - type: string - kind: - description: Kind is the type of resource being referenced - type: string - name: - description: Name is the name of resource being referenced - type: string - required: - - kind - - name - type: object - resources: - description: 'Resources represents the minimum resources the - volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources' - properties: - limits: - additionalProperties: - anyOf: - - type: integer - - type: string - pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ - x-kubernetes-int-or-string: true - description: 'Limits describes the maximum amount of compute - resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/' - type: object - requests: - additionalProperties: - anyOf: - - type: integer - - type: string - pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ - x-kubernetes-int-or-string: true - 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. - More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/' - type: object - type: object - selector: - description: A label query over volumes to consider for binding. - properties: - matchExpressions: - description: matchExpressions is a list of label selector - requirements. The requirements are ANDed. - items: - description: A label selector requirement is a selector - that contains values, a key, and an operator that - relates the key and values. - properties: - key: - description: key is the label key that the selector - applies to. - type: string - operator: - description: operator represents a key's relationship - to a set of values. Valid operators are In, NotIn, - Exists and DoesNotExist. - type: string - values: - description: 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. - items: - type: string - type: array - required: - - key - - operator - type: object - type: array - matchLabels: - additionalProperties: - type: string - 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: object - type: object - storageClassName: - description: 'Name of the StorageClass required by the claim. - More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1' - type: string - volumeMode: - description: volumeMode defines what type of volume is required - by the claim. Value of Filesystem is implied when not included - in claim spec. - type: string - volumeName: - description: VolumeName is the binding reference to the PersistentVolume - backing this claim. - type: string - type: object - required: - - mountPath - - name - - pvcSpec - type: object - type: array - topology: - description: Topology to create Cassandra DC and Racks and to target - appropriate Kubernetes Nodes - properties: - dc: - description: List of DC defined in the CassandraCluster - items: - description: DC allow to configure Cassandra RC according to kubernetes - nodeselector labels - properties: - dataCapacity: - description: Define the Capacity for Persistent Volume Claims - in the local storage - pattern: ^([+-]?[0-9.]+)([eEinumkKMGTP]*[-+]?[0-9]*)$ - type: string - dataStorageClass: - description: Define StorageClass for Persistent Volume Claims - in the local storage. - type: string - labels: - additionalProperties: - type: string - description: Labels used to target Kubernetes nodes - type: object - name: - description: Name of the DC - pattern: ^[^-]+$ - type: string - nodesPerRacks: - description: 'Number of nodes to deploy for a Cassandra deployment - in each Racks. Default: 1. Optional, if not filled, used - value define in CassandraClusterSpec' - format: int32 - type: integer - numTokens: - description: 'NumTokens : configure the CASSANDRA_NUM_TOKENS - parameter which can be different for each DD' - format: int32 - type: integer - rack: - description: List of Racks defined in the Cassandra DC - items: - description: Rack allow to configure Cassandra Rack according - to kubernetes nodeselector labels - properties: - labels: - additionalProperties: - type: string - description: Labels used to target Kubernetes nodes - type: object - name: - description: Name of the Rack - pattern: ^[^-]+$ - type: string - rollingPartition: - description: The Partition to control the Statefulset - Upgrade - format: int32 - type: integer - rollingRestart: - description: Flag to tell the operator to trigger a - rolling restart of the Rack - type: boolean - type: object - type: array - type: object - type: array - type: object - unlockNextOperation: - description: Very special Flag to hack CassKop reconcile loop - use - with really good Care - type: boolean - type: object - status: - description: CassandraClusterStatus defines Global state of CassandraCluster - properties: - cassandraNodeStatus: - additionalProperties: - properties: - hostId: - type: string - nodeIp: - type: string - type: object - type: object - cassandraRackStatus: - additionalProperties: - description: CassandraRackStatus defines states of Cassandra for 1 - rack (1 statefulset) - properties: - cassandraLastAction: - description: 'CassandraLastAction is the set of Cassandra State - & Actions: Active, Standby..' - properties: - endTime: - format: date-time - type: string - name: - description: 'Type of action to perform : UpdateVersion, UpdateBaseImage, - UpdateConfigMap..' - type: string - startTime: - format: date-time - type: string - status: - description: Action is the specific actions that can be done - on a Cassandra Cluster such as cleanup, upgradesstables.. - type: string - updatedNodes: - description: PodNames of updated Cassandra nodes. Updated - means the Cassandra container image version matches the - spec's version. - items: - type: string - type: array - type: object - phase: - description: 'Phase indicates the state this Cassandra cluster - jumps in. Phase goes as one way as below: Initial -> Running - <-> updating' - type: string - podLastOperation: - description: PodLastOperation manage status for Pod Operation - (nodetool cleanup, upgradesstables..) - properties: - endTime: - format: date-time - type: string - name: - type: string - operatorName: - description: Name of operator - type: string - pods: - description: List of pods running an operation - items: - type: string - type: array - podsKO: - description: List of pods that fail to run an operation - items: - type: string - type: array - podsOK: - description: List of pods that run an operation successfully - items: - type: string - type: array - startTime: - format: date-time - type: string - status: - type: string - type: object - type: object - description: CassandraRackStatusList list status for each Rack - type: object - lastClusterAction: - description: Store last action at cluster level - type: string - lastClusterActionStatus: - type: string - phase: - description: 'Phase indicates the state this Cassandra cluster jumps - in. Phase goes as one way as below: Initial -> Running <-> updating' - type: string - seedlist: - description: seeList to be used in Cassandra's Pods (computed by the - Operator) - items: - type: string - type: array - type: object - type: object - version: v1alpha1 - versions: - - name: v1alpha1 - served: true - storage: true diff --git a/deploy/crds/v1beta1/db.orange.com_cassandrarestores_crd.yaml b/deploy/crds/v1beta1/db.orange.com_cassandrarestores_crd.yaml deleted file mode 100644 index 401dfd37e..000000000 --- a/deploy/crds/v1beta1/db.orange.com_cassandrarestores_crd.yaml +++ /dev/null @@ -1,166 +0,0 @@ -apiVersion: apiextensions.k8s.io/v1beta1 -kind: CustomResourceDefinition -metadata: - name: cassandrarestores.db.orange.com -spec: - group: db.orange.com - names: - kind: CassandraRestore - listKind: CassandraRestoreList - plural: cassandrarestores - singular: cassandrarestore - scope: Namespaced - validation: - openAPIV3Schema: - description: CassandraRestore is a Casskop Operator resource that represents - the restoration of a backup of a Cassandra cluster - properties: - apiVersion: - description: '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' - type: string - kind: - description: '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' - type: string - metadata: - type: object - spec: - description: CassandraRestoreSpec defines the specification for a restore - of a Cassandra backup. - properties: - cassandraBackup: - description: Name of the CassandraBackup to restore - type: string - cassandraCluster: - description: Name of the CassandraCluster the restore belongs to - type: string - cassandraDirectory: - description: Directory of Cassandra where data folder resides. Defaults - to /var/lib/cassandra - type: string - concurrentConnection: - description: Maximum number of threads used to download files from the - cloud. Defaults to 10 - format: int32 - type: integer - entities: - description: Database entities to restore, it might be either only keyspaces - or only tables prefixed by their respective keyspace, e.g. 'k1,k2' - if one wants to backup whole keyspaces or 'ks1.t1,ks2.t2' if one wants - to restore specific tables. These formats are mutually exclusive so - 'k1,k2.t2' is invalid. An empty field will restore all keyspaces - type: string - exactSchemaVersion: - description: When set a running node's schema version must match the - snapshot's schema version. There might be cases when we want to restore - a table for which its CQL schema has not changed but it has changed - for other table / keyspace but a schema for that node has changed - by doing that. Defaults to False - type: boolean - noDeleteTruncates: - description: When set do not delete truncated SSTables after they've - been restored during CLEANUP phase. Defaults to false - type: boolean - restorationStrategyType: - description: Strategy telling how we should go about restoration, please - refer to details in backup and sidecar documentation - enum: - - HARDLINKS - - IMPORT - type: string - schemaVersion: - description: Version of the schema to restore from. Upon backup, a schema - version is automatically appended to a snapshot name and its manifest - is uploaded under that name. In case we have two snapshots having - same name, we might distinguish between the two of them by using the - schema version. If schema version is not specified, we expect a unique - backup taken with respective snapshot name. This schema version has - to match the version of a Cassandra node we are doing restore for - (hence, by proxy, when global request mode is used, all nodes have - to be on exact same schema version). Defaults to False - type: string - secret: - description: Name of Secret to use when accessing cloud storage providers - type: string - required: - - cassandraBackup - - cassandraCluster - type: object - status: - description: CassandraRestoreStatus captures the current status of a Cassandra - restore. - properties: - conditions: - description: RestoreCondition describes the observed state of a Restore - at a certain point - properties: - failureCause: - properties: - localizedMessage: - type: string - message: - type: string - stackTrace: - items: - properties: - className: - type: string - fileName: - type: string - lineNumber: - type: string - methodName: - type: string - nativeMethod: - type: string - type: object - type: array - required: - - localizedMessage - - message - - stackTrace - type: object - lastTransitionTime: - type: string - type: - description: RestoreConditionType represents a valid condition of - a Restore - type: string - required: - - type - type: object - coordinatorMember: - description: Name of the pod the restore operation is executed on - type: string - id: - description: unique identifier of an operation, a random id is assigned - to each operation after a request is submitted, from caller's perspective, - an id is sent back as a response to his request so he can further - query state of that operation, referencing id, by operations/{id} - endpoint - type: string - progress: - description: Progress is a percentage, 100% means the operation is completed, - either successfully or with errors - type: string - restorationPhase: - type: string - timeCompleted: - type: string - timeCreated: - type: string - timeStarted: - type: string - type: object - required: - - metadata - - spec - type: object - version: v1alpha1 - versions: - - name: v1alpha1 - served: true - storage: true diff --git a/helm/cassandra-operator/crds/db.orange.com_cassandrabackups_crd.yaml b/helm/cassandra-operator/crds/db.orange.com_cassandrabackups_crd.yaml new file mode 100644 index 000000000..9a2474b4f --- /dev/null +++ b/helm/cassandra-operator/crds/db.orange.com_cassandrabackups_crd.yaml @@ -0,0 +1,136 @@ +apiVersion: apiextensions.k8s.io/v1 +kind: CustomResourceDefinition +metadata: + name: cassandrabackups.db.orange.com +spec: + group: db.orange.com + names: + kind: CassandraBackup + listKind: CassandraBackupList + plural: cassandrabackups + singular: cassandrabackup + scope: Namespaced + versions: + - name: v1alpha1 + schema: + openAPIV3Schema: + description: Defines a backup operation and its details + properties: + apiVersion: + description: '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' + type: string + kind: + description: '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' + type: string + metadata: + type: object + spec: + properties: + bandwidth: + description: Specify the bandwidth to not exceed when uploading files + to the cloud. Format supported is \d+[KMG] case insensitive. You + can use values like 10M (meaning 10MB), 1024, 1024K, 2G, etc... + type: string + cassandraCluster: + description: Name of the CassandraCluster to backup + type: string + concurrentConnections: + description: Maximum number of threads used to download files from + the cloud. Defaults to 10 + format: int32 + type: integer + datacenter: + description: Cassandra DC name to back up, used to find the cassandra + nodes in the CassandraCluster + type: string + duration: + description: Specify a duration the backup should try to last. See + https://golang.org/pkg/time/#ParseDuration for an exhaustive list + of the supported units. You can use values like .25h, 15m, 900s + all meaning 15 minutes + type: string + entities: + description: Database entities to backup, it might be either only + keyspaces or only tables prefixed by their respective keyspace, + e.g. 'k1,k2' if one wants to backup whole keyspaces or 'ks1.t1,ks2.t2' + if one wants to restore specific tables. These formats are mutually + exclusive so 'k1,k2.t2' is invalid. An empty field will backup all + keyspaces + type: string + schedule: + description: Specify a schedule to assigned to the backup. The schedule + doesn't enforce anything so if you schedule multiple backups around + the same time they would conflict. See https://godoc.org/github.com/robfig/cron + for more information regarding the supported formats + type: string + secret: + description: Name of Secret to use when accessing cloud storage providers + type: string + snapshotTag: + description: name of snapshot to make so this snapshot will be uploaded + to storage location. If not specified, the name of snapshot will + be automatically generated and it will have name 'autosnap-milliseconds-since-epoch' + type: string + storageLocation: + description: URI for the backup target location e.g. s3 bucket, filepath + type: string + required: + - cassandraCluster + - datacenter + - snapshotTag + - storageLocation + type: object + status: + properties: + condition: + description: BackRestCondition describes the observed state of a Restore + at a certain point + properties: + failureCause: + items: + properties: + message: + description: message explaining the error + type: string + source: + description: hostame of a node where this error has occurred + type: string + type: object + type: array + lastTransitionTime: + type: string + type: + type: string + required: + - type + type: object + coordinatorMember: + description: Name of the pod the restore operation is executed on + type: string + id: + description: unique identifier of an operation, a random id is assigned + to each operation after a request is submitted, from caller's perspective, + an id is sent back as a response to his request so he can further + query state of that operation, referencing id, by operations/{id} + endpoint + type: string + progress: + description: Progress is a percentage, 100% means the operation is + completed, either successfully or with errors + type: string + timeCompleted: + type: string + timeCreated: + type: string + timeStarted: + type: string + type: object + required: + - spec + type: object + served: true + storage: true diff --git a/helm/cassandra-operator/crds/db.orange.com_cassandraclusters_crd.yaml b/helm/cassandra-operator/crds/db.orange.com_cassandraclusters_crd.yaml new file mode 100644 index 000000000..84c0fa2a2 --- /dev/null +++ b/helm/cassandra-operator/crds/db.orange.com_cassandraclusters_crd.yaml @@ -0,0 +1,1736 @@ +apiVersion: apiextensions.k8s.io/v1 +kind: CustomResourceDefinition +metadata: + name: cassandraclusters.db.orange.com +spec: + group: db.orange.com + names: + kind: CassandraCluster + listKind: CassandraClusterList + plural: cassandraclusters + singular: cassandracluster + scope: Namespaced + versions: + - name: v1alpha1 + schema: + openAPIV3Schema: + description: CassandraCluster is the Schema for the cassandraclusters API + properties: + apiVersion: + description: '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' + type: string + kind: + description: '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' + type: string + metadata: + type: object + spec: + properties: + autoPilot: + description: AutoPilot defines if the Operator can fly alone or if + we need human action to trigger Actions on specific Cassandra nodes + If autoPilot=true, the operator will set labels pod-operation-status=To-Do + on Pods which allows him to automatically triggers Action If autoPilot=false, + the operator will set labels pod-operation-status=Manual on Pods + which won't automatically triggers Action + type: boolean + autoUpdateSeedList: + description: AutoUpdateSeedList defines if the Operator automatically + update the SeedList according to new cluster CRD topology by default + a boolean is false + type: boolean + backRestSidecar: + description: BackRestSidecar defines details about cassandra-sidecar + to load along with each C* pod + properties: + image: + default: gcr.io/cassandra-operator/instaclustr-icarus:1.0.5 + description: Image of backup/restore sidecar + type: string + imagePullPolicy: + description: ImagePullPolicy define the pull policy for backrest + sidecar docker image + type: string + resources: + description: 'Kubernetes object : https://godoc.org/k8s.io/api/core/v1#ResourceRequirements' + properties: + limits: + additionalProperties: + anyOf: + - type: integer + - type: string + pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ + x-kubernetes-int-or-string: true + description: 'Limits describes the maximum amount of compute + resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/' + type: object + requests: + additionalProperties: + anyOf: + - type: integer + - type: string + pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ + x-kubernetes-int-or-string: true + 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. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/' + type: object + type: object + type: object + bootstrapImage: + description: Image used for bootstrapping cluster (use the form base:version) + type: string + cassandraImage: + description: Image + version to use for Cassandra + type: string + configMapName: + description: Name of the ConfigMap for Cassandra configuration (cassandra.yaml) + If this is empty, operator will uses default cassandra.yaml from + the baseImage If this is not empty, operator will uses the cassandra.yaml + from the Configmap instead + type: string + dataCapacity: + description: Define the Capacity for Persistent Volume Claims in the + local storage + pattern: ^([+-]?[0-9.]+)([eEinumkKMGTP]*[-+]?[0-9]*)$ + type: string + dataStorageClass: + description: Define StorageClass for Persistent Volume Claims in the + local storage. + type: string + debug: + description: Debug is used to surcharge Cassandra pod command to not + directly start cassandra but starts an infinite wait to allow user + to connect a bash into the pod to make some diagnoses. + type: boolean + deletePVC: + description: DeletePVC defines if the PVC must be deleted when the + cluster is deleted it is false by default + type: boolean + gcStdout: + description: 'GCStdout set the parameter CASSANDRA_GC_STDOUT which + configure the JVM -Xloggc: true by default' + type: boolean + hardAntiAffinity: + description: HardAntiAffinity defines if the PodAntiAffinity of the + statefulset has to be hard (it's soft by default) + type: boolean + imageJolokiaSecret: + description: JMX Secret if Set is used to set JMX_USER and JMX_PASSWORD + properties: + name: + description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid?' + type: string + type: object + imagePullSecret: + description: Name of the secret to uses to authenticate on Docker + registries If this is empty, operator do nothing If this is not + empty, propagate the imagePullSecrets to the statefulsets + properties: + name: + description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid?' + type: string + type: object + imagepullpolicy: + description: ImagePullPolicy define the pull policy for C* docker + image + type: string + initContainerCmd: + description: Command to execute in the initContainer in the targeted + image + type: string + initContainerImage: + description: Image used in the initContainer (use the form base:version) + type: string + livenessFailureThreshold: + description: 'LivenessFailureThreshold defines failure threshold for + the liveness probe of the main cassandra container : https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#configure-probes' + format: int32 + type: integer + livenessHealthCheckPeriod: + description: 'LivenessHealthCheckPeriod defines health check period + for the liveness probe of the main cassandra container : https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#configure-probes' + format: int32 + type: integer + livenessHealthCheckTimeout: + description: 'LivenessHealthCheckTimeout defines health check timeout + for the liveness probe of the main cassandra container : https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#configure-probes' + format: int32 + type: integer + livenessInitialDelaySeconds: + description: 'LivenessInitialDelaySeconds defines initial delay for + the liveness probe of the main cassandra container : https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#configure-probes' + format: int32 + type: integer + livenessSuccessThreshold: + description: 'LivenessSuccessThreshold defines success threshold for + the liveness probe of the main cassandra container : https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#configure-probes' + format: int32 + type: integer + maxPodUnavailable: + format: int32 + type: integer + noCheckStsAreEqual: + type: boolean + nodesPerRacks: + description: 'Number of nodes to deploy for a Cassandra deployment + in each Racks. Default: 1. If NodesPerRacks = 2 and there is 3 racks, + the cluster will have 6 Cassandra Nodes' + format: int32 + type: integer + pod: + description: PodPolicy defines the policy for pods owned by CassKop + operator. + properties: + annotations: + additionalProperties: + type: string + description: Annotations specifies the annotations to attach to + headless service the CassKop operator creates + type: object + tolerations: + description: Tolerations specifies the tolerations to attach to + the pods the CassKop operator creates + items: + description: The pod this Toleration is attached to tolerates + any taint that matches the triple using + the matching operator . + properties: + effect: + description: Effect indicates the taint effect to match. + Empty means match all taint effects. When specified, allowed + values are NoSchedule, PreferNoSchedule and NoExecute. + type: string + key: + description: Key is the taint key that the toleration applies + to. Empty means match all taint keys. If the key is empty, + operator must be Exists; this combination means to match + all values and all keys. + type: string + operator: + description: Operator represents a key's relationship to + the value. Valid operators are Exists and Equal. Defaults + to Equal. Exists is equivalent to wildcard for value, + so that a pod can tolerate all taints of a particular + category. + type: string + tolerationSeconds: + description: TolerationSeconds represents the period of + time the toleration (which must be of effect NoExecute, + otherwise this field is ignored) tolerates the taint. + By default, it is not set, which means tolerate the taint + forever (do not evict). Zero and negative values will + be treated as 0 (evict immediately) by the system. + format: int64 + type: integer + value: + description: Value is the taint value the toleration matches + to. If the operator is Exists, the value should be empty, + otherwise just a regular string. + type: string + type: object + type: array + type: object + readOnlyRootFilesystem: + description: Make the pod as Readonly + type: boolean + readinessFailureThreshold: + description: 'ReadinessFailureThreshold defines failure threshold + for the readiness probe of the main cassandra container : https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#configure-probes' + format: int32 + type: integer + readinessHealthCheckPeriod: + description: 'ReadinessHealthCheckPeriod defines health check period + for the readiness probe of the main cassandra container : https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#configure-probes' + format: int32 + type: integer + readinessHealthCheckTimeout: + description: 'ReadinessHealthCheckTimeout defines health check timeout + for the readiness probe of the main cassandra container : https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#configure-probes' + format: int32 + type: integer + readinessInitialDelaySeconds: + description: 'ReadinessInitialDelaySeconds defines initial delay for + the readiness probe of the main cassandra container : https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#configure-probes' + format: int32 + type: integer + readinessSuccessThreshold: + description: 'ReadinessSuccessThreshold defines success threshold + for the readiness probe of the main cassandra container : https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#configure-probes' + format: int32 + type: integer + resources: + description: ResourceRequirements describes the compute resource requirements. + properties: + limits: + additionalProperties: + anyOf: + - type: integer + - type: string + pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ + x-kubernetes-int-or-string: true + description: 'Limits describes the maximum amount of compute resources + allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/' + type: object + requests: + additionalProperties: + anyOf: + - type: integer + - type: string + pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ + x-kubernetes-int-or-string: true + 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. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/' + type: object + type: object + restartCountBeforePodDeletion: + description: RestartCountBeforePodDeletion defines the number of restart + allowed for a cassandra container allowed before deleting the pod to + force its restart from scratch. if set to 0 or omit, no action will + be performed based on restart count. + format: int32 + type: integer + runAsUser: + description: RunAsUser define the id of the user to run in the Cassandra + image + format: int64 + minimum: 1 + type: integer + service: + description: ServicePolicy defines the policy for headless service + owned by CassKop operator. + properties: + annotations: + additionalProperties: + type: string + description: Annotations specifies the annotations to attach to + headless service the CassKop operator creates + type: object + type: object + serviceAccountName: + type: string + shareProcessNamespace: + description: 'When process namespace sharing is enabled, processes + in a container are visible to all other containers in that pod. + https://kubernetes.io/docs/tasks/configure-pod-container/share-process-namespace/ + Optional: Default to false.' + type: boolean + sidecarConfigs: + description: SidecarsConfig defines additional sidecar configurations + items: + description: A single application container that you want to run + within a pod. + properties: + args: + description: 'Arguments to the entrypoint. The docker image''s + CMD is used if this is not provided. Variable references $(VAR_NAME) + are expanded using the container''s environment. If a variable + cannot be resolved, the reference in the input string will + be unchanged. The $(VAR_NAME) syntax can be escaped with a + double $$, ie: $$(VAR_NAME). Escaped references will never + be expanded, regardless of whether the variable exists or + not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell' + items: + type: string + type: array + command: + description: 'Entrypoint array. Not executed within a shell. + The docker image''s ENTRYPOINT is used if this is not provided. + Variable references $(VAR_NAME) are expanded using the container''s + environment. If a variable cannot be resolved, the reference + in the input string will be unchanged. The $(VAR_NAME) syntax + can be escaped with a double $$, ie: $$(VAR_NAME). Escaped + references will never be expanded, regardless of whether the + variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell' + items: + type: string + type: array + env: + description: List of environment variables to set in the container. + Cannot be updated. + items: + description: EnvVar represents an environment variable present + in a Container. + properties: + name: + description: Name of the environment variable. Must be + a C_IDENTIFIER. + type: string + value: + description: 'Variable references $(VAR_NAME) are expanded + using the previous defined environment variables in + the container and any service environment variables. + If a variable cannot be resolved, the reference in the + input string will be unchanged. The $(VAR_NAME) syntax + can be escaped with a double $$, ie: $$(VAR_NAME). Escaped + references will never be expanded, regardless of whether + the variable exists or not. Defaults to "".' + type: string + valueFrom: + description: Source for the environment variable's value. + Cannot be used if value is not empty. + properties: + configMapKeyRef: + description: Selects a key of a ConfigMap. + properties: + key: + description: The key to select. + type: string + name: + description: 'Name of the referent. More info: + https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, + uid?' + type: string + optional: + description: Specify whether the ConfigMap or + its key must be defined + type: boolean + required: + - key + type: object + fieldRef: + description: 'Selects a field of the pod: supports + metadata.name, metadata.namespace, metadata.labels, + metadata.annotations, spec.nodeName, spec.serviceAccountName, + status.hostIP, status.podIP, status.podIPs.' + properties: + apiVersion: + description: Version of the schema the FieldPath + is written in terms of, defaults to "v1". + type: string + fieldPath: + description: Path of the field to select in the + specified API version. + type: string + required: + - fieldPath + type: object + resourceFieldRef: + description: 'Selects a resource of the container: + only resources limits and requests (limits.cpu, + limits.memory, limits.ephemeral-storage, requests.cpu, + requests.memory and requests.ephemeral-storage) + are currently supported.' + properties: + containerName: + description: 'Container name: required for volumes, + optional for env vars' + type: string + divisor: + anyOf: + - type: integer + - type: string + description: Specifies the output format of the + exposed resources, defaults to "1" + pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ + x-kubernetes-int-or-string: true + resource: + description: 'Required: resource to select' + type: string + required: + - resource + type: object + secretKeyRef: + description: Selects a key of a secret in the pod's + namespace + properties: + key: + description: The key of the secret to select from. Must + be a valid secret key. + type: string + name: + description: 'Name of the referent. More info: + https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, + uid?' + type: string + optional: + description: Specify whether the Secret or its + key must be defined + type: boolean + required: + - key + type: object + type: object + required: + - name + type: object + type: array + envFrom: + description: List of sources to populate environment variables + in the container. The keys defined within a source must be + a C_IDENTIFIER. All invalid keys will be reported as an event + when the container is starting. When a key exists in multiple + sources, the value associated with the last source will take + precedence. Values defined by an Env with a duplicate key + will take precedence. Cannot be updated. + items: + description: EnvFromSource represents the source of a set + of ConfigMaps + properties: + configMapRef: + description: The ConfigMap to select from + properties: + name: + description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, + uid?' + type: string + optional: + description: Specify whether the ConfigMap must be + defined + type: boolean + type: object + prefix: + description: An optional identifier to prepend to each + key in the ConfigMap. Must be a C_IDENTIFIER. + type: string + secretRef: + description: The Secret to select from + properties: + name: + description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, + uid?' + type: string + optional: + description: Specify whether the Secret must be defined + type: boolean + type: object + type: object + type: array + image: + description: 'Docker image name. More info: https://kubernetes.io/docs/concepts/containers/images + This field is optional to allow higher level config management + to default or override container images in workload controllers + like Deployments and StatefulSets.' + type: string + imagePullPolicy: + description: 'Image pull policy. One of Always, Never, IfNotPresent. + Defaults to Always if :latest tag is specified, or IfNotPresent + otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images' + type: string + lifecycle: + description: Actions that the management system should take + in response to container lifecycle events. Cannot be updated. + properties: + postStart: + description: 'PostStart is called immediately after a container + is created. If the handler fails, the container is terminated + and restarted according to its restart policy. Other management + of the container blocks until the hook completes. More + info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks' + properties: + exec: + description: One and only one of the following should + be specified. Exec specifies the action to take. + properties: + command: + description: Command is the command line to execute + inside the container, the working directory for + the command is root ('/') in the container's + filesystem. The command is simply exec'd, it is + not run inside a shell, so traditional shell instructions + ('|', etc) won't work. To use a shell, you need + to explicitly call out to that shell. Exit status + of 0 is treated as live/healthy and non-zero is + unhealthy. + items: + type: string + type: array + type: object + httpGet: + description: HTTPGet specifies the http request to perform. + properties: + host: + description: Host name to connect to, defaults to + the pod IP. You probably want to set "Host" in + httpHeaders instead. + type: string + httpHeaders: + description: Custom headers to set in the request. + HTTP allows repeated headers. + items: + description: HTTPHeader describes a custom header + to be used in HTTP probes + properties: + name: + description: The header field name + type: string + value: + description: The header field value + type: string + required: + - name + - value + type: object + type: array + path: + description: Path to access on the HTTP server. + type: string + port: + anyOf: + - type: integer + - type: string + description: Name or number of the port to access + on the container. Number must be in the range + 1 to 65535. Name must be an IANA_SVC_NAME. + x-kubernetes-int-or-string: true + scheme: + description: Scheme to use for connecting to the + host. Defaults to HTTP. + type: string + required: + - port + type: object + tcpSocket: + description: 'TCPSocket specifies an action involving + a TCP port. TCP hooks not yet supported TODO: implement + a realistic TCP lifecycle hook' + properties: + host: + description: 'Optional: Host name to connect to, + defaults to the pod IP.' + type: string + port: + anyOf: + - type: integer + - type: string + description: Number or name of the port to access + on the container. Number must be in the range + 1 to 65535. Name must be an IANA_SVC_NAME. + x-kubernetes-int-or-string: true + required: + - port + type: object + type: object + preStop: + description: 'PreStop is called immediately before a container + is terminated due to an API request or management event + such as liveness/startup probe failure, preemption, resource + contention, etc. The handler is not called if the container + crashes or exits. The reason for termination is passed + to the handler. The Pod''s termination grace period countdown + begins before the PreStop hooked is executed. Regardless + of the outcome of the handler, the container will eventually + terminate within the Pod''s termination grace period. + Other management of the container blocks until the hook + completes or until the termination grace period is reached. + More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks' + properties: + exec: + description: One and only one of the following should + be specified. Exec specifies the action to take. + properties: + command: + description: Command is the command line to execute + inside the container, the working directory for + the command is root ('/') in the container's + filesystem. The command is simply exec'd, it is + not run inside a shell, so traditional shell instructions + ('|', etc) won't work. To use a shell, you need + to explicitly call out to that shell. Exit status + of 0 is treated as live/healthy and non-zero is + unhealthy. + items: + type: string + type: array + type: object + httpGet: + description: HTTPGet specifies the http request to perform. + properties: + host: + description: Host name to connect to, defaults to + the pod IP. You probably want to set "Host" in + httpHeaders instead. + type: string + httpHeaders: + description: Custom headers to set in the request. + HTTP allows repeated headers. + items: + description: HTTPHeader describes a custom header + to be used in HTTP probes + properties: + name: + description: The header field name + type: string + value: + description: The header field value + type: string + required: + - name + - value + type: object + type: array + path: + description: Path to access on the HTTP server. + type: string + port: + anyOf: + - type: integer + - type: string + description: Name or number of the port to access + on the container. Number must be in the range + 1 to 65535. Name must be an IANA_SVC_NAME. + x-kubernetes-int-or-string: true + scheme: + description: Scheme to use for connecting to the + host. Defaults to HTTP. + type: string + required: + - port + type: object + tcpSocket: + description: 'TCPSocket specifies an action involving + a TCP port. TCP hooks not yet supported TODO: implement + a realistic TCP lifecycle hook' + properties: + host: + description: 'Optional: Host name to connect to, + defaults to the pod IP.' + type: string + port: + anyOf: + - type: integer + - type: string + description: Number or name of the port to access + on the container. Number must be in the range + 1 to 65535. Name must be an IANA_SVC_NAME. + x-kubernetes-int-or-string: true + required: + - port + type: object + type: object + type: object + livenessProbe: + description: 'Periodic probe of container liveness. Container + will be restarted if the probe fails. Cannot be updated. More + info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes' + properties: + exec: + description: One and only one of the following should be + specified. Exec specifies the action to take. + properties: + command: + description: Command is the command line to execute + inside the container, the working directory for the + command is root ('/') in the container's filesystem. + The command is simply exec'd, it is not run inside + a shell, so traditional shell instructions ('|', etc) + won't work. To use a shell, you need to explicitly + call out to that shell. Exit status of 0 is treated + as live/healthy and non-zero is unhealthy. + items: + type: string + type: array + type: object + failureThreshold: + description: Minimum consecutive failures for the probe + to be considered failed after having succeeded. Defaults + to 3. Minimum value is 1. + format: int32 + type: integer + httpGet: + description: HTTPGet specifies the http request to perform. + properties: + host: + description: Host name to connect to, defaults to the + pod IP. You probably want to set "Host" in httpHeaders + instead. + type: string + httpHeaders: + description: Custom headers to set in the request. HTTP + allows repeated headers. + items: + description: HTTPHeader describes a custom header + to be used in HTTP probes + properties: + name: + description: The header field name + type: string + value: + description: The header field value + type: string + required: + - name + - value + type: object + type: array + path: + description: Path to access on the HTTP server. + type: string + port: + anyOf: + - type: integer + - type: string + description: Name or number of the port to access on + the container. Number must be in the range 1 to 65535. + Name must be an IANA_SVC_NAME. + x-kubernetes-int-or-string: true + scheme: + description: Scheme to use for connecting to the host. + Defaults to HTTP. + type: string + required: + - port + type: object + initialDelaySeconds: + description: 'Number of seconds after the container has + started before liveness probes are initiated. More info: + https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes' + format: int32 + type: integer + periodSeconds: + description: How often (in seconds) to perform the probe. + Default to 10 seconds. Minimum value is 1. + format: int32 + type: integer + successThreshold: + description: Minimum consecutive successes for the probe + to be considered successful after having failed. Defaults + to 1. Must be 1 for liveness and startup. Minimum value + is 1. + format: int32 + type: integer + tcpSocket: + description: 'TCPSocket specifies an action involving a + TCP port. TCP hooks not yet supported TODO: implement + a realistic TCP lifecycle hook' + properties: + host: + description: 'Optional: Host name to connect to, defaults + to the pod IP.' + type: string + port: + anyOf: + - type: integer + - type: string + description: Number or name of the port to access on + the container. Number must be in the range 1 to 65535. + Name must be an IANA_SVC_NAME. + x-kubernetes-int-or-string: true + required: + - port + type: object + timeoutSeconds: + description: 'Number of seconds after which the probe times + out. Defaults to 1 second. Minimum value is 1. More info: + https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes' + format: int32 + type: integer + type: object + name: + description: Name of the container specified as a DNS_LABEL. + Each container in a pod must have a unique name (DNS_LABEL). + Cannot be updated. + type: string + ports: + description: List of ports to expose from the container. Exposing + a port here gives the system additional information about + the network connections a container uses, but is primarily + informational. Not specifying a port here DOES NOT prevent + that port from being exposed. Any port which is listening + on the default "0.0.0.0" address inside a container will be + accessible from the network. Cannot be updated. + items: + description: ContainerPort represents a network port in a + single container. + properties: + containerPort: + description: Number of port to expose on the pod's IP + address. This must be a valid port number, 0 < x < 65536. + format: int32 + type: integer + hostIP: + description: What host IP to bind the external port to. + type: string + hostPort: + description: Number of port to expose on the host. If + specified, this must be a valid port number, 0 < x < + 65536. If HostNetwork is specified, this must match + ContainerPort. Most containers do not need this. + format: int32 + type: integer + name: + description: If specified, this must be an IANA_SVC_NAME + and unique within the pod. Each named port in a pod + must have a unique name. Name for the port that can + be referred to by services. + type: string + protocol: + description: Protocol for port. Must be UDP, TCP, or SCTP. + Defaults to "TCP". + type: string + required: + - containerPort + type: object + type: array + x-kubernetes-list-map-keys: + - containerPort + x-kubernetes-list-type: map + readinessProbe: + description: 'Periodic probe of container service readiness. + Container will be removed from service endpoints if the probe + fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes' + properties: + exec: + description: One and only one of the following should be + specified. Exec specifies the action to take. + properties: + command: + description: Command is the command line to execute + inside the container, the working directory for the + command is root ('/') in the container's filesystem. + The command is simply exec'd, it is not run inside + a shell, so traditional shell instructions ('|', etc) + won't work. To use a shell, you need to explicitly + call out to that shell. Exit status of 0 is treated + as live/healthy and non-zero is unhealthy. + items: + type: string + type: array + type: object + failureThreshold: + description: Minimum consecutive failures for the probe + to be considered failed after having succeeded. Defaults + to 3. Minimum value is 1. + format: int32 + type: integer + httpGet: + description: HTTPGet specifies the http request to perform. + properties: + host: + description: Host name to connect to, defaults to the + pod IP. You probably want to set "Host" in httpHeaders + instead. + type: string + httpHeaders: + description: Custom headers to set in the request. HTTP + allows repeated headers. + items: + description: HTTPHeader describes a custom header + to be used in HTTP probes + properties: + name: + description: The header field name + type: string + value: + description: The header field value + type: string + required: + - name + - value + type: object + type: array + path: + description: Path to access on the HTTP server. + type: string + port: + anyOf: + - type: integer + - type: string + description: Name or number of the port to access on + the container. Number must be in the range 1 to 65535. + Name must be an IANA_SVC_NAME. + x-kubernetes-int-or-string: true + scheme: + description: Scheme to use for connecting to the host. + Defaults to HTTP. + type: string + required: + - port + type: object + initialDelaySeconds: + description: 'Number of seconds after the container has + started before liveness probes are initiated. More info: + https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes' + format: int32 + type: integer + periodSeconds: + description: How often (in seconds) to perform the probe. + Default to 10 seconds. Minimum value is 1. + format: int32 + type: integer + successThreshold: + description: Minimum consecutive successes for the probe + to be considered successful after having failed. Defaults + to 1. Must be 1 for liveness and startup. Minimum value + is 1. + format: int32 + type: integer + tcpSocket: + description: 'TCPSocket specifies an action involving a + TCP port. TCP hooks not yet supported TODO: implement + a realistic TCP lifecycle hook' + properties: + host: + description: 'Optional: Host name to connect to, defaults + to the pod IP.' + type: string + port: + anyOf: + - type: integer + - type: string + description: Number or name of the port to access on + the container. Number must be in the range 1 to 65535. + Name must be an IANA_SVC_NAME. + x-kubernetes-int-or-string: true + required: + - port + type: object + timeoutSeconds: + description: 'Number of seconds after which the probe times + out. Defaults to 1 second. Minimum value is 1. More info: + https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes' + format: int32 + type: integer + type: object + resources: + description: 'Compute Resources required by this container. + Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/' + properties: + limits: + additionalProperties: + anyOf: + - type: integer + - type: string + pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ + x-kubernetes-int-or-string: true + description: 'Limits describes the maximum amount of compute + resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/' + type: object + requests: + additionalProperties: + anyOf: + - type: integer + - type: string + pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ + x-kubernetes-int-or-string: true + 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. More info: + https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/' + type: object + type: object + securityContext: + description: 'Security options the pod should run with. More + info: https://kubernetes.io/docs/concepts/policy/security-context/ + More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/' + properties: + allowPrivilegeEscalation: + description: 'AllowPrivilegeEscalation controls whether + a process can gain more privileges than its parent process. + This bool directly controls if the no_new_privs flag will + be set on the container process. AllowPrivilegeEscalation + is true always when the container is: 1) run as Privileged + 2) has CAP_SYS_ADMIN' + type: boolean + capabilities: + description: The capabilities to add/drop when running containers. + Defaults to the default set of capabilities granted by + the container runtime. + properties: + add: + description: Added capabilities + items: + description: Capability represent POSIX capabilities + type + type: string + type: array + drop: + description: Removed capabilities + items: + description: Capability represent POSIX capabilities + type + type: string + type: array + type: object + privileged: + description: Run container in privileged mode. Processes + in privileged containers are essentially equivalent to + root on the host. Defaults to false. + type: boolean + procMount: + description: procMount denotes the type of proc mount to + use for the containers. The default is DefaultProcMount + which uses the container runtime defaults for readonly + paths and masked paths. This requires the ProcMountType + feature flag to be enabled. + type: string + readOnlyRootFilesystem: + description: Whether this container has a read-only root + filesystem. Default is false. + type: boolean + runAsGroup: + description: The GID to run the entrypoint of the container + process. Uses runtime default if unset. May also be set + in PodSecurityContext. If set in both SecurityContext + and PodSecurityContext, the value specified in SecurityContext + takes precedence. + format: int64 + type: integer + runAsNonRoot: + description: Indicates that the container must run as a + non-root user. If true, the Kubelet will validate the + image at runtime to ensure that it does not run as UID + 0 (root) and fail to start the container if it does. If + unset or false, no such validation will be performed. + May also be set in PodSecurityContext. If set in both + SecurityContext and PodSecurityContext, the value specified + in SecurityContext takes precedence. + type: boolean + runAsUser: + description: The UID to run the entrypoint of the container + process. Defaults to user specified in image metadata + if unspecified. May also be set in PodSecurityContext. If + set in both SecurityContext and PodSecurityContext, the + value specified in SecurityContext takes precedence. + format: int64 + type: integer + seLinuxOptions: + description: The SELinux context to be applied to the container. + If unspecified, the container runtime will allocate a + random SELinux context for each container. May also be + set in PodSecurityContext. If set in both SecurityContext + and PodSecurityContext, the value specified in SecurityContext + takes precedence. + properties: + level: + description: Level is SELinux level label that applies + to the container. + type: string + role: + description: Role is a SELinux role label that applies + to the container. + type: string + type: + description: Type is a SELinux type label that applies + to the container. + type: string + user: + description: User is a SELinux user label that applies + to the container. + type: string + type: object + windowsOptions: + description: The Windows specific settings applied to all + containers. If unspecified, the options from the PodSecurityContext + will be used. If set in both SecurityContext and PodSecurityContext, + the value specified in SecurityContext takes precedence. + properties: + gmsaCredentialSpec: + description: GMSACredentialSpec is where the GMSA admission + webhook (https://github.com/kubernetes-sigs/windows-gmsa) + inlines the contents of the GMSA credential spec named + by the GMSACredentialSpecName field. + type: string + gmsaCredentialSpecName: + description: GMSACredentialSpecName is the name of the + GMSA credential spec to use. + type: string + runAsUserName: + description: The UserName in Windows to run the entrypoint + of the container process. Defaults to the user specified + in image metadata if unspecified. May also be set + in PodSecurityContext. If set in both SecurityContext + and PodSecurityContext, the value specified in SecurityContext + takes precedence. + type: string + type: object + type: object + startupProbe: + description: 'StartupProbe indicates that the Pod has successfully + initialized. If specified, no other probes are executed until + this completes successfully. If this probe fails, the Pod + will be restarted, just as if the livenessProbe failed. This + can be used to provide different probe parameters at the beginning + of a Pod''s lifecycle, when it might take a long time to load + data or warm a cache, than during steady-state operation. + This cannot be updated. This is a beta feature enabled by + the StartupProbe feature flag. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes' + properties: + exec: + description: One and only one of the following should be + specified. Exec specifies the action to take. + properties: + command: + description: Command is the command line to execute + inside the container, the working directory for the + command is root ('/') in the container's filesystem. + The command is simply exec'd, it is not run inside + a shell, so traditional shell instructions ('|', etc) + won't work. To use a shell, you need to explicitly + call out to that shell. Exit status of 0 is treated + as live/healthy and non-zero is unhealthy. + items: + type: string + type: array + type: object + failureThreshold: + description: Minimum consecutive failures for the probe + to be considered failed after having succeeded. Defaults + to 3. Minimum value is 1. + format: int32 + type: integer + httpGet: + description: HTTPGet specifies the http request to perform. + properties: + host: + description: Host name to connect to, defaults to the + pod IP. You probably want to set "Host" in httpHeaders + instead. + type: string + httpHeaders: + description: Custom headers to set in the request. HTTP + allows repeated headers. + items: + description: HTTPHeader describes a custom header + to be used in HTTP probes + properties: + name: + description: The header field name + type: string + value: + description: The header field value + type: string + required: + - name + - value + type: object + type: array + path: + description: Path to access on the HTTP server. + type: string + port: + anyOf: + - type: integer + - type: string + description: Name or number of the port to access on + the container. Number must be in the range 1 to 65535. + Name must be an IANA_SVC_NAME. + x-kubernetes-int-or-string: true + scheme: + description: Scheme to use for connecting to the host. + Defaults to HTTP. + type: string + required: + - port + type: object + initialDelaySeconds: + description: 'Number of seconds after the container has + started before liveness probes are initiated. More info: + https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes' + format: int32 + type: integer + periodSeconds: + description: How often (in seconds) to perform the probe. + Default to 10 seconds. Minimum value is 1. + format: int32 + type: integer + successThreshold: + description: Minimum consecutive successes for the probe + to be considered successful after having failed. Defaults + to 1. Must be 1 for liveness and startup. Minimum value + is 1. + format: int32 + type: integer + tcpSocket: + description: 'TCPSocket specifies an action involving a + TCP port. TCP hooks not yet supported TODO: implement + a realistic TCP lifecycle hook' + properties: + host: + description: 'Optional: Host name to connect to, defaults + to the pod IP.' + type: string + port: + anyOf: + - type: integer + - type: string + description: Number or name of the port to access on + the container. Number must be in the range 1 to 65535. + Name must be an IANA_SVC_NAME. + x-kubernetes-int-or-string: true + required: + - port + type: object + timeoutSeconds: + description: 'Number of seconds after which the probe times + out. Defaults to 1 second. Minimum value is 1. More info: + https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes' + format: int32 + type: integer + type: object + stdin: + description: Whether this container should allocate a buffer + for stdin in the container runtime. If this is not set, reads + from stdin in the container will always result in EOF. Default + is false. + type: boolean + stdinOnce: + description: Whether the container runtime should close the + stdin channel after it has been opened by a single attach. + When stdin is true the stdin stream will remain open across + multiple attach sessions. If stdinOnce is set to true, stdin + is opened on container start, is empty until the first client + attaches to stdin, and then remains open and accepts data + until the client disconnects, at which time stdin is closed + and remains closed until the container is restarted. If this + flag is false, a container processes that reads from stdin + will never receive an EOF. Default is false + type: boolean + terminationMessagePath: + description: 'Optional: Path at which the file to which the + container''s termination message will be written is mounted + into the container''s filesystem. Message written is intended + to be brief final status, such as an assertion failure message. + Will be truncated by the node if greater than 4096 bytes. + The total message length across all containers will be limited + to 12kb. Defaults to /dev/termination-log. Cannot be updated.' + type: string + terminationMessagePolicy: + description: Indicate how the termination message should be + populated. File will use the contents of terminationMessagePath + to populate the container status message on both success and + failure. FallbackToLogsOnError will use the last chunk of + container log output if the termination message file is empty + and the container exited with an error. The log output is + limited to 2048 bytes or 80 lines, whichever is smaller. Defaults + to File. Cannot be updated. + type: string + tty: + description: Whether this container should allocate a TTY for + itself, also requires 'stdin' to be true. Default is false. + type: boolean + volumeDevices: + description: volumeDevices is the list of block devices to be + used by the container. + items: + description: volumeDevice describes a mapping of a raw block + device within a container. + properties: + devicePath: + description: devicePath is the path inside of the container + that the device will be mapped to. + type: string + name: + description: name must match the name of a persistentVolumeClaim + in the pod + type: string + required: + - devicePath + - name + type: object + type: array + volumeMounts: + description: Pod volumes to mount into the container's filesystem. + Cannot be updated. + items: + description: VolumeMount describes a mounting of a Volume + within a container. + properties: + mountPath: + description: Path within the container at which the volume + should be mounted. Must not contain ':'. + type: string + mountPropagation: + description: mountPropagation determines how mounts are + propagated from the host to container and the other + way around. When not set, MountPropagationNone is used. + This field is beta in 1.10. + type: string + name: + description: This must match the Name of a Volume. + type: string + readOnly: + description: Mounted read-only if true, read-write otherwise + (false or unspecified). Defaults to false. + type: boolean + subPath: + description: Path within the volume from which the container's + volume should be mounted. Defaults to "" (volume's root). + type: string + subPathExpr: + description: Expanded path within the volume from which + the container's volume should be mounted. Behaves similarly + to SubPath but environment variable references $(VAR_NAME) + are expanded using the container's environment. Defaults + to "" (volume's root). SubPathExpr and SubPath are mutually + exclusive. + type: string + required: + - mountPath + - name + type: object + type: array + workingDir: + description: Container's working directory. If not specified, + the container runtime's default will be used, which might + be configured in the container image. Cannot be updated. + type: string + required: + - name + type: object + type: array + storageConfigs: + description: StorageConfig defines additional storage configurations + items: + description: StorageConfig defines additional storage configurations + properties: + mountPath: + description: Mount path into cassandra container + type: string + name: + description: Name of the pvc + pattern: '[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*' + type: string + pvcSpec: + description: Persistent volume claim spec + properties: + accessModes: + description: 'AccessModes contains the desired access modes + the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1' + items: + type: string + type: array + dataSource: + description: 'This field can be used to specify either: + * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot + - Beta) * An existing PVC (PersistentVolumeClaim) * An + existing custom resource/object that implements data population + (Alpha) In order to use VolumeSnapshot object types, the + appropriate feature gate must be enabled (VolumeSnapshotDataSource + or AnyVolumeDataSource) If the provisioner or an external + controller can support the specified data source, it will + create a new volume based on the contents of the specified + data source. If the specified data source is not supported, + the volume will not be created and the failure will be + reported as an event. In the future, we plan to support + more data source types and the behavior of the provisioner + may change.' + properties: + apiGroup: + description: APIGroup is the group for the resource + being referenced. If APIGroup is not specified, the + specified Kind must be in the core API group. For + any other third-party types, APIGroup is required. + type: string + kind: + description: Kind is the type of resource being referenced + type: string + name: + description: Name is the name of resource being referenced + type: string + required: + - kind + - name + type: object + resources: + description: 'Resources represents the minimum resources + the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources' + properties: + limits: + additionalProperties: + anyOf: + - type: integer + - type: string + pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ + x-kubernetes-int-or-string: true + description: 'Limits describes the maximum amount of + compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/' + type: object + requests: + additionalProperties: + anyOf: + - type: integer + - type: string + pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ + x-kubernetes-int-or-string: true + 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. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/' + type: object + type: object + selector: + description: A label query over volumes to consider for + binding. + properties: + matchExpressions: + description: matchExpressions is a list of label selector + requirements. The requirements are ANDed. + items: + description: A label selector requirement is a selector + that contains values, a key, and an operator that + relates the key and values. + properties: + key: + description: key is the label key that the selector + applies to. + type: string + operator: + description: operator represents a key's relationship + to a set of values. Valid operators are In, + NotIn, Exists and DoesNotExist. + type: string + values: + description: 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. + items: + type: string + type: array + required: + - key + - operator + type: object + type: array + matchLabels: + additionalProperties: + type: string + 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: object + type: object + storageClassName: + description: 'Name of the StorageClass required by the claim. + More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1' + type: string + volumeMode: + description: volumeMode defines what type of volume is required + by the claim. Value of Filesystem is implied when not + included in claim spec. + type: string + volumeName: + description: VolumeName is the binding reference to the + PersistentVolume backing this claim. + type: string + type: object + required: + - mountPath + - name + - pvcSpec + type: object + type: array + topology: + description: Topology to create Cassandra DC and Racks and to target + appropriate Kubernetes Nodes + properties: + dc: + description: List of DC defined in the CassandraCluster + items: + description: DC allow to configure Cassandra RC according to + kubernetes nodeselector labels + properties: + dataCapacity: + description: Define the Capacity for Persistent Volume Claims + in the local storage + pattern: ^([+-]?[0-9.]+)([eEinumkKMGTP]*[-+]?[0-9]*)$ + type: string + dataStorageClass: + description: Define StorageClass for Persistent Volume Claims + in the local storage. + type: string + labels: + additionalProperties: + type: string + description: Labels used to target Kubernetes nodes + type: object + name: + description: Name of the DC + pattern: ^[^-]+$ + type: string + nodesPerRacks: + description: 'Number of nodes to deploy for a Cassandra + deployment in each Racks. Default: 1. Optional, if not + filled, used value define in CassandraClusterSpec' + format: int32 + type: integer + numTokens: + description: 'NumTokens : configure the CASSANDRA_NUM_TOKENS + parameter which can be different for each DD' + format: int32 + type: integer + rack: + description: List of Racks defined in the Cassandra DC + items: + description: Rack allow to configure Cassandra Rack according + to kubernetes nodeselector labels + properties: + labels: + additionalProperties: + type: string + description: Labels used to target Kubernetes nodes + type: object + name: + description: Name of the Rack + pattern: ^[^-]+$ + type: string + rollingPartition: + description: The Partition to control the Statefulset + Upgrade + format: int32 + type: integer + rollingRestart: + description: Flag to tell the operator to trigger + a rolling restart of the Rack + type: boolean + type: object + type: array + resources: + description: ResourceRequirements describes the compute + resource requirements. + properties: + limits: + additionalProperties: + anyOf: + - type: integer + - type: string + pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ + x-kubernetes-int-or-string: true + description: 'Limits describes the maximum amount of + compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/' + type: object + requests: + additionalProperties: + anyOf: + - type: integer + - type: string + pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ + x-kubernetes-int-or-string: true + 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. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/' + type: object + type: object + type: object + type: array + type: object + unlockNextOperation: + description: Very special Flag to hack CassKop reconcile loop - use + with really good Care + type: boolean + type: object + status: + description: CassandraClusterStatus defines Global state of CassandraCluster + properties: + cassandraNodeStatus: + additionalProperties: + properties: + hostId: + type: string + nodeIp: + type: string + type: object + type: object + cassandraRackStatus: + additionalProperties: + description: CassandraRackStatus defines states of Cassandra for + 1 rack (1 statefulset) + properties: + cassandraLastAction: + description: 'CassandraLastAction is the set of Cassandra State + & Actions: Active, Standby..' + properties: + endTime: + format: date-time + type: string + name: + description: 'Type of action to perform : UpdateVersion, + UpdateBaseImage, UpdateConfigMap..' + type: string + startTime: + format: date-time + type: string + status: + description: Action is the specific actions that can be + done on a Cassandra Cluster such as cleanup, upgradesstables.. + type: string + updatedNodes: + description: PodNames of updated Cassandra nodes. Updated + means the Cassandra container image version matches the + spec's version. + items: + type: string + type: array + type: object + phase: + description: 'Phase indicates the state this Cassandra cluster + jumps in. Phase goes as one way as below: Initial -> Running + <-> updating' + type: string + podLastOperation: + description: PodLastOperation manage status for Pod Operation + (nodetool cleanup, upgradesstables..) + properties: + endTime: + format: date-time + type: string + name: + type: string + operatorName: + description: Name of operator + type: string + pods: + description: List of pods running an operation + items: + type: string + type: array + podsKO: + description: List of pods that fail to run an operation + items: + type: string + type: array + podsOK: + description: List of pods that run an operation successfully + items: + type: string + type: array + startTime: + format: date-time + type: string + status: + type: string + type: object + type: object + description: CassandraRackStatusList list status for each Rack + type: object + lastClusterAction: + description: Store last action at cluster level + type: string + lastClusterActionStatus: + type: string + phase: + description: 'Phase indicates the state this Cassandra cluster jumps + in. Phase goes as one way as below: Initial -> Running <-> updating' + type: string + seedlist: + description: seedList to be used in Cassandra's Pods (computed by + the Operator) + items: + type: string + type: array + type: object + type: object + served: true + storage: true diff --git a/helm/cassandra-operator/crds/db.orange.com_cassandrarestores_crd.yaml b/helm/cassandra-operator/crds/db.orange.com_cassandrarestores_crd.yaml new file mode 100644 index 000000000..f8400e6d7 --- /dev/null +++ b/helm/cassandra-operator/crds/db.orange.com_cassandrarestores_crd.yaml @@ -0,0 +1,146 @@ +apiVersion: apiextensions.k8s.io/v1 +kind: CustomResourceDefinition +metadata: + name: cassandrarestores.db.orange.com +spec: + group: db.orange.com + names: + kind: CassandraRestore + listKind: CassandraRestoreList + plural: cassandrarestores + singular: cassandrarestore + scope: Namespaced + versions: + - name: v1alpha1 + schema: + openAPIV3Schema: + description: CassandraRestore is a Casskop Operator resource that represents + the restoration of a backup of a Cassandra cluster + properties: + apiVersion: + description: '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' + type: string + kind: + description: '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' + type: string + metadata: + type: object + spec: + description: CassandraRestoreSpec defines the specification for a restore + of a Cassandra backup. + properties: + cassandraBackup: + description: Name of the CassandraBackup to restore + type: string + cassandraCluster: + description: Name of the CassandraCluster the restore belongs to + type: string + cassandraDirectory: + description: Directory of Cassandra where data folder resides. Defaults + to /var/lib/cassandra + type: string + concurrentConnection: + description: Maximum number of threads used to download files from + the cloud. Defaults to 10 + format: int32 + type: integer + entities: + description: Database entities to restore, it might be either only + keyspaces or only tables prefixed by their respective keyspace, + e.g. 'k1,k2' if one wants to backup whole keyspaces or 'ks1.t1,ks2.t2' + if one wants to restore specific tables. These formats are mutually + exclusive so 'k1,k2.t2' is invalid. An empty field will restore + all keyspaces + type: string + exactSchemaVersion: + description: When set a running node's schema version must match the + snapshot's schema version. There might be cases when we want to + restore a table for which its CQL schema has not changed but it + has changed for other table / keyspace but a schema for that node + has changed by doing that. Defaults to False + type: boolean + noDeleteTruncates: + description: When set do not delete truncated SSTables after they've + been restored during CLEANUP phase. Defaults to false + type: boolean + restorationStrategyType: + description: Strategy telling how we should go about restoration, + please refer to details in backup and sidecar documentation + enum: + - HARDLINKS + - IMPORT + type: string + schemaVersion: + description: Version of the schema to restore from. Upon backup, a + schema version is automatically appended to a snapshot name and + its manifest is uploaded under that name. In case we have two snapshots + having same name, we might distinguish between the two of them by + using the schema version. If schema version is not specified, we + expect a unique backup taken with respective snapshot name. This + schema version has to match the version of a Cassandra node we are + doing restore for (hence, by proxy, when global request mode is + used, all nodes have to be on exact same schema version). Defaults + to False + type: string + secret: + description: Name of Secret to use when accessing cloud storage providers + type: string + required: + - cassandraBackup + - cassandraCluster + type: object + status: + properties: + condition: + description: BackRestCondition describes the observed state of a Restore + at a certain point + properties: + failureCause: + items: + properties: + message: + description: message explaining the error + type: string + source: + description: hostame of a node where this error has occurred + type: string + type: object + type: array + lastTransitionTime: + type: string + type: + type: string + required: + - type + type: object + coordinatorMember: + description: Name of the pod the restore operation is executed on + type: string + id: + description: unique identifier of an operation, a random id is assigned + to each operation after a request is submitted, from caller's perspective, + an id is sent back as a response to his request so he can further + query state of that operation, referencing id, by operations/{id} + endpoint + type: string + progress: + description: Progress is a percentage, 100% means the operation is + completed, either successfully or with errors + type: string + timeCompleted: + type: string + timeCreated: + type: string + timeStarted: + type: string + type: object + required: + - metadata + - spec + type: object + served: true + storage: true diff --git a/helm/cassandra-operator/readme.md b/helm/cassandra-operator/readme.md index b5d1fa7d8..0c8018f2d 100644 --- a/helm/cassandra-operator/readme.md +++ b/helm/cassandra-operator/readme.md @@ -39,14 +39,6 @@ $ helm install --name casskop incubator/cassandra-operator -f values.yaml ### Installing the Chart -> Helm 3 users -> -> You need to manually install the crds beforehand -> -> ```console -> kubectl apply -f https://raw.githubusercontent.com/Orange-OpenSource/casskop/master/deploy/crds/db.orange.com_cassandraclusters_crd.yaml -> ``` - You can make a dry run of the chart before deploying : ```console @@ -129,7 +121,7 @@ $ helm delete --purge casskop ### Install of the CRD -By default, the chart will install via a helm hook the Casskop CRD, but this installation is global for the whole +By default, the chart will install the Casskop CRD, but this installation is global for the whole cluster, and you may deploy a chart with an existing CRD already deployed. In that case you can get an error like : @@ -139,9 +131,3 @@ In that case you can get an error like : $ helm install --name casskop ./helm/cassandra-operator Error: customresourcedefinitions.apiextensions.k8s.io "cassandraclusters.db.orange.com" already exists ``` - -In this case there si a parameter to say to not uses the hook to install the CRD : - -``` -$ helm install --name casskop ./helm/cassandra-operator --no-hooks -``` diff --git a/helm/cassandra-operator/templates/db_v1alpha1_cassandracluster_crd.yaml b/helm/cassandra-operator/templates/db_v1alpha1_cassandracluster_crd.yaml deleted file mode 100644 index 58d08bf64..000000000 --- a/helm/cassandra-operator/templates/db_v1alpha1_cassandracluster_crd.yaml +++ /dev/null @@ -1,20 +0,0 @@ -apiVersion: apiextensions.k8s.io/v1beta1 -kind: CustomResourceDefinition -metadata: - name: cassandraclusters.db.orange.com - labels: - app: {{ template "cassandra-operator.name" . }} - chart: {{ .Chart.Name }}-{{ .Chart.Version }} - heritage: {{ .Release.Service }} - release: {{ .Release.Name }} - annotations: - "helm.sh/hook": crd-install -spec: - group: db.orange.com - names: - kind: CassandraCluster - listKind: CassandraClusterList - plural: cassandraclusters - singular: cassandracluster - scope: Namespaced - version: v1alpha1 diff --git a/multi-casskop/helm/multi-casskop/crds/db.orange.com_cassandrabackups_crd.yaml b/multi-casskop/helm/multi-casskop/crds/db.orange.com_cassandrabackups_crd.yaml new file mode 100644 index 000000000..9a2474b4f --- /dev/null +++ b/multi-casskop/helm/multi-casskop/crds/db.orange.com_cassandrabackups_crd.yaml @@ -0,0 +1,136 @@ +apiVersion: apiextensions.k8s.io/v1 +kind: CustomResourceDefinition +metadata: + name: cassandrabackups.db.orange.com +spec: + group: db.orange.com + names: + kind: CassandraBackup + listKind: CassandraBackupList + plural: cassandrabackups + singular: cassandrabackup + scope: Namespaced + versions: + - name: v1alpha1 + schema: + openAPIV3Schema: + description: Defines a backup operation and its details + properties: + apiVersion: + description: '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' + type: string + kind: + description: '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' + type: string + metadata: + type: object + spec: + properties: + bandwidth: + description: Specify the bandwidth to not exceed when uploading files + to the cloud. Format supported is \d+[KMG] case insensitive. You + can use values like 10M (meaning 10MB), 1024, 1024K, 2G, etc... + type: string + cassandraCluster: + description: Name of the CassandraCluster to backup + type: string + concurrentConnections: + description: Maximum number of threads used to download files from + the cloud. Defaults to 10 + format: int32 + type: integer + datacenter: + description: Cassandra DC name to back up, used to find the cassandra + nodes in the CassandraCluster + type: string + duration: + description: Specify a duration the backup should try to last. See + https://golang.org/pkg/time/#ParseDuration for an exhaustive list + of the supported units. You can use values like .25h, 15m, 900s + all meaning 15 minutes + type: string + entities: + description: Database entities to backup, it might be either only + keyspaces or only tables prefixed by their respective keyspace, + e.g. 'k1,k2' if one wants to backup whole keyspaces or 'ks1.t1,ks2.t2' + if one wants to restore specific tables. These formats are mutually + exclusive so 'k1,k2.t2' is invalid. An empty field will backup all + keyspaces + type: string + schedule: + description: Specify a schedule to assigned to the backup. The schedule + doesn't enforce anything so if you schedule multiple backups around + the same time they would conflict. See https://godoc.org/github.com/robfig/cron + for more information regarding the supported formats + type: string + secret: + description: Name of Secret to use when accessing cloud storage providers + type: string + snapshotTag: + description: name of snapshot to make so this snapshot will be uploaded + to storage location. If not specified, the name of snapshot will + be automatically generated and it will have name 'autosnap-milliseconds-since-epoch' + type: string + storageLocation: + description: URI for the backup target location e.g. s3 bucket, filepath + type: string + required: + - cassandraCluster + - datacenter + - snapshotTag + - storageLocation + type: object + status: + properties: + condition: + description: BackRestCondition describes the observed state of a Restore + at a certain point + properties: + failureCause: + items: + properties: + message: + description: message explaining the error + type: string + source: + description: hostame of a node where this error has occurred + type: string + type: object + type: array + lastTransitionTime: + type: string + type: + type: string + required: + - type + type: object + coordinatorMember: + description: Name of the pod the restore operation is executed on + type: string + id: + description: unique identifier of an operation, a random id is assigned + to each operation after a request is submitted, from caller's perspective, + an id is sent back as a response to his request so he can further + query state of that operation, referencing id, by operations/{id} + endpoint + type: string + progress: + description: Progress is a percentage, 100% means the operation is + completed, either successfully or with errors + type: string + timeCompleted: + type: string + timeCreated: + type: string + timeStarted: + type: string + type: object + required: + - spec + type: object + served: true + storage: true diff --git a/multi-casskop/helm/multi-casskop/crds/db.orange.com_cassandraclusters_crd.yaml b/multi-casskop/helm/multi-casskop/crds/db.orange.com_cassandraclusters_crd.yaml new file mode 100644 index 000000000..84c0fa2a2 --- /dev/null +++ b/multi-casskop/helm/multi-casskop/crds/db.orange.com_cassandraclusters_crd.yaml @@ -0,0 +1,1736 @@ +apiVersion: apiextensions.k8s.io/v1 +kind: CustomResourceDefinition +metadata: + name: cassandraclusters.db.orange.com +spec: + group: db.orange.com + names: + kind: CassandraCluster + listKind: CassandraClusterList + plural: cassandraclusters + singular: cassandracluster + scope: Namespaced + versions: + - name: v1alpha1 + schema: + openAPIV3Schema: + description: CassandraCluster is the Schema for the cassandraclusters API + properties: + apiVersion: + description: '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' + type: string + kind: + description: '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' + type: string + metadata: + type: object + spec: + properties: + autoPilot: + description: AutoPilot defines if the Operator can fly alone or if + we need human action to trigger Actions on specific Cassandra nodes + If autoPilot=true, the operator will set labels pod-operation-status=To-Do + on Pods which allows him to automatically triggers Action If autoPilot=false, + the operator will set labels pod-operation-status=Manual on Pods + which won't automatically triggers Action + type: boolean + autoUpdateSeedList: + description: AutoUpdateSeedList defines if the Operator automatically + update the SeedList according to new cluster CRD topology by default + a boolean is false + type: boolean + backRestSidecar: + description: BackRestSidecar defines details about cassandra-sidecar + to load along with each C* pod + properties: + image: + default: gcr.io/cassandra-operator/instaclustr-icarus:1.0.5 + description: Image of backup/restore sidecar + type: string + imagePullPolicy: + description: ImagePullPolicy define the pull policy for backrest + sidecar docker image + type: string + resources: + description: 'Kubernetes object : https://godoc.org/k8s.io/api/core/v1#ResourceRequirements' + properties: + limits: + additionalProperties: + anyOf: + - type: integer + - type: string + pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ + x-kubernetes-int-or-string: true + description: 'Limits describes the maximum amount of compute + resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/' + type: object + requests: + additionalProperties: + anyOf: + - type: integer + - type: string + pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ + x-kubernetes-int-or-string: true + 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. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/' + type: object + type: object + type: object + bootstrapImage: + description: Image used for bootstrapping cluster (use the form base:version) + type: string + cassandraImage: + description: Image + version to use for Cassandra + type: string + configMapName: + description: Name of the ConfigMap for Cassandra configuration (cassandra.yaml) + If this is empty, operator will uses default cassandra.yaml from + the baseImage If this is not empty, operator will uses the cassandra.yaml + from the Configmap instead + type: string + dataCapacity: + description: Define the Capacity for Persistent Volume Claims in the + local storage + pattern: ^([+-]?[0-9.]+)([eEinumkKMGTP]*[-+]?[0-9]*)$ + type: string + dataStorageClass: + description: Define StorageClass for Persistent Volume Claims in the + local storage. + type: string + debug: + description: Debug is used to surcharge Cassandra pod command to not + directly start cassandra but starts an infinite wait to allow user + to connect a bash into the pod to make some diagnoses. + type: boolean + deletePVC: + description: DeletePVC defines if the PVC must be deleted when the + cluster is deleted it is false by default + type: boolean + gcStdout: + description: 'GCStdout set the parameter CASSANDRA_GC_STDOUT which + configure the JVM -Xloggc: true by default' + type: boolean + hardAntiAffinity: + description: HardAntiAffinity defines if the PodAntiAffinity of the + statefulset has to be hard (it's soft by default) + type: boolean + imageJolokiaSecret: + description: JMX Secret if Set is used to set JMX_USER and JMX_PASSWORD + properties: + name: + description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid?' + type: string + type: object + imagePullSecret: + description: Name of the secret to uses to authenticate on Docker + registries If this is empty, operator do nothing If this is not + empty, propagate the imagePullSecrets to the statefulsets + properties: + name: + description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid?' + type: string + type: object + imagepullpolicy: + description: ImagePullPolicy define the pull policy for C* docker + image + type: string + initContainerCmd: + description: Command to execute in the initContainer in the targeted + image + type: string + initContainerImage: + description: Image used in the initContainer (use the form base:version) + type: string + livenessFailureThreshold: + description: 'LivenessFailureThreshold defines failure threshold for + the liveness probe of the main cassandra container : https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#configure-probes' + format: int32 + type: integer + livenessHealthCheckPeriod: + description: 'LivenessHealthCheckPeriod defines health check period + for the liveness probe of the main cassandra container : https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#configure-probes' + format: int32 + type: integer + livenessHealthCheckTimeout: + description: 'LivenessHealthCheckTimeout defines health check timeout + for the liveness probe of the main cassandra container : https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#configure-probes' + format: int32 + type: integer + livenessInitialDelaySeconds: + description: 'LivenessInitialDelaySeconds defines initial delay for + the liveness probe of the main cassandra container : https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#configure-probes' + format: int32 + type: integer + livenessSuccessThreshold: + description: 'LivenessSuccessThreshold defines success threshold for + the liveness probe of the main cassandra container : https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#configure-probes' + format: int32 + type: integer + maxPodUnavailable: + format: int32 + type: integer + noCheckStsAreEqual: + type: boolean + nodesPerRacks: + description: 'Number of nodes to deploy for a Cassandra deployment + in each Racks. Default: 1. If NodesPerRacks = 2 and there is 3 racks, + the cluster will have 6 Cassandra Nodes' + format: int32 + type: integer + pod: + description: PodPolicy defines the policy for pods owned by CassKop + operator. + properties: + annotations: + additionalProperties: + type: string + description: Annotations specifies the annotations to attach to + headless service the CassKop operator creates + type: object + tolerations: + description: Tolerations specifies the tolerations to attach to + the pods the CassKop operator creates + items: + description: The pod this Toleration is attached to tolerates + any taint that matches the triple using + the matching operator . + properties: + effect: + description: Effect indicates the taint effect to match. + Empty means match all taint effects. When specified, allowed + values are NoSchedule, PreferNoSchedule and NoExecute. + type: string + key: + description: Key is the taint key that the toleration applies + to. Empty means match all taint keys. If the key is empty, + operator must be Exists; this combination means to match + all values and all keys. + type: string + operator: + description: Operator represents a key's relationship to + the value. Valid operators are Exists and Equal. Defaults + to Equal. Exists is equivalent to wildcard for value, + so that a pod can tolerate all taints of a particular + category. + type: string + tolerationSeconds: + description: TolerationSeconds represents the period of + time the toleration (which must be of effect NoExecute, + otherwise this field is ignored) tolerates the taint. + By default, it is not set, which means tolerate the taint + forever (do not evict). Zero and negative values will + be treated as 0 (evict immediately) by the system. + format: int64 + type: integer + value: + description: Value is the taint value the toleration matches + to. If the operator is Exists, the value should be empty, + otherwise just a regular string. + type: string + type: object + type: array + type: object + readOnlyRootFilesystem: + description: Make the pod as Readonly + type: boolean + readinessFailureThreshold: + description: 'ReadinessFailureThreshold defines failure threshold + for the readiness probe of the main cassandra container : https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#configure-probes' + format: int32 + type: integer + readinessHealthCheckPeriod: + description: 'ReadinessHealthCheckPeriod defines health check period + for the readiness probe of the main cassandra container : https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#configure-probes' + format: int32 + type: integer + readinessHealthCheckTimeout: + description: 'ReadinessHealthCheckTimeout defines health check timeout + for the readiness probe of the main cassandra container : https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#configure-probes' + format: int32 + type: integer + readinessInitialDelaySeconds: + description: 'ReadinessInitialDelaySeconds defines initial delay for + the readiness probe of the main cassandra container : https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#configure-probes' + format: int32 + type: integer + readinessSuccessThreshold: + description: 'ReadinessSuccessThreshold defines success threshold + for the readiness probe of the main cassandra container : https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#configure-probes' + format: int32 + type: integer + resources: + description: ResourceRequirements describes the compute resource requirements. + properties: + limits: + additionalProperties: + anyOf: + - type: integer + - type: string + pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ + x-kubernetes-int-or-string: true + description: 'Limits describes the maximum amount of compute resources + allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/' + type: object + requests: + additionalProperties: + anyOf: + - type: integer + - type: string + pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ + x-kubernetes-int-or-string: true + 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. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/' + type: object + type: object + restartCountBeforePodDeletion: + description: RestartCountBeforePodDeletion defines the number of restart + allowed for a cassandra container allowed before deleting the pod to + force its restart from scratch. if set to 0 or omit, no action will + be performed based on restart count. + format: int32 + type: integer + runAsUser: + description: RunAsUser define the id of the user to run in the Cassandra + image + format: int64 + minimum: 1 + type: integer + service: + description: ServicePolicy defines the policy for headless service + owned by CassKop operator. + properties: + annotations: + additionalProperties: + type: string + description: Annotations specifies the annotations to attach to + headless service the CassKop operator creates + type: object + type: object + serviceAccountName: + type: string + shareProcessNamespace: + description: 'When process namespace sharing is enabled, processes + in a container are visible to all other containers in that pod. + https://kubernetes.io/docs/tasks/configure-pod-container/share-process-namespace/ + Optional: Default to false.' + type: boolean + sidecarConfigs: + description: SidecarsConfig defines additional sidecar configurations + items: + description: A single application container that you want to run + within a pod. + properties: + args: + description: 'Arguments to the entrypoint. The docker image''s + CMD is used if this is not provided. Variable references $(VAR_NAME) + are expanded using the container''s environment. If a variable + cannot be resolved, the reference in the input string will + be unchanged. The $(VAR_NAME) syntax can be escaped with a + double $$, ie: $$(VAR_NAME). Escaped references will never + be expanded, regardless of whether the variable exists or + not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell' + items: + type: string + type: array + command: + description: 'Entrypoint array. Not executed within a shell. + The docker image''s ENTRYPOINT is used if this is not provided. + Variable references $(VAR_NAME) are expanded using the container''s + environment. If a variable cannot be resolved, the reference + in the input string will be unchanged. The $(VAR_NAME) syntax + can be escaped with a double $$, ie: $$(VAR_NAME). Escaped + references will never be expanded, regardless of whether the + variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell' + items: + type: string + type: array + env: + description: List of environment variables to set in the container. + Cannot be updated. + items: + description: EnvVar represents an environment variable present + in a Container. + properties: + name: + description: Name of the environment variable. Must be + a C_IDENTIFIER. + type: string + value: + description: 'Variable references $(VAR_NAME) are expanded + using the previous defined environment variables in + the container and any service environment variables. + If a variable cannot be resolved, the reference in the + input string will be unchanged. The $(VAR_NAME) syntax + can be escaped with a double $$, ie: $$(VAR_NAME). Escaped + references will never be expanded, regardless of whether + the variable exists or not. Defaults to "".' + type: string + valueFrom: + description: Source for the environment variable's value. + Cannot be used if value is not empty. + properties: + configMapKeyRef: + description: Selects a key of a ConfigMap. + properties: + key: + description: The key to select. + type: string + name: + description: 'Name of the referent. More info: + https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, + uid?' + type: string + optional: + description: Specify whether the ConfigMap or + its key must be defined + type: boolean + required: + - key + type: object + fieldRef: + description: 'Selects a field of the pod: supports + metadata.name, metadata.namespace, metadata.labels, + metadata.annotations, spec.nodeName, spec.serviceAccountName, + status.hostIP, status.podIP, status.podIPs.' + properties: + apiVersion: + description: Version of the schema the FieldPath + is written in terms of, defaults to "v1". + type: string + fieldPath: + description: Path of the field to select in the + specified API version. + type: string + required: + - fieldPath + type: object + resourceFieldRef: + description: 'Selects a resource of the container: + only resources limits and requests (limits.cpu, + limits.memory, limits.ephemeral-storage, requests.cpu, + requests.memory and requests.ephemeral-storage) + are currently supported.' + properties: + containerName: + description: 'Container name: required for volumes, + optional for env vars' + type: string + divisor: + anyOf: + - type: integer + - type: string + description: Specifies the output format of the + exposed resources, defaults to "1" + pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ + x-kubernetes-int-or-string: true + resource: + description: 'Required: resource to select' + type: string + required: + - resource + type: object + secretKeyRef: + description: Selects a key of a secret in the pod's + namespace + properties: + key: + description: The key of the secret to select from. Must + be a valid secret key. + type: string + name: + description: 'Name of the referent. More info: + https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, + uid?' + type: string + optional: + description: Specify whether the Secret or its + key must be defined + type: boolean + required: + - key + type: object + type: object + required: + - name + type: object + type: array + envFrom: + description: List of sources to populate environment variables + in the container. The keys defined within a source must be + a C_IDENTIFIER. All invalid keys will be reported as an event + when the container is starting. When a key exists in multiple + sources, the value associated with the last source will take + precedence. Values defined by an Env with a duplicate key + will take precedence. Cannot be updated. + items: + description: EnvFromSource represents the source of a set + of ConfigMaps + properties: + configMapRef: + description: The ConfigMap to select from + properties: + name: + description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, + uid?' + type: string + optional: + description: Specify whether the ConfigMap must be + defined + type: boolean + type: object + prefix: + description: An optional identifier to prepend to each + key in the ConfigMap. Must be a C_IDENTIFIER. + type: string + secretRef: + description: The Secret to select from + properties: + name: + description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, + uid?' + type: string + optional: + description: Specify whether the Secret must be defined + type: boolean + type: object + type: object + type: array + image: + description: 'Docker image name. More info: https://kubernetes.io/docs/concepts/containers/images + This field is optional to allow higher level config management + to default or override container images in workload controllers + like Deployments and StatefulSets.' + type: string + imagePullPolicy: + description: 'Image pull policy. One of Always, Never, IfNotPresent. + Defaults to Always if :latest tag is specified, or IfNotPresent + otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images' + type: string + lifecycle: + description: Actions that the management system should take + in response to container lifecycle events. Cannot be updated. + properties: + postStart: + description: 'PostStart is called immediately after a container + is created. If the handler fails, the container is terminated + and restarted according to its restart policy. Other management + of the container blocks until the hook completes. More + info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks' + properties: + exec: + description: One and only one of the following should + be specified. Exec specifies the action to take. + properties: + command: + description: Command is the command line to execute + inside the container, the working directory for + the command is root ('/') in the container's + filesystem. The command is simply exec'd, it is + not run inside a shell, so traditional shell instructions + ('|', etc) won't work. To use a shell, you need + to explicitly call out to that shell. Exit status + of 0 is treated as live/healthy and non-zero is + unhealthy. + items: + type: string + type: array + type: object + httpGet: + description: HTTPGet specifies the http request to perform. + properties: + host: + description: Host name to connect to, defaults to + the pod IP. You probably want to set "Host" in + httpHeaders instead. + type: string + httpHeaders: + description: Custom headers to set in the request. + HTTP allows repeated headers. + items: + description: HTTPHeader describes a custom header + to be used in HTTP probes + properties: + name: + description: The header field name + type: string + value: + description: The header field value + type: string + required: + - name + - value + type: object + type: array + path: + description: Path to access on the HTTP server. + type: string + port: + anyOf: + - type: integer + - type: string + description: Name or number of the port to access + on the container. Number must be in the range + 1 to 65535. Name must be an IANA_SVC_NAME. + x-kubernetes-int-or-string: true + scheme: + description: Scheme to use for connecting to the + host. Defaults to HTTP. + type: string + required: + - port + type: object + tcpSocket: + description: 'TCPSocket specifies an action involving + a TCP port. TCP hooks not yet supported TODO: implement + a realistic TCP lifecycle hook' + properties: + host: + description: 'Optional: Host name to connect to, + defaults to the pod IP.' + type: string + port: + anyOf: + - type: integer + - type: string + description: Number or name of the port to access + on the container. Number must be in the range + 1 to 65535. Name must be an IANA_SVC_NAME. + x-kubernetes-int-or-string: true + required: + - port + type: object + type: object + preStop: + description: 'PreStop is called immediately before a container + is terminated due to an API request or management event + such as liveness/startup probe failure, preemption, resource + contention, etc. The handler is not called if the container + crashes or exits. The reason for termination is passed + to the handler. The Pod''s termination grace period countdown + begins before the PreStop hooked is executed. Regardless + of the outcome of the handler, the container will eventually + terminate within the Pod''s termination grace period. + Other management of the container blocks until the hook + completes or until the termination grace period is reached. + More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks' + properties: + exec: + description: One and only one of the following should + be specified. Exec specifies the action to take. + properties: + command: + description: Command is the command line to execute + inside the container, the working directory for + the command is root ('/') in the container's + filesystem. The command is simply exec'd, it is + not run inside a shell, so traditional shell instructions + ('|', etc) won't work. To use a shell, you need + to explicitly call out to that shell. Exit status + of 0 is treated as live/healthy and non-zero is + unhealthy. + items: + type: string + type: array + type: object + httpGet: + description: HTTPGet specifies the http request to perform. + properties: + host: + description: Host name to connect to, defaults to + the pod IP. You probably want to set "Host" in + httpHeaders instead. + type: string + httpHeaders: + description: Custom headers to set in the request. + HTTP allows repeated headers. + items: + description: HTTPHeader describes a custom header + to be used in HTTP probes + properties: + name: + description: The header field name + type: string + value: + description: The header field value + type: string + required: + - name + - value + type: object + type: array + path: + description: Path to access on the HTTP server. + type: string + port: + anyOf: + - type: integer + - type: string + description: Name or number of the port to access + on the container. Number must be in the range + 1 to 65535. Name must be an IANA_SVC_NAME. + x-kubernetes-int-or-string: true + scheme: + description: Scheme to use for connecting to the + host. Defaults to HTTP. + type: string + required: + - port + type: object + tcpSocket: + description: 'TCPSocket specifies an action involving + a TCP port. TCP hooks not yet supported TODO: implement + a realistic TCP lifecycle hook' + properties: + host: + description: 'Optional: Host name to connect to, + defaults to the pod IP.' + type: string + port: + anyOf: + - type: integer + - type: string + description: Number or name of the port to access + on the container. Number must be in the range + 1 to 65535. Name must be an IANA_SVC_NAME. + x-kubernetes-int-or-string: true + required: + - port + type: object + type: object + type: object + livenessProbe: + description: 'Periodic probe of container liveness. Container + will be restarted if the probe fails. Cannot be updated. More + info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes' + properties: + exec: + description: One and only one of the following should be + specified. Exec specifies the action to take. + properties: + command: + description: Command is the command line to execute + inside the container, the working directory for the + command is root ('/') in the container's filesystem. + The command is simply exec'd, it is not run inside + a shell, so traditional shell instructions ('|', etc) + won't work. To use a shell, you need to explicitly + call out to that shell. Exit status of 0 is treated + as live/healthy and non-zero is unhealthy. + items: + type: string + type: array + type: object + failureThreshold: + description: Minimum consecutive failures for the probe + to be considered failed after having succeeded. Defaults + to 3. Minimum value is 1. + format: int32 + type: integer + httpGet: + description: HTTPGet specifies the http request to perform. + properties: + host: + description: Host name to connect to, defaults to the + pod IP. You probably want to set "Host" in httpHeaders + instead. + type: string + httpHeaders: + description: Custom headers to set in the request. HTTP + allows repeated headers. + items: + description: HTTPHeader describes a custom header + to be used in HTTP probes + properties: + name: + description: The header field name + type: string + value: + description: The header field value + type: string + required: + - name + - value + type: object + type: array + path: + description: Path to access on the HTTP server. + type: string + port: + anyOf: + - type: integer + - type: string + description: Name or number of the port to access on + the container. Number must be in the range 1 to 65535. + Name must be an IANA_SVC_NAME. + x-kubernetes-int-or-string: true + scheme: + description: Scheme to use for connecting to the host. + Defaults to HTTP. + type: string + required: + - port + type: object + initialDelaySeconds: + description: 'Number of seconds after the container has + started before liveness probes are initiated. More info: + https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes' + format: int32 + type: integer + periodSeconds: + description: How often (in seconds) to perform the probe. + Default to 10 seconds. Minimum value is 1. + format: int32 + type: integer + successThreshold: + description: Minimum consecutive successes for the probe + to be considered successful after having failed. Defaults + to 1. Must be 1 for liveness and startup. Minimum value + is 1. + format: int32 + type: integer + tcpSocket: + description: 'TCPSocket specifies an action involving a + TCP port. TCP hooks not yet supported TODO: implement + a realistic TCP lifecycle hook' + properties: + host: + description: 'Optional: Host name to connect to, defaults + to the pod IP.' + type: string + port: + anyOf: + - type: integer + - type: string + description: Number or name of the port to access on + the container. Number must be in the range 1 to 65535. + Name must be an IANA_SVC_NAME. + x-kubernetes-int-or-string: true + required: + - port + type: object + timeoutSeconds: + description: 'Number of seconds after which the probe times + out. Defaults to 1 second. Minimum value is 1. More info: + https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes' + format: int32 + type: integer + type: object + name: + description: Name of the container specified as a DNS_LABEL. + Each container in a pod must have a unique name (DNS_LABEL). + Cannot be updated. + type: string + ports: + description: List of ports to expose from the container. Exposing + a port here gives the system additional information about + the network connections a container uses, but is primarily + informational. Not specifying a port here DOES NOT prevent + that port from being exposed. Any port which is listening + on the default "0.0.0.0" address inside a container will be + accessible from the network. Cannot be updated. + items: + description: ContainerPort represents a network port in a + single container. + properties: + containerPort: + description: Number of port to expose on the pod's IP + address. This must be a valid port number, 0 < x < 65536. + format: int32 + type: integer + hostIP: + description: What host IP to bind the external port to. + type: string + hostPort: + description: Number of port to expose on the host. If + specified, this must be a valid port number, 0 < x < + 65536. If HostNetwork is specified, this must match + ContainerPort. Most containers do not need this. + format: int32 + type: integer + name: + description: If specified, this must be an IANA_SVC_NAME + and unique within the pod. Each named port in a pod + must have a unique name. Name for the port that can + be referred to by services. + type: string + protocol: + description: Protocol for port. Must be UDP, TCP, or SCTP. + Defaults to "TCP". + type: string + required: + - containerPort + type: object + type: array + x-kubernetes-list-map-keys: + - containerPort + x-kubernetes-list-type: map + readinessProbe: + description: 'Periodic probe of container service readiness. + Container will be removed from service endpoints if the probe + fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes' + properties: + exec: + description: One and only one of the following should be + specified. Exec specifies the action to take. + properties: + command: + description: Command is the command line to execute + inside the container, the working directory for the + command is root ('/') in the container's filesystem. + The command is simply exec'd, it is not run inside + a shell, so traditional shell instructions ('|', etc) + won't work. To use a shell, you need to explicitly + call out to that shell. Exit status of 0 is treated + as live/healthy and non-zero is unhealthy. + items: + type: string + type: array + type: object + failureThreshold: + description: Minimum consecutive failures for the probe + to be considered failed after having succeeded. Defaults + to 3. Minimum value is 1. + format: int32 + type: integer + httpGet: + description: HTTPGet specifies the http request to perform. + properties: + host: + description: Host name to connect to, defaults to the + pod IP. You probably want to set "Host" in httpHeaders + instead. + type: string + httpHeaders: + description: Custom headers to set in the request. HTTP + allows repeated headers. + items: + description: HTTPHeader describes a custom header + to be used in HTTP probes + properties: + name: + description: The header field name + type: string + value: + description: The header field value + type: string + required: + - name + - value + type: object + type: array + path: + description: Path to access on the HTTP server. + type: string + port: + anyOf: + - type: integer + - type: string + description: Name or number of the port to access on + the container. Number must be in the range 1 to 65535. + Name must be an IANA_SVC_NAME. + x-kubernetes-int-or-string: true + scheme: + description: Scheme to use for connecting to the host. + Defaults to HTTP. + type: string + required: + - port + type: object + initialDelaySeconds: + description: 'Number of seconds after the container has + started before liveness probes are initiated. More info: + https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes' + format: int32 + type: integer + periodSeconds: + description: How often (in seconds) to perform the probe. + Default to 10 seconds. Minimum value is 1. + format: int32 + type: integer + successThreshold: + description: Minimum consecutive successes for the probe + to be considered successful after having failed. Defaults + to 1. Must be 1 for liveness and startup. Minimum value + is 1. + format: int32 + type: integer + tcpSocket: + description: 'TCPSocket specifies an action involving a + TCP port. TCP hooks not yet supported TODO: implement + a realistic TCP lifecycle hook' + properties: + host: + description: 'Optional: Host name to connect to, defaults + to the pod IP.' + type: string + port: + anyOf: + - type: integer + - type: string + description: Number or name of the port to access on + the container. Number must be in the range 1 to 65535. + Name must be an IANA_SVC_NAME. + x-kubernetes-int-or-string: true + required: + - port + type: object + timeoutSeconds: + description: 'Number of seconds after which the probe times + out. Defaults to 1 second. Minimum value is 1. More info: + https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes' + format: int32 + type: integer + type: object + resources: + description: 'Compute Resources required by this container. + Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/' + properties: + limits: + additionalProperties: + anyOf: + - type: integer + - type: string + pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ + x-kubernetes-int-or-string: true + description: 'Limits describes the maximum amount of compute + resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/' + type: object + requests: + additionalProperties: + anyOf: + - type: integer + - type: string + pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ + x-kubernetes-int-or-string: true + 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. More info: + https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/' + type: object + type: object + securityContext: + description: 'Security options the pod should run with. More + info: https://kubernetes.io/docs/concepts/policy/security-context/ + More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/' + properties: + allowPrivilegeEscalation: + description: 'AllowPrivilegeEscalation controls whether + a process can gain more privileges than its parent process. + This bool directly controls if the no_new_privs flag will + be set on the container process. AllowPrivilegeEscalation + is true always when the container is: 1) run as Privileged + 2) has CAP_SYS_ADMIN' + type: boolean + capabilities: + description: The capabilities to add/drop when running containers. + Defaults to the default set of capabilities granted by + the container runtime. + properties: + add: + description: Added capabilities + items: + description: Capability represent POSIX capabilities + type + type: string + type: array + drop: + description: Removed capabilities + items: + description: Capability represent POSIX capabilities + type + type: string + type: array + type: object + privileged: + description: Run container in privileged mode. Processes + in privileged containers are essentially equivalent to + root on the host. Defaults to false. + type: boolean + procMount: + description: procMount denotes the type of proc mount to + use for the containers. The default is DefaultProcMount + which uses the container runtime defaults for readonly + paths and masked paths. This requires the ProcMountType + feature flag to be enabled. + type: string + readOnlyRootFilesystem: + description: Whether this container has a read-only root + filesystem. Default is false. + type: boolean + runAsGroup: + description: The GID to run the entrypoint of the container + process. Uses runtime default if unset. May also be set + in PodSecurityContext. If set in both SecurityContext + and PodSecurityContext, the value specified in SecurityContext + takes precedence. + format: int64 + type: integer + runAsNonRoot: + description: Indicates that the container must run as a + non-root user. If true, the Kubelet will validate the + image at runtime to ensure that it does not run as UID + 0 (root) and fail to start the container if it does. If + unset or false, no such validation will be performed. + May also be set in PodSecurityContext. If set in both + SecurityContext and PodSecurityContext, the value specified + in SecurityContext takes precedence. + type: boolean + runAsUser: + description: The UID to run the entrypoint of the container + process. Defaults to user specified in image metadata + if unspecified. May also be set in PodSecurityContext. If + set in both SecurityContext and PodSecurityContext, the + value specified in SecurityContext takes precedence. + format: int64 + type: integer + seLinuxOptions: + description: The SELinux context to be applied to the container. + If unspecified, the container runtime will allocate a + random SELinux context for each container. May also be + set in PodSecurityContext. If set in both SecurityContext + and PodSecurityContext, the value specified in SecurityContext + takes precedence. + properties: + level: + description: Level is SELinux level label that applies + to the container. + type: string + role: + description: Role is a SELinux role label that applies + to the container. + type: string + type: + description: Type is a SELinux type label that applies + to the container. + type: string + user: + description: User is a SELinux user label that applies + to the container. + type: string + type: object + windowsOptions: + description: The Windows specific settings applied to all + containers. If unspecified, the options from the PodSecurityContext + will be used. If set in both SecurityContext and PodSecurityContext, + the value specified in SecurityContext takes precedence. + properties: + gmsaCredentialSpec: + description: GMSACredentialSpec is where the GMSA admission + webhook (https://github.com/kubernetes-sigs/windows-gmsa) + inlines the contents of the GMSA credential spec named + by the GMSACredentialSpecName field. + type: string + gmsaCredentialSpecName: + description: GMSACredentialSpecName is the name of the + GMSA credential spec to use. + type: string + runAsUserName: + description: The UserName in Windows to run the entrypoint + of the container process. Defaults to the user specified + in image metadata if unspecified. May also be set + in PodSecurityContext. If set in both SecurityContext + and PodSecurityContext, the value specified in SecurityContext + takes precedence. + type: string + type: object + type: object + startupProbe: + description: 'StartupProbe indicates that the Pod has successfully + initialized. If specified, no other probes are executed until + this completes successfully. If this probe fails, the Pod + will be restarted, just as if the livenessProbe failed. This + can be used to provide different probe parameters at the beginning + of a Pod''s lifecycle, when it might take a long time to load + data or warm a cache, than during steady-state operation. + This cannot be updated. This is a beta feature enabled by + the StartupProbe feature flag. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes' + properties: + exec: + description: One and only one of the following should be + specified. Exec specifies the action to take. + properties: + command: + description: Command is the command line to execute + inside the container, the working directory for the + command is root ('/') in the container's filesystem. + The command is simply exec'd, it is not run inside + a shell, so traditional shell instructions ('|', etc) + won't work. To use a shell, you need to explicitly + call out to that shell. Exit status of 0 is treated + as live/healthy and non-zero is unhealthy. + items: + type: string + type: array + type: object + failureThreshold: + description: Minimum consecutive failures for the probe + to be considered failed after having succeeded. Defaults + to 3. Minimum value is 1. + format: int32 + type: integer + httpGet: + description: HTTPGet specifies the http request to perform. + properties: + host: + description: Host name to connect to, defaults to the + pod IP. You probably want to set "Host" in httpHeaders + instead. + type: string + httpHeaders: + description: Custom headers to set in the request. HTTP + allows repeated headers. + items: + description: HTTPHeader describes a custom header + to be used in HTTP probes + properties: + name: + description: The header field name + type: string + value: + description: The header field value + type: string + required: + - name + - value + type: object + type: array + path: + description: Path to access on the HTTP server. + type: string + port: + anyOf: + - type: integer + - type: string + description: Name or number of the port to access on + the container. Number must be in the range 1 to 65535. + Name must be an IANA_SVC_NAME. + x-kubernetes-int-or-string: true + scheme: + description: Scheme to use for connecting to the host. + Defaults to HTTP. + type: string + required: + - port + type: object + initialDelaySeconds: + description: 'Number of seconds after the container has + started before liveness probes are initiated. More info: + https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes' + format: int32 + type: integer + periodSeconds: + description: How often (in seconds) to perform the probe. + Default to 10 seconds. Minimum value is 1. + format: int32 + type: integer + successThreshold: + description: Minimum consecutive successes for the probe + to be considered successful after having failed. Defaults + to 1. Must be 1 for liveness and startup. Minimum value + is 1. + format: int32 + type: integer + tcpSocket: + description: 'TCPSocket specifies an action involving a + TCP port. TCP hooks not yet supported TODO: implement + a realistic TCP lifecycle hook' + properties: + host: + description: 'Optional: Host name to connect to, defaults + to the pod IP.' + type: string + port: + anyOf: + - type: integer + - type: string + description: Number or name of the port to access on + the container. Number must be in the range 1 to 65535. + Name must be an IANA_SVC_NAME. + x-kubernetes-int-or-string: true + required: + - port + type: object + timeoutSeconds: + description: 'Number of seconds after which the probe times + out. Defaults to 1 second. Minimum value is 1. More info: + https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes' + format: int32 + type: integer + type: object + stdin: + description: Whether this container should allocate a buffer + for stdin in the container runtime. If this is not set, reads + from stdin in the container will always result in EOF. Default + is false. + type: boolean + stdinOnce: + description: Whether the container runtime should close the + stdin channel after it has been opened by a single attach. + When stdin is true the stdin stream will remain open across + multiple attach sessions. If stdinOnce is set to true, stdin + is opened on container start, is empty until the first client + attaches to stdin, and then remains open and accepts data + until the client disconnects, at which time stdin is closed + and remains closed until the container is restarted. If this + flag is false, a container processes that reads from stdin + will never receive an EOF. Default is false + type: boolean + terminationMessagePath: + description: 'Optional: Path at which the file to which the + container''s termination message will be written is mounted + into the container''s filesystem. Message written is intended + to be brief final status, such as an assertion failure message. + Will be truncated by the node if greater than 4096 bytes. + The total message length across all containers will be limited + to 12kb. Defaults to /dev/termination-log. Cannot be updated.' + type: string + terminationMessagePolicy: + description: Indicate how the termination message should be + populated. File will use the contents of terminationMessagePath + to populate the container status message on both success and + failure. FallbackToLogsOnError will use the last chunk of + container log output if the termination message file is empty + and the container exited with an error. The log output is + limited to 2048 bytes or 80 lines, whichever is smaller. Defaults + to File. Cannot be updated. + type: string + tty: + description: Whether this container should allocate a TTY for + itself, also requires 'stdin' to be true. Default is false. + type: boolean + volumeDevices: + description: volumeDevices is the list of block devices to be + used by the container. + items: + description: volumeDevice describes a mapping of a raw block + device within a container. + properties: + devicePath: + description: devicePath is the path inside of the container + that the device will be mapped to. + type: string + name: + description: name must match the name of a persistentVolumeClaim + in the pod + type: string + required: + - devicePath + - name + type: object + type: array + volumeMounts: + description: Pod volumes to mount into the container's filesystem. + Cannot be updated. + items: + description: VolumeMount describes a mounting of a Volume + within a container. + properties: + mountPath: + description: Path within the container at which the volume + should be mounted. Must not contain ':'. + type: string + mountPropagation: + description: mountPropagation determines how mounts are + propagated from the host to container and the other + way around. When not set, MountPropagationNone is used. + This field is beta in 1.10. + type: string + name: + description: This must match the Name of a Volume. + type: string + readOnly: + description: Mounted read-only if true, read-write otherwise + (false or unspecified). Defaults to false. + type: boolean + subPath: + description: Path within the volume from which the container's + volume should be mounted. Defaults to "" (volume's root). + type: string + subPathExpr: + description: Expanded path within the volume from which + the container's volume should be mounted. Behaves similarly + to SubPath but environment variable references $(VAR_NAME) + are expanded using the container's environment. Defaults + to "" (volume's root). SubPathExpr and SubPath are mutually + exclusive. + type: string + required: + - mountPath + - name + type: object + type: array + workingDir: + description: Container's working directory. If not specified, + the container runtime's default will be used, which might + be configured in the container image. Cannot be updated. + type: string + required: + - name + type: object + type: array + storageConfigs: + description: StorageConfig defines additional storage configurations + items: + description: StorageConfig defines additional storage configurations + properties: + mountPath: + description: Mount path into cassandra container + type: string + name: + description: Name of the pvc + pattern: '[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*' + type: string + pvcSpec: + description: Persistent volume claim spec + properties: + accessModes: + description: 'AccessModes contains the desired access modes + the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1' + items: + type: string + type: array + dataSource: + description: 'This field can be used to specify either: + * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot + - Beta) * An existing PVC (PersistentVolumeClaim) * An + existing custom resource/object that implements data population + (Alpha) In order to use VolumeSnapshot object types, the + appropriate feature gate must be enabled (VolumeSnapshotDataSource + or AnyVolumeDataSource) If the provisioner or an external + controller can support the specified data source, it will + create a new volume based on the contents of the specified + data source. If the specified data source is not supported, + the volume will not be created and the failure will be + reported as an event. In the future, we plan to support + more data source types and the behavior of the provisioner + may change.' + properties: + apiGroup: + description: APIGroup is the group for the resource + being referenced. If APIGroup is not specified, the + specified Kind must be in the core API group. For + any other third-party types, APIGroup is required. + type: string + kind: + description: Kind is the type of resource being referenced + type: string + name: + description: Name is the name of resource being referenced + type: string + required: + - kind + - name + type: object + resources: + description: 'Resources represents the minimum resources + the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources' + properties: + limits: + additionalProperties: + anyOf: + - type: integer + - type: string + pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ + x-kubernetes-int-or-string: true + description: 'Limits describes the maximum amount of + compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/' + type: object + requests: + additionalProperties: + anyOf: + - type: integer + - type: string + pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ + x-kubernetes-int-or-string: true + 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. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/' + type: object + type: object + selector: + description: A label query over volumes to consider for + binding. + properties: + matchExpressions: + description: matchExpressions is a list of label selector + requirements. The requirements are ANDed. + items: + description: A label selector requirement is a selector + that contains values, a key, and an operator that + relates the key and values. + properties: + key: + description: key is the label key that the selector + applies to. + type: string + operator: + description: operator represents a key's relationship + to a set of values. Valid operators are In, + NotIn, Exists and DoesNotExist. + type: string + values: + description: 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. + items: + type: string + type: array + required: + - key + - operator + type: object + type: array + matchLabels: + additionalProperties: + type: string + 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: object + type: object + storageClassName: + description: 'Name of the StorageClass required by the claim. + More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1' + type: string + volumeMode: + description: volumeMode defines what type of volume is required + by the claim. Value of Filesystem is implied when not + included in claim spec. + type: string + volumeName: + description: VolumeName is the binding reference to the + PersistentVolume backing this claim. + type: string + type: object + required: + - mountPath + - name + - pvcSpec + type: object + type: array + topology: + description: Topology to create Cassandra DC and Racks and to target + appropriate Kubernetes Nodes + properties: + dc: + description: List of DC defined in the CassandraCluster + items: + description: DC allow to configure Cassandra RC according to + kubernetes nodeselector labels + properties: + dataCapacity: + description: Define the Capacity for Persistent Volume Claims + in the local storage + pattern: ^([+-]?[0-9.]+)([eEinumkKMGTP]*[-+]?[0-9]*)$ + type: string + dataStorageClass: + description: Define StorageClass for Persistent Volume Claims + in the local storage. + type: string + labels: + additionalProperties: + type: string + description: Labels used to target Kubernetes nodes + type: object + name: + description: Name of the DC + pattern: ^[^-]+$ + type: string + nodesPerRacks: + description: 'Number of nodes to deploy for a Cassandra + deployment in each Racks. Default: 1. Optional, if not + filled, used value define in CassandraClusterSpec' + format: int32 + type: integer + numTokens: + description: 'NumTokens : configure the CASSANDRA_NUM_TOKENS + parameter which can be different for each DD' + format: int32 + type: integer + rack: + description: List of Racks defined in the Cassandra DC + items: + description: Rack allow to configure Cassandra Rack according + to kubernetes nodeselector labels + properties: + labels: + additionalProperties: + type: string + description: Labels used to target Kubernetes nodes + type: object + name: + description: Name of the Rack + pattern: ^[^-]+$ + type: string + rollingPartition: + description: The Partition to control the Statefulset + Upgrade + format: int32 + type: integer + rollingRestart: + description: Flag to tell the operator to trigger + a rolling restart of the Rack + type: boolean + type: object + type: array + resources: + description: ResourceRequirements describes the compute + resource requirements. + properties: + limits: + additionalProperties: + anyOf: + - type: integer + - type: string + pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ + x-kubernetes-int-or-string: true + description: 'Limits describes the maximum amount of + compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/' + type: object + requests: + additionalProperties: + anyOf: + - type: integer + - type: string + pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ + x-kubernetes-int-or-string: true + 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. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/' + type: object + type: object + type: object + type: array + type: object + unlockNextOperation: + description: Very special Flag to hack CassKop reconcile loop - use + with really good Care + type: boolean + type: object + status: + description: CassandraClusterStatus defines Global state of CassandraCluster + properties: + cassandraNodeStatus: + additionalProperties: + properties: + hostId: + type: string + nodeIp: + type: string + type: object + type: object + cassandraRackStatus: + additionalProperties: + description: CassandraRackStatus defines states of Cassandra for + 1 rack (1 statefulset) + properties: + cassandraLastAction: + description: 'CassandraLastAction is the set of Cassandra State + & Actions: Active, Standby..' + properties: + endTime: + format: date-time + type: string + name: + description: 'Type of action to perform : UpdateVersion, + UpdateBaseImage, UpdateConfigMap..' + type: string + startTime: + format: date-time + type: string + status: + description: Action is the specific actions that can be + done on a Cassandra Cluster such as cleanup, upgradesstables.. + type: string + updatedNodes: + description: PodNames of updated Cassandra nodes. Updated + means the Cassandra container image version matches the + spec's version. + items: + type: string + type: array + type: object + phase: + description: 'Phase indicates the state this Cassandra cluster + jumps in. Phase goes as one way as below: Initial -> Running + <-> updating' + type: string + podLastOperation: + description: PodLastOperation manage status for Pod Operation + (nodetool cleanup, upgradesstables..) + properties: + endTime: + format: date-time + type: string + name: + type: string + operatorName: + description: Name of operator + type: string + pods: + description: List of pods running an operation + items: + type: string + type: array + podsKO: + description: List of pods that fail to run an operation + items: + type: string + type: array + podsOK: + description: List of pods that run an operation successfully + items: + type: string + type: array + startTime: + format: date-time + type: string + status: + type: string + type: object + type: object + description: CassandraRackStatusList list status for each Rack + type: object + lastClusterAction: + description: Store last action at cluster level + type: string + lastClusterActionStatus: + type: string + phase: + description: 'Phase indicates the state this Cassandra cluster jumps + in. Phase goes as one way as below: Initial -> Running <-> updating' + type: string + seedlist: + description: seedList to be used in Cassandra's Pods (computed by + the Operator) + items: + type: string + type: array + type: object + type: object + served: true + storage: true diff --git a/multi-casskop/helm/multi-casskop/crds/db.orange.com_cassandrarestores_crd.yaml b/multi-casskop/helm/multi-casskop/crds/db.orange.com_cassandrarestores_crd.yaml new file mode 100644 index 000000000..f8400e6d7 --- /dev/null +++ b/multi-casskop/helm/multi-casskop/crds/db.orange.com_cassandrarestores_crd.yaml @@ -0,0 +1,146 @@ +apiVersion: apiextensions.k8s.io/v1 +kind: CustomResourceDefinition +metadata: + name: cassandrarestores.db.orange.com +spec: + group: db.orange.com + names: + kind: CassandraRestore + listKind: CassandraRestoreList + plural: cassandrarestores + singular: cassandrarestore + scope: Namespaced + versions: + - name: v1alpha1 + schema: + openAPIV3Schema: + description: CassandraRestore is a Casskop Operator resource that represents + the restoration of a backup of a Cassandra cluster + properties: + apiVersion: + description: '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' + type: string + kind: + description: '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' + type: string + metadata: + type: object + spec: + description: CassandraRestoreSpec defines the specification for a restore + of a Cassandra backup. + properties: + cassandraBackup: + description: Name of the CassandraBackup to restore + type: string + cassandraCluster: + description: Name of the CassandraCluster the restore belongs to + type: string + cassandraDirectory: + description: Directory of Cassandra where data folder resides. Defaults + to /var/lib/cassandra + type: string + concurrentConnection: + description: Maximum number of threads used to download files from + the cloud. Defaults to 10 + format: int32 + type: integer + entities: + description: Database entities to restore, it might be either only + keyspaces or only tables prefixed by their respective keyspace, + e.g. 'k1,k2' if one wants to backup whole keyspaces or 'ks1.t1,ks2.t2' + if one wants to restore specific tables. These formats are mutually + exclusive so 'k1,k2.t2' is invalid. An empty field will restore + all keyspaces + type: string + exactSchemaVersion: + description: When set a running node's schema version must match the + snapshot's schema version. There might be cases when we want to + restore a table for which its CQL schema has not changed but it + has changed for other table / keyspace but a schema for that node + has changed by doing that. Defaults to False + type: boolean + noDeleteTruncates: + description: When set do not delete truncated SSTables after they've + been restored during CLEANUP phase. Defaults to false + type: boolean + restorationStrategyType: + description: Strategy telling how we should go about restoration, + please refer to details in backup and sidecar documentation + enum: + - HARDLINKS + - IMPORT + type: string + schemaVersion: + description: Version of the schema to restore from. Upon backup, a + schema version is automatically appended to a snapshot name and + its manifest is uploaded under that name. In case we have two snapshots + having same name, we might distinguish between the two of them by + using the schema version. If schema version is not specified, we + expect a unique backup taken with respective snapshot name. This + schema version has to match the version of a Cassandra node we are + doing restore for (hence, by proxy, when global request mode is + used, all nodes have to be on exact same schema version). Defaults + to False + type: string + secret: + description: Name of Secret to use when accessing cloud storage providers + type: string + required: + - cassandraBackup + - cassandraCluster + type: object + status: + properties: + condition: + description: BackRestCondition describes the observed state of a Restore + at a certain point + properties: + failureCause: + items: + properties: + message: + description: message explaining the error + type: string + source: + description: hostame of a node where this error has occurred + type: string + type: object + type: array + lastTransitionTime: + type: string + type: + type: string + required: + - type + type: object + coordinatorMember: + description: Name of the pod the restore operation is executed on + type: string + id: + description: unique identifier of an operation, a random id is assigned + to each operation after a request is submitted, from caller's perspective, + an id is sent back as a response to his request so he can further + query state of that operation, referencing id, by operations/{id} + endpoint + type: string + progress: + description: Progress is a percentage, 100% means the operation is + completed, either successfully or with errors + type: string + timeCompleted: + type: string + timeCreated: + type: string + timeStarted: + type: string + type: object + required: + - metadata + - spec + type: object + served: true + storage: true diff --git a/multi-casskop/helm/multi-casskop/templates/db_v1alpha1_cassandracluster_crd.yaml b/multi-casskop/helm/multi-casskop/crds/multicluster_v1alpha1_cassandramulticluster_crd.yaml similarity index 57% rename from multi-casskop/helm/multi-casskop/templates/db_v1alpha1_cassandracluster_crd.yaml rename to multi-casskop/helm/multi-casskop/crds/multicluster_v1alpha1_cassandramulticluster_crd.yaml index 95c7ea125..825434222 100644 --- a/multi-casskop/helm/multi-casskop/templates/db_v1alpha1_cassandracluster_crd.yaml +++ b/multi-casskop/helm/multi-casskop/crds/multicluster_v1alpha1_cassandramulticluster_crd.yaml @@ -2,13 +2,6 @@ apiVersion: apiextensions.k8s.io/v1beta1 kind: CustomResourceDefinition metadata: name: multicasskops.db.orange.com - labels: - app: {{ template "multi-casskop.name" . }} - chart: {{ .Chart.Name }}-{{ .Chart.Version }} - heritage: {{ .Release.Service }} - release: {{ .Release.Name }} - annotations: - "helm.sh/hook": crd-install spec: group: db.orange.com names: @@ -17,4 +10,10 @@ spec: plural: multicasskops singular: multicasskop scope: Namespaced + subresources: + status: {} version: v1alpha1 + versions: + - name: v1alpha1 + served: true + storage: true diff --git a/pkg/apis/db/v1alpha1/cassandrabackup_types.go b/pkg/apis/db/v1alpha1/cassandrabackup_types.go index 1a223851f..382ea2e7d 100644 --- a/pkg/apis/db/v1alpha1/cassandrabackup_types.go +++ b/pkg/apis/db/v1alpha1/cassandrabackup_types.go @@ -21,7 +21,7 @@ func (backupSpec CassandraBackupSpec) ValidateScheduleFormat() error { type CassandraBackupSpec struct { // Name of the CassandraCluster to backup - CassandraCluster string `json:"cassandracluster"` + CassandraCluster string `json:"cassandraCluster"` // Cassandra DC name to back up, used to find the cassandra nodes in the CassandraCluster Datacenter string `json:"datacenter"` // URI for the backup target location e.g. s3 bucket, filepath diff --git a/pkg/apis/db/v1alpha1/cassandrabackup_types_test.go b/pkg/apis/db/v1alpha1/cassandrabackup_types_test.go index a90a09919..2e625d552 100644 --- a/pkg/apis/db/v1alpha1/cassandrabackup_types_test.go +++ b/pkg/apis/db/v1alpha1/cassandrabackup_types_test.go @@ -55,7 +55,7 @@ func TestCassandraBackupComputeLastAppliedConfiguration(t *testing.T) { lastAppliedConfiguration, _ := backup.ComputeLastAppliedAnnotation() result := `{"metadata":{"creationTimestamp":null}, - "spec":{"cassandracluster":"cluster1","datacenter":"dc1","storageLocation":"s3://cassie", + "spec":{"cassandraCluster":"cluster1","datacenter":"dc1","storageLocation":"s3://cassie", "schedule":"@weekly","snapshotTag":"weekly","entities":"k1.t1, k3.t3"},"status":{} }` diff --git a/pkg/apis/db/v1alpha1/zz_generated.openapi.go b/pkg/apis/db/v1alpha1/zz_generated.openapi.go index fa3409658..3b45af1f5 100644 --- a/pkg/apis/db/v1alpha1/zz_generated.openapi.go +++ b/pkg/apis/db/v1alpha1/zz_generated.openapi.go @@ -75,7 +75,7 @@ func schema_pkg_apis_db_v1alpha1_CassandraBackupSpec(ref common.ReferenceCallbac Description: "CassandraBackupSpec defines the desired state of CassandraBackup", Type: []string{"object"}, Properties: map[string]spec.Schema{ - "cassandracluster": { + "cassandraCluster": { SchemaProps: spec.SchemaProps{ Type: []string{"string"}, Format: "", @@ -139,7 +139,7 @@ func schema_pkg_apis_db_v1alpha1_CassandraBackupSpec(ref common.ReferenceCallbac }, }, }, - Required: []string{"cassandracluster", "datacenter", "storageLocation", "snapshotTag"}, + Required: []string{"cassandraCluster", "datacenter", "storageLocation", "snapshotTag"}, }, }, } diff --git a/pkg/controller/cassandrabackup/reconcile.go b/pkg/controller/cassandrabackup/reconcile.go index 39dc7558b..d67d17575 100644 --- a/pkg/controller/cassandrabackup/reconcile.go +++ b/pkg/controller/cassandrabackup/reconcile.go @@ -27,6 +27,7 @@ const ( backupAlreadyScheduled = "Reconcilliation stopped as backup already scheduled and there are no new changes" undoScheduleChange = "Resetting the schedule to what it was previously. Everything else will be updated" retryFailedUndoSchedule = "Issue when resetting schedule, we'll give it another try" + secretError = "Your secret is not valid" ) // ReconcileCassandraBackup reconciles a CassandraBackup object @@ -148,6 +149,8 @@ func (r *ReconcileCassandraBackup) Reconcile(request reconcile.Request) (reconci // Based on storage location, be sure that respective secret entry is there so we error out asap if err := validateBackupSecret(secret, cassandraBackup, reqLogger); err != nil { + logrus.WithFields(logrus.Fields{"backup": request.NamespacedName, + "err": err}).Error(secretError) return reconcile.Result{}, err } diff --git a/pkg/controller/cassandracluster/testdata/cassandracluster-2DC-dc1-rack1-sts.yaml b/pkg/controller/cassandracluster/testdata/cassandracluster-2DC-dc1-rack1-sts.yaml index 2bbfb32ee..96af851cf 100644 --- a/pkg/controller/cassandracluster/testdata/cassandracluster-2DC-dc1-rack1-sts.yaml +++ b/pkg/controller/cassandracluster/testdata/cassandracluster-2DC-dc1-rack1-sts.yaml @@ -10,7 +10,7 @@ metadata: generation: 1 labels: app: cassandracluster - cassandracluster: cassandra-demo + cassandraCluster: cassandra-demo cassandraclusters.db.orange.com.dc: dc1 cassandraclusters.db.orange.com.rack: rack1 cluster: casskop @@ -33,7 +33,7 @@ spec: selector: matchLabels: app: cassandracluster - cassandracluster: cassandra-demo + cassandraCluster: cassandra-demo cassandraclusters.db.orange.com.dc: dc1 cassandraclusters.db.orange.com.rack: rack1 cluster: casskop @@ -44,7 +44,7 @@ spec: creationTimestamp: null labels: app: cassandracluster - cassandracluster: cassandra-demo + cassandraCluster: cassandra-demo cassandraclusters.db.orange.com.dc: dc1 cassandraclusters.db.orange.com.rack: rack1 cluster: casskop @@ -76,7 +76,7 @@ spec: - labelSelector: matchLabels: app: cassandracluster - cassandracluster: cassandra-demo + cassandraCluster: cassandra-demo cluster: casskop topologyKey: kubernetes.io/hostname containers: @@ -274,7 +274,7 @@ spec: creationTimestamp: null labels: app: cassandracluster - cassandracluster: cassandra-demo + cassandraCluster: cassandra-demo cassandraclusters.db.orange.com.dc: dc1 cassandraclusters.db.orange.com.rack: rack1 cluster: casskop diff --git a/pkg/controller/cassandrarestore/reconcile_test.go b/pkg/controller/cassandrarestore/reconcile_test.go index 84ab36a02..a090559d0 100644 --- a/pkg/controller/cassandrarestore/reconcile_test.go +++ b/pkg/controller/cassandrarestore/reconcile_test.go @@ -49,7 +49,7 @@ metadata: annotations: a1: v1 spec: - cassandracluster: test-cluster-dc1 + cassandraCluster: test-cluster-dc1 cluster: test-cluster datacenter: dc1 storageLocation: s3://cassie diff --git a/test/e2e/kuttl/ScaleUpAndDown/00-createCluster.yaml b/test/e2e/kuttl/ScaleUpAndDown/00-createCluster.yaml index b37b7bf2c..189fe2203 100644 --- a/test/e2e/kuttl/ScaleUpAndDown/00-createCluster.yaml +++ b/test/e2e/kuttl/ScaleUpAndDown/00-createCluster.yaml @@ -1,7 +1,7 @@ apiVersion: kuttl.dev/v1beta1 kind: TestStep commands: - - command: helm install casskop orange-incubator/cassandra-operator + - command: helm install casskop ../../../../helm/cassandra-operator namespaced: true --- apiVersion: db.orange.com/v1alpha1 diff --git a/test/e2e/kuttl/kuttl-test.yaml b/test/e2e/kuttl/kuttl-test.yaml index b1e3f563f..d6d9ed78c 100644 --- a/test/e2e/kuttl/kuttl-test.yaml +++ b/test/e2e/kuttl/kuttl-test.yaml @@ -3,13 +3,4 @@ kind: TestSuite #crdDir: ../../../deploy/crds/ testDirs: - . -timeout: 300 -commands: - - command: helm repo add orange-incubator https://orange-kubernetes-charts-incubator.storage.googleapis.com/ - ignoreFailure: true - - command: kubectl apply -f https://raw.githubusercontent.com/Orange-OpenSource/casskop/master/deploy/crds/db.orange.com_cassandraclusters_crd.yaml - ignoreFailure: true - - command: kubectl apply -f https://raw.githubusercontent.com/Orange-OpenSource/casskop/master/deploy/crds/db.orange.com_cassandrabackups_crd.yaml - ignoreFailure: true - - command: kubectl apply -f https://raw.githubusercontent.com/Orange-OpenSource/casskop/master/deploy/crds/db.orange.com_cassandrarestores_crd.yaml - ignoreFailure: true \ No newline at end of file +timeout: 300 \ No newline at end of file diff --git a/website/docs/2_setup/1_getting_started.md b/website/docs/2_setup/1_getting_started.md index b6a80b1a5..6d2e36a00 100644 --- a/website/docs/2_setup/1_getting_started.md +++ b/website/docs/2_setup/1_getting_started.md @@ -12,7 +12,7 @@ CassKop uses the standard Cassandra image (tested up to Version 3.11), and can r As a pre-requisite it needs : - [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/) version v1.13.3+. -- [Helm](https://helm.sh/) version v2.12.2+. +- [Helm](https://helm.sh/) version v3. - Access to a Kubernetes v1.13.3+ cluster. - Cassandra needs fast local storage (we have tested with local storage provisioner, GKE ssd storage, and Rancher local-path-provisioner). Fast remote storage should work but is not tested yet. @@ -26,9 +26,9 @@ First, we need to create a `namespace` in order to host our operator & cluster ( kubectl create namespace cassandra ``` -### Installing CassKop with Helm +### Installing CassKop with Helm 3 -You can (should) deploy CassKop using this [Helm chart](https://github.com/Orange-Opensource/casskop/tree/master/helm): +You can (should) deploy CassKop using this [Helm 3 chart](https://github.com/Orange-Opensource/casskop/tree/master/helm): First we add the repo: @@ -36,43 +36,12 @@ First we add the repo: helm repo add orange-incubator https://orange-kubernetes-charts-incubator.storage.googleapis.com/ ``` -Then the chart itself depending on your installed version of Helm: - - - +Then install the chart using Helm 3: ```bash -# You have to create the namespace before executing following commands -kubectl apply -f https://raw.githubusercontent.com/Orange-OpenSource/casskop/master/deploy/crds/db.orange.com_cassandraclusters_crd.yaml -kubectl apply -f https://raw.githubusercontent.com/Orange-OpenSource/casskop/master/deploy/crds/db.orange.com_cassandrabackups_crd.yaml -kubectl apply -f https://raw.githubusercontent.com/Orange-OpenSource/casskop/master/deploy/crds/db.orange.com_cassandrarestores_crd.yaml - -helm install casskop --namespace=cassandra orange-incubator/cassandra-operator +helm install casskop orange-incubator/cassandra-operator ``` - - - -```bash -# Install helm -helm init --history-max 200 -kubectl create serviceaccount tiller --namespace kube-system -kubectl create -f tiller-clusterrolebinding.yaml -helm init --service-account tiller --upgrade - -# Deploy operator -helm install --name=casskop --namespace=cassandra orange-incubator/cassandra-operator -``` - - - - You can find more information in the [Customizable install with helm](/casskop/docs/3_configuration_deployment/1_customizable_install_with_helm). If you have problem you can see [Troubleshooting](/casskop/docs/7_troubleshooting/1_operations_issues) section @@ -131,4 +100,4 @@ which namespace to monitor (Your namespace need to be listed in the `namespaceSe #### Add Grafana dashboard for Cassandra You can use our dashboard that monitors both Cassandra nodes and CassKop by running: -```kubectl apply -f monitoring/dashboards/``` \ No newline at end of file +```kubectl apply -f monitoring/dashboards/``` diff --git a/website/docs/2_setup/2_multi_casskop.md b/website/docs/2_setup/2_multi_casskop.md index 02cee960a..3a0ed0e6e 100644 --- a/website/docs/2_setup/2_multi_casskop.md +++ b/website/docs/2_setup/2_multi_casskop.md @@ -66,37 +66,11 @@ Proceed with Multi-CassKop installation only when [Pre-requisites](#pre-requisit Deployment with Helm. Multi-CassKop and CassKop shared the same github/helm repo and semantic version. - - ```bash -# You have to create the namespace before executing following command -kubectl apply -f https://github.com/Orange-OpenSource/casskop/blob/master/multi-casskop/deploy/crds/multicluster_v1alpha1_cassandramulticluster_crd.yaml -helm install multi-casskop --namespace=cassandra orange-incubator/multi-casskop --set k8s.local=k8s-cluster1 --set k8s.remote={k8s-cluster2} +helm install multi-casskop orange-incubator/multi-casskop --set k8s.local=k8s-cluster1 --set k8s.remote={k8s-cluster2} ``` - - - -```bash -# Install helm -helm init --history-max 200 -kubectl create serviceaccount tiller --namespace kube-system -kubectl create -f tiller-clusterrolebinding.yaml -helm init --service-account tiller --upgrade - -# Deploy operator -helm install --name=multi-casskop --namespace=cassandra orange-incubator/multi-casskop --set k8s.local=k8s-cluster1 --set k8s.remote={k8s-cluster2} -``` - - - When starting Multi-CassKop, we need to give some parameters: - k8s.local is the name of the k8s-cluster we want to refere to when talking to this cluster. - k8s.remote is a list of other kubernetes we want to connect to. diff --git a/website/docs/5_operations/3_5_backup_restore.md b/website/docs/5_operations/3_5_backup_restore.md index 0893973f9..2e3ada7ab 100644 --- a/website/docs/5_operations/3_5_backup_restore.md +++ b/website/docs/5_operations/3_5_backup_restore.md @@ -3,13 +3,14 @@ id: 3_5_backup_restore title: Backup and restore sidebar_label: Backup and restore --- +**Tip**: For a full working example step by step, please check also this [well written article](https://cscetbon.medium.com/casskop-1-0-1-backup-and-restore-ba92f01c00df). This also explain more deeply how Casskop Backup & Restore works in background In order to provide Backup/Restore abilities we use InstaCluster's [cassandra-sidecar project](https://github.com/instaclustr/cassandra-sidecar) and add it to each Cassandra node to spawn. We want to thant Instaclustr for the modifications they made to make it work with CassKop! ## Backup It is possible to backup keyspaces or tables from a cluster managed by Casskop. To start or schedule a backup, you -create an object of type CassandraBackup: +create an object of type [CassandraBackup](/casskop/docs/6_references/5_cassandra_backup): ```yaml apiVersion: db.orange.com/v1alpha1 @@ -19,7 +20,7 @@ metadata: labels: app: cassandra spec: - cassandracluster: test-cluster + cassandraCluster: test-cluster datacenter: dc1 storageLocation: s3://cassie snapshotTag: SnapshotTag2 @@ -59,8 +60,8 @@ When this object gets updated, and the change is located in the spec section, Ca ## Restore -Following the same logic, a CassandraRestore object must be created to trigger a restore, and it must refer to an -existing CassandraBackup object in K8S: +Following the same logic, a [CassandraRestore](/casskop/docs/6_references/6_cassandra_restore) object must be created to trigger a restore, and it must refer to an +existing [CassandraBackup](/casskop/docs/6_references/5_cassandra_backup) object in K8S: ```yaml apiVersion: db.orange.com/v1alpha1 @@ -70,9 +71,9 @@ metadata: labels: app: cassandra spec: - backup: - name: nightly-cassandra-backup - cluster: test-cluster + cassandraBackup: nightly-cassandra-backup + cassandraCluster: test-cluster + restorationStrategyType: HARDLINKS entities: k1.t1 ``` diff --git a/website/docs/6_references/1_cassandra_cluster.md b/website/docs/6_references/1_cassandra_cluster.md index a782c9d87..64c0cf393 100644 --- a/website/docs/6_references/1_cassandra_cluster.md +++ b/website/docs/6_references/1_cassandra_cluster.md @@ -71,8 +71,7 @@ spec: |service|[ServicePolicy](#servicepolicy)||No|-| |deletePVC|bool|Defines if the PVC must be deleted when the cluster is deleted|Yes|false| |debug|bool|Is used to surcharge Cassandra pod command to not directly start cassandra but starts an infinite wait to allow user to connect a bash into the pod to make some diagnoses.|Yes|false| -|shareProcessNamespace|bool|When process namespace sharing is enabled, processes in a container are visible to all other containers in that pod. - // https://kubernetes.io/docs/tasks/configure-pod-container/share-process-namespace/|Yes|false| +|shareProcessNamespace|bool|When process namespace sharing is enabled, processes in a container are visible to all other containers in that pod. [Check documentation for more informations](https://kubernetes.io/docs/tasks/configure-pod-container/share-process-namespace/)|Yes|false| |autoPilot|bool|Defines if the Operator can fly alone or if we need human action to trigger actions on specific Cassandra nodes. [Check documentation for more informations](/casskop/docs/5_operations/2_pods_operations)|Yes|false| |noCheckStsAreEqual|bool||Yes|false| |gcStdout|bool|Set the parameter CASSANDRA_GC_STDOUT which configure the JVM -Xloggc: true by default|Yes|true| diff --git a/website/docs/6_references/5_cassandra_backup.md b/website/docs/6_references/5_cassandra_backup.md new file mode 100644 index 000000000..fdfb31b4b --- /dev/null +++ b/website/docs/6_references/5_cassandra_backup.md @@ -0,0 +1,72 @@ +--- +id: 5_cassandra_backup +title: Cassandra backup +sidebar_label: Cassandra backup +--- + +```yaml +apiVersion: db.orange.com/v1alpha1 +kind: CassandraBackup +metadata: + name: backup-demo-scheduled +spec: + cassandraCluster: cluster-demo + datacenter: dc1 + storageLocation: s3://cscetbon-lab + secret: aws-backup-secrets + entities: k1.standard1 + snapshotTag: second +# I don't really expect you to run backups every minute ;) + schedule: "@every 1m" +``` + +## CassandraBackup + +|Field|Type|Description|Required|Default| +|-----|----|-----------|--------|--------| +|metadata|[ObjectMetadata](https://godoc.org/k8s.io/apimachinery/pkg/apis/meta/v1#ObjectMeta)|is metadata that all persisted resources must have, which includes all objects users must create.|No|-|| +|spec|[CassandraBackupSpec](#cassandrabackupspec)|defines the desired state of CassandraBackup.|No|nil| +|status|[CassandraBackupStatus](#cassandrabackupstatus)|defines the observed state of CassandraBackup.|No|nil| + +## CassandraBackupSpec + +|Field|Type|Description|Required|Default| +|-----|----|-----------|--------|--------| +|bandwidth|string|Specify the bandwidth to not exceed when uploading files to the cloud. Format supported is \d+[KMG] case insensitive. You can use values like 10M (meaning 10MB), 1024, 1024K, 2G, etc...|no|-| +|cassandraCluster|string|Name of the CassandraCluster to backup|Yes|-| +|concurrentConnections|int32|Maximum number of threads used to download files from the cloud. Defaults to 10|No|-| +|datacenter|string|Cassandra DC name to back up, used to find the cassandra nodes in the CassandraCluster|Yes|-| +|duration|string|Specify a duration the backup should try to last. See https://golang.org/pkg/time/#ParseDuration for an exhaustive list of the supported units. You can use values like .25h, 15m, 900s all meaning 15 minutes|No|-| +|entities|string|Database entities to backup, it might be either only keyspaces or only tables prefixed by their respective keyspace, e.g. 'k1,k2' if one wants to backup whole keyspaces or 'ks1.t1,ks2.t2' if one wants to restore specific tables. These formats are mutually exclusive so 'k1,k2.t2' is invalid. An empty field will backup all keyspaces|No|-| +|schedule|string|Specify a schedule to assigned to the backup. The schedule doesn't enforce anything so if you schedule multiple backups around the same time they would conflict. See https://godoc.org/github.com/robfig/cron for more information regarding the supported formats|No|-| +|secret|string|Name of Secret to use when accessing cloud storage providers|No|-| +|snapshotTag|string|name of snapshot to make so this snapshot will be uploaded to storage location. If not specified, the name of snapshot will be automatically generated and it will have name 'autosnap-milliseconds-since-epoch'|Yes|-| +|storageLocation|string|URI for the backup target location e.g. s3 bucket, filepath|Yes|-| + +## CassandraBackupStatus + +|Field|Type|Description|Required|Default| +|-----|----|-----------|--------|--------| +|condition|[Condition](#condition)|BackRestCondition describes the observed state of a Restore at a certain point|Yes|-| +|coordinatorMember|string|Name of the pod the restore operation is executed on|Yes|-| +|id|string|unique identifier of an operation, a random id is assigned to each operation after a request is submitted, from caller's perspective, an id is sent back as a response to his request so he can further query state of that operation, referencing id, by operations/{id} endpoint|Yes|-| +|progress|string|Progress is a percentage, 100% means the operation is completed, either successfully or with errors|Yes|-| +|timeCompleted|string| |Yes|-| +|timeCreated|string| |Yes|-| +|timeStarted|string| |Yes|-| + +### Condition + +|Field|Type|Description|Required|Default| +|-----|----|-----------|--------|--------| +|failureCause|[[]items](#items)| |Yes|nil +|lastTransitionTime|string| |Yes|- +|type|string| |Yes|- + + +### Items + +|Field|Type|Description|Required|Default| +|-----|----|-----------|--------|--------| +|message|string|message explaining the error|Yes|-| +|source|string|hostame of a node where this error has occurred|Yes|-| diff --git a/website/docs/6_references/6_cassandra_restore.md b/website/docs/6_references/6_cassandra_restore.md new file mode 100644 index 000000000..55d009682 --- /dev/null +++ b/website/docs/6_references/6_cassandra_restore.md @@ -0,0 +1,70 @@ +--- +id: 6_cassandra_restore +title: Cassandra restore +sidebar_label: Cassandra restore +--- + +`CassandraRestoreSpec` defines the specification for a restore of a Cassandra backup. + +```yaml +apiVersion: db.orange.com/v1alpha1 +kind: CassandraRestore +metadata: + name: restore-demo +spec: + cassandraCluster: cluster-demo + cassandraBackup: backup-demo + restorationStrategyType: HARDLINKS + entities: k1.standard1 +``` + +## CassandraRestore + +|Field|Type|Description|Required|Default| +|-----|----|-----------|--------|--------| +|metadata|[ObjectMetadata](https://godoc.org/k8s.io/apimachinery/pkg/apis/meta/v1#ObjectMeta)|is metadata that all persisted resources must have, which includes all objects users must create.|No|nil| +|spec|[CassandraRestoreSpec](#cassandrarestorespec)|defines the desired state of CassandraRestore.|No|nil| +|status|[CassandraRestoreStatus](#cassandrarestorestatus)|defines the observed state of CassandraRestore.|No|nil| + +## CassandraRestoreSpec + +|Field|Type|Description|Required|Default| +|-----|----|-----------|--------|--------| +|cassandraBackup|string|Name of the [CassandraBackup](/casskop/docs/6_references/5_cassandra_backup) to restore|Yes|-| +|cassandraCluster|string|Name of the CassandraCluster the restore belongs to|Yes|-| +|cassandraDirectory|string|Directory of Cassandra where data folder resides. Defaults to /var/lib/cassandra|No|-| +|concurrentConnection|int32|Maximum number of threads used to download files from the cloud. Defaults to 10|No|-| +|entities|string|Database entities to restore, it might be either only keyspaces or only tables prefixed by their respective keyspace, e.g. 'k1,k2' if one wants to backup whole keyspaces or 'ks1.t1,ks2.t2' if one wants to restore specific tables. These formats are mutually exclusive so 'k1,k2.t2' is invalid. An empty field will restore all keyspaces|No|-| +|exactSchemaVersion|boolean|When set a running node's schema version must match the snapshot's schema version. There might be cases when we want to restore a table for which its CQL schema has not changed but it has changed for other table / keyspace but a schema for that node has changed by doing that. Defaults to False|No|false| +|noDeleteTruncates|boolean|When set do not delete truncated SSTables after they've been restored during CLEANUP phase. Defaults to false|No|false| +|restorationStrategyType|string|Strategy telling how we should go about restoration, please refer to details in backup and sidecar documentation. Enum values are : HARDLINKS or IMPORT|No|-| +|schemaVersion|string|Version of the schema to restore from. Upon backup, a schema version is automatically appended to a snapshot name and its manifest is uploaded under that name. In case we have two snapshots having same name, we might distinguish between the two of them by using the schema version. If schema version is not specified, we expect a unique backup taken with respective snapshot name. This schema version has to match the version of a Cassandra node we are doing restore for (hence, by proxy, when global request mode is used, all nodes have to be on exact same schema version). Defaults to False|No|-| +|secret|string|Name of Secret to use when accessing cloud storage providers|No|-| + +## CassandraRestoreStatus + +|Field|Type|Description|Required|Default| +|-----|----|-----------|--------|--------| +|condition|[Condition](#condition)|BackRestCondition describes the observed state of a Restore at a certain point|No|-| +|coordinatorMember|string|Name of the pod the restore operation is executed on|No|-| +|id|string|unique identifier of an operation, a random id is assigned to each operation after a request is submitted, from caller's perspective, an id is sent back as a response to his request so he can further query state of that operation, referencing id, by operations/{id} endpoint|No|-| +|progress|string|Progress is a percentage, 100% means the operation is completed, either successfully or with errors|No|-| +|timeCompleted|string| |No|-| +|timeCreated|string| |No|-| +|timeStarted|string| |No|-| + +### Condition + +|Field|Type|Description|Required|Default| +|-----|----|-----------|--------|--------| +|failureCause|[[]items](#items)| |No|nil +|lastTransitionTime|string| |No|- +|type|string| |No|- + + +### Items + +|Field|Type|Description|Required|Default| +|-----|----|-----------|--------|--------| +|message|string|message explaining the error|No|-| +|source|string|hostame of a node where this error has occurred|No|-| diff --git a/website/docs/8_contributing/1_developer_guide.md b/website/docs/8_contributing/1_developer_guide.md index 92729998e..38165ee07 100644 --- a/website/docs/8_contributing/1_developer_guide.md +++ b/website/docs/8_contributing/1_developer_guide.md @@ -44,7 +44,7 @@ Casskop has been validated with : - [go](https://golang.org) version v1.13+. - [docker](https://www.docker.com) version 18.09+. - [kubectl](https://kubernetes.io/fr/docs/tasks/tools/install-kubectl/) version v1.13.3+. -- [Helm](https://helm.sh/) version v2.12.2. +- [Helm](https://helm.sh/) version v.3. - Fork from [Operator sdk](https://github.com/operator-framework/operator-sdk) version v0.18.0 : [Operator sdk - forked](https://github.com/erdrix/operator-sdk/tree/v0.18.0-forked-pr317)