basePath: /api/v1 definitions: config.GenericConfig: properties: mp: additionalProperties: true description: |- Export this field to make "apiequality.Semantic.DeepEqual" happy now. User of GenericConfig should not directly access this field. type: object type: object errors.StatusError: properties: errStatus: $ref: '#/definitions/v1.Status' type: object intstr.IntOrString: properties: intVal: type: integer strVal: type: string type: type: integer type: object resource.Quantity: properties: Format: type: string type: object v1.AWSElasticBlockStoreVolumeSource: properties: fsType: description: |- Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore TODO: how do we prevent errors in the filesystem from compromising the machine +optional type: string partition: description: |- The partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). +optional type: integer readOnly: description: |- Specify "true" to force and set the ReadOnly property in VolumeMounts to "true". If omitted, the default is "false". More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore +optional type: boolean volumeID: description: |- Unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore type: string type: object v1.Affinity: properties: nodeAffinity: $ref: '#/definitions/v1.NodeAffinity' description: |- Describes node affinity scheduling rules for the pod. +optional podAffinity: $ref: '#/definitions/v1.PodAffinity' description: |- Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)). +optional podAntiAffinity: $ref: '#/definitions/v1.PodAntiAffinity' description: |- Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)). +optional type: object v1.AzureDiskVolumeSource: properties: cachingMode: description: |- Host Caching mode: None, Read Only, Read Write. +optional type: string diskName: description: The Name of the data disk in the blob storage type: string diskURI: description: The URI the data disk in the blob storage type: string fsType: description: |- Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. +optional type: string kind: description: 'Expected values Shared: multiple blob disks per storage account Dedicated: single blob disk per storage account Managed: azure managed data disk (only in managed availability set). defaults to shared' type: string readOnly: description: |- Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. +optional type: boolean type: object v1.AzureFileVolumeSource: properties: readOnly: description: |- Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. +optional type: boolean secretName: description: the name of secret that contains Azure Storage Account Name and Key type: string shareName: description: Share Name type: string type: object v1.CSIVolumeSource: properties: driver: description: |- Driver is the name of the CSI driver that handles this volume. Consult with your admin for the correct name as registered in the cluster. type: string fsType: description: |- Filesystem type to mount. Ex. "ext4", "xfs", "ntfs". If not provided, the empty value is passed to the associated CSI driver which will determine the default filesystem to apply. +optional type: string nodePublishSecretRef: $ref: '#/definitions/v1.LocalObjectReference' description: |- NodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secret references are passed. +optional readOnly: description: |- Specifies a read-only configuration for the volume. Defaults to false (read/write). +optional type: boolean volumeAttributes: additionalProperties: type: string description: |- VolumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver's documentation for supported values. +optional type: object type: object v1.Capabilities: properties: add: description: |- Added capabilities +optional items: type: string type: array drop: description: |- Removed capabilities +optional items: type: string type: array type: object v1.CephFSVolumeSource: properties: monitors: description: |- Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it items: type: string type: array path: description: |- Optional: Used as the mounted root, rather than the full Ceph tree, default is / +optional type: string readOnly: description: |- Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it +optional type: boolean secretFile: description: |- Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it +optional type: string secretRef: $ref: '#/definitions/v1.LocalObjectReference' description: |- Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it +optional user: description: |- Optional: User is the rados user name, default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it +optional type: string type: object v1.CinderVolumeSource: properties: fsType: description: |- Filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://examples.k8s.io/mysql-cinder-pd/README.md +optional type: string readOnly: description: |- Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/mysql-cinder-pd/README.md +optional type: boolean secretRef: $ref: '#/definitions/v1.LocalObjectReference' description: |- Optional: points to a secret object containing parameters used to connect to OpenStack. +optional volumeID: description: |- volume id used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md type: string type: object v1.ConfigMapEnvSource: 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? +optional type: string optional: description: |- Specify whether the ConfigMap must be defined +optional type: boolean type: object v1.ConfigMapKeySelector: 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? +optional type: string optional: description: |- Specify whether the ConfigMap or its key must be defined +optional type: boolean type: object v1.ConfigMapProjection: properties: items: description: |- If unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. +optional items: $ref: '#/definitions/v1.KeyToPath' type: array 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? +optional type: string optional: description: |- Specify whether the ConfigMap or its keys must be defined +optional type: boolean type: object v1.ConfigMapVolumeSource: properties: defaultMode: description: |- Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. +optional type: integer items: description: |- If unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. +optional items: $ref: '#/definitions/v1.KeyToPath' type: array 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? +optional type: string optional: description: |- Specify whether the ConfigMap or its keys must be defined +optional type: boolean type: object v1.Container: 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 +optional 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 +optional items: type: string type: array env: description: |- List of environment variables to set in the container. Cannot be updated. +optional +patchMergeKey=name +patchStrategy=merge items: $ref: '#/definitions/v1.EnvVar' 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. +optional items: $ref: '#/definitions/v1.EnvFromSource' 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. +optional 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 +optional type: string lifecycle: $ref: '#/definitions/v1.Lifecycle' description: |- Actions that the management system should take in response to container lifecycle events. Cannot be updated. +optional livenessProbe: $ref: '#/definitions/v1.Probe' 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 +optional 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. +optional +patchMergeKey=containerPort +patchStrategy=merge +listType=map +listMapKey=containerPort +listMapKey=protocol items: $ref: '#/definitions/v1.ContainerPort' type: array readinessProbe: $ref: '#/definitions/v1.Probe' 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 +optional resources: $ref: '#/definitions/v1.ResourceRequirements' description: |- Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ +optional securityContext: $ref: '#/definitions/v1.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/ +optional startupProbe: $ref: '#/definitions/v1.Probe' 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 an alpha feature enabled by the StartupProbe feature flag. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes +optional 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. +optional 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 +optional 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. +optional 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. +optional type: string tty: description: |- Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false. +optional type: boolean volumeDevices: description: |- volumeDevices is the list of block devices to be used by the container. This is a beta feature. +patchMergeKey=devicePath +patchStrategy=merge +optional items: $ref: '#/definitions/v1.VolumeDevice' type: array volumeMounts: description: |- Pod volumes to mount into the container's filesystem. Cannot be updated. +optional +patchMergeKey=mountPath +patchStrategy=merge items: $ref: '#/definitions/v1.VolumeMount' 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. +optional type: string type: object v1.ContainerPort: properties: containerPort: description: |- Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536. type: integer hostIP: description: |- What host IP to bind the external port to. +optional 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. +optional 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. +optional type: string protocol: description: |- Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP". +optional type: string type: object v1.DownwardAPIProjection: properties: items: description: |- Items is a list of DownwardAPIVolume file +optional items: $ref: '#/definitions/v1.DownwardAPIVolumeFile' type: array type: object v1.DownwardAPIVolumeFile: properties: fieldRef: $ref: '#/definitions/v1.ObjectFieldSelector' description: |- Required: Selects a field of the pod: only annotations, labels, name and namespace are supported. +optional mode: description: |- Optional: mode bits to use on this file, must be a value between 0 and 0777. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. +optional type: integer path: description: 'Required: Path is the relative path name of the file to be created. Must not be absolute or contain the ''..'' path. Must be utf-8 encoded. The first item of the relative path must not start with ''..''' type: string resourceFieldRef: $ref: '#/definitions/v1.ResourceFieldSelector' description: |- Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported. +optional type: object v1.DownwardAPIVolumeSource: properties: defaultMode: description: |- Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. +optional type: integer items: description: |- Items is a list of downward API volume file +optional items: $ref: '#/definitions/v1.DownwardAPIVolumeFile' type: array type: object v1.EmptyDirVolumeSource: properties: medium: description: |- What type of storage medium should back this directory. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir +optional type: string sizeLimit: $ref: '#/definitions/resource.Quantity' description: |- Total amount of local storage required for this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers in a pod. The default is nil which means that the limit is undefined. More info: http://kubernetes.io/docs/user-guide/volumes#emptydir +optional type: object v1.EnvFromSource: properties: configMapRef: $ref: '#/definitions/v1.ConfigMapEnvSource' description: |- The ConfigMap to select from +optional prefix: description: |- An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER. +optional type: string secretRef: $ref: '#/definitions/v1.SecretEnvSource' description: |- The Secret to select from +optional type: object v1.EnvVar: 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 "". +optional type: string valueFrom: $ref: '#/definitions/v1.EnvVarSource' description: |- Source for the environment variable's value. Cannot be used if value is not empty. +optional type: object v1.EnvVarSource: properties: configMapKeyRef: $ref: '#/definitions/v1.ConfigMapKeySelector' description: |- Selects a key of a ConfigMap. +optional fieldRef: $ref: '#/definitions/v1.ObjectFieldSelector' description: |- Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels, metadata.annotations, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP. +optional resourceFieldRef: $ref: '#/definitions/v1.ResourceFieldSelector' 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. +optional secretKeyRef: $ref: '#/definitions/v1.SecretKeySelector' description: |- Selects a key of a secret in the pod's namespace +optional type: object v1.ExecAction: 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. +optional items: type: string type: array type: object v1.FCVolumeSource: properties: fsType: description: |- Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. TODO: how do we prevent errors in the filesystem from compromising the machine +optional type: string lun: description: |- Optional: FC target lun number +optional type: integer readOnly: description: |- Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. +optional type: boolean targetWWNs: description: |- Optional: FC target worldwide names (WWNs) +optional items: type: string type: array wwids: description: |- Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously. +optional items: type: string type: array type: object v1.FlexVolumeSource: properties: driver: description: Driver is the name of the driver to use for this volume. type: string fsType: description: |- Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script. +optional type: string options: additionalProperties: type: string description: |- Optional: Extra command options if any. +optional type: object readOnly: description: |- Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. +optional type: boolean secretRef: $ref: '#/definitions/v1.LocalObjectReference' description: |- Optional: SecretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts. +optional type: object v1.FlockerVolumeSource: properties: datasetName: description: |- Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecated +optional type: string datasetUUID: description: |- UUID of the dataset. This is unique identifier of a Flocker dataset +optional type: string type: object v1.GCEPersistentDiskVolumeSource: properties: fsType: description: |- Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk TODO: how do we prevent errors in the filesystem from compromising the machine +optional type: string partition: description: |- The partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk +optional type: integer pdName: description: |- Unique name of the PD resource in GCE. Used to identify the disk in GCE. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk type: string readOnly: description: |- ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk +optional type: boolean type: object v1.GitRepoVolumeSource: properties: directory: description: |- Target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name. +optional type: string repository: description: Repository URL type: string revision: description: |- Commit hash for the specified revision. +optional type: string type: object v1.GlusterfsVolumeSource: properties: endpoints: description: |- EndpointsName is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod type: string path: description: |- Path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod type: string readOnly: description: |- ReadOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod +optional type: boolean type: object v1.HTTPGetAction: properties: host: description: |- Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. +optional type: string httpHeaders: description: |- Custom headers to set in the request. HTTP allows repeated headers. +optional items: $ref: '#/definitions/v1.HTTPHeader' type: array path: description: |- Path to access on the HTTP server. +optional type: string port: $ref: '#/definitions/intstr.IntOrString' 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. scheme: description: |- Scheme to use for connecting to the host. Defaults to HTTP. +optional type: string type: object v1.HTTPHeader: properties: name: description: The header field name type: string value: description: The header field value type: string type: object v1.Handler: properties: exec: $ref: '#/definitions/v1.ExecAction' description: |- One and only one of the following should be specified. Exec specifies the action to take. +optional httpGet: $ref: '#/definitions/v1.HTTPGetAction' description: |- HTTPGet specifies the http request to perform. +optional tcpSocket: $ref: '#/definitions/v1.TCPSocketAction' description: |- TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook +optional type: object v1.HostPathVolumeSource: properties: path: description: |- Path of the directory on the host. If the path is a symlink, it will follow the link to the real path. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath type: string type: description: |- Type for HostPath Volume Defaults to "" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath +optional type: string type: object v1.ISCSIVolumeSource: properties: chapAuthDiscovery: description: |- whether support iSCSI Discovery CHAP authentication +optional type: boolean chapAuthSession: description: |- whether support iSCSI Session CHAP authentication +optional type: boolean fsType: description: |- Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi TODO: how do we prevent errors in the filesystem from compromising the machine +optional type: string initiatorName: description: |- Custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface : will be created for the connection. +optional type: string iqn: description: Target iSCSI Qualified Name. type: string iscsiInterface: description: |- iSCSI Interface Name that uses an iSCSI transport. Defaults to 'default' (tcp). +optional type: string lun: description: iSCSI Target Lun number. type: integer portals: description: |- iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260). +optional items: type: string type: array readOnly: description: |- ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. +optional type: boolean secretRef: $ref: '#/definitions/v1.LocalObjectReference' description: |- CHAP Secret for iSCSI target and initiator authentication +optional targetPortal: description: |- iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260). type: string type: object v1.KeyToPath: properties: key: description: The key to project. type: string mode: description: |- Optional: mode bits to use on this file, must be a value between 0 and 0777. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. +optional type: integer path: description: |- The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'. type: string type: object v1.LabelSelector: properties: matchExpressions: description: |- matchExpressions is a list of label selector requirements. The requirements are ANDed. +optional items: $ref: '#/definitions/v1.LabelSelectorRequirement' 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. +optional type: object type: object v1.LabelSelectorRequirement: properties: key: description: |- key is the label key that the selector applies to. +patchMergeKey=key +patchStrategy=merge 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. +optional items: type: string type: array type: object v1.Lifecycle: properties: postStart: $ref: '#/definitions/v1.Handler' 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 +optional preStop: $ref: '#/definitions/v1.Handler' 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 +optional type: object v1.LocalObjectReference: 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? +optional type: string type: object v1.NFSVolumeSource: properties: path: description: |- Path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs type: string readOnly: description: |- ReadOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs +optional type: boolean server: description: |- Server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs type: string type: object v1.NodeAffinity: properties: preferredDuringSchedulingIgnoredDuringExecution: description: |- The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred. +optional items: $ref: '#/definitions/v1.PreferredSchedulingTerm' type: array requiredDuringSchedulingIgnoredDuringExecution: $ref: '#/definitions/v1.NodeSelector' description: |- If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to an update), the system may or may not try to eventually evict the pod from its node. +optional type: object v1.NodeSelector: properties: nodeSelectorTerms: description: Required. A list of node selector terms. The terms are ORed. items: $ref: '#/definitions/v1.NodeSelectorTerm' type: array type: object v1.NodeSelectorRequirement: properties: key: description: The label key that the selector applies to. type: string operator: description: |- Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. type: string values: description: |- 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. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. +optional items: type: string type: array type: object v1.NodeSelectorTerm: properties: matchExpressions: description: |- A list of node selector requirements by node's labels. +optional items: $ref: '#/definitions/v1.NodeSelectorRequirement' type: array matchFields: description: |- A list of node selector requirements by node's fields. +optional items: $ref: '#/definitions/v1.NodeSelectorRequirement' type: array type: object v1.ObjectFieldSelector: properties: apiVersion: description: |- Version of the schema the FieldPath is written in terms of, defaults to "v1". +optional type: string fieldPath: description: Path of the field to select in the specified API version. type: string type: object v1.PersistentVolumeClaimVolumeSource: properties: claimName: description: |- ClaimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims type: string readOnly: description: |- Will force the ReadOnly setting in VolumeMounts. Default false. +optional type: boolean type: object v1.PhotonPersistentDiskVolumeSource: properties: fsType: description: |- Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. type: string pdID: description: ID that identifies Photon Controller persistent disk type: string type: object v1.PodAffinity: properties: preferredDuringSchedulingIgnoredDuringExecution: description: |- The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred. +optional items: $ref: '#/definitions/v1.WeightedPodAffinityTerm' type: array requiredDuringSchedulingIgnoredDuringExecution: description: |- If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied. +optional items: $ref: '#/definitions/v1.PodAffinityTerm' type: array type: object v1.PodAffinityTerm: properties: labelSelector: $ref: '#/definitions/v1.LabelSelector' description: |- A label query over a set of resources, in this case pods. +optional namespaces: description: |- namespaces specifies which namespaces the labelSelector applies to (matches against); null or empty list means "this pod's namespace" +optional items: type: string type: array topologyKey: description: |- This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. type: string type: object v1.PodAntiAffinity: properties: preferredDuringSchedulingIgnoredDuringExecution: description: |- The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred. +optional items: $ref: '#/definitions/v1.WeightedPodAffinityTerm' type: array requiredDuringSchedulingIgnoredDuringExecution: description: |- If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied. +optional items: $ref: '#/definitions/v1.PodAffinityTerm' type: array type: object v1.PodSecurityContext: properties: fsGroup: description: |- A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod: 1. The owning GID will be the FSGroup 2. The setgid bit is set (new files created in the volume will be owned by FSGroup) 3. The permission bits are OR'd with rw-rw---- If unset, the Kubelet will not modify the ownership and permissions of any volume. +optional type: integer runAsGroup: description: |- The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. +optional 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 SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. +optional 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 SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. +optional type: integer seLinuxOptions: $ref: '#/definitions/v1.SELinuxOptions' description: |- The SELinux context to be applied to all containers. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. +optional supplementalGroups: description: |- A list of groups applied to the first process run in each container, in addition to the container's primary GID. If unspecified, no groups will be added to any container. +optional items: type: integer type: array sysctls: description: |- Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch. +optional items: $ref: '#/definitions/v1.Sysctl' type: array windowsOptions: $ref: '#/definitions/v1.WindowsSecurityContextOptions' description: |- The Windows specific settings applied to all containers. If unspecified, the options within a container's SecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. +optional type: object v1.PortworxVolumeSource: properties: fsType: description: |- FSType represents the filesystem type to mount Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs". Implicitly inferred to be "ext4" if unspecified. type: string readOnly: description: |- Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. +optional type: boolean volumeID: description: VolumeID uniquely identifies a Portworx volume type: string type: object v1.PreferredSchedulingTerm: properties: preference: $ref: '#/definitions/v1.NodeSelectorTerm' description: A node selector term, associated with the corresponding weight. weight: description: Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100. type: integer type: object v1.Probe: properties: exec: $ref: '#/definitions/v1.ExecAction' description: |- One and only one of the following should be specified. Exec specifies the action to take. +optional failureThreshold: description: |- Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. +optional type: integer httpGet: $ref: '#/definitions/v1.HTTPGetAction' description: |- HTTPGet specifies the http request to perform. +optional 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 +optional type: integer periodSeconds: description: |- How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. +optional 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. +optional type: integer tcpSocket: $ref: '#/definitions/v1.TCPSocketAction' description: |- TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook +optional 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 +optional type: integer type: object v1.ProjectedVolumeSource: properties: defaultMode: description: |- Mode bits to use on created files by default. Must be a value between 0 and 0777. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. +optional type: integer sources: description: list of volume projections items: $ref: '#/definitions/v1.VolumeProjection' type: array type: object v1.QuobyteVolumeSource: properties: group: description: |- Group to map volume access to Default is no group +optional type: string readOnly: description: |- ReadOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false. +optional type: boolean registry: description: |- Registry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumes type: string tenant: description: |- Tenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes, value is set by the plugin +optional type: string user: description: |- User to map volume access to Defaults to serivceaccount user +optional type: string volume: description: Volume is a string that references an already created Quobyte volume by name. type: string type: object v1.RBDVolumeSource: properties: fsType: description: |- Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#rbd TODO: how do we prevent errors in the filesystem from compromising the machine +optional type: string image: description: |- The rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it type: string keyring: description: |- Keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it +optional type: string monitors: description: |- A collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it items: type: string type: array pool: description: |- The rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it +optional type: string readOnly: description: |- ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it +optional type: boolean secretRef: $ref: '#/definitions/v1.LocalObjectReference' description: |- SecretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it +optional user: description: |- The rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it +optional type: string type: object v1.ResourceFieldSelector: properties: containerName: description: |- Container name: required for volumes, optional for env vars +optional type: string divisor: $ref: '#/definitions/resource.Quantity' description: |- Specifies the output format of the exposed resources, defaults to "1" +optional resource: description: 'Required: resource to select' type: string type: object v1.ResourceList: additionalProperties: $ref: '#/definitions/resource.Quantity' type: object v1.ResourceRequirements: properties: limits: $ref: '#/definitions/v1.ResourceList' description: |- Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ +optional requests: $ref: '#/definitions/v1.ResourceList' 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/ +optional type: object v1.SELinuxOptions: properties: level: description: |- Level is SELinux level label that applies to the container. +optional type: string role: description: |- Role is a SELinux role label that applies to the container. +optional type: string type: description: |- Type is a SELinux type label that applies to the container. +optional type: string user: description: |- User is a SELinux user label that applies to the container. +optional type: string type: object v1.ScaleIOVolumeSource: properties: fsType: description: |- Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Default is "xfs". +optional type: string gateway: description: The host address of the ScaleIO API Gateway. type: string protectionDomain: description: |- The name of the ScaleIO Protection Domain for the configured storage. +optional type: string readOnly: description: |- Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. +optional type: boolean secretRef: $ref: '#/definitions/v1.LocalObjectReference' description: |- SecretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail. sslEnabled: description: |- Flag to enable/disable SSL communication with Gateway, default false +optional type: boolean storageMode: description: |- Indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned. +optional type: string storagePool: description: |- The ScaleIO Storage Pool associated with the protection domain. +optional type: string system: description: The name of the storage system as configured in ScaleIO. type: string volumeName: description: |- The name of a volume already created in the ScaleIO system that is associated with this volume source. type: string type: object v1.SecretEnvSource: 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? +optional type: string optional: description: |- Specify whether the Secret must be defined +optional type: boolean type: object v1.SecretKeySelector: 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? +optional type: string optional: description: |- Specify whether the Secret or its key must be defined +optional type: boolean type: object v1.SecretProjection: properties: items: description: |- If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. +optional items: $ref: '#/definitions/v1.KeyToPath' type: array 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? +optional type: string optional: description: |- Specify whether the Secret or its key must be defined +optional type: boolean type: object v1.SecretVolumeSource: properties: defaultMode: description: |- Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. +optional type: integer items: description: |- If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. +optional items: $ref: '#/definitions/v1.KeyToPath' type: array optional: description: |- Specify whether the Secret or its keys must be defined +optional type: boolean secretName: description: |- Name of the secret in the pod's namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret +optional type: string type: object v1.SecurityContext: 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 +optional type: boolean capabilities: $ref: '#/definitions/v1.Capabilities' description: |- The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. +optional privileged: description: |- Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. +optional 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. +optional type: string readOnlyRootFilesystem: description: |- Whether this container has a read-only root filesystem. Default is false. +optional 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. +optional 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. +optional 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. +optional type: integer seLinuxOptions: $ref: '#/definitions/v1.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. +optional windowsOptions: $ref: '#/definitions/v1.WindowsSecurityContextOptions' 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. +optional type: object v1.ServiceAccountTokenProjection: properties: audience: description: |- Audience is the intended audience of the token. A recipient of a token must identify itself with an identifier specified in the audience of the token, and otherwise should reject the token. The audience defaults to the identifier of the apiserver. +optional type: string expirationSeconds: description: |- ExpirationSeconds is the requested duration of validity of the service account token. As the token approaches expiration, the kubelet volume plugin will proactively rotate the service account token. The kubelet will start trying to rotate the token if the token is older than 80 percent of its time to live or if the token is older than 24 hours.Defaults to 1 hour and must be at least 10 minutes. +optional type: integer path: description: |- Path is the path relative to the mount point of the file to project the token into. type: string type: object v1.ServicePort: properties: name: description: |- The name of this port within the service. This must be a DNS_LABEL. All ports within a ServiceSpec must have unique names. When considering the endpoints for a Service, this must match the 'name' field in the EndpointPort. Optional if only one ServicePort is defined on this service. +optional type: string nodePort: description: |- The port on each node on which this service is exposed when type=NodePort or LoadBalancer. Usually assigned by the system. If specified, it will be allocated to the service if unused or else creation of the service will fail. Default is to auto-allocate a port if the ServiceType of this Service requires one. More info: https://kubernetes.io/docs/concepts/services-networking/service/#type-nodeport +optional type: integer port: description: The port that will be exposed by this service. type: integer protocol: description: |- The IP protocol for this port. Supports "TCP", "UDP", and "SCTP". Default is TCP. +optional type: string targetPort: $ref: '#/definitions/intstr.IntOrString' description: |- Number or name of the port to access on the pods targeted by the service. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. If this is a string, it will be looked up as a named port in the target Pod's container ports. If this is not specified, the value of the 'port' field is used (an identity map). This field is ignored for services with clusterIP=None, and should be omitted or set equal to the 'port' field. More info: https://kubernetes.io/docs/concepts/services-networking/service/#defining-a-service +optional type: object v1.Status: 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 +optional type: string code: description: |- Suggested HTTP return code for this status, 0 if not set. +optional type: integer continue: description: |- continue may be set if the user set a limit on the number of items returned, and indicates that the server has more data available. The value is opaque and may be used to issue another request to the endpoint that served this list to retrieve the next set of available objects. Continuing a consistent list may not be possible if the server configuration has changed or more than a few minutes have passed. The resourceVersion field returned when using this continue value will be identical to the value in the first response, unless you have received this token from an error message. type: string details: $ref: '#/definitions/v1.StatusDetails' description: |- Extended data associated with the reason. Each reason may define its own extended details. This field is optional and the data returned is not guaranteed to conform to any schema except that defined by the reason type. +optional 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 +optional type: string message: description: |- A human-readable description of the status of this operation. +optional type: string reason: description: |- A machine-readable description of why this operation is in the "Failure" status. If this value is empty there is no information available. A Reason clarifies an HTTP status code but does not override it. +optional type: string remainingItemCount: description: |- remainingItemCount is the number of subsequent items in the list which are not included in this list response. If the list request contained label or field selectors, then the number of remaining items is unknown and the field will be left unset and omitted during serialization. If the list is complete (either because it is not chunking or because this is the last chunk), then there are no more remaining items and this field will be left unset and omitted during serialization. Servers older than v1.15 do not set this field. The intended use of the remainingItemCount is *estimating* the size of a collection. Clients should not rely on the remainingItemCount to be set or to be exact. +optional type: integer resourceVersion: description: |- String that identifies the server's internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency +optional type: string selfLink: description: |- selfLink is a URL representing this object. Populated by the system. Read-only. DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release. +optional type: string status: description: |- Status of the operation. One of: "Success" or "Failure". More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status +optional type: string type: object v1.StatusCause: properties: field: description: |- The field of the resource that has caused this error, as named by its JSON serialization. May include dot and postfix notation for nested attributes. Arrays are zero-indexed. Fields may appear more than once in an array of causes due to fields having multiple errors. Optional. Examples: "name" - the field "name" on the current resource "items[0].name" - the field "name" on the first array entry in "items" +optional type: string message: description: |- A human-readable description of the cause of the error. This field may be presented as-is to a reader. +optional type: string reason: description: |- A machine-readable description of the cause of the error. If this value is empty there is no information available. +optional type: string type: object v1.StatusDetails: properties: causes: description: |- The Causes array includes more details associated with the StatusReason failure. Not all StatusReasons may provide detailed causes. +optional items: $ref: '#/definitions/v1.StatusCause' type: array group: description: |- The group attribute of the resource associated with the status StatusReason. +optional type: string kind: description: |- The kind attribute of the resource associated with the status StatusReason. On some operations may differ from the requested resource Kind. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +optional type: string name: description: |- The name attribute of the resource associated with the status StatusReason (when there is a single name which can be described). +optional type: string retryAfterSeconds: description: |- If specified, the time in seconds before the operation should be retried. Some errors may indicate the client must take an alternate action - for those errors this field may indicate how long to wait before taking the alternate action. +optional type: integer uid: description: |- UID of the resource. (when there is a single resource which can be described). More info: http://kubernetes.io/docs/user-guide/identifiers#uids +optional type: string type: object v1.StorageOSVolumeSource: properties: fsType: description: |- Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. +optional type: string readOnly: description: |- Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. +optional type: boolean secretRef: $ref: '#/definitions/v1.LocalObjectReference' description: |- SecretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted. +optional volumeName: description: |- VolumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace. type: string volumeNamespace: description: |- VolumeNamespace specifies the scope of the volume within StorageOS. If no namespace is specified then the Pod's namespace will be used. This allows the Kubernetes name scoping to be mirrored within StorageOS for tighter integration. Set VolumeName to any name to override the default behaviour. Set to "default" if you are not using namespaces within StorageOS. Namespaces that do not pre-exist within StorageOS will be created. +optional type: string type: object v1.Sysctl: properties: name: description: Name of a property to set type: string value: description: Value of a property to set type: string type: object v1.TCPSocketAction: properties: host: description: |- Optional: Host name to connect to, defaults to the pod IP. +optional type: string port: $ref: '#/definitions/intstr.IntOrString' 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. type: object v1.Toleration: 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. +optional 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. +optional 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. +optional 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. +optional 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. +optional type: string type: object v1.Volume: properties: awsElasticBlockStore: $ref: '#/definitions/v1.AWSElasticBlockStoreVolumeSource' description: |- AWSElasticBlockStore represents an AWS Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore +optional azureDisk: $ref: '#/definitions/v1.AzureDiskVolumeSource' description: |- AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod. +optional azureFile: $ref: '#/definitions/v1.AzureFileVolumeSource' description: |- AzureFile represents an Azure File Service mount on the host and bind mount to the pod. +optional cephfs: $ref: '#/definitions/v1.CephFSVolumeSource' description: |- CephFS represents a Ceph FS mount on the host that shares a pod's lifetime +optional cinder: $ref: '#/definitions/v1.CinderVolumeSource' description: |- Cinder represents a cinder volume attached and mounted on kubelets host machine. More info: https://examples.k8s.io/mysql-cinder-pd/README.md +optional configMap: $ref: '#/definitions/v1.ConfigMapVolumeSource' description: |- ConfigMap represents a configMap that should populate this volume +optional csi: $ref: '#/definitions/v1.CSIVolumeSource' description: |- CSI (Container Storage Interface) represents storage that is handled by an external CSI driver (Alpha feature). +optional downwardAPI: $ref: '#/definitions/v1.DownwardAPIVolumeSource' description: |- DownwardAPI represents downward API about the pod that should populate this volume +optional emptyDir: $ref: '#/definitions/v1.EmptyDirVolumeSource' description: |- EmptyDir represents a temporary directory that shares a pod's lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir +optional fc: $ref: '#/definitions/v1.FCVolumeSource' description: |- FC represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod. +optional flexVolume: $ref: '#/definitions/v1.FlexVolumeSource' description: |- FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. +optional flocker: $ref: '#/definitions/v1.FlockerVolumeSource' description: |- Flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running +optional gcePersistentDisk: $ref: '#/definitions/v1.GCEPersistentDiskVolumeSource' description: |- GCEPersistentDisk represents a GCE Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk +optional gitRepo: $ref: '#/definitions/v1.GitRepoVolumeSource' description: |- GitRepo represents a git repository at a particular revision. DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod's container. +optional glusterfs: $ref: '#/definitions/v1.GlusterfsVolumeSource' description: |- Glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/glusterfs/README.md +optional hostPath: $ref: '#/definitions/v1.HostPathVolumeSource' description: |- HostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath --- TODO(jonesdl) We need to restrict who can use host directory mounts and who can/can not mount host directories as read/write. +optional iscsi: $ref: '#/definitions/v1.ISCSIVolumeSource' description: |- ISCSI represents an ISCSI Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://examples.k8s.io/volumes/iscsi/README.md +optional name: description: |- Volume's name. Must be a DNS_LABEL and unique within the pod. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names type: string nfs: $ref: '#/definitions/v1.NFSVolumeSource' description: |- NFS represents an NFS mount on the host that shares a pod's lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs +optional persistentVolumeClaim: $ref: '#/definitions/v1.PersistentVolumeClaimVolumeSource' description: |- PersistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims +optional photonPersistentDisk: $ref: '#/definitions/v1.PhotonPersistentDiskVolumeSource' description: PhotonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine portworxVolume: $ref: '#/definitions/v1.PortworxVolumeSource' description: |- PortworxVolume represents a portworx volume attached and mounted on kubelets host machine +optional projected: $ref: '#/definitions/v1.ProjectedVolumeSource' description: Items for all in one resources secrets, configmaps, and downward API quobyte: $ref: '#/definitions/v1.QuobyteVolumeSource' description: |- Quobyte represents a Quobyte mount on the host that shares a pod's lifetime +optional rbd: $ref: '#/definitions/v1.RBDVolumeSource' description: |- RBD represents a Rados Block Device mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/rbd/README.md +optional scaleIO: $ref: '#/definitions/v1.ScaleIOVolumeSource' description: |- ScaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes. +optional secret: $ref: '#/definitions/v1.SecretVolumeSource' description: |- Secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret +optional storageos: $ref: '#/definitions/v1.StorageOSVolumeSource' description: |- StorageOS represents a StorageOS volume attached and mounted on Kubernetes nodes. +optional vsphereVolume: $ref: '#/definitions/v1.VsphereVirtualDiskVolumeSource' description: |- VsphereVolume represents a vSphere volume attached and mounted on kubelets host machine +optional type: object v1.VolumeDevice: 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 type: object v1.VolumeMount: 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. +optional 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. +optional type: boolean subPath: description: |- Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). +optional 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. This field is beta in 1.15. +optional type: string type: object v1.VolumeProjection: properties: configMap: $ref: '#/definitions/v1.ConfigMapProjection' description: |- information about the configMap data to project +optional downwardAPI: $ref: '#/definitions/v1.DownwardAPIProjection' description: |- information about the downwardAPI data to project +optional secret: $ref: '#/definitions/v1.SecretProjection' description: |- information about the secret data to project +optional serviceAccountToken: $ref: '#/definitions/v1.ServiceAccountTokenProjection' description: |- information about the serviceAccountToken data to project +optional type: object v1.VsphereVirtualDiskVolumeSource: properties: fsType: description: |- Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. +optional type: string storagePolicyID: description: |- Storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName. +optional type: string storagePolicyName: description: |- Storage Policy Based Management (SPBM) profile name. +optional type: string volumePath: description: Path that identifies vSphere volume vmdk type: string type: object v1.WeightedPodAffinityTerm: properties: podAffinityTerm: $ref: '#/definitions/v1.PodAffinityTerm' description: Required. A pod affinity term, associated with the corresponding weight. weight: description: |- weight associated with matching the corresponding podAffinityTerm, in the range 1-100. type: integer type: object v1.WindowsSecurityContextOptions: 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. This field is alpha-level and is only honored by servers that enable the WindowsGMSA feature flag. +optional type: string gmsaCredentialSpecName: description: |- GMSACredentialSpecName is the name of the GMSA credential spec to use. This field is alpha-level and is only honored by servers that enable the WindowsGMSA feature flag. +optional 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. This field is alpha-level and it is only honored by servers that enable the WindowsRunAsUserName feature flag. +optional type: string type: object v1alpha1.CDCConfigWraper: properties: mp: additionalProperties: true description: |- Export this field to make "apiequality.Semantic.DeepEqual" happy now. User of GenericConfig should not directly access this field. type: object type: object v1alpha1.DiscoverySpec: properties: limits: $ref: '#/definitions/v1.ResourceList' description: |- Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ +optional requests: $ref: '#/definitions/v1.ResourceList' 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/ +optional type: object v1alpha1.HelperSpec: properties: image: description: |- Image used to tail slow log and set kernel parameters if necessary, must have `tail` and `sysctl` installed Optional: Defaults to busybox:1.26.2 +optional type: string imagePullPolicy: description: |- ImagePullPolicy of the component. Override the cluster-level imagePullPolicy if present Optional: Defaults to the cluster-level setting +optional type: string type: object v1alpha1.LogTailerSpec: properties: limits: $ref: '#/definitions/v1.ResourceList' description: |- Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ +optional requests: $ref: '#/definitions/v1.ResourceList' 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/ +optional type: object v1alpha1.PDConfigWraper: properties: mp: additionalProperties: true description: |- Export this field to make "apiequality.Semantic.DeepEqual" happy now. User of GenericConfig should not directly access this field. type: object type: object v1alpha1.PDSpec: properties: additionalContainers: description: |- Additional containers of the component. +optional items: $ref: '#/definitions/v1.Container' type: array additionalVolumeMounts: description: Additional volume mounts of component pod. items: $ref: '#/definitions/v1.VolumeMount' type: array additionalVolumes: description: |- Additional volumes of component pod. +optional items: $ref: '#/definitions/v1.Volume' type: array affinity: $ref: '#/definitions/v1.Affinity' description: |- Affinity of the component. Override the cluster-level setting if present. Optional: Defaults to cluster-level setting +optional annotations: additionalProperties: type: string description: |- Annotations for the component. Merge into the cluster-level annotations if non-empty Optional: Defaults to cluster-level setting +optional type: object baseImage: description: |- Base image of the component, image tag is now allowed during validation +kubebuilder:default=pingcap/pd +optional type: string config: $ref: '#/definitions/v1alpha1.PDConfigWraper' description: |- Config is the Configuration of pd-servers +optional configUpdateStrategy: description: |- ConfigUpdateStrategy of the component. Override the cluster-level updateStrategy if present Optional: Defaults to cluster-level setting +optional type: string dataSubDir: description: |- Subdirectory within the volume to store PD Data. By default, the data is stored in the root directory of volume which is mounted at /var/lib/pd. Specifying this will change the data directory to a subdirectory, e.g. /var/lib/pd/data if you set the value to "data". It's dangerous to change this value for a running cluster as it will upgrade your cluster to use a new storage directory. Defaults to "" (volume's root). +optional type: string enableDashboardInternalProxy: description: |- (Deprecated) EnableDashboardInternalProxy would directly set `internal-proxy` in the `PdConfig`. Note that this is deprecated, we should just set `dashboard.internal-proxy` in `pd.config`. +optional type: boolean env: description: |- List of environment variables to set in the container, like v1.Container.Env. Note that the following env names cannot be used and will be overridden by TiDB Operator builtin envs - NAMESPACE - TZ - SERVICE_NAME - PEER_SERVICE_NAME - HEADLESS_SERVICE_NAME - SET_NAME - HOSTNAME - CLUSTER_NAME - POD_NAME - BINLOG_ENABLED - SLOW_LOG_FILE +optional items: $ref: '#/definitions/v1.EnvVar' type: array hostNetwork: description: |- Whether Hostnetwork of the component is enabled. Override the cluster-level setting if present Optional: Defaults to cluster-level setting +optional type: boolean image: description: |- (Deprecated) Image of the component Use `baseImage` and `version` instead +k8s:openapi-gen=false type: string imagePullPolicy: description: |- ImagePullPolicy of the component. Override the cluster-level imagePullPolicy if present Optional: Defaults to cluster-level setting +optional type: string imagePullSecrets: description: |- ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images. +optional items: $ref: '#/definitions/v1.LocalObjectReference' type: array initContainers: description: |- Init containers of the components +optional items: $ref: '#/definitions/v1.Container' type: array labels: additionalProperties: type: string description: |- Labels for the component. Merge into the cluster-level labels if non-empty Optional: Defaults to cluster-level setting +optional type: object limits: $ref: '#/definitions/v1.ResourceList' description: |- Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ +optional maxFailoverCount: description: |- MaxFailoverCount limit the max replicas could be added in failover, 0 means no failover. Optional: Defaults to 3 +kubebuilder:validation:Minimum=0 +optional type: integer mountClusterClientSecret: description: |- MountClusterClientSecret indicates whether to mount `cluster-client-secret` to the Pod +optional type: boolean nodeSelector: additionalProperties: type: string description: |- NodeSelector of the component. Merged into the cluster-level nodeSelector if non-empty Optional: Defaults to cluster-level setting +optional type: object podSecurityContext: $ref: '#/definitions/v1.PodSecurityContext' description: |- PodSecurityContext of the component +optional priorityClassName: description: |- PriorityClassName of the component. Override the cluster-level one if present Optional: Defaults to cluster-level setting +optional type: string replicas: description: |- The desired ready replicas +kubebuilder:validation:Minimum=1 type: integer requests: $ref: '#/definitions/v1.ResourceList' 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/ +optional schedulerName: description: |- SchedulerName of the component. Override the cluster-level one if present Optional: Defaults to cluster-level setting +optional type: string service: $ref: '#/definitions/v1alpha1.ServiceSpec' description: |- Service defines a Kubernetes service of PD cluster. Optional: Defaults to `.spec.services` in favor of backward compatibility +optional serviceAccount: description: Specify a Service Account for pd type: string statefulSetUpdateStrategy: description: |- StatefulSetUpdateStrategy indicates the StatefulSetUpdateStrategy that will be employed to update Pods in the StatefulSet when a revision is made to Template. +optional type: string storageClassName: description: |- The storageClassName of the persistent volume for PD data storage. Defaults to Kubernetes default storage class. +optional type: string storageVolumes: description: |- StorageVolumes configure additional storage for PD pods. +optional items: $ref: '#/definitions/v1alpha1.StorageVolume' type: array terminationGracePeriodSeconds: description: |- Optional duration in seconds the pod needs to terminate gracefully. May be decreased in delete request. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period will be used instead. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. Defaults to 30 seconds. +optional type: integer tlsClientSecretName: description: |- TLSClientSecretName is the name of secret which stores tidb server client certificate which used by Dashboard. +optional type: string tolerations: description: |- Tolerations of the component. Override the cluster-level tolerations if non-empty Optional: Defaults to cluster-level setting +optional items: $ref: '#/definitions/v1.Toleration' type: array topologySpreadConstraints: description: |- TopologySpreadConstraints describes how a group of pods ought to spread across topology domains. Scheduler will schedule pods in a way which abides by the constraints. This field is is only honored by clusters that enables the EvenPodsSpread feature. All topologySpreadConstraints are ANDed. +optional +listType=map +listMapKey=topologyKey items: $ref: '#/definitions/v1alpha1.TopologySpreadConstraint' type: array version: description: |- Version of the component. Override the cluster-level version if non-empty Optional: Defaults to cluster-level setting +optional type: string type: object v1alpha1.PumpSpec: properties: additionalContainers: description: |- Additional containers of the component. +optional items: $ref: '#/definitions/v1.Container' type: array additionalVolumeMounts: description: Additional volume mounts of component pod. items: $ref: '#/definitions/v1.VolumeMount' type: array additionalVolumes: description: |- Additional volumes of component pod. +optional items: $ref: '#/definitions/v1.Volume' type: array affinity: $ref: '#/definitions/v1.Affinity' description: |- Affinity of the component. Override the cluster-level setting if present. Optional: Defaults to cluster-level setting +optional annotations: additionalProperties: type: string description: |- Annotations for the component. Merge into the cluster-level annotations if non-empty Optional: Defaults to cluster-level setting +optional type: object baseImage: description: |- Base image of the component, image tag is now allowed during validation +kubebuilder:default=pingcap/tidb-binlog +optional type: string config: $ref: '#/definitions/config.GenericConfig' description: |- The configuration of Pump cluster. +optional configUpdateStrategy: description: |- ConfigUpdateStrategy of the component. Override the cluster-level updateStrategy if present Optional: Defaults to cluster-level setting +optional type: string env: description: |- List of environment variables to set in the container, like v1.Container.Env. Note that the following env names cannot be used and will be overridden by TiDB Operator builtin envs - NAMESPACE - TZ - SERVICE_NAME - PEER_SERVICE_NAME - HEADLESS_SERVICE_NAME - SET_NAME - HOSTNAME - CLUSTER_NAME - POD_NAME - BINLOG_ENABLED - SLOW_LOG_FILE +optional items: $ref: '#/definitions/v1.EnvVar' type: array hostNetwork: description: |- Whether Hostnetwork of the component is enabled. Override the cluster-level setting if present Optional: Defaults to cluster-level setting +optional type: boolean image: description: |- (Deprecated) Image of the component Use `baseImage` and `version` instead +k8s:openapi-gen=false type: string imagePullPolicy: description: |- ImagePullPolicy of the component. Override the cluster-level imagePullPolicy if present Optional: Defaults to cluster-level setting +optional type: string imagePullSecrets: description: |- ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images. +optional items: $ref: '#/definitions/v1.LocalObjectReference' type: array initContainers: description: |- Init containers of the components +optional items: $ref: '#/definitions/v1.Container' type: array labels: additionalProperties: type: string description: |- Labels for the component. Merge into the cluster-level labels if non-empty Optional: Defaults to cluster-level setting +optional type: object limits: $ref: '#/definitions/v1.ResourceList' description: |- Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ +optional nodeSelector: additionalProperties: type: string description: |- NodeSelector of the component. Merged into the cluster-level nodeSelector if non-empty Optional: Defaults to cluster-level setting +optional type: object podSecurityContext: $ref: '#/definitions/v1.PodSecurityContext' description: |- PodSecurityContext of the component +optional priorityClassName: description: |- PriorityClassName of the component. Override the cluster-level one if present Optional: Defaults to cluster-level setting +optional type: string replicas: description: |- The desired ready replicas +kubebuilder:validation:Minimum=0 type: integer requests: $ref: '#/definitions/v1.ResourceList' 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/ +optional schedulerName: description: |- SchedulerName of the component. Override the cluster-level one if present Optional: Defaults to cluster-level setting +optional type: string serviceAccount: description: Specify a Service Account for pump type: string setTimeZone: description: |- +k8s:openapi-gen=false For backward compatibility with helm chart type: boolean statefulSetUpdateStrategy: description: |- StatefulSetUpdateStrategy indicates the StatefulSetUpdateStrategy that will be employed to update Pods in the StatefulSet when a revision is made to Template. +optional type: string storageClassName: description: |- The storageClassName of the persistent volume for Pump data storage. Defaults to Kubernetes default storage class. +optional type: string terminationGracePeriodSeconds: description: |- Optional duration in seconds the pod needs to terminate gracefully. May be decreased in delete request. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period will be used instead. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. Defaults to 30 seconds. +optional type: integer tolerations: description: |- Tolerations of the component. Override the cluster-level tolerations if non-empty Optional: Defaults to cluster-level setting +optional items: $ref: '#/definitions/v1.Toleration' type: array topologySpreadConstraints: description: |- TopologySpreadConstraints describes how a group of pods ought to spread across topology domains. Scheduler will schedule pods in a way which abides by the constraints. This field is is only honored by clusters that enables the EvenPodsSpread feature. All topologySpreadConstraints are ANDed. +optional +listType=map +listMapKey=topologyKey items: $ref: '#/definitions/v1alpha1.TopologySpreadConstraint' type: array version: description: |- Version of the component. Override the cluster-level version if non-empty Optional: Defaults to cluster-level setting +optional type: string type: object v1alpha1.Service: properties: name: type: string type: type: string type: object v1alpha1.ServiceSpec: properties: annotations: additionalProperties: type: string description: |- Additional annotations for the service +optional type: object clusterIP: description: |- ClusterIP is the clusterIP of service +optional type: string labels: additionalProperties: type: string description: |- Additional labels for the service +optional type: object loadBalancerIP: description: |- LoadBalancerIP is the loadBalancerIP of service Optional: Defaults to omitted +optional type: string loadBalancerSourceRanges: description: |- LoadBalancerSourceRanges is the loadBalancerSourceRanges of service If specified and supported by the platform, this will restrict traffic through the cloud-provider load-balancer will be restricted to the specified client IPs. This field will be ignored if the cloud-provider does not support the feature." More info: https://kubernetes.io/docs/concepts/services-networking/service/#aws-nlb-support Optional: Defaults to omitted +optional items: type: string type: array portName: description: |- PortName is the name of service port +optional type: string type: description: Type of the real kubernetes service type: string type: object v1alpha1.StorageClaim: properties: resources: $ref: '#/definitions/v1.ResourceRequirements' description: |- Resources represents the minimum resources the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources +optional storageClassName: description: |- Name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1 +optional type: string type: object v1alpha1.StorageVolume: properties: mountPath: type: string name: type: string storageClassName: type: string storageSize: type: string type: object v1alpha1.TLSCluster: properties: enabled: description: |- Enable mutual TLS connection between TiDB cluster components Once enabled, the mutual authentication applies to all components, and it does not support applying to only part of the components. The steps to enable this feature: 1. Generate TiDB cluster components certificates and a client-side certifiacete for them. There are multiple ways to generate these certificates: - user-provided certificates: https://pingcap.com/docs/stable/how-to/secure/generate-self-signed-certificates/ - use the K8s built-in certificate signing system signed certificates: https://kubernetes.io/docs/tasks/tls/managing-tls-in-a-cluster/ - or use cert-manager signed certificates: https://cert-manager.io/ 2. Create one secret object for one component which contains the certificates created above. The name of this Secret must be: --cluster-secret. For PD: kubectl create secret generic -pd-cluster-secret --namespace= --from-file=tls.crt= --from-file=tls.key= --from-file=ca.crt= For TiKV: kubectl create secret generic -tikv-cluster-secret --namespace= --from-file=tls.crt= --from-file=tls.key= --from-file=ca.crt= For TiDB: kubectl create secret generic -tidb-cluster-secret --namespace= --from-file=tls.crt= --from-file=tls.key= --from-file=ca.crt= For Client: kubectl create secret generic -cluster-client-secret --namespace= --from-file=tls.crt= --from-file=tls.key= --from-file=ca.crt= Same for other components. +optional type: boolean type: object v1alpha1.TiCDCSpec: properties: additionalContainers: description: |- Additional containers of the component. +optional items: $ref: '#/definitions/v1.Container' type: array additionalVolumeMounts: description: Additional volume mounts of component pod. items: $ref: '#/definitions/v1.VolumeMount' type: array additionalVolumes: description: |- Additional volumes of component pod. +optional items: $ref: '#/definitions/v1.Volume' type: array affinity: $ref: '#/definitions/v1.Affinity' description: |- Affinity of the component. Override the cluster-level setting if present. Optional: Defaults to cluster-level setting +optional annotations: additionalProperties: type: string description: |- Annotations for the component. Merge into the cluster-level annotations if non-empty Optional: Defaults to cluster-level setting +optional type: object baseImage: description: |- Base image of the component, image tag is now allowed during validation +kubebuilder:default=pingcap/ticdc +optional type: string config: $ref: '#/definitions/v1alpha1.CDCConfigWraper' description: |- Config is the Configuration of tidbcdc servers +optional configUpdateStrategy: description: |- ConfigUpdateStrategy of the component. Override the cluster-level updateStrategy if present Optional: Defaults to cluster-level setting +optional type: string env: description: |- List of environment variables to set in the container, like v1.Container.Env. Note that the following env names cannot be used and will be overridden by TiDB Operator builtin envs - NAMESPACE - TZ - SERVICE_NAME - PEER_SERVICE_NAME - HEADLESS_SERVICE_NAME - SET_NAME - HOSTNAME - CLUSTER_NAME - POD_NAME - BINLOG_ENABLED - SLOW_LOG_FILE +optional items: $ref: '#/definitions/v1.EnvVar' type: array hostNetwork: description: |- Whether Hostnetwork of the component is enabled. Override the cluster-level setting if present Optional: Defaults to cluster-level setting +optional type: boolean image: description: |- (Deprecated) Image of the component Use `baseImage` and `version` instead +k8s:openapi-gen=false type: string imagePullPolicy: description: |- ImagePullPolicy of the component. Override the cluster-level imagePullPolicy if present Optional: Defaults to cluster-level setting +optional type: string imagePullSecrets: description: |- ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images. +optional items: $ref: '#/definitions/v1.LocalObjectReference' type: array initContainers: description: |- Init containers of the components +optional items: $ref: '#/definitions/v1.Container' type: array labels: additionalProperties: type: string description: |- Labels for the component. Merge into the cluster-level labels if non-empty Optional: Defaults to cluster-level setting +optional type: object limits: $ref: '#/definitions/v1.ResourceList' description: |- Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ +optional nodeSelector: additionalProperties: type: string description: |- NodeSelector of the component. Merged into the cluster-level nodeSelector if non-empty Optional: Defaults to cluster-level setting +optional type: object podSecurityContext: $ref: '#/definitions/v1.PodSecurityContext' description: |- PodSecurityContext of the component +optional priorityClassName: description: |- PriorityClassName of the component. Override the cluster-level one if present Optional: Defaults to cluster-level setting +optional type: string replicas: description: |- The desired ready replicas +kubebuilder:validation:Minimum=1 type: integer requests: $ref: '#/definitions/v1.ResourceList' 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/ +optional schedulerName: description: |- SchedulerName of the component. Override the cluster-level one if present Optional: Defaults to cluster-level setting +optional type: string serviceAccount: description: Specify a Service Account for TiCDC type: string statefulSetUpdateStrategy: description: |- StatefulSetUpdateStrategy indicates the StatefulSetUpdateStrategy that will be employed to update Pods in the StatefulSet when a revision is made to Template. +optional type: string storageClassName: description: |- The storageClassName of the persistent volume for TiCDC data storage. Defaults to Kubernetes default storage class. +optional type: string storageVolumes: description: |- StorageVolumes configure additional storage for TiCDC pods. +optional items: $ref: '#/definitions/v1alpha1.StorageVolume' type: array terminationGracePeriodSeconds: description: |- Optional duration in seconds the pod needs to terminate gracefully. May be decreased in delete request. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period will be used instead. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. Defaults to 30 seconds. +optional type: integer tlsClientSecretNames: description: |- TLSClientSecretNames are the names of secrets that store the client certificates for the downstream. +optional items: type: string type: array tolerations: description: |- Tolerations of the component. Override the cluster-level tolerations if non-empty Optional: Defaults to cluster-level setting +optional items: $ref: '#/definitions/v1.Toleration' type: array topologySpreadConstraints: description: |- TopologySpreadConstraints describes how a group of pods ought to spread across topology domains. Scheduler will schedule pods in a way which abides by the constraints. This field is is only honored by clusters that enables the EvenPodsSpread feature. All topologySpreadConstraints are ANDed. +optional +listType=map +listMapKey=topologyKey items: $ref: '#/definitions/v1alpha1.TopologySpreadConstraint' type: array version: description: |- Version of the component. Override the cluster-level version if non-empty Optional: Defaults to cluster-level setting +optional type: string type: object v1alpha1.TiDBConfigWraper: properties: mp: additionalProperties: true description: |- Export this field to make "apiequality.Semantic.DeepEqual" happy now. User of GenericConfig should not directly access this field. type: object type: object v1alpha1.TiDBProbe: properties: type: description: |- "tcp" will use TCP socket to connetct port 4000 "command" will probe the status api of tidb. This will use curl command to request tidb, before v4.0.9 there is no curl in the image, So do not use this before v4.0.9. +kubebuilder:validation:Enum=tcp,command +optional type: string type: object v1alpha1.TiDBServiceSpec: properties: additionalPorts: description: |- Expose additional ports for TiDB Optional: Defaults to omitted +optional items: $ref: '#/definitions/v1.ServicePort' type: array annotations: additionalProperties: type: string description: |- Additional annotations for the service +optional type: object clusterIP: description: |- ClusterIP is the clusterIP of service +optional type: string exposeStatus: description: |- Whether expose the status port Optional: Defaults to true +optional type: boolean externalTrafficPolicy: description: |- ExternalTrafficPolicy of the service Optional: Defaults to omitted +optional type: string labels: additionalProperties: type: string description: |- Additional labels for the service +optional type: object loadBalancerIP: description: |- LoadBalancerIP is the loadBalancerIP of service Optional: Defaults to omitted +optional type: string loadBalancerSourceRanges: description: |- LoadBalancerSourceRanges is the loadBalancerSourceRanges of service If specified and supported by the platform, this will restrict traffic through the cloud-provider load-balancer will be restricted to the specified client IPs. This field will be ignored if the cloud-provider does not support the feature." More info: https://kubernetes.io/docs/concepts/services-networking/service/#aws-nlb-support Optional: Defaults to omitted +optional items: type: string type: array mysqlNodePort: description: |- Expose the tidb cluster mysql port to MySQLNodePort Optional: Defaults to 0 +optional type: integer portName: description: |- PortName is the name of service port +optional type: string statusNodePort: description: |- Expose the tidb status node port to StatusNodePort Optional: Defaults to 0 +optional type: integer type: description: Type of the real kubernetes service type: string type: object v1alpha1.TiDBSlowLogTailerSpec: properties: image: description: |- (Deprecated) Image used for slowlog tailer. Use `spec.helper.image` instead +k8s:openapi-gen=false type: string imagePullPolicy: description: |- (Deprecated) ImagePullPolicy of the component. Override the cluster-level imagePullPolicy if present Use `spec.helper.imagePullPolicy` instead +k8s:openapi-gen=false type: string limits: $ref: '#/definitions/v1.ResourceList' description: |- Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ +optional requests: $ref: '#/definitions/v1.ResourceList' 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/ +optional type: object v1alpha1.TiDBSpec: properties: additionalContainers: description: |- Additional containers of the component. +optional items: $ref: '#/definitions/v1.Container' type: array additionalVolumeMounts: description: Additional volume mounts of component pod. items: $ref: '#/definitions/v1.VolumeMount' type: array additionalVolumes: description: |- Additional volumes of component pod. +optional items: $ref: '#/definitions/v1.Volume' type: array affinity: $ref: '#/definitions/v1.Affinity' description: |- Affinity of the component. Override the cluster-level setting if present. Optional: Defaults to cluster-level setting +optional annotations: additionalProperties: type: string description: |- Annotations for the component. Merge into the cluster-level annotations if non-empty Optional: Defaults to cluster-level setting +optional type: object baseImage: description: |- Base image of the component, image tag is now allowed during validation +kubebuilder:default=pingcap/tidb +optional type: string binlogEnabled: description: |- Whether enable TiDB Binlog, it is encouraged to not set this field and rely on the default behavior Optional: Defaults to true if PumpSpec is non-nil, otherwise false +optional type: boolean config: $ref: '#/definitions/v1alpha1.TiDBConfigWraper' description: |- Config is the Configuration of tidb-servers +optional configUpdateStrategy: description: |- ConfigUpdateStrategy of the component. Override the cluster-level updateStrategy if present Optional: Defaults to cluster-level setting +optional type: string env: description: |- List of environment variables to set in the container, like v1.Container.Env. Note that the following env names cannot be used and will be overridden by TiDB Operator builtin envs - NAMESPACE - TZ - SERVICE_NAME - PEER_SERVICE_NAME - HEADLESS_SERVICE_NAME - SET_NAME - HOSTNAME - CLUSTER_NAME - POD_NAME - BINLOG_ENABLED - SLOW_LOG_FILE +optional items: $ref: '#/definitions/v1.EnvVar' type: array hostNetwork: description: |- Whether Hostnetwork of the component is enabled. Override the cluster-level setting if present Optional: Defaults to cluster-level setting +optional type: boolean image: description: |- (Deprecated) Image of the component Use `baseImage` and `version` instead +k8s:openapi-gen=false type: string imagePullPolicy: description: |- ImagePullPolicy of the component. Override the cluster-level imagePullPolicy if present Optional: Defaults to cluster-level setting +optional type: string imagePullSecrets: description: |- ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images. +optional items: $ref: '#/definitions/v1.LocalObjectReference' type: array initContainers: description: |- Init containers of the components +optional items: $ref: '#/definitions/v1.Container' type: array labels: additionalProperties: type: string description: |- Labels for the component. Merge into the cluster-level labels if non-empty Optional: Defaults to cluster-level setting +optional type: object lifecycle: $ref: '#/definitions/v1.Lifecycle' description: |- Lifecycle describes actions that the management system should take in response to container lifecycle events. For the PostStart and PreStop lifecycle handlers, management of the container blocks until the action is complete, unless the container process fails, in which case the handler is aborted. +optional limits: $ref: '#/definitions/v1.ResourceList' description: |- Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ +optional maxFailoverCount: description: |- MaxFailoverCount limit the max replicas could be added in failover, 0 means no failover Optional: Defaults to 3 +kubebuilder:validation:Minimum=0 +optional type: integer nodeSelector: additionalProperties: type: string description: |- NodeSelector of the component. Merged into the cluster-level nodeSelector if non-empty Optional: Defaults to cluster-level setting +optional type: object plugins: description: |- Plugins is a list of plugins that are loaded by TiDB server, empty means plugin disabled +optional items: type: string type: array podSecurityContext: $ref: '#/definitions/v1.PodSecurityContext' description: |- PodSecurityContext of the component +optional priorityClassName: description: |- PriorityClassName of the component. Override the cluster-level one if present Optional: Defaults to cluster-level setting +optional type: string readinessProbe: $ref: '#/definitions/v1alpha1.TiDBProbe' description: |- ReadinessProbe describes actions that probe the tidb's readiness. the default behavior is like setting type as "tcp" +optional replicas: description: |- The desired ready replicas +kubebuilder:validation:Minimum=0 type: integer requests: $ref: '#/definitions/v1.ResourceList' 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/ +optional schedulerName: description: |- SchedulerName of the component. Override the cluster-level one if present Optional: Defaults to cluster-level setting +optional type: string separateSlowLog: description: |- Whether output the slow log in an separate sidecar container Optional: Defaults to true +optional type: boolean service: $ref: '#/definitions/v1alpha1.TiDBServiceSpec' description: |- Service defines a Kubernetes service of TiDB cluster. Optional: No kubernetes service will be created by default. +optional serviceAccount: description: Specify a Service Account for tidb type: string slowLogTailer: $ref: '#/definitions/v1alpha1.TiDBSlowLogTailerSpec' description: |- The specification of the slow log tailer sidecar +optional slowLogVolumeName: description: |- Optional volume name configuration for slow query log. +optional type: string statefulSetUpdateStrategy: description: |- StatefulSetUpdateStrategy indicates the StatefulSetUpdateStrategy that will be employed to update Pods in the StatefulSet when a revision is made to Template. +optional type: string storageClassName: description: |- The storageClassName of the persistent volume for TiDB data storage. Defaults to Kubernetes default storage class. +optional type: string storageVolumes: description: |- StorageVolumes configure additional storage for TiDB pods. +optional items: $ref: '#/definitions/v1alpha1.StorageVolume' type: array terminationGracePeriodSeconds: description: |- Optional duration in seconds the pod needs to terminate gracefully. May be decreased in delete request. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period will be used instead. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. Defaults to 30 seconds. +optional type: integer tlsClient: $ref: '#/definitions/v1alpha1.TiDBTLSClient' description: |- Whether enable the TLS connection between the SQL client and TiDB server Optional: Defaults to nil +optional tolerations: description: |- Tolerations of the component. Override the cluster-level tolerations if non-empty Optional: Defaults to cluster-level setting +optional items: $ref: '#/definitions/v1.Toleration' type: array topologySpreadConstraints: description: |- TopologySpreadConstraints describes how a group of pods ought to spread across topology domains. Scheduler will schedule pods in a way which abides by the constraints. This field is is only honored by clusters that enables the EvenPodsSpread feature. All topologySpreadConstraints are ANDed. +optional +listType=map +listMapKey=topologyKey items: $ref: '#/definitions/v1alpha1.TopologySpreadConstraint' type: array version: description: |- Version of the component. Override the cluster-level version if non-empty Optional: Defaults to cluster-level setting +optional type: string type: object v1alpha1.TiDBTLSClient: properties: enabled: description: |- When enabled, TiDB will accept TLS encrypted connections from MySQL client The steps to enable this feature: 1. Generate a TiDB server-side certificate and a client-side certifiacete for the TiDB cluster. There are multiple ways to generate certificates: - user-provided certificates: https://pingcap.com/docs/stable/how-to/secure/enable-tls-clients/ - use the K8s built-in certificate signing system signed certificates: https://kubernetes.io/docs/tasks/tls/managing-tls-in-a-cluster/ - or use cert-manager signed certificates: https://cert-manager.io/ 2. Create a K8s Secret object which contains the TiDB server-side certificate created above. The name of this Secret must be: -tidb-server-secret. kubectl create secret generic -tidb-server-secret --namespace= --from-file=tls.crt= --from-file=tls.key= --from-file=ca.crt= 3. Create a K8s Secret object which contains the TiDB client-side certificate created above which will be used by TiDB Operator. The name of this Secret must be: -tidb-client-secret. kubectl create secret generic -tidb-client-secret --namespace= --from-file=tls.crt= --from-file=tls.key= --from-file=ca.crt= 4. Set Enabled to `true`. +optional type: boolean type: object v1alpha1.TiFlashCommonConfigWraper: properties: mp: additionalProperties: true description: |- Export this field to make "apiequality.Semantic.DeepEqual" happy now. User of GenericConfig should not directly access this field. type: object type: object v1alpha1.TiFlashConfigWraper: properties: config: $ref: '#/definitions/v1alpha1.TiFlashCommonConfigWraper' proxy: $ref: '#/definitions/v1alpha1.TiFlashProxyConfigWraper' type: object v1alpha1.TiFlashProxyConfigWraper: properties: mp: additionalProperties: true description: |- Export this field to make "apiequality.Semantic.DeepEqual" happy now. User of GenericConfig should not directly access this field. type: object type: object v1alpha1.TiFlashSpec: properties: additionalContainers: description: |- Additional containers of the component. +optional items: $ref: '#/definitions/v1.Container' type: array additionalVolumeMounts: description: Additional volume mounts of component pod. items: $ref: '#/definitions/v1.VolumeMount' type: array additionalVolumes: description: |- Additional volumes of component pod. +optional items: $ref: '#/definitions/v1.Volume' type: array affinity: $ref: '#/definitions/v1.Affinity' description: |- Affinity of the component. Override the cluster-level setting if present. Optional: Defaults to cluster-level setting +optional annotations: additionalProperties: type: string description: |- Annotations for the component. Merge into the cluster-level annotations if non-empty Optional: Defaults to cluster-level setting +optional type: object baseImage: description: |- Base image of the component, image tag is now allowed during validation +kubebuilder:default=pingcap/tiflash +optional type: string config: $ref: '#/definitions/v1alpha1.TiFlashConfigWraper' description: |- Config is the Configuration of TiFlash +optional configUpdateStrategy: description: |- ConfigUpdateStrategy of the component. Override the cluster-level updateStrategy if present Optional: Defaults to cluster-level setting +optional type: string env: description: |- List of environment variables to set in the container, like v1.Container.Env. Note that the following env names cannot be used and will be overridden by TiDB Operator builtin envs - NAMESPACE - TZ - SERVICE_NAME - PEER_SERVICE_NAME - HEADLESS_SERVICE_NAME - SET_NAME - HOSTNAME - CLUSTER_NAME - POD_NAME - BINLOG_ENABLED - SLOW_LOG_FILE +optional items: $ref: '#/definitions/v1.EnvVar' type: array hostNetwork: description: |- Whether Hostnetwork of the component is enabled. Override the cluster-level setting if present Optional: Defaults to cluster-level setting +optional type: boolean image: description: |- (Deprecated) Image of the component Use `baseImage` and `version` instead +k8s:openapi-gen=false type: string imagePullPolicy: description: |- ImagePullPolicy of the component. Override the cluster-level imagePullPolicy if present Optional: Defaults to cluster-level setting +optional type: string imagePullSecrets: description: |- ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images. +optional items: $ref: '#/definitions/v1.LocalObjectReference' type: array initContainers: description: |- Init containers of the components +optional items: $ref: '#/definitions/v1.Container' type: array labels: additionalProperties: type: string description: |- Labels for the component. Merge into the cluster-level labels if non-empty Optional: Defaults to cluster-level setting +optional type: object limits: $ref: '#/definitions/v1.ResourceList' description: |- Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ +optional logTailer: $ref: '#/definitions/v1alpha1.LogTailerSpec' description: |- LogTailer is the configurations of the log tailers for TiFlash +optional maxFailoverCount: description: |- MaxFailoverCount limit the max replicas could be added in failover, 0 means no failover Optional: Defaults to 3 +kubebuilder:validation:Minimum=0 +optional type: integer nodeSelector: additionalProperties: type: string description: |- NodeSelector of the component. Merged into the cluster-level nodeSelector if non-empty Optional: Defaults to cluster-level setting +optional type: object podSecurityContext: $ref: '#/definitions/v1.PodSecurityContext' description: |- PodSecurityContext of the component +optional priorityClassName: description: |- PriorityClassName of the component. Override the cluster-level one if present Optional: Defaults to cluster-level setting +optional type: string privileged: description: |- Whether create the TiFlash container in privileged mode, it is highly discouraged to enable this in critical environment. Optional: defaults to false +optional type: boolean recoverFailover: description: |- RecoverFailover indicates that Operator can recover the failover Pods +optional type: boolean replicas: description: |- The desired ready replicas +kubebuilder:validation:Minimum=1 type: integer requests: $ref: '#/definitions/v1.ResourceList' 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/ +optional schedulerName: description: |- SchedulerName of the component. Override the cluster-level one if present Optional: Defaults to cluster-level setting +optional type: string serviceAccount: description: Specify a Service Account for TiFlash type: string statefulSetUpdateStrategy: description: |- StatefulSetUpdateStrategy indicates the StatefulSetUpdateStrategy that will be employed to update Pods in the StatefulSet when a revision is made to Template. +optional type: string storageClaims: description: |- The persistent volume claims of the TiFlash data storages. TiFlash supports multiple disks. items: $ref: '#/definitions/v1alpha1.StorageClaim' type: array terminationGracePeriodSeconds: description: |- Optional duration in seconds the pod needs to terminate gracefully. May be decreased in delete request. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period will be used instead. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. Defaults to 30 seconds. +optional type: integer tolerations: description: |- Tolerations of the component. Override the cluster-level tolerations if non-empty Optional: Defaults to cluster-level setting +optional items: $ref: '#/definitions/v1.Toleration' type: array topologySpreadConstraints: description: |- TopologySpreadConstraints describes how a group of pods ought to spread across topology domains. Scheduler will schedule pods in a way which abides by the constraints. This field is is only honored by clusters that enables the EvenPodsSpread feature. All topologySpreadConstraints are ANDed. +optional +listType=map +listMapKey=topologyKey items: $ref: '#/definitions/v1alpha1.TopologySpreadConstraint' type: array version: description: |- Version of the component. Override the cluster-level version if non-empty Optional: Defaults to cluster-level setting +optional type: string type: object v1alpha1.TiKVConfigWraper: properties: mp: additionalProperties: true description: |- Export this field to make "apiequality.Semantic.DeepEqual" happy now. User of GenericConfig should not directly access this field. type: object type: object v1alpha1.TiKVSpec: properties: additionalContainers: description: |- Additional containers of the component. +optional items: $ref: '#/definitions/v1.Container' type: array additionalVolumeMounts: description: Additional volume mounts of component pod. items: $ref: '#/definitions/v1.VolumeMount' type: array additionalVolumes: description: |- Additional volumes of component pod. +optional items: $ref: '#/definitions/v1.Volume' type: array affinity: $ref: '#/definitions/v1.Affinity' description: |- Affinity of the component. Override the cluster-level setting if present. Optional: Defaults to cluster-level setting +optional annotations: additionalProperties: type: string description: |- Annotations for the component. Merge into the cluster-level annotations if non-empty Optional: Defaults to cluster-level setting +optional type: object baseImage: description: |- Base image of the component, image tag is now allowed during validation +kubebuilder:default=pingcap/tikv +optional type: string config: $ref: '#/definitions/v1alpha1.TiKVConfigWraper' description: |- Config is the Configuration of tikv-servers +optional configUpdateStrategy: description: |- ConfigUpdateStrategy of the component. Override the cluster-level updateStrategy if present Optional: Defaults to cluster-level setting +optional type: string dataSubDir: description: |- Subdirectory within the volume to store TiKV Data. By default, the data is stored in the root directory of volume which is mounted at /var/lib/tikv. Specifying this will change the data directory to a subdirectory, e.g. /var/lib/tikv/data if you set the value to "data". It's dangerous to change this value for a running cluster as it will upgrade your cluster to use a new storage directory. Defaults to "" (volume's root). +optional type: string enableNamedStatusPort: description: |- EnableNamedStatusPort enables status port(20180) in the Pod spec. If you set it to `true` for an existing cluster, the TiKV cluster will be rolling updated. type: boolean env: description: |- List of environment variables to set in the container, like v1.Container.Env. Note that the following env names cannot be used and will be overridden by TiDB Operator builtin envs - NAMESPACE - TZ - SERVICE_NAME - PEER_SERVICE_NAME - HEADLESS_SERVICE_NAME - SET_NAME - HOSTNAME - CLUSTER_NAME - POD_NAME - BINLOG_ENABLED - SLOW_LOG_FILE +optional items: $ref: '#/definitions/v1.EnvVar' type: array evictLeaderTimeout: description: |- EvictLeaderTimeout indicates the timeout to evict tikv leader, in the format of Go Duration. Defaults to 10m +optional type: string hostNetwork: description: |- Whether Hostnetwork of the component is enabled. Override the cluster-level setting if present Optional: Defaults to cluster-level setting +optional type: boolean image: description: |- (Deprecated) Image of the component Use `baseImage` and `version` instead +k8s:openapi-gen=false type: string imagePullPolicy: description: |- ImagePullPolicy of the component. Override the cluster-level imagePullPolicy if present Optional: Defaults to cluster-level setting +optional type: string imagePullSecrets: description: |- ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images. +optional items: $ref: '#/definitions/v1.LocalObjectReference' type: array initContainers: description: |- Init containers of the components +optional items: $ref: '#/definitions/v1.Container' type: array labels: additionalProperties: type: string description: |- Labels for the component. Merge into the cluster-level labels if non-empty Optional: Defaults to cluster-level setting +optional type: object limits: $ref: '#/definitions/v1.ResourceList' description: |- Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ +optional logTailer: $ref: '#/definitions/v1alpha1.LogTailerSpec' description: |- LogTailer is the configurations of the log tailers for TiKV +optional maxFailoverCount: description: |- MaxFailoverCount limit the max replicas could be added in failover, 0 means no failover Optional: Defaults to 3 +kubebuilder:validation:Minimum=0 +optional type: integer mountClusterClientSecret: description: |- MountClusterClientSecret indicates whether to mount `cluster-client-secret` to the Pod +optional type: boolean nodeSelector: additionalProperties: type: string description: |- NodeSelector of the component. Merged into the cluster-level nodeSelector if non-empty Optional: Defaults to cluster-level setting +optional type: object podSecurityContext: $ref: '#/definitions/v1.PodSecurityContext' description: |- PodSecurityContext of the component +optional priorityClassName: description: |- PriorityClassName of the component. Override the cluster-level one if present Optional: Defaults to cluster-level setting +optional type: string privileged: description: |- Whether create the TiKV container in privileged mode, it is highly discouraged to enable this in critical environment. Optional: defaults to false +optional type: boolean recoverFailover: description: |- RecoverFailover indicates that Operator can recover the failed Pods +optional type: boolean replicas: description: |- The desired ready replicas +kubebuilder:validation:Minimum=1 type: integer requests: $ref: '#/definitions/v1.ResourceList' 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/ +optional schedulerName: description: |- SchedulerName of the component. Override the cluster-level one if present Optional: Defaults to cluster-level setting +optional type: string separateRaftLog: description: |- Whether output the Raft log in a separate sidecar container Optional: Defaults to false +optional type: boolean separateRocksDBLog: description: |- Whether output the RocksDB log in a separate sidecar container Optional: Defaults to false +optional type: boolean serviceAccount: description: Specify a Service Account for tikv type: string statefulSetUpdateStrategy: description: |- StatefulSetUpdateStrategy indicates the StatefulSetUpdateStrategy that will be employed to update Pods in the StatefulSet when a revision is made to Template. +optional type: string storageClassName: description: |- The storageClassName of the persistent volume for TiKV data storage. Defaults to Kubernetes default storage class. +optional type: string storageVolumes: description: |- StorageVolumes configure additional storage for TiKV pods. +optional items: $ref: '#/definitions/v1alpha1.StorageVolume' type: array storeLabels: description: |- StoreLabels configures additional labels for TiKV stores. +optional items: type: string type: array terminationGracePeriodSeconds: description: |- Optional duration in seconds the pod needs to terminate gracefully. May be decreased in delete request. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period will be used instead. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. Defaults to 30 seconds. +optional type: integer tolerations: description: |- Tolerations of the component. Override the cluster-level tolerations if non-empty Optional: Defaults to cluster-level setting +optional items: $ref: '#/definitions/v1.Toleration' type: array topologySpreadConstraints: description: |- TopologySpreadConstraints describes how a group of pods ought to spread across topology domains. Scheduler will schedule pods in a way which abides by the constraints. This field is is only honored by clusters that enables the EvenPodsSpread feature. All topologySpreadConstraints are ANDed. +optional +listType=map +listMapKey=topologyKey items: $ref: '#/definitions/v1alpha1.TopologySpreadConstraint' type: array version: description: |- Version of the component. Override the cluster-level version if non-empty Optional: Defaults to cluster-level setting +optional type: string type: object v1alpha1.TidbClusterRef: properties: clusterDomain: description: |- ClusterDomain is the domain of TidbCluster object +optional type: string name: description: Name is the name of TidbCluster object type: string namespace: description: |- Namespace is the namespace that TidbCluster object locates, default to the same namespace with TidbMonitor +optional type: string type: object v1alpha1.TidbClusterSpec: properties: affinity: $ref: '#/definitions/v1.Affinity' description: |- Affinity of TiDB cluster Pods. Will be overwritten by each cluster component's specific affinity setting, e.g. `spec.tidb.affinity` +optional annotations: additionalProperties: type: string description: |- Base annotations for TiDB cluster, all Pods in the cluster should have these annotations. Can be overrode by annotations in the specific component spec. +optional type: object cluster: $ref: '#/definitions/v1alpha1.TidbClusterRef' description: |- Cluster is the external cluster, if configured, the components in this TidbCluster will join to this configured cluster. +optional clusterDomain: description: |- ClusterDomain is the Kubernetes Cluster Domain of TiDB cluster Optional: Defaults to "" +optional type: string configUpdateStrategy: description: |- ConfigUpdateStrategy determines how the configuration change is applied to the cluster. UpdateStrategyInPlace will update the ConfigMap of configuration in-place and an extra rolling-update of the cluster component is needed to reload the configuration change. UpdateStrategyRollingUpdate will create a new ConfigMap with the new configuration and rolling-update the related components to use the new ConfigMap, that is, the new configuration will be applied automatically. +kubebuilder:validation:Enum=InPlace,RollingUpdate +kubebuilder:default=InPlacne type: string discovery: $ref: '#/definitions/v1alpha1.DiscoverySpec' description: Discovery spec enableDynamicConfiguration: description: |- EnableDynamicConfiguration indicates whether to append `--advertise-status-addr` to the startup parameters of TiKV. +optional type: boolean enablePVReclaim: description: |- Whether enable PVC reclaim for orphan PVC left by statefulset scale-in Optional: Defaults to false +optional type: boolean helper: $ref: '#/definitions/v1alpha1.HelperSpec' description: |- Helper spec +optional hostNetwork: description: |- Whether Hostnetwork is enabled for TiDB cluster Pods Optional: Defaults to false +optional type: boolean imagePullPolicy: description: |- ImagePullPolicy of TiDB cluster Pods +kubebuilder:default=IfNotPresent type: string imagePullSecrets: description: |- ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images. +optional items: $ref: '#/definitions/v1.LocalObjectReference' type: array labels: additionalProperties: type: string description: |- Base labels for TiDB cluster, all Pods in the cluster should have these labels. Can be overrode by labels in the specific component spec. +optional type: object nodeSelector: additionalProperties: type: string description: |- Base node selectors of TiDB cluster Pods, components may add or override selectors upon this respectively +optional type: object paused: description: |- Indicates that the tidb cluster is paused and will not be processed by the controller. +optional type: boolean pd: $ref: '#/definitions/v1alpha1.PDSpec' description: |- PD cluster spec +optional pdAddresses: description: |- PDAddresses are the external PD addresses, if configured, the PDs in this TidbCluster will join to the configured PD cluster. +optional items: type: string type: array podSecurityContext: $ref: '#/definitions/v1.PodSecurityContext' description: |- PodSecurityContext of the component +optional priorityClassName: description: |- PriorityClassName of TiDB cluster Pods Optional: Defaults to omitted +optional type: string pump: $ref: '#/definitions/v1alpha1.PumpSpec' description: |- Pump cluster spec +optional pvReclaimPolicy: description: |- Persistent volume reclaim policy applied to the PVs that consumed by TiDB cluster +kubebuilder:default=Retain type: string schedulerName: description: |- SchedulerName of TiDB cluster Pods +kubebuilder:default=tidb-scheduler type: string serviceAccount: description: Specify a Service Account type: string services: description: |- (Deprecated) Services list non-headless services type used in TidbCluster +k8s:openapi-gen=false items: $ref: '#/definitions/v1alpha1.Service' type: array statefulSetUpdateStrategy: description: |- StatefulSetUpdateStrategy of TiDB cluster StatefulSets +optional type: string ticdc: $ref: '#/definitions/v1alpha1.TiCDCSpec' description: |- TiCDC cluster spec +optional tidb: $ref: '#/definitions/v1alpha1.TiDBSpec' description: |- TiDB cluster spec +optional tiflash: $ref: '#/definitions/v1alpha1.TiFlashSpec' description: |- TiFlash cluster spec +optional tikv: $ref: '#/definitions/v1alpha1.TiKVSpec' description: |- TiKV cluster spec +optional timezone: description: |- Time zone of TiDB cluster Pods Optional: Defaults to UTC +optional type: string tlsCluster: $ref: '#/definitions/v1alpha1.TLSCluster' description: |- Whether enable the TLS connection between TiDB server components Optional: Defaults to nil +optional tolerations: description: |- Base tolerations of TiDB cluster Pods, components may add more tolerations upon this respectively +optional items: $ref: '#/definitions/v1.Toleration' type: array topologySpreadConstraints: description: |- TopologySpreadConstraints describes how a group of pods ought to spread across topology domains. Scheduler will schedule pods in a way which abides by the constraints. This field is is only honored by clusters that enables the EvenPodsSpread feature. All topologySpreadConstraints are ANDed. +optional +listType=map +listMapKey=topologyKey items: $ref: '#/definitions/v1alpha1.TopologySpreadConstraint' type: array version: description: |- TiDB cluster version +optional type: string type: object v1alpha1.TopologySpreadConstraint: properties: topologyKey: description: |- TopologyKey is the key of node labels. Nodes that have a label with this key and identical values are considered to be in the same topology. We consider each as a "bucket", and try to put balanced number of pods into each bucket. MaxSkew is default set to 1 WhenUnsatisfiable is default set to DoNotSchedule LabelSelector is generated by component type See pkg/apis/pingcap/v1alpha1/tidbcluster_component.go#TopologySpreadConstraints() type: string type: object info: contact: {} title: tc-validator API version: "1.0" paths: /credential/: post: consumes: - application/json parameters: - description: tidbClusterSpec in: body name: resource required: true schema: $ref: '#/definitions/v1alpha1.TidbClusterSpec' produces: - application/json responses: "200": description: OK schema: type: string "400": description: Bad Request schema: $ref: '#/definitions/errors.StatusError' summary: validate tidb-cluster specification tags: - validate swagger: "2.0"