{ "swagger": "2.0", "info": { "title": "tc-validator API", "contact": {}, "version": "1.0" }, "basePath": "/api/v1", "paths": { "/credential/": { "post": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "validate" ], "summary": "validate tidb-cluster specification", "parameters": [ { "description": "tidbClusterSpec", "name": "resource", "in": "body", "required": true, "schema": { "$ref": "#/definitions/v1alpha1.TidbClusterSpec" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/errors.StatusError" } } } } } }, "definitions": { "config.GenericConfig": { "type": "object", "properties": { "mp": { "description": "Export this field to make \"apiequality.Semantic.DeepEqual\" happy now.\nUser of GenericConfig should not directly access this field.", "type": "object", "additionalProperties": true } } }, "errors.StatusError": { "type": "object", "properties": { "errStatus": { "$ref": "#/definitions/v1.Status" } } }, "intstr.IntOrString": { "type": "object", "properties": { "intVal": { "type": "integer" }, "strVal": { "type": "string" }, "type": { "type": "integer" } } }, "resource.Quantity": { "type": "object", "properties": { "Format": { "type": "string" } } }, "v1.AWSElasticBlockStoreVolumeSource": { "type": "object", "properties": { "fsType": { "description": "Filesystem type of the volume that you want to mount.\nTip: Ensure that the filesystem type is supported by the host operating system.\nExamples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore\nTODO: how do we prevent errors in the filesystem from compromising the machine\n+optional", "type": "string" }, "partition": { "description": "The partition in the volume that you want to mount.\nIf omitted, the default is to mount by volume name.\nExamples: For volume /dev/sda1, you specify the partition as \"1\".\nSimilarly, the volume partition for /dev/sda is \"0\" (or you can leave the property empty).\n+optional", "type": "integer" }, "readOnly": { "description": "Specify \"true\" to force and set the ReadOnly property in VolumeMounts to \"true\".\nIf omitted, the default is \"false\".\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore\n+optional", "type": "boolean" }, "volumeID": { "description": "Unique ID of the persistent disk resource in AWS (Amazon EBS volume).\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore", "type": "string" } } }, "v1.Affinity": { "type": "object", "properties": { "nodeAffinity": { "description": "Describes node affinity scheduling rules for the pod.\n+optional", "$ref": "#/definitions/v1.NodeAffinity" }, "podAffinity": { "description": "Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).\n+optional", "$ref": "#/definitions/v1.PodAffinity" }, "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)).\n+optional", "$ref": "#/definitions/v1.PodAntiAffinity" } } }, "v1.AzureDiskVolumeSource": { "type": "object", "properties": { "cachingMode": { "description": "Host Caching mode: None, Read Only, Read Write.\n+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.\nMust be a filesystem type supported by the host operating system.\nEx. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.\n+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\nthe ReadOnly setting in VolumeMounts.\n+optional", "type": "boolean" } } }, "v1.AzureFileVolumeSource": { "type": "object", "properties": { "readOnly": { "description": "Defaults to false (read/write). ReadOnly here will force\nthe ReadOnly setting in VolumeMounts.\n+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" } } }, "v1.CSIVolumeSource": { "type": "object", "properties": { "driver": { "description": "Driver is the name of the CSI driver that handles this volume.\nConsult with your admin for the correct name as registered in the cluster.", "type": "string" }, "fsType": { "description": "Filesystem type to mount. Ex. \"ext4\", \"xfs\", \"ntfs\".\nIf not provided, the empty value is passed to the associated CSI driver\nwhich will determine the default filesystem to apply.\n+optional", "type": "string" }, "nodePublishSecretRef": { "description": "NodePublishSecretRef is a reference to the secret object containing\nsensitive information to pass to the CSI driver to complete the CSI\nNodePublishVolume and NodeUnpublishVolume calls.\nThis field is optional, and may be empty if no secret is required. If the\nsecret object contains more than one secret, all secret references are passed.\n+optional", "$ref": "#/definitions/v1.LocalObjectReference" }, "readOnly": { "description": "Specifies a read-only configuration for the volume.\nDefaults to false (read/write).\n+optional", "type": "boolean" }, "volumeAttributes": { "description": "VolumeAttributes stores driver-specific properties that are passed to the CSI\ndriver. Consult your driver's documentation for supported values.\n+optional", "type": "object", "additionalProperties": { "type": "string" } } } }, "v1.Capabilities": { "type": "object", "properties": { "add": { "description": "Added capabilities\n+optional", "type": "array", "items": { "type": "string" } }, "drop": { "description": "Removed capabilities\n+optional", "type": "array", "items": { "type": "string" } } } }, "v1.CephFSVolumeSource": { "type": "object", "properties": { "monitors": { "description": "Required: Monitors is a collection of Ceph monitors\nMore info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it", "type": "array", "items": { "type": "string" } }, "path": { "description": "Optional: Used as the mounted root, rather than the full Ceph tree, default is /\n+optional", "type": "string" }, "readOnly": { "description": "Optional: Defaults to false (read/write). ReadOnly here will force\nthe ReadOnly setting in VolumeMounts.\nMore info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it\n+optional", "type": "boolean" }, "secretFile": { "description": "Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret\nMore info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it\n+optional", "type": "string" }, "secretRef": { "description": "Optional: SecretRef is reference to the authentication secret for User, default is empty.\nMore info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it\n+optional", "$ref": "#/definitions/v1.LocalObjectReference" }, "user": { "description": "Optional: User is the rados user name, default is admin\nMore info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it\n+optional", "type": "string" } } }, "v1.CinderVolumeSource": { "type": "object", "properties": { "fsType": { "description": "Filesystem type to mount.\nMust be a filesystem type supported by the host operating system.\nExamples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.\nMore info: https://examples.k8s.io/mysql-cinder-pd/README.md\n+optional", "type": "string" }, "readOnly": { "description": "Optional: Defaults to false (read/write). ReadOnly here will force\nthe ReadOnly setting in VolumeMounts.\nMore info: https://examples.k8s.io/mysql-cinder-pd/README.md\n+optional", "type": "boolean" }, "secretRef": { "description": "Optional: points to a secret object containing parameters used to connect\nto OpenStack.\n+optional", "$ref": "#/definitions/v1.LocalObjectReference" }, "volumeID": { "description": "volume id used to identify the volume in cinder.\nMore info: https://examples.k8s.io/mysql-cinder-pd/README.md", "type": "string" } } }, "v1.ConfigMapEnvSource": { "type": "object", "properties": { "name": { "description": "Name of the referent.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Add other useful fields. apiVersion, kind, uid?\n+optional", "type": "string" }, "optional": { "description": "Specify whether the ConfigMap must be defined\n+optional", "type": "boolean" } } }, "v1.ConfigMapKeySelector": { "type": "object", "properties": { "key": { "description": "The key to select.", "type": "string" }, "name": { "description": "Name of the referent.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Add other useful fields. apiVersion, kind, uid?\n+optional", "type": "string" }, "optional": { "description": "Specify whether the ConfigMap or its key must be defined\n+optional", "type": "boolean" } } }, "v1.ConfigMapProjection": { "type": "object", "properties": { "items": { "description": "If unspecified, each key-value pair in the Data field of the referenced\nConfigMap will be projected into the volume as a file whose name is the\nkey and content is the value. If specified, the listed keys will be\nprojected into the specified paths, and unlisted keys will not be\npresent. If a key is specified which is not present in the ConfigMap,\nthe volume setup will error unless it is marked optional. Paths must be\nrelative and may not contain the '..' path or start with '..'.\n+optional", "type": "array", "items": { "$ref": "#/definitions/v1.KeyToPath" } }, "name": { "description": "Name of the referent.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Add other useful fields. apiVersion, kind, uid?\n+optional", "type": "string" }, "optional": { "description": "Specify whether the ConfigMap or its keys must be defined\n+optional", "type": "boolean" } } }, "v1.ConfigMapVolumeSource": { "type": "object", "properties": { "defaultMode": { "description": "Optional: mode bits to use on created files by default. Must be a\nvalue between 0 and 0777. Defaults to 0644.\nDirectories within the path are not affected by this setting.\nThis might be in conflict with other options that affect the file\nmode, like fsGroup, and the result can be other mode bits set.\n+optional", "type": "integer" }, "items": { "description": "If unspecified, each key-value pair in the Data field of the referenced\nConfigMap will be projected into the volume as a file whose name is the\nkey and content is the value. If specified, the listed keys will be\nprojected into the specified paths, and unlisted keys will not be\npresent. If a key is specified which is not present in the ConfigMap,\nthe volume setup will error unless it is marked optional. Paths must be\nrelative and may not contain the '..' path or start with '..'.\n+optional", "type": "array", "items": { "$ref": "#/definitions/v1.KeyToPath" } }, "name": { "description": "Name of the referent.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Add other useful fields. apiVersion, kind, uid?\n+optional", "type": "string" }, "optional": { "description": "Specify whether the ConfigMap or its keys must be defined\n+optional", "type": "boolean" } } }, "v1.Container": { "type": "object", "properties": { "args": { "description": "Arguments to the entrypoint.\nThe docker image's CMD is used if this is not provided.\nVariable references $(VAR_NAME) are expanded using the container's environment. If a variable\ncannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax\ncan be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded,\nregardless of whether the variable exists or not.\nCannot be updated.\nMore info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell\n+optional", "type": "array", "items": { "type": "string" } }, "command": { "description": "Entrypoint array. Not executed within a shell.\nThe docker image's ENTRYPOINT is used if this is not provided.\nVariable references $(VAR_NAME) are expanded using the container's environment. If a variable\ncannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax\ncan be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded,\nregardless of whether the variable exists or not.\nCannot be updated.\nMore info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell\n+optional", "type": "array", "items": { "type": "string" } }, "env": { "description": "List of environment variables to set in the container.\nCannot be updated.\n+optional\n+patchMergeKey=name\n+patchStrategy=merge", "type": "array", "items": { "$ref": "#/definitions/v1.EnvVar" } }, "envFrom": { "description": "List of sources to populate environment variables in the container.\nThe keys defined within a source must be a C_IDENTIFIER. All invalid keys\nwill be reported as an event when the container is starting. When a key exists in multiple\nsources, the value associated with the last source will take precedence.\nValues defined by an Env with a duplicate key will take precedence.\nCannot be updated.\n+optional", "type": "array", "items": { "$ref": "#/definitions/v1.EnvFromSource" } }, "image": { "description": "Docker image name.\nMore info: https://kubernetes.io/docs/concepts/containers/images\nThis field is optional to allow higher level config management to default or override\ncontainer images in workload controllers like Deployments and StatefulSets.\n+optional", "type": "string" }, "imagePullPolicy": { "description": "Image pull policy.\nOne of Always, Never, IfNotPresent.\nDefaults to Always if :latest tag is specified, or IfNotPresent otherwise.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/containers/images#updating-images\n+optional", "type": "string" }, "lifecycle": { "description": "Actions that the management system should take in response to container lifecycle events.\nCannot be updated.\n+optional", "$ref": "#/definitions/v1.Lifecycle" }, "livenessProbe": { "description": "Periodic probe of container liveness.\nContainer will be restarted if the probe fails.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes\n+optional", "$ref": "#/definitions/v1.Probe" }, "name": { "description": "Name of the container specified as a DNS_LABEL.\nEach container in a pod must have a unique name (DNS_LABEL).\nCannot be updated.", "type": "string" }, "ports": { "description": "List of ports to expose from the container. Exposing a port here gives\nthe system additional information about the network connections a\ncontainer uses, but is primarily informational. Not specifying a port here\nDOES NOT prevent that port from being exposed. Any port which is\nlistening on the default \"0.0.0.0\" address inside a container will be\naccessible from the network.\nCannot be updated.\n+optional\n+patchMergeKey=containerPort\n+patchStrategy=merge\n+listType=map\n+listMapKey=containerPort\n+listMapKey=protocol", "type": "array", "items": { "$ref": "#/definitions/v1.ContainerPort" } }, "readinessProbe": { "description": "Periodic probe of container service readiness.\nContainer will be removed from service endpoints if the probe fails.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes\n+optional", "$ref": "#/definitions/v1.Probe" }, "resources": { "description": "Compute Resources required by this container.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/\n+optional", "$ref": "#/definitions/v1.ResourceRequirements" }, "securityContext": { "description": "Security options the pod should run with.\nMore info: https://kubernetes.io/docs/concepts/policy/security-context/\nMore info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/\n+optional", "$ref": "#/definitions/v1.SecurityContext" }, "startupProbe": { "description": "StartupProbe indicates that the Pod has successfully initialized.\nIf specified, no other probes are executed until this completes successfully.\nIf this probe fails, the Pod will be restarted, just as if the livenessProbe failed.\nThis can be used to provide different probe parameters at the beginning of a Pod's lifecycle,\nwhen it might take a long time to load data or warm a cache, than during steady-state operation.\nThis cannot be updated.\nThis is an alpha feature enabled by the StartupProbe feature flag.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes\n+optional", "$ref": "#/definitions/v1.Probe" }, "stdin": { "description": "Whether this container should allocate a buffer for stdin in the container runtime. If this\nis not set, reads from stdin in the container will always result in EOF.\nDefault is false.\n+optional", "type": "boolean" }, "stdinOnce": { "description": "Whether the container runtime should close the stdin channel after it has been opened by\na single attach. When stdin is true the stdin stream will remain open across multiple attach\nsessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the\nfirst client attaches to stdin, and then remains open and accepts data until the client disconnects,\nat which time stdin is closed and remains closed until the container is restarted. If this\nflag is false, a container processes that reads from stdin will never receive an EOF.\nDefault is false\n+optional", "type": "boolean" }, "terminationMessagePath": { "description": "Optional: Path at which the file to which the container's termination message\nwill be written is mounted into the container's filesystem.\nMessage written is intended to be brief final status, such as an assertion failure message.\nWill be truncated by the node if greater than 4096 bytes. The total message length across\nall containers will be limited to 12kb.\nDefaults to /dev/termination-log.\nCannot be updated.\n+optional", "type": "string" }, "terminationMessagePolicy": { "description": "Indicate how the termination message should be populated. File will use the contents of\nterminationMessagePath to populate the container status message on both success and failure.\nFallbackToLogsOnError will use the last chunk of container log output if the termination\nmessage file is empty and the container exited with an error.\nThe log output is limited to 2048 bytes or 80 lines, whichever is smaller.\nDefaults to File.\nCannot be updated.\n+optional", "type": "string" }, "tty": { "description": "Whether this container should allocate a TTY for itself, also requires 'stdin' to be true.\nDefault is false.\n+optional", "type": "boolean" }, "volumeDevices": { "description": "volumeDevices is the list of block devices to be used by the container.\nThis is a beta feature.\n+patchMergeKey=devicePath\n+patchStrategy=merge\n+optional", "type": "array", "items": { "$ref": "#/definitions/v1.VolumeDevice" } }, "volumeMounts": { "description": "Pod volumes to mount into the container's filesystem.\nCannot be updated.\n+optional\n+patchMergeKey=mountPath\n+patchStrategy=merge", "type": "array", "items": { "$ref": "#/definitions/v1.VolumeMount" } }, "workingDir": { "description": "Container's working directory.\nIf not specified, the container runtime's default will be used, which\nmight be configured in the container image.\nCannot be updated.\n+optional", "type": "string" } } }, "v1.ContainerPort": { "type": "object", "properties": { "containerPort": { "description": "Number of port to expose on the pod's IP address.\nThis must be a valid port number, 0 \u003c x \u003c 65536.", "type": "integer" }, "hostIP": { "description": "What host IP to bind the external port to.\n+optional", "type": "string" }, "hostPort": { "description": "Number of port to expose on the host.\nIf specified, this must be a valid port number, 0 \u003c x \u003c 65536.\nIf HostNetwork is specified, this must match ContainerPort.\nMost containers do not need this.\n+optional", "type": "integer" }, "name": { "description": "If specified, this must be an IANA_SVC_NAME and unique within the pod. Each\nnamed port in a pod must have a unique name. Name for the port that can be\nreferred to by services.\n+optional", "type": "string" }, "protocol": { "description": "Protocol for port. Must be UDP, TCP, or SCTP.\nDefaults to \"TCP\".\n+optional", "type": "string" } } }, "v1.DownwardAPIProjection": { "type": "object", "properties": { "items": { "description": "Items is a list of DownwardAPIVolume file\n+optional", "type": "array", "items": { "$ref": "#/definitions/v1.DownwardAPIVolumeFile" } } } }, "v1.DownwardAPIVolumeFile": { "type": "object", "properties": { "fieldRef": { "description": "Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.\n+optional", "$ref": "#/definitions/v1.ObjectFieldSelector" }, "mode": { "description": "Optional: mode bits to use on this file, must be a value between 0\nand 0777. If not specified, the volume defaultMode will be used.\nThis might be in conflict with other options that affect the file\nmode, like fsGroup, and the result can be other mode bits set.\n+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": { "description": "Selects a resource of the container: only resources limits and requests\n(limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.\n+optional", "$ref": "#/definitions/v1.ResourceFieldSelector" } } }, "v1.DownwardAPIVolumeSource": { "type": "object", "properties": { "defaultMode": { "description": "Optional: mode bits to use on created files by default. Must be a\nvalue between 0 and 0777. Defaults to 0644.\nDirectories within the path are not affected by this setting.\nThis might be in conflict with other options that affect the file\nmode, like fsGroup, and the result can be other mode bits set.\n+optional", "type": "integer" }, "items": { "description": "Items is a list of downward API volume file\n+optional", "type": "array", "items": { "$ref": "#/definitions/v1.DownwardAPIVolumeFile" } } } }, "v1.EmptyDirVolumeSource": { "type": "object", "properties": { "medium": { "description": "What type of storage medium should back this directory.\nThe default is \"\" which means to use the node's default medium.\nMust be an empty string (default) or Memory.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir\n+optional", "type": "string" }, "sizeLimit": { "description": "Total amount of local storage required for this EmptyDir volume.\nThe size limit is also applicable for memory medium.\nThe maximum usage on memory medium EmptyDir would be the minimum value between\nthe SizeLimit specified here and the sum of memory limits of all containers in a pod.\nThe default is nil which means that the limit is undefined.\nMore info: http://kubernetes.io/docs/user-guide/volumes#emptydir\n+optional", "$ref": "#/definitions/resource.Quantity" } } }, "v1.EnvFromSource": { "type": "object", "properties": { "configMapRef": { "description": "The ConfigMap to select from\n+optional", "$ref": "#/definitions/v1.ConfigMapEnvSource" }, "prefix": { "description": "An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.\n+optional", "type": "string" }, "secretRef": { "description": "The Secret to select from\n+optional", "$ref": "#/definitions/v1.SecretEnvSource" } } }, "v1.EnvVar": { "type": "object", "properties": { "name": { "description": "Name of the environment variable. Must be a C_IDENTIFIER.", "type": "string" }, "value": { "description": "Variable references $(VAR_NAME) are expanded\nusing the previous defined environment variables in the container and\nany service environment variables. If a variable cannot be resolved,\nthe reference in the input string will be unchanged. The $(VAR_NAME)\nsyntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped\nreferences will never be expanded, regardless of whether the variable\nexists or not.\nDefaults to \"\".\n+optional", "type": "string" }, "valueFrom": { "description": "Source for the environment variable's value. Cannot be used if value is not empty.\n+optional", "$ref": "#/definitions/v1.EnvVarSource" } } }, "v1.EnvVarSource": { "type": "object", "properties": { "configMapKeyRef": { "description": "Selects a key of a ConfigMap.\n+optional", "$ref": "#/definitions/v1.ConfigMapKeySelector" }, "fieldRef": { "description": "Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels, metadata.annotations,\nspec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP.\n+optional", "$ref": "#/definitions/v1.ObjectFieldSelector" }, "resourceFieldRef": { "description": "Selects a resource of the container: only resources limits and requests\n(limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.\n+optional", "$ref": "#/definitions/v1.ResourceFieldSelector" }, "secretKeyRef": { "description": "Selects a key of a secret in the pod's namespace\n+optional", "$ref": "#/definitions/v1.SecretKeySelector" } } }, "v1.ExecAction": { "type": "object", "properties": { "command": { "description": "Command is the command line to execute inside the container, the working directory for the\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\na shell, you need to explicitly call out to that shell.\nExit status of 0 is treated as live/healthy and non-zero is unhealthy.\n+optional", "type": "array", "items": { "type": "string" } } } }, "v1.FCVolumeSource": { "type": "object", "properties": { "fsType": { "description": "Filesystem type to mount.\nMust be a filesystem type supported by the host operating system.\nEx. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.\nTODO: how do we prevent errors in the filesystem from compromising the machine\n+optional", "type": "string" }, "lun": { "description": "Optional: FC target lun number\n+optional", "type": "integer" }, "readOnly": { "description": "Optional: Defaults to false (read/write). ReadOnly here will force\nthe ReadOnly setting in VolumeMounts.\n+optional", "type": "boolean" }, "targetWWNs": { "description": "Optional: FC target worldwide names (WWNs)\n+optional", "type": "array", "items": { "type": "string" } }, "wwids": { "description": "Optional: FC volume world wide identifiers (wwids)\nEither wwids or combination of targetWWNs and lun must be set, but not both simultaneously.\n+optional", "type": "array", "items": { "type": "string" } } } }, "v1.FlexVolumeSource": { "type": "object", "properties": { "driver": { "description": "Driver is the name of the driver to use for this volume.", "type": "string" }, "fsType": { "description": "Filesystem type to mount.\nMust be a filesystem type supported by the host operating system.\nEx. \"ext4\", \"xfs\", \"ntfs\". The default filesystem depends on FlexVolume script.\n+optional", "type": "string" }, "options": { "description": "Optional: Extra command options if any.\n+optional", "type": "object", "additionalProperties": { "type": "string" } }, "readOnly": { "description": "Optional: Defaults to false (read/write). ReadOnly here will force\nthe ReadOnly setting in VolumeMounts.\n+optional", "type": "boolean" }, "secretRef": { "description": "Optional: SecretRef is reference to the secret object containing\nsensitive information to pass to the plugin scripts. This may be\nempty if no secret object is specified. If the secret object\ncontains more than one secret, all secrets are passed to the plugin\nscripts.\n+optional", "$ref": "#/definitions/v1.LocalObjectReference" } } }, "v1.FlockerVolumeSource": { "type": "object", "properties": { "datasetName": { "description": "Name of the dataset stored as metadata -\u003e name on the dataset for Flocker\nshould be considered as deprecated\n+optional", "type": "string" }, "datasetUUID": { "description": "UUID of the dataset. This is unique identifier of a Flocker dataset\n+optional", "type": "string" } } }, "v1.GCEPersistentDiskVolumeSource": { "type": "object", "properties": { "fsType": { "description": "Filesystem type of the volume that you want to mount.\nTip: Ensure that the filesystem type is supported by the host operating system.\nExamples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk\nTODO: how do we prevent errors in the filesystem from compromising the machine\n+optional", "type": "string" }, "partition": { "description": "The partition in the volume that you want to mount.\nIf omitted, the default is to mount by volume name.\nExamples: For volume /dev/sda1, you specify the partition as \"1\".\nSimilarly, the volume partition for /dev/sda is \"0\" (or you can leave the property empty).\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk\n+optional", "type": "integer" }, "pdName": { "description": "Unique name of the PD resource in GCE. Used to identify the disk in GCE.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk", "type": "string" }, "readOnly": { "description": "ReadOnly here will force the ReadOnly setting in VolumeMounts.\nDefaults to false.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk\n+optional", "type": "boolean" } } }, "v1.GitRepoVolumeSource": { "type": "object", "properties": { "directory": { "description": "Target directory name.\nMust not contain or start with '..'. If '.' is supplied, the volume directory will be the\ngit repository. Otherwise, if specified, the volume will contain the git repository in\nthe subdirectory with the given name.\n+optional", "type": "string" }, "repository": { "description": "Repository URL", "type": "string" }, "revision": { "description": "Commit hash for the specified revision.\n+optional", "type": "string" } } }, "v1.GlusterfsVolumeSource": { "type": "object", "properties": { "endpoints": { "description": "EndpointsName is the endpoint name that details Glusterfs topology.\nMore info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod", "type": "string" }, "path": { "description": "Path is the Glusterfs volume path.\nMore 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.\nDefaults to false.\nMore info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod\n+optional", "type": "boolean" } } }, "v1.HTTPGetAction": { "type": "object", "properties": { "host": { "description": "Host name to connect to, defaults to the pod IP. You probably want to set\n\"Host\" in httpHeaders instead.\n+optional", "type": "string" }, "httpHeaders": { "description": "Custom headers to set in the request. HTTP allows repeated headers.\n+optional", "type": "array", "items": { "$ref": "#/definitions/v1.HTTPHeader" } }, "path": { "description": "Path to access on the HTTP server.\n+optional", "type": "string" }, "port": { "description": "Name or number of the port to access on the container.\nNumber must be in the range 1 to 65535.\nName must be an IANA_SVC_NAME.", "$ref": "#/definitions/intstr.IntOrString" }, "scheme": { "description": "Scheme to use for connecting to the host.\nDefaults to HTTP.\n+optional", "type": "string" } } }, "v1.HTTPHeader": { "type": "object", "properties": { "name": { "description": "The header field name", "type": "string" }, "value": { "description": "The header field value", "type": "string" } } }, "v1.Handler": { "type": "object", "properties": { "exec": { "description": "One and only one of the following should be specified.\nExec specifies the action to take.\n+optional", "$ref": "#/definitions/v1.ExecAction" }, "httpGet": { "description": "HTTPGet specifies the http request to perform.\n+optional", "$ref": "#/definitions/v1.HTTPGetAction" }, "tcpSocket": { "description": "TCPSocket specifies an action involving a TCP port.\nTCP hooks not yet supported\nTODO: implement a realistic TCP lifecycle hook\n+optional", "$ref": "#/definitions/v1.TCPSocketAction" } } }, "v1.HostPathVolumeSource": { "type": "object", "properties": { "path": { "description": "Path of the directory on the host.\nIf the path is a symlink, it will follow the link to the real path.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath", "type": "string" }, "type": { "description": "Type for HostPath Volume\nDefaults to \"\"\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath\n+optional", "type": "string" } } }, "v1.ISCSIVolumeSource": { "type": "object", "properties": { "chapAuthDiscovery": { "description": "whether support iSCSI Discovery CHAP authentication\n+optional", "type": "boolean" }, "chapAuthSession": { "description": "whether support iSCSI Session CHAP authentication\n+optional", "type": "boolean" }, "fsType": { "description": "Filesystem type of the volume that you want to mount.\nTip: Ensure that the filesystem type is supported by the host operating system.\nExamples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi\nTODO: how do we prevent errors in the filesystem from compromising the machine\n+optional", "type": "string" }, "initiatorName": { "description": "Custom iSCSI Initiator Name.\nIf initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface\n\u003ctarget portal\u003e:\u003cvolume name\u003e will be created for the connection.\n+optional", "type": "string" }, "iqn": { "description": "Target iSCSI Qualified Name.", "type": "string" }, "iscsiInterface": { "description": "iSCSI Interface Name that uses an iSCSI transport.\nDefaults to 'default' (tcp).\n+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\nis other than default (typically TCP ports 860 and 3260).\n+optional", "type": "array", "items": { "type": "string" } }, "readOnly": { "description": "ReadOnly here will force the ReadOnly setting in VolumeMounts.\nDefaults to false.\n+optional", "type": "boolean" }, "secretRef": { "description": "CHAP Secret for iSCSI target and initiator authentication\n+optional", "$ref": "#/definitions/v1.LocalObjectReference" }, "targetPortal": { "description": "iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port\nis other than default (typically TCP ports 860 and 3260).", "type": "string" } } }, "v1.KeyToPath": { "type": "object", "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\nand 0777. If not specified, the volume defaultMode will be used.\nThis might be in conflict with other options that affect the file\nmode, like fsGroup, and the result can be other mode bits set.\n+optional", "type": "integer" }, "path": { "description": "The relative path of the file to map the key to.\nMay not be an absolute path.\nMay not contain the path element '..'.\nMay not start with the string '..'.", "type": "string" } } }, "v1.LabelSelector": { "type": "object", "properties": { "matchExpressions": { "description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.\n+optional", "type": "array", "items": { "$ref": "#/definitions/v1.LabelSelectorRequirement" } }, "matchLabels": { "description": "matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed.\n+optional", "type": "object", "additionalProperties": { "type": "string" } } } }, "v1.LabelSelectorRequirement": { "type": "object", "properties": { "key": { "description": "key is the label key that the selector applies to.\n+patchMergeKey=key\n+patchStrategy=merge", "type": "string" }, "operator": { "description": "operator represents a key's relationship to a set of values.\nValid 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,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch.\n+optional", "type": "array", "items": { "type": "string" } } } }, "v1.Lifecycle": { "type": "object", "properties": { "postStart": { "description": "PostStart is called immediately after a container is created. If the handler fails,\nthe container is terminated and restarted according to its restart policy.\nOther management of the container blocks until the hook completes.\nMore info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks\n+optional", "$ref": "#/definitions/v1.Handler" }, "preStop": { "description": "PreStop is called immediately before a container is terminated due to an\nAPI request or management event such as liveness/startup probe failure,\npreemption, resource contention, etc. The handler is not called if the\ncontainer crashes or exits. The reason for termination is passed to the\nhandler. The Pod's termination grace period countdown begins before the\nPreStop hooked is executed. Regardless of the outcome of the handler, the\ncontainer will eventually terminate within the Pod's termination grace\nperiod. Other management of the container blocks until the hook completes\nor until the termination grace period is reached.\nMore info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks\n+optional", "$ref": "#/definitions/v1.Handler" } } }, "v1.LocalObjectReference": { "type": "object", "properties": { "name": { "description": "Name of the referent.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Add other useful fields. apiVersion, kind, uid?\n+optional", "type": "string" } } }, "v1.NFSVolumeSource": { "type": "object", "properties": { "path": { "description": "Path that is exported by the NFS server.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#nfs", "type": "string" }, "readOnly": { "description": "ReadOnly here will force\nthe NFS export to be mounted with read-only permissions.\nDefaults to false.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#nfs\n+optional", "type": "boolean" }, "server": { "description": "Server is the hostname or IP address of the NFS server.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#nfs", "type": "string" } } }, "v1.NodeAffinity": { "type": "object", "properties": { "preferredDuringSchedulingIgnoredDuringExecution": { "description": "The scheduler will prefer to schedule pods to nodes that satisfy\nthe affinity expressions specified by this field, but it may choose\na node that violates one or more of the expressions. The node that is\nmost preferred is the one with the greatest sum of weights, i.e.\nfor each node that meets all of the scheduling requirements (resource\nrequest, requiredDuringScheduling affinity expressions, etc.),\ncompute a sum by iterating through the elements of this field and adding\n\"weight\" to the sum if the node matches the corresponding matchExpressions; the\nnode(s) with the highest sum are the most preferred.\n+optional", "type": "array", "items": { "$ref": "#/definitions/v1.PreferredSchedulingTerm" } }, "requiredDuringSchedulingIgnoredDuringExecution": { "description": "If the affinity requirements specified by this field are not met at\nscheduling time, the pod will not be scheduled onto the node.\nIf the affinity requirements specified by this field cease to be met\nat some point during pod execution (e.g. due to an update), the system\nmay or may not try to eventually evict the pod from its node.\n+optional", "$ref": "#/definitions/v1.NodeSelector" } } }, "v1.NodeSelector": { "type": "object", "properties": { "nodeSelectorTerms": { "description": "Required. A list of node selector terms. The terms are ORed.", "type": "array", "items": { "$ref": "#/definitions/v1.NodeSelectorTerm" } } } }, "v1.NodeSelectorRequirement": { "type": "object", "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.\nValid 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,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. If the operator is Gt or Lt, the values\narray must have a single element, which will be interpreted as an integer.\nThis array is replaced during a strategic merge patch.\n+optional", "type": "array", "items": { "type": "string" } } } }, "v1.NodeSelectorTerm": { "type": "object", "properties": { "matchExpressions": { "description": "A list of node selector requirements by node's labels.\n+optional", "type": "array", "items": { "$ref": "#/definitions/v1.NodeSelectorRequirement" } }, "matchFields": { "description": "A list of node selector requirements by node's fields.\n+optional", "type": "array", "items": { "$ref": "#/definitions/v1.NodeSelectorRequirement" } } } }, "v1.ObjectFieldSelector": { "type": "object", "properties": { "apiVersion": { "description": "Version of the schema the FieldPath is written in terms of, defaults to \"v1\".\n+optional", "type": "string" }, "fieldPath": { "description": "Path of the field to select in the specified API version.", "type": "string" } } }, "v1.PersistentVolumeClaimVolumeSource": { "type": "object", "properties": { "claimName": { "description": "ClaimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims", "type": "string" }, "readOnly": { "description": "Will force the ReadOnly setting in VolumeMounts.\nDefault false.\n+optional", "type": "boolean" } } }, "v1.PhotonPersistentDiskVolumeSource": { "type": "object", "properties": { "fsType": { "description": "Filesystem type to mount.\nMust be a filesystem type supported by the host operating system.\nEx. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.", "type": "string" }, "pdID": { "description": "ID that identifies Photon Controller persistent disk", "type": "string" } } }, "v1.PodAffinity": { "type": "object", "properties": { "preferredDuringSchedulingIgnoredDuringExecution": { "description": "The scheduler will prefer to schedule pods to nodes that satisfy\nthe affinity expressions specified by this field, but it may choose\na node that violates one or more of the expressions. The node that is\nmost preferred is the one with the greatest sum of weights, i.e.\nfor each node that meets all of the scheduling requirements (resource\nrequest, requiredDuringScheduling affinity expressions, etc.),\ncompute a sum by iterating through the elements of this field and adding\n\"weight\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the\nnode(s) with the highest sum are the most preferred.\n+optional", "type": "array", "items": { "$ref": "#/definitions/v1.WeightedPodAffinityTerm" } }, "requiredDuringSchedulingIgnoredDuringExecution": { "description": "If the affinity requirements specified by this field are not met at\nscheduling time, the pod will not be scheduled onto the node.\nIf the affinity requirements specified by this field cease to be met\nat some point during pod execution (e.g. due to a pod label update), the\nsystem may or may not try to eventually evict the pod from its node.\nWhen there are multiple elements, the lists of nodes corresponding to each\npodAffinityTerm are intersected, i.e. all terms must be satisfied.\n+optional", "type": "array", "items": { "$ref": "#/definitions/v1.PodAffinityTerm" } } } }, "v1.PodAffinityTerm": { "type": "object", "properties": { "labelSelector": { "description": "A label query over a set of resources, in this case pods.\n+optional", "$ref": "#/definitions/v1.LabelSelector" }, "namespaces": { "description": "namespaces specifies which namespaces the labelSelector applies to (matches against);\nnull or empty list means \"this pod's namespace\"\n+optional", "type": "array", "items": { "type": "string" } }, "topologyKey": { "description": "This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching\nthe labelSelector in the specified namespaces, where co-located is defined as running on a node\nwhose value of the label with key topologyKey matches that of any node on which any of the\nselected pods is running.\nEmpty topologyKey is not allowed.", "type": "string" } } }, "v1.PodAntiAffinity": { "type": "object", "properties": { "preferredDuringSchedulingIgnoredDuringExecution": { "description": "The scheduler will prefer to schedule pods to nodes that satisfy\nthe anti-affinity expressions specified by this field, but it may choose\na node that violates one or more of the expressions. The node that is\nmost preferred is the one with the greatest sum of weights, i.e.\nfor each node that meets all of the scheduling requirements (resource\nrequest, requiredDuringScheduling anti-affinity expressions, etc.),\ncompute a sum by iterating through the elements of this field and adding\n\"weight\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the\nnode(s) with the highest sum are the most preferred.\n+optional", "type": "array", "items": { "$ref": "#/definitions/v1.WeightedPodAffinityTerm" } }, "requiredDuringSchedulingIgnoredDuringExecution": { "description": "If the anti-affinity requirements specified by this field are not met at\nscheduling time, the pod will not be scheduled onto the node.\nIf the anti-affinity requirements specified by this field cease to be met\nat some point during pod execution (e.g. due to a pod label update), the\nsystem may or may not try to eventually evict the pod from its node.\nWhen there are multiple elements, the lists of nodes corresponding to each\npodAffinityTerm are intersected, i.e. all terms must be satisfied.\n+optional", "type": "array", "items": { "$ref": "#/definitions/v1.PodAffinityTerm" } } } }, "v1.PodSecurityContext": { "type": "object", "properties": { "fsGroup": { "description": "A special supplemental group that applies to all containers in a pod.\nSome volume types allow the Kubelet to change the ownership of that volume\nto be owned by the pod:\n\n1. The owning GID will be the FSGroup\n2. The setgid bit is set (new files created in the volume will be owned by FSGroup)\n3. The permission bits are OR'd with rw-rw----\n\nIf unset, the Kubelet will not modify the ownership and permissions of any volume.\n+optional", "type": "integer" }, "runAsGroup": { "description": "The GID to run the entrypoint of the container process.\nUses runtime default if unset.\nMay also be set in SecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence\nfor that container.\n+optional", "type": "integer" }, "runAsNonRoot": { "description": "Indicates that the container must run as a non-root user.\nIf true, the Kubelet will validate the image at runtime to ensure that it\ndoes not run as UID 0 (root) and fail to start the container if it does.\nIf unset or false, no such validation will be performed.\nMay also be set in SecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence.\n+optional", "type": "boolean" }, "runAsUser": { "description": "The UID to run the entrypoint of the container process.\nDefaults to user specified in image metadata if unspecified.\nMay also be set in SecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence\nfor that container.\n+optional", "type": "integer" }, "seLinuxOptions": { "description": "The SELinux context to be applied to all containers.\nIf unspecified, the container runtime will allocate a random SELinux context for each\ncontainer. May also be set in SecurityContext. If set in\nboth SecurityContext and PodSecurityContext, the value specified in SecurityContext\ntakes precedence for that container.\n+optional", "$ref": "#/definitions/v1.SELinuxOptions" }, "supplementalGroups": { "description": "A list of groups applied to the first process run in each container, in addition\nto the container's primary GID. If unspecified, no groups will be added to\nany container.\n+optional", "type": "array", "items": { "type": "integer" } }, "sysctls": { "description": "Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported\nsysctls (by the container runtime) might fail to launch.\n+optional", "type": "array", "items": { "$ref": "#/definitions/v1.Sysctl" } }, "windowsOptions": { "description": "The Windows specific settings applied to all containers.\nIf unspecified, the options within a container's SecurityContext will be used.\nIf set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.\n+optional", "$ref": "#/definitions/v1.WindowsSecurityContextOptions" } } }, "v1.PortworxVolumeSource": { "type": "object", "properties": { "fsType": { "description": "FSType represents the filesystem type to mount\nMust be a filesystem type supported by the host operating system.\nEx. \"ext4\", \"xfs\". Implicitly inferred to be \"ext4\" if unspecified.", "type": "string" }, "readOnly": { "description": "Defaults to false (read/write). ReadOnly here will force\nthe ReadOnly setting in VolumeMounts.\n+optional", "type": "boolean" }, "volumeID": { "description": "VolumeID uniquely identifies a Portworx volume", "type": "string" } } }, "v1.PreferredSchedulingTerm": { "type": "object", "properties": { "preference": { "description": "A node selector term, associated with the corresponding weight.", "$ref": "#/definitions/v1.NodeSelectorTerm" }, "weight": { "description": "Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100.", "type": "integer" } } }, "v1.Probe": { "type": "object", "properties": { "exec": { "description": "One and only one of the following should be specified.\nExec specifies the action to take.\n+optional", "$ref": "#/definitions/v1.ExecAction" }, "failureThreshold": { "description": "Minimum consecutive failures for the probe to be considered failed after having succeeded.\nDefaults to 3. Minimum value is 1.\n+optional", "type": "integer" }, "httpGet": { "description": "HTTPGet specifies the http request to perform.\n+optional", "$ref": "#/definitions/v1.HTTPGetAction" }, "initialDelaySeconds": { "description": "Number of seconds after the container has started before liveness probes are initiated.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes\n+optional", "type": "integer" }, "periodSeconds": { "description": "How often (in seconds) to perform the probe.\nDefault to 10 seconds. Minimum value is 1.\n+optional", "type": "integer" }, "successThreshold": { "description": "Minimum consecutive successes for the probe to be considered successful after having failed.\nDefaults to 1. Must be 1 for liveness and startup. Minimum value is 1.\n+optional", "type": "integer" }, "tcpSocket": { "description": "TCPSocket specifies an action involving a TCP port.\nTCP hooks not yet supported\nTODO: implement a realistic TCP lifecycle hook\n+optional", "$ref": "#/definitions/v1.TCPSocketAction" }, "timeoutSeconds": { "description": "Number of seconds after which the probe times out.\nDefaults to 1 second. Minimum value is 1.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes\n+optional", "type": "integer" } } }, "v1.ProjectedVolumeSource": { "type": "object", "properties": { "defaultMode": { "description": "Mode bits to use on created files by default. Must be a value between\n0 and 0777.\nDirectories within the path are not affected by this setting.\nThis might be in conflict with other options that affect the file\nmode, like fsGroup, and the result can be other mode bits set.\n+optional", "type": "integer" }, "sources": { "description": "list of volume projections", "type": "array", "items": { "$ref": "#/definitions/v1.VolumeProjection" } } } }, "v1.QuobyteVolumeSource": { "type": "object", "properties": { "group": { "description": "Group to map volume access to\nDefault is no group\n+optional", "type": "string" }, "readOnly": { "description": "ReadOnly here will force the Quobyte volume to be mounted with read-only permissions.\nDefaults to false.\n+optional", "type": "boolean" }, "registry": { "description": "Registry represents a single or multiple Quobyte Registry services\nspecified as a string as host:port pair (multiple entries are separated with commas)\nwhich acts as the central registry for volumes", "type": "string" }, "tenant": { "description": "Tenant owning the given Quobyte volume in the Backend\nUsed with dynamically provisioned Quobyte volumes, value is set by the plugin\n+optional", "type": "string" }, "user": { "description": "User to map volume access to\nDefaults to serivceaccount user\n+optional", "type": "string" }, "volume": { "description": "Volume is a string that references an already created Quobyte volume by name.", "type": "string" } } }, "v1.RBDVolumeSource": { "type": "object", "properties": { "fsType": { "description": "Filesystem type of the volume that you want to mount.\nTip: Ensure that the filesystem type is supported by the host operating system.\nExamples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#rbd\nTODO: how do we prevent errors in the filesystem from compromising the machine\n+optional", "type": "string" }, "image": { "description": "The rados image name.\nMore 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.\nDefault is /etc/ceph/keyring.\nMore info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it\n+optional", "type": "string" }, "monitors": { "description": "A collection of Ceph monitors.\nMore info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it", "type": "array", "items": { "type": "string" } }, "pool": { "description": "The rados pool name.\nDefault is rbd.\nMore info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it\n+optional", "type": "string" }, "readOnly": { "description": "ReadOnly here will force the ReadOnly setting in VolumeMounts.\nDefaults to false.\nMore info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it\n+optional", "type": "boolean" }, "secretRef": { "description": "SecretRef is name of the authentication secret for RBDUser. If provided\noverrides keyring.\nDefault is nil.\nMore info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it\n+optional", "$ref": "#/definitions/v1.LocalObjectReference" }, "user": { "description": "The rados user name.\nDefault is admin.\nMore info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it\n+optional", "type": "string" } } }, "v1.ResourceFieldSelector": { "type": "object", "properties": { "containerName": { "description": "Container name: required for volumes, optional for env vars\n+optional", "type": "string" }, "divisor": { "description": "Specifies the output format of the exposed resources, defaults to \"1\"\n+optional", "$ref": "#/definitions/resource.Quantity" }, "resource": { "description": "Required: resource to select", "type": "string" } } }, "v1.ResourceList": { "type": "object", "additionalProperties": { "$ref": "#/definitions/resource.Quantity" } }, "v1.ResourceRequirements": { "type": "object", "properties": { "limits": { "description": "Limits describes the maximum amount of compute resources allowed.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/\n+optional", "$ref": "#/definitions/v1.ResourceList" }, "requests": { "description": "Requests describes the minimum amount of compute resources required.\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\notherwise to an implementation-defined value.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/\n+optional", "$ref": "#/definitions/v1.ResourceList" } } }, "v1.SELinuxOptions": { "type": "object", "properties": { "level": { "description": "Level is SELinux level label that applies to the container.\n+optional", "type": "string" }, "role": { "description": "Role is a SELinux role label that applies to the container.\n+optional", "type": "string" }, "type": { "description": "Type is a SELinux type label that applies to the container.\n+optional", "type": "string" }, "user": { "description": "User is a SELinux user label that applies to the container.\n+optional", "type": "string" } } }, "v1.ScaleIOVolumeSource": { "type": "object", "properties": { "fsType": { "description": "Filesystem type to mount.\nMust be a filesystem type supported by the host operating system.\nEx. \"ext4\", \"xfs\", \"ntfs\".\nDefault is \"xfs\".\n+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.\n+optional", "type": "string" }, "readOnly": { "description": "Defaults to false (read/write). ReadOnly here will force\nthe ReadOnly setting in VolumeMounts.\n+optional", "type": "boolean" }, "secretRef": { "description": "SecretRef references to the secret for ScaleIO user and other\nsensitive information. If this is not provided, Login operation will fail.", "$ref": "#/definitions/v1.LocalObjectReference" }, "sslEnabled": { "description": "Flag to enable/disable SSL communication with Gateway, default false\n+optional", "type": "boolean" }, "storageMode": { "description": "Indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned.\nDefault is ThinProvisioned.\n+optional", "type": "string" }, "storagePool": { "description": "The ScaleIO Storage Pool associated with the protection domain.\n+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\nthat is associated with this volume source.", "type": "string" } } }, "v1.SecretEnvSource": { "type": "object", "properties": { "name": { "description": "Name of the referent.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Add other useful fields. apiVersion, kind, uid?\n+optional", "type": "string" }, "optional": { "description": "Specify whether the Secret must be defined\n+optional", "type": "boolean" } } }, "v1.SecretKeySelector": { "type": "object", "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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Add other useful fields. apiVersion, kind, uid?\n+optional", "type": "string" }, "optional": { "description": "Specify whether the Secret or its key must be defined\n+optional", "type": "boolean" } } }, "v1.SecretProjection": { "type": "object", "properties": { "items": { "description": "If unspecified, each key-value pair in the Data field of the referenced\nSecret will be projected into the volume as a file whose name is the\nkey and content is the value. If specified, the listed keys will be\nprojected into the specified paths, and unlisted keys will not be\npresent. If a key is specified which is not present in the Secret,\nthe volume setup will error unless it is marked optional. Paths must be\nrelative and may not contain the '..' path or start with '..'.\n+optional", "type": "array", "items": { "$ref": "#/definitions/v1.KeyToPath" } }, "name": { "description": "Name of the referent.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Add other useful fields. apiVersion, kind, uid?\n+optional", "type": "string" }, "optional": { "description": "Specify whether the Secret or its key must be defined\n+optional", "type": "boolean" } } }, "v1.SecretVolumeSource": { "type": "object", "properties": { "defaultMode": { "description": "Optional: mode bits to use on created files by default. Must be a\nvalue between 0 and 0777. Defaults to 0644.\nDirectories within the path are not affected by this setting.\nThis might be in conflict with other options that affect the file\nmode, like fsGroup, and the result can be other mode bits set.\n+optional", "type": "integer" }, "items": { "description": "If unspecified, each key-value pair in the Data field of the referenced\nSecret will be projected into the volume as a file whose name is the\nkey and content is the value. If specified, the listed keys will be\nprojected into the specified paths, and unlisted keys will not be\npresent. If a key is specified which is not present in the Secret,\nthe volume setup will error unless it is marked optional. Paths must be\nrelative and may not contain the '..' path or start with '..'.\n+optional", "type": "array", "items": { "$ref": "#/definitions/v1.KeyToPath" } }, "optional": { "description": "Specify whether the Secret or its keys must be defined\n+optional", "type": "boolean" }, "secretName": { "description": "Name of the secret in the pod's namespace to use.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#secret\n+optional", "type": "string" } } }, "v1.SecurityContext": { "type": "object", "properties": { "allowPrivilegeEscalation": { "description": "AllowPrivilegeEscalation controls whether a process can gain more\nprivileges than its parent process. This bool directly controls if\nthe no_new_privs flag will be set on the container process.\nAllowPrivilegeEscalation is true always when the container is:\n1) run as Privileged\n2) has CAP_SYS_ADMIN\n+optional", "type": "boolean" }, "capabilities": { "description": "The capabilities to add/drop when running containers.\nDefaults to the default set of capabilities granted by the container runtime.\n+optional", "$ref": "#/definitions/v1.Capabilities" }, "privileged": { "description": "Run container in privileged mode.\nProcesses in privileged containers are essentially equivalent to root on the host.\nDefaults to false.\n+optional", "type": "boolean" }, "procMount": { "description": "procMount denotes the type of proc mount to use for the containers.\nThe default is DefaultProcMount which uses the container runtime defaults for\nreadonly paths and masked paths.\nThis requires the ProcMountType feature flag to be enabled.\n+optional", "type": "string" }, "readOnlyRootFilesystem": { "description": "Whether this container has a read-only root filesystem.\nDefault is false.\n+optional", "type": "boolean" }, "runAsGroup": { "description": "The GID to run the entrypoint of the container process.\nUses runtime default if unset.\nMay also be set in PodSecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence.\n+optional", "type": "integer" }, "runAsNonRoot": { "description": "Indicates that the container must run as a non-root user.\nIf true, the Kubelet will validate the image at runtime to ensure that it\ndoes not run as UID 0 (root) and fail to start the container if it does.\nIf unset or false, no such validation will be performed.\nMay also be set in PodSecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence.\n+optional", "type": "boolean" }, "runAsUser": { "description": "The UID to run the entrypoint of the container process.\nDefaults to user specified in image metadata if unspecified.\nMay also be set in PodSecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence.\n+optional", "type": "integer" }, "seLinuxOptions": { "description": "The SELinux context to be applied to the container.\nIf unspecified, the container runtime will allocate a random SELinux context for each\ncontainer. May also be set in PodSecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence.\n+optional", "$ref": "#/definitions/v1.SELinuxOptions" }, "windowsOptions": { "description": "The Windows specific settings applied to all containers.\nIf unspecified, the options from the PodSecurityContext will be used.\nIf set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.\n+optional", "$ref": "#/definitions/v1.WindowsSecurityContextOptions" } } }, "v1.ServiceAccountTokenProjection": { "type": "object", "properties": { "audience": { "description": "Audience is the intended audience of the token. A recipient of a token\nmust identify itself with an identifier specified in the audience of the\ntoken, and otherwise should reject the token. The audience defaults to the\nidentifier of the apiserver.\n+optional", "type": "string" }, "expirationSeconds": { "description": "ExpirationSeconds is the requested duration of validity of the service\naccount token. As the token approaches expiration, the kubelet volume\nplugin will proactively rotate the service account token. The kubelet will\nstart trying to rotate the token if the token is older than 80 percent of\nits time to live or if the token is older than 24 hours.Defaults to 1 hour\nand must be at least 10 minutes.\n+optional", "type": "integer" }, "path": { "description": "Path is the path relative to the mount point of the file to project the\ntoken into.", "type": "string" } } }, "v1.ServicePort": { "type": "object", "properties": { "name": { "description": "The name of this port within the service. This must be a DNS_LABEL.\nAll ports within a ServiceSpec must have unique names. When considering\nthe endpoints for a Service, this must match the 'name' field in the\nEndpointPort.\nOptional if only one ServicePort is defined on this service.\n+optional", "type": "string" }, "nodePort": { "description": "The port on each node on which this service is exposed when type=NodePort or LoadBalancer.\nUsually assigned by the system. If specified, it will be allocated to the service\nif unused or else creation of the service will fail.\nDefault is to auto-allocate a port if the ServiceType of this Service requires one.\nMore info: https://kubernetes.io/docs/concepts/services-networking/service/#type-nodeport\n+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\".\nDefault is TCP.\n+optional", "type": "string" }, "targetPort": { "description": "Number or name of the port to access on the pods targeted by the service.\nNumber must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.\nIf this is a string, it will be looked up as a named port in the\ntarget Pod's container ports. If this is not specified, the value\nof the 'port' field is used (an identity map).\nThis field is ignored for services with clusterIP=None, and should be\nomitted or set equal to the 'port' field.\nMore info: https://kubernetes.io/docs/concepts/services-networking/service/#defining-a-service\n+optional", "$ref": "#/definitions/intstr.IntOrString" } } }, "v1.Status": { "type": "object", "properties": { "apiVersion": { "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources\n+optional", "type": "string" }, "code": { "description": "Suggested HTTP return code for this status, 0 if not set.\n+optional", "type": "integer" }, "continue": { "description": "continue may be set if the user set a limit on the number of items returned, and indicates that\nthe server has more data available. The value is opaque and may be used to issue another request\nto the endpoint that served this list to retrieve the next set of available objects. Continuing a\nconsistent list may not be possible if the server configuration has changed or more than a few\nminutes have passed. The resourceVersion field returned when using this continue value will be\nidentical to the value in the first response, unless you have received this token from an error\nmessage.", "type": "string" }, "details": { "description": "Extended data associated with the reason. Each reason may define its\nown extended details. This field is optional and the data returned\nis not guaranteed to conform to any schema except that defined by\nthe reason type.\n+optional", "$ref": "#/definitions/v1.StatusDetails" }, "kind": { "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds\n+optional", "type": "string" }, "message": { "description": "A human-readable description of the status of this operation.\n+optional", "type": "string" }, "reason": { "description": "A machine-readable description of why this operation is in the\n\"Failure\" status. If this value is empty there\nis no information available. A Reason clarifies an HTTP status\ncode but does not override it.\n+optional", "type": "string" }, "remainingItemCount": { "description": "remainingItemCount is the number of subsequent items in the list which are not included in this\nlist response. If the list request contained label or field selectors, then the number of\nremaining items is unknown and the field will be left unset and omitted during serialization.\nIf the list is complete (either because it is not chunking or because this is the last chunk),\nthen there are no more remaining items and this field will be left unset and omitted during\nserialization.\nServers older than v1.15 do not set this field.\nThe intended use of the remainingItemCount is *estimating* the size of a collection. Clients\nshould not rely on the remainingItemCount to be set or to be exact.\n+optional", "type": "integer" }, "resourceVersion": { "description": "String that identifies the server's internal version of this object that\ncan be used by clients to determine when objects have changed.\nValue must be treated as opaque by clients and passed unmodified back to the server.\nPopulated by the system.\nRead-only.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency\n+optional", "type": "string" }, "selfLink": { "description": "selfLink is a URL representing this object.\nPopulated by the system.\nRead-only.\n\nDEPRECATED\nKubernetes will stop propagating this field in 1.20 release and the field is planned\nto be removed in 1.21 release.\n+optional", "type": "string" }, "status": { "description": "Status of the operation.\nOne of: \"Success\" or \"Failure\".\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status\n+optional", "type": "string" } } }, "v1.StatusCause": { "type": "object", "properties": { "field": { "description": "The field of the resource that has caused this error, as named by its JSON\nserialization. May include dot and postfix notation for nested attributes.\nArrays are zero-indexed. Fields may appear more than once in an array of\ncauses due to fields having multiple errors.\nOptional.\n\nExamples:\n \"name\" - the field \"name\" on the current resource\n \"items[0].name\" - the field \"name\" on the first array entry in \"items\"\n+optional", "type": "string" }, "message": { "description": "A human-readable description of the cause of the error. This field may be\npresented as-is to a reader.\n+optional", "type": "string" }, "reason": { "description": "A machine-readable description of the cause of the error. If this value is\nempty there is no information available.\n+optional", "type": "string" } } }, "v1.StatusDetails": { "type": "object", "properties": { "causes": { "description": "The Causes array includes more details associated with the StatusReason\nfailure. Not all StatusReasons may provide detailed causes.\n+optional", "type": "array", "items": { "$ref": "#/definitions/v1.StatusCause" } }, "group": { "description": "The group attribute of the resource associated with the status StatusReason.\n+optional", "type": "string" }, "kind": { "description": "The kind attribute of the resource associated with the status StatusReason.\nOn some operations may differ from the requested resource Kind.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds\n+optional", "type": "string" }, "name": { "description": "The name attribute of the resource associated with the status StatusReason\n(when there is a single name which can be described).\n+optional", "type": "string" }, "retryAfterSeconds": { "description": "If specified, the time in seconds before the operation should be retried. Some errors may indicate\nthe client must take an alternate action - for those errors this field may indicate how long to wait\nbefore taking the alternate action.\n+optional", "type": "integer" }, "uid": { "description": "UID of the resource.\n(when there is a single resource which can be described).\nMore info: http://kubernetes.io/docs/user-guide/identifiers#uids\n+optional", "type": "string" } } }, "v1.StorageOSVolumeSource": { "type": "object", "properties": { "fsType": { "description": "Filesystem type to mount.\nMust be a filesystem type supported by the host operating system.\nEx. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.\n+optional", "type": "string" }, "readOnly": { "description": "Defaults to false (read/write). ReadOnly here will force\nthe ReadOnly setting in VolumeMounts.\n+optional", "type": "boolean" }, "secretRef": { "description": "SecretRef specifies the secret to use for obtaining the StorageOS API\ncredentials. If not specified, default values will be attempted.\n+optional", "$ref": "#/definitions/v1.LocalObjectReference" }, "volumeName": { "description": "VolumeName is the human-readable name of the StorageOS volume. Volume\nnames are only unique within a namespace.", "type": "string" }, "volumeNamespace": { "description": "VolumeNamespace specifies the scope of the volume within StorageOS. If no\nnamespace is specified then the Pod's namespace will be used. This allows the\nKubernetes name scoping to be mirrored within StorageOS for tighter integration.\nSet VolumeName to any name to override the default behaviour.\nSet to \"default\" if you are not using namespaces within StorageOS.\nNamespaces that do not pre-exist within StorageOS will be created.\n+optional", "type": "string" } } }, "v1.Sysctl": { "type": "object", "properties": { "name": { "description": "Name of a property to set", "type": "string" }, "value": { "description": "Value of a property to set", "type": "string" } } }, "v1.TCPSocketAction": { "type": "object", "properties": { "host": { "description": "Optional: Host name to connect to, defaults to the pod IP.\n+optional", "type": "string" }, "port": { "description": "Number or name of the port to access on the container.\nNumber must be in the range 1 to 65535.\nName must be an IANA_SVC_NAME.", "$ref": "#/definitions/intstr.IntOrString" } } }, "v1.Toleration": { "type": "object", "properties": { "effect": { "description": "Effect indicates the taint effect to match. Empty means match all taint effects.\nWhen specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.\n+optional", "type": "string" }, "key": { "description": "Key is the taint key that the toleration applies to. Empty means match all taint keys.\nIf the key is empty, operator must be Exists; this combination means to match all values and all keys.\n+optional", "type": "string" }, "operator": { "description": "Operator represents a key's relationship to the value.\nValid operators are Exists and Equal. Defaults to Equal.\nExists is equivalent to wildcard for value, so that a pod can\ntolerate all taints of a particular category.\n+optional", "type": "string" }, "tolerationSeconds": { "description": "TolerationSeconds represents the period of time the toleration (which must be\nof effect NoExecute, otherwise this field is ignored) tolerates the taint. By default,\nit is not set, which means tolerate the taint forever (do not evict). Zero and\nnegative values will be treated as 0 (evict immediately) by the system.\n+optional", "type": "integer" }, "value": { "description": "Value is the taint value the toleration matches to.\nIf the operator is Exists, the value should be empty, otherwise just a regular string.\n+optional", "type": "string" } } }, "v1.Volume": { "type": "object", "properties": { "awsElasticBlockStore": { "description": "AWSElasticBlockStore represents an AWS Disk resource that is attached to a\nkubelet's host machine and then exposed to the pod.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore\n+optional", "$ref": "#/definitions/v1.AWSElasticBlockStoreVolumeSource" }, "azureDisk": { "description": "AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.\n+optional", "$ref": "#/definitions/v1.AzureDiskVolumeSource" }, "azureFile": { "description": "AzureFile represents an Azure File Service mount on the host and bind mount to the pod.\n+optional", "$ref": "#/definitions/v1.AzureFileVolumeSource" }, "cephfs": { "description": "CephFS represents a Ceph FS mount on the host that shares a pod's lifetime\n+optional", "$ref": "#/definitions/v1.CephFSVolumeSource" }, "cinder": { "description": "Cinder represents a cinder volume attached and mounted on kubelets host machine.\nMore info: https://examples.k8s.io/mysql-cinder-pd/README.md\n+optional", "$ref": "#/definitions/v1.CinderVolumeSource" }, "configMap": { "description": "ConfigMap represents a configMap that should populate this volume\n+optional", "$ref": "#/definitions/v1.ConfigMapVolumeSource" }, "csi": { "description": "CSI (Container Storage Interface) represents storage that is handled by an external CSI driver (Alpha feature).\n+optional", "$ref": "#/definitions/v1.CSIVolumeSource" }, "downwardAPI": { "description": "DownwardAPI represents downward API about the pod that should populate this volume\n+optional", "$ref": "#/definitions/v1.DownwardAPIVolumeSource" }, "emptyDir": { "description": "EmptyDir represents a temporary directory that shares a pod's lifetime.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir\n+optional", "$ref": "#/definitions/v1.EmptyDirVolumeSource" }, "fc": { "description": "FC represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod.\n+optional", "$ref": "#/definitions/v1.FCVolumeSource" }, "flexVolume": { "description": "FlexVolume represents a generic volume resource that is\nprovisioned/attached using an exec based plugin.\n+optional", "$ref": "#/definitions/v1.FlexVolumeSource" }, "flocker": { "description": "Flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running\n+optional", "$ref": "#/definitions/v1.FlockerVolumeSource" }, "gcePersistentDisk": { "description": "GCEPersistentDisk represents a GCE Disk resource that is attached to a\nkubelet's host machine and then exposed to the pod.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk\n+optional", "$ref": "#/definitions/v1.GCEPersistentDiskVolumeSource" }, "gitRepo": { "description": "GitRepo represents a git repository at a particular revision.\nDEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an\nEmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir\ninto the Pod's container.\n+optional", "$ref": "#/definitions/v1.GitRepoVolumeSource" }, "glusterfs": { "description": "Glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime.\nMore info: https://examples.k8s.io/volumes/glusterfs/README.md\n+optional", "$ref": "#/definitions/v1.GlusterfsVolumeSource" }, "hostPath": { "description": "HostPath represents a pre-existing file or directory on the host\nmachine that is directly exposed to the container. This is generally\nused for system agents or other privileged things that are allowed\nto see the host machine. Most containers will NOT need this.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath\n---\nTODO(jonesdl) We need to restrict who can use host directory mounts and who can/can not\nmount host directories as read/write.\n+optional", "$ref": "#/definitions/v1.HostPathVolumeSource" }, "iscsi": { "description": "ISCSI represents an ISCSI Disk resource that is attached to a\nkubelet's host machine and then exposed to the pod.\nMore info: https://examples.k8s.io/volumes/iscsi/README.md\n+optional", "$ref": "#/definitions/v1.ISCSIVolumeSource" }, "name": { "description": "Volume's name.\nMust be a DNS_LABEL and unique within the pod.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": "string" }, "nfs": { "description": "NFS represents an NFS mount on the host that shares a pod's lifetime\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#nfs\n+optional", "$ref": "#/definitions/v1.NFSVolumeSource" }, "persistentVolumeClaim": { "description": "PersistentVolumeClaimVolumeSource represents a reference to a\nPersistentVolumeClaim in the same namespace.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims\n+optional", "$ref": "#/definitions/v1.PersistentVolumeClaimVolumeSource" }, "photonPersistentDisk": { "description": "PhotonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine", "$ref": "#/definitions/v1.PhotonPersistentDiskVolumeSource" }, "portworxVolume": { "description": "PortworxVolume represents a portworx volume attached and mounted on kubelets host machine\n+optional", "$ref": "#/definitions/v1.PortworxVolumeSource" }, "projected": { "description": "Items for all in one resources secrets, configmaps, and downward API", "$ref": "#/definitions/v1.ProjectedVolumeSource" }, "quobyte": { "description": "Quobyte represents a Quobyte mount on the host that shares a pod's lifetime\n+optional", "$ref": "#/definitions/v1.QuobyteVolumeSource" }, "rbd": { "description": "RBD represents a Rados Block Device mount on the host that shares a pod's lifetime.\nMore info: https://examples.k8s.io/volumes/rbd/README.md\n+optional", "$ref": "#/definitions/v1.RBDVolumeSource" }, "scaleIO": { "description": "ScaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.\n+optional", "$ref": "#/definitions/v1.ScaleIOVolumeSource" }, "secret": { "description": "Secret represents a secret that should populate this volume.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#secret\n+optional", "$ref": "#/definitions/v1.SecretVolumeSource" }, "storageos": { "description": "StorageOS represents a StorageOS volume attached and mounted on Kubernetes nodes.\n+optional", "$ref": "#/definitions/v1.StorageOSVolumeSource" }, "vsphereVolume": { "description": "VsphereVolume represents a vSphere volume attached and mounted on kubelets host machine\n+optional", "$ref": "#/definitions/v1.VsphereVirtualDiskVolumeSource" } } }, "v1.VolumeDevice": { "type": "object", "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" } } }, "v1.VolumeMount": { "type": "object", "properties": { "mountPath": { "description": "Path within the container at which the volume should be mounted. Must\nnot contain ':'.", "type": "string" }, "mountPropagation": { "description": "mountPropagation determines how mounts are propagated from the host\nto container and the other way around.\nWhen not set, MountPropagationNone is used.\nThis field is beta in 1.10.\n+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).\nDefaults to false.\n+optional", "type": "boolean" }, "subPath": { "description": "Path within the volume from which the container's volume should be mounted.\nDefaults to \"\" (volume's root).\n+optional", "type": "string" }, "subPathExpr": { "description": "Expanded path within the volume from which the container's volume should be mounted.\nBehaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment.\nDefaults to \"\" (volume's root).\nSubPathExpr and SubPath are mutually exclusive.\nThis field is beta in 1.15.\n+optional", "type": "string" } } }, "v1.VolumeProjection": { "type": "object", "properties": { "configMap": { "description": "information about the configMap data to project\n+optional", "$ref": "#/definitions/v1.ConfigMapProjection" }, "downwardAPI": { "description": "information about the downwardAPI data to project\n+optional", "$ref": "#/definitions/v1.DownwardAPIProjection" }, "secret": { "description": "information about the secret data to project\n+optional", "$ref": "#/definitions/v1.SecretProjection" }, "serviceAccountToken": { "description": "information about the serviceAccountToken data to project\n+optional", "$ref": "#/definitions/v1.ServiceAccountTokenProjection" } } }, "v1.VsphereVirtualDiskVolumeSource": { "type": "object", "properties": { "fsType": { "description": "Filesystem type to mount.\nMust be a filesystem type supported by the host operating system.\nEx. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.\n+optional", "type": "string" }, "storagePolicyID": { "description": "Storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.\n+optional", "type": "string" }, "storagePolicyName": { "description": "Storage Policy Based Management (SPBM) profile name.\n+optional", "type": "string" }, "volumePath": { "description": "Path that identifies vSphere volume vmdk", "type": "string" } } }, "v1.WeightedPodAffinityTerm": { "type": "object", "properties": { "podAffinityTerm": { "description": "Required. A pod affinity term, associated with the corresponding weight.", "$ref": "#/definitions/v1.PodAffinityTerm" }, "weight": { "description": "weight associated with matching the corresponding podAffinityTerm,\nin the range 1-100.", "type": "integer" } } }, "v1.WindowsSecurityContextOptions": { "type": "object", "properties": { "gmsaCredentialSpec": { "description": "GMSACredentialSpec is where the GMSA admission webhook\n(https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the\nGMSA credential spec named by the GMSACredentialSpecName field.\nThis field is alpha-level and is only honored by servers that enable the WindowsGMSA feature flag.\n+optional", "type": "string" }, "gmsaCredentialSpecName": { "description": "GMSACredentialSpecName is the name of the GMSA credential spec to use.\nThis field is alpha-level and is only honored by servers that enable the WindowsGMSA feature flag.\n+optional", "type": "string" }, "runAsUserName": { "description": "The UserName in Windows to run the entrypoint of the container process.\nDefaults to the user specified in image metadata if unspecified.\nMay also be set in PodSecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence.\nThis field is alpha-level and it is only honored by servers that enable the WindowsRunAsUserName feature flag.\n+optional", "type": "string" } } }, "v1alpha1.CDCConfigWraper": { "type": "object", "properties": { "mp": { "description": "Export this field to make \"apiequality.Semantic.DeepEqual\" happy now.\nUser of GenericConfig should not directly access this field.", "type": "object", "additionalProperties": true } } }, "v1alpha1.DiscoverySpec": { "type": "object", "properties": { "limits": { "description": "Limits describes the maximum amount of compute resources allowed.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/\n+optional", "$ref": "#/definitions/v1.ResourceList" }, "requests": { "description": "Requests describes the minimum amount of compute resources required.\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\notherwise to an implementation-defined value.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/\n+optional", "$ref": "#/definitions/v1.ResourceList" } } }, "v1alpha1.HelperSpec": { "type": "object", "properties": { "image": { "description": "Image used to tail slow log and set kernel parameters if necessary, must have `tail` and `sysctl` installed\nOptional: Defaults to busybox:1.26.2\n+optional", "type": "string" }, "imagePullPolicy": { "description": "ImagePullPolicy of the component. Override the cluster-level imagePullPolicy if present\nOptional: Defaults to the cluster-level setting\n+optional", "type": "string" } } }, "v1alpha1.LogTailerSpec": { "type": "object", "properties": { "limits": { "description": "Limits describes the maximum amount of compute resources allowed.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/\n+optional", "$ref": "#/definitions/v1.ResourceList" }, "requests": { "description": "Requests describes the minimum amount of compute resources required.\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\notherwise to an implementation-defined value.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/\n+optional", "$ref": "#/definitions/v1.ResourceList" } } }, "v1alpha1.PDConfigWraper": { "type": "object", "properties": { "mp": { "description": "Export this field to make \"apiequality.Semantic.DeepEqual\" happy now.\nUser of GenericConfig should not directly access this field.", "type": "object", "additionalProperties": true } } }, "v1alpha1.PDSpec": { "type": "object", "properties": { "additionalContainers": { "description": "Additional containers of the component.\n+optional", "type": "array", "items": { "$ref": "#/definitions/v1.Container" } }, "additionalVolumeMounts": { "description": "Additional volume mounts of component pod.", "type": "array", "items": { "$ref": "#/definitions/v1.VolumeMount" } }, "additionalVolumes": { "description": "Additional volumes of component pod.\n+optional", "type": "array", "items": { "$ref": "#/definitions/v1.Volume" } }, "affinity": { "description": "Affinity of the component. Override the cluster-level setting if present.\nOptional: Defaults to cluster-level setting\n+optional", "$ref": "#/definitions/v1.Affinity" }, "annotations": { "description": "Annotations for the component. Merge into the cluster-level annotations if non-empty\nOptional: Defaults to cluster-level setting\n+optional", "type": "object", "additionalProperties": { "type": "string" } }, "baseImage": { "description": "Base image of the component, image tag is now allowed during validation\n+kubebuilder:default=pingcap/pd\n+optional", "type": "string" }, "config": { "description": "Config is the Configuration of pd-servers\n+optional", "$ref": "#/definitions/v1alpha1.PDConfigWraper" }, "configUpdateStrategy": { "description": "ConfigUpdateStrategy of the component. Override the cluster-level updateStrategy if present\nOptional: Defaults to cluster-level setting\n+optional", "type": "string" }, "dataSubDir": { "description": "Subdirectory within the volume to store PD Data. By default, the data\nis stored in the root directory of volume which is mounted at\n/var/lib/pd.\nSpecifying this will change the data directory to a subdirectory, e.g.\n/var/lib/pd/data if you set the value to \"data\".\nIt's dangerous to change this value for a running cluster as it will\nupgrade your cluster to use a new storage directory.\nDefaults to \"\" (volume's root).\n+optional", "type": "string" }, "enableDashboardInternalProxy": { "description": "(Deprecated) EnableDashboardInternalProxy would directly set `internal-proxy` in the `PdConfig`.\nNote that this is deprecated, we should just set `dashboard.internal-proxy` in `pd.config`.\n+optional", "type": "boolean" }, "env": { "description": "List of environment variables to set in the container, like v1.Container.Env.\nNote that the following env names cannot be used and will be overridden by TiDB Operator builtin envs\n- NAMESPACE\n- TZ\n- SERVICE_NAME\n- PEER_SERVICE_NAME\n- HEADLESS_SERVICE_NAME\n- SET_NAME\n- HOSTNAME\n- CLUSTER_NAME\n- POD_NAME\n- BINLOG_ENABLED\n- SLOW_LOG_FILE\n+optional", "type": "array", "items": { "$ref": "#/definitions/v1.EnvVar" } }, "hostNetwork": { "description": "Whether Hostnetwork of the component is enabled. Override the cluster-level setting if present\nOptional: Defaults to cluster-level setting\n+optional", "type": "boolean" }, "image": { "description": "(Deprecated) Image of the component\nUse `baseImage` and `version` instead\n+k8s:openapi-gen=false", "type": "string" }, "imagePullPolicy": { "description": "ImagePullPolicy of the component. Override the cluster-level imagePullPolicy if present\nOptional: Defaults to cluster-level setting\n+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.\n+optional", "type": "array", "items": { "$ref": "#/definitions/v1.LocalObjectReference" } }, "initContainers": { "description": "Init containers of the components\n+optional", "type": "array", "items": { "$ref": "#/definitions/v1.Container" } }, "labels": { "description": "Labels for the component. Merge into the cluster-level labels if non-empty\nOptional: Defaults to cluster-level setting\n+optional", "type": "object", "additionalProperties": { "type": "string" } }, "limits": { "description": "Limits describes the maximum amount of compute resources allowed.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/\n+optional", "$ref": "#/definitions/v1.ResourceList" }, "maxFailoverCount": { "description": "MaxFailoverCount limit the max replicas could be added in failover, 0 means no failover.\nOptional: Defaults to 3\n+kubebuilder:validation:Minimum=0\n+optional", "type": "integer" }, "mountClusterClientSecret": { "description": "MountClusterClientSecret indicates whether to mount `cluster-client-secret` to the Pod\n+optional", "type": "boolean" }, "nodeSelector": { "description": "NodeSelector of the component. Merged into the cluster-level nodeSelector if non-empty\nOptional: Defaults to cluster-level setting\n+optional", "type": "object", "additionalProperties": { "type": "string" } }, "podSecurityContext": { "description": "PodSecurityContext of the component\n+optional", "$ref": "#/definitions/v1.PodSecurityContext" }, "priorityClassName": { "description": "PriorityClassName of the component. Override the cluster-level one if present\nOptional: Defaults to cluster-level setting\n+optional", "type": "string" }, "replicas": { "description": "The desired ready replicas\n+kubebuilder:validation:Minimum=1", "type": "integer" }, "requests": { "description": "Requests describes the minimum amount of compute resources required.\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\notherwise to an implementation-defined value.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/\n+optional", "$ref": "#/definitions/v1.ResourceList" }, "schedulerName": { "description": "SchedulerName of the component. Override the cluster-level one if present\nOptional: Defaults to cluster-level setting\n+optional", "type": "string" }, "service": { "description": "Service defines a Kubernetes service of PD cluster.\nOptional: Defaults to `.spec.services` in favor of backward compatibility\n+optional", "$ref": "#/definitions/v1alpha1.ServiceSpec" }, "serviceAccount": { "description": "Specify a Service Account for pd", "type": "string" }, "statefulSetUpdateStrategy": { "description": "StatefulSetUpdateStrategy indicates the StatefulSetUpdateStrategy that will be\nemployed to update Pods in the StatefulSet when a revision is made to\nTemplate.\n+optional", "type": "string" }, "storageClassName": { "description": "The storageClassName of the persistent volume for PD data storage.\nDefaults to Kubernetes default storage class.\n+optional", "type": "string" }, "storageVolumes": { "description": "StorageVolumes configure additional storage for PD pods.\n+optional", "type": "array", "items": { "$ref": "#/definitions/v1alpha1.StorageVolume" } }, "terminationGracePeriodSeconds": { "description": "Optional duration in seconds the pod needs to terminate gracefully. May be decreased in delete request.\nValue must be non-negative integer. The value zero indicates delete immediately.\nIf this value is nil, the default grace period will be used instead.\nThe grace period is the duration in seconds after the processes running in the pod are sent\na termination signal and the time when the processes are forcibly halted with a kill signal.\nSet this value longer than the expected cleanup time for your process.\nDefaults to 30 seconds.\n+optional", "type": "integer" }, "tlsClientSecretName": { "description": "TLSClientSecretName is the name of secret which stores tidb server client certificate\nwhich used by Dashboard.\n+optional", "type": "string" }, "tolerations": { "description": "Tolerations of the component. Override the cluster-level tolerations if non-empty\nOptional: Defaults to cluster-level setting\n+optional", "type": "array", "items": { "$ref": "#/definitions/v1.Toleration" } }, "topologySpreadConstraints": { "description": "TopologySpreadConstraints describes how a group of pods ought to spread across topology\ndomains. Scheduler will schedule pods in a way which abides by the constraints.\nThis field is is only honored by clusters that enables the EvenPodsSpread feature.\nAll topologySpreadConstraints are ANDed.\n+optional\n+listType=map\n+listMapKey=topologyKey", "type": "array", "items": { "$ref": "#/definitions/v1alpha1.TopologySpreadConstraint" } }, "version": { "description": "Version of the component. Override the cluster-level version if non-empty\nOptional: Defaults to cluster-level setting\n+optional", "type": "string" } } }, "v1alpha1.PumpSpec": { "type": "object", "properties": { "additionalContainers": { "description": "Additional containers of the component.\n+optional", "type": "array", "items": { "$ref": "#/definitions/v1.Container" } }, "additionalVolumeMounts": { "description": "Additional volume mounts of component pod.", "type": "array", "items": { "$ref": "#/definitions/v1.VolumeMount" } }, "additionalVolumes": { "description": "Additional volumes of component pod.\n+optional", "type": "array", "items": { "$ref": "#/definitions/v1.Volume" } }, "affinity": { "description": "Affinity of the component. Override the cluster-level setting if present.\nOptional: Defaults to cluster-level setting\n+optional", "$ref": "#/definitions/v1.Affinity" }, "annotations": { "description": "Annotations for the component. Merge into the cluster-level annotations if non-empty\nOptional: Defaults to cluster-level setting\n+optional", "type": "object", "additionalProperties": { "type": "string" } }, "baseImage": { "description": "Base image of the component, image tag is now allowed during validation\n+kubebuilder:default=pingcap/tidb-binlog\n+optional", "type": "string" }, "config": { "description": "The configuration of Pump cluster.\n+optional", "$ref": "#/definitions/config.GenericConfig" }, "configUpdateStrategy": { "description": "ConfigUpdateStrategy of the component. Override the cluster-level updateStrategy if present\nOptional: Defaults to cluster-level setting\n+optional", "type": "string" }, "env": { "description": "List of environment variables to set in the container, like v1.Container.Env.\nNote that the following env names cannot be used and will be overridden by TiDB Operator builtin envs\n- NAMESPACE\n- TZ\n- SERVICE_NAME\n- PEER_SERVICE_NAME\n- HEADLESS_SERVICE_NAME\n- SET_NAME\n- HOSTNAME\n- CLUSTER_NAME\n- POD_NAME\n- BINLOG_ENABLED\n- SLOW_LOG_FILE\n+optional", "type": "array", "items": { "$ref": "#/definitions/v1.EnvVar" } }, "hostNetwork": { "description": "Whether Hostnetwork of the component is enabled. Override the cluster-level setting if present\nOptional: Defaults to cluster-level setting\n+optional", "type": "boolean" }, "image": { "description": "(Deprecated) Image of the component\nUse `baseImage` and `version` instead\n+k8s:openapi-gen=false", "type": "string" }, "imagePullPolicy": { "description": "ImagePullPolicy of the component. Override the cluster-level imagePullPolicy if present\nOptional: Defaults to cluster-level setting\n+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.\n+optional", "type": "array", "items": { "$ref": "#/definitions/v1.LocalObjectReference" } }, "initContainers": { "description": "Init containers of the components\n+optional", "type": "array", "items": { "$ref": "#/definitions/v1.Container" } }, "labels": { "description": "Labels for the component. Merge into the cluster-level labels if non-empty\nOptional: Defaults to cluster-level setting\n+optional", "type": "object", "additionalProperties": { "type": "string" } }, "limits": { "description": "Limits describes the maximum amount of compute resources allowed.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/\n+optional", "$ref": "#/definitions/v1.ResourceList" }, "nodeSelector": { "description": "NodeSelector of the component. Merged into the cluster-level nodeSelector if non-empty\nOptional: Defaults to cluster-level setting\n+optional", "type": "object", "additionalProperties": { "type": "string" } }, "podSecurityContext": { "description": "PodSecurityContext of the component\n+optional", "$ref": "#/definitions/v1.PodSecurityContext" }, "priorityClassName": { "description": "PriorityClassName of the component. Override the cluster-level one if present\nOptional: Defaults to cluster-level setting\n+optional", "type": "string" }, "replicas": { "description": "The desired ready replicas\n+kubebuilder:validation:Minimum=0", "type": "integer" }, "requests": { "description": "Requests describes the minimum amount of compute resources required.\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\notherwise to an implementation-defined value.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/\n+optional", "$ref": "#/definitions/v1.ResourceList" }, "schedulerName": { "description": "SchedulerName of the component. Override the cluster-level one if present\nOptional: Defaults to cluster-level setting\n+optional", "type": "string" }, "serviceAccount": { "description": "Specify a Service Account for pump", "type": "string" }, "setTimeZone": { "description": "+k8s:openapi-gen=false\nFor backward compatibility with helm chart", "type": "boolean" }, "statefulSetUpdateStrategy": { "description": "StatefulSetUpdateStrategy indicates the StatefulSetUpdateStrategy that will be\nemployed to update Pods in the StatefulSet when a revision is made to\nTemplate.\n+optional", "type": "string" }, "storageClassName": { "description": "The storageClassName of the persistent volume for Pump data storage.\nDefaults to Kubernetes default storage class.\n+optional", "type": "string" }, "terminationGracePeriodSeconds": { "description": "Optional duration in seconds the pod needs to terminate gracefully. May be decreased in delete request.\nValue must be non-negative integer. The value zero indicates delete immediately.\nIf this value is nil, the default grace period will be used instead.\nThe grace period is the duration in seconds after the processes running in the pod are sent\na termination signal and the time when the processes are forcibly halted with a kill signal.\nSet this value longer than the expected cleanup time for your process.\nDefaults to 30 seconds.\n+optional", "type": "integer" }, "tolerations": { "description": "Tolerations of the component. Override the cluster-level tolerations if non-empty\nOptional: Defaults to cluster-level setting\n+optional", "type": "array", "items": { "$ref": "#/definitions/v1.Toleration" } }, "topologySpreadConstraints": { "description": "TopologySpreadConstraints describes how a group of pods ought to spread across topology\ndomains. Scheduler will schedule pods in a way which abides by the constraints.\nThis field is is only honored by clusters that enables the EvenPodsSpread feature.\nAll topologySpreadConstraints are ANDed.\n+optional\n+listType=map\n+listMapKey=topologyKey", "type": "array", "items": { "$ref": "#/definitions/v1alpha1.TopologySpreadConstraint" } }, "version": { "description": "Version of the component. Override the cluster-level version if non-empty\nOptional: Defaults to cluster-level setting\n+optional", "type": "string" } } }, "v1alpha1.Service": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string" } } }, "v1alpha1.ServiceSpec": { "type": "object", "properties": { "annotations": { "description": "Additional annotations for the service\n+optional", "type": "object", "additionalProperties": { "type": "string" } }, "clusterIP": { "description": "ClusterIP is the clusterIP of service\n+optional", "type": "string" }, "labels": { "description": "Additional labels for the service\n+optional", "type": "object", "additionalProperties": { "type": "string" } }, "loadBalancerIP": { "description": "LoadBalancerIP is the loadBalancerIP of service\nOptional: Defaults to omitted\n+optional", "type": "string" }, "loadBalancerSourceRanges": { "description": "LoadBalancerSourceRanges is the loadBalancerSourceRanges of service\nIf specified and supported by the platform, this will restrict traffic through the cloud-provider\nload-balancer will be restricted to the specified client IPs. This field will be ignored if the\ncloud-provider does not support the feature.\"\nMore info: https://kubernetes.io/docs/concepts/services-networking/service/#aws-nlb-support\nOptional: Defaults to omitted\n+optional", "type": "array", "items": { "type": "string" } }, "portName": { "description": "PortName is the name of service port\n+optional", "type": "string" }, "type": { "description": "Type of the real kubernetes service", "type": "string" } } }, "v1alpha1.StorageClaim": { "type": "object", "properties": { "resources": { "description": "Resources represents the minimum resources the volume should have.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources\n+optional", "$ref": "#/definitions/v1.ResourceRequirements" }, "storageClassName": { "description": "Name of the StorageClass required by the claim.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1\n+optional", "type": "string" } } }, "v1alpha1.StorageVolume": { "type": "object", "properties": { "mountPath": { "type": "string" }, "name": { "type": "string" }, "storageClassName": { "type": "string" }, "storageSize": { "type": "string" } } }, "v1alpha1.TLSCluster": { "type": "object", "properties": { "enabled": { "description": "Enable mutual TLS connection between TiDB cluster components\nOnce enabled, the mutual authentication applies to all components,\nand it does not support applying to only part of the components.\nThe steps to enable this feature:\n 1. Generate TiDB cluster components certificates and a client-side certifiacete for them.\n There are multiple ways to generate these certificates:\n - user-provided certificates: https://pingcap.com/docs/stable/how-to/secure/generate-self-signed-certificates/\n - use the K8s built-in certificate signing system signed certificates: https://kubernetes.io/docs/tasks/tls/managing-tls-in-a-cluster/\n - or use cert-manager signed certificates: https://cert-manager.io/\n 2. Create one secret object for one component which contains the certificates created above.\n The name of this Secret must be: \u003cclusterName\u003e-\u003ccomponentName\u003e-cluster-secret.\n For PD: kubectl create secret generic \u003cclusterName\u003e-pd-cluster-secret --namespace=\u003cnamespace\u003e --from-file=tls.crt=\u003cpath/to/tls.crt\u003e --from-file=tls.key=\u003cpath/to/tls.key\u003e --from-file=ca.crt=\u003cpath/to/ca.crt\u003e\n For TiKV: kubectl create secret generic \u003cclusterName\u003e-tikv-cluster-secret --namespace=\u003cnamespace\u003e --from-file=tls.crt=\u003cpath/to/tls.crt\u003e --from-file=tls.key=\u003cpath/to/tls.key\u003e --from-file=ca.crt=\u003cpath/to/ca.crt\u003e\n For TiDB: kubectl create secret generic \u003cclusterName\u003e-tidb-cluster-secret --namespace=\u003cnamespace\u003e --from-file=tls.crt=\u003cpath/to/tls.crt\u003e --from-file=tls.key=\u003cpath/to/tls.key\u003e --from-file=ca.crt=\u003cpath/to/ca.crt\u003e\n For Client: kubectl create secret generic \u003cclusterName\u003e-cluster-client-secret --namespace=\u003cnamespace\u003e --from-file=tls.crt=\u003cpath/to/tls.crt\u003e --from-file=tls.key=\u003cpath/to/tls.key\u003e --from-file=ca.crt=\u003cpath/to/ca.crt\u003e\n Same for other components.\n+optional", "type": "boolean" } } }, "v1alpha1.TiCDCSpec": { "type": "object", "properties": { "additionalContainers": { "description": "Additional containers of the component.\n+optional", "type": "array", "items": { "$ref": "#/definitions/v1.Container" } }, "additionalVolumeMounts": { "description": "Additional volume mounts of component pod.", "type": "array", "items": { "$ref": "#/definitions/v1.VolumeMount" } }, "additionalVolumes": { "description": "Additional volumes of component pod.\n+optional", "type": "array", "items": { "$ref": "#/definitions/v1.Volume" } }, "affinity": { "description": "Affinity of the component. Override the cluster-level setting if present.\nOptional: Defaults to cluster-level setting\n+optional", "$ref": "#/definitions/v1.Affinity" }, "annotations": { "description": "Annotations for the component. Merge into the cluster-level annotations if non-empty\nOptional: Defaults to cluster-level setting\n+optional", "type": "object", "additionalProperties": { "type": "string" } }, "baseImage": { "description": "Base image of the component, image tag is now allowed during validation\n+kubebuilder:default=pingcap/ticdc\n+optional", "type": "string" }, "config": { "description": "Config is the Configuration of tidbcdc servers\n+optional", "$ref": "#/definitions/v1alpha1.CDCConfigWraper" }, "configUpdateStrategy": { "description": "ConfigUpdateStrategy of the component. Override the cluster-level updateStrategy if present\nOptional: Defaults to cluster-level setting\n+optional", "type": "string" }, "env": { "description": "List of environment variables to set in the container, like v1.Container.Env.\nNote that the following env names cannot be used and will be overridden by TiDB Operator builtin envs\n- NAMESPACE\n- TZ\n- SERVICE_NAME\n- PEER_SERVICE_NAME\n- HEADLESS_SERVICE_NAME\n- SET_NAME\n- HOSTNAME\n- CLUSTER_NAME\n- POD_NAME\n- BINLOG_ENABLED\n- SLOW_LOG_FILE\n+optional", "type": "array", "items": { "$ref": "#/definitions/v1.EnvVar" } }, "hostNetwork": { "description": "Whether Hostnetwork of the component is enabled. Override the cluster-level setting if present\nOptional: Defaults to cluster-level setting\n+optional", "type": "boolean" }, "image": { "description": "(Deprecated) Image of the component\nUse `baseImage` and `version` instead\n+k8s:openapi-gen=false", "type": "string" }, "imagePullPolicy": { "description": "ImagePullPolicy of the component. Override the cluster-level imagePullPolicy if present\nOptional: Defaults to cluster-level setting\n+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.\n+optional", "type": "array", "items": { "$ref": "#/definitions/v1.LocalObjectReference" } }, "initContainers": { "description": "Init containers of the components\n+optional", "type": "array", "items": { "$ref": "#/definitions/v1.Container" } }, "labels": { "description": "Labels for the component. Merge into the cluster-level labels if non-empty\nOptional: Defaults to cluster-level setting\n+optional", "type": "object", "additionalProperties": { "type": "string" } }, "limits": { "description": "Limits describes the maximum amount of compute resources allowed.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/\n+optional", "$ref": "#/definitions/v1.ResourceList" }, "nodeSelector": { "description": "NodeSelector of the component. Merged into the cluster-level nodeSelector if non-empty\nOptional: Defaults to cluster-level setting\n+optional", "type": "object", "additionalProperties": { "type": "string" } }, "podSecurityContext": { "description": "PodSecurityContext of the component\n+optional", "$ref": "#/definitions/v1.PodSecurityContext" }, "priorityClassName": { "description": "PriorityClassName of the component. Override the cluster-level one if present\nOptional: Defaults to cluster-level setting\n+optional", "type": "string" }, "replicas": { "description": "The desired ready replicas\n+kubebuilder:validation:Minimum=1", "type": "integer" }, "requests": { "description": "Requests describes the minimum amount of compute resources required.\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\notherwise to an implementation-defined value.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/\n+optional", "$ref": "#/definitions/v1.ResourceList" }, "schedulerName": { "description": "SchedulerName of the component. Override the cluster-level one if present\nOptional: Defaults to cluster-level setting\n+optional", "type": "string" }, "serviceAccount": { "description": "Specify a Service Account for TiCDC", "type": "string" }, "statefulSetUpdateStrategy": { "description": "StatefulSetUpdateStrategy indicates the StatefulSetUpdateStrategy that will be\nemployed to update Pods in the StatefulSet when a revision is made to\nTemplate.\n+optional", "type": "string" }, "storageClassName": { "description": "The storageClassName of the persistent volume for TiCDC data storage.\nDefaults to Kubernetes default storage class.\n+optional", "type": "string" }, "storageVolumes": { "description": "StorageVolumes configure additional storage for TiCDC pods.\n+optional", "type": "array", "items": { "$ref": "#/definitions/v1alpha1.StorageVolume" } }, "terminationGracePeriodSeconds": { "description": "Optional duration in seconds the pod needs to terminate gracefully. May be decreased in delete request.\nValue must be non-negative integer. The value zero indicates delete immediately.\nIf this value is nil, the default grace period will be used instead.\nThe grace period is the duration in seconds after the processes running in the pod are sent\na termination signal and the time when the processes are forcibly halted with a kill signal.\nSet this value longer than the expected cleanup time for your process.\nDefaults to 30 seconds.\n+optional", "type": "integer" }, "tlsClientSecretNames": { "description": "TLSClientSecretNames are the names of secrets that store the\nclient certificates for the downstream.\n+optional", "type": "array", "items": { "type": "string" } }, "tolerations": { "description": "Tolerations of the component. Override the cluster-level tolerations if non-empty\nOptional: Defaults to cluster-level setting\n+optional", "type": "array", "items": { "$ref": "#/definitions/v1.Toleration" } }, "topologySpreadConstraints": { "description": "TopologySpreadConstraints describes how a group of pods ought to spread across topology\ndomains. Scheduler will schedule pods in a way which abides by the constraints.\nThis field is is only honored by clusters that enables the EvenPodsSpread feature.\nAll topologySpreadConstraints are ANDed.\n+optional\n+listType=map\n+listMapKey=topologyKey", "type": "array", "items": { "$ref": "#/definitions/v1alpha1.TopologySpreadConstraint" } }, "version": { "description": "Version of the component. Override the cluster-level version if non-empty\nOptional: Defaults to cluster-level setting\n+optional", "type": "string" } } }, "v1alpha1.TiDBConfigWraper": { "type": "object", "properties": { "mp": { "description": "Export this field to make \"apiequality.Semantic.DeepEqual\" happy now.\nUser of GenericConfig should not directly access this field.", "type": "object", "additionalProperties": true } } }, "v1alpha1.TiDBProbe": { "type": "object", "properties": { "type": { "description": "\"tcp\" will use TCP socket to connetct port 4000\n\n\"command\" will probe the status api of tidb.\nThis will use curl command to request tidb, before v4.0.9 there is no curl in the image,\nSo do not use this before v4.0.9.\n+kubebuilder:validation:Enum=tcp,command\n+optional", "type": "string" } } }, "v1alpha1.TiDBServiceSpec": { "type": "object", "properties": { "additionalPorts": { "description": "Expose additional ports for TiDB\nOptional: Defaults to omitted\n+optional", "type": "array", "items": { "$ref": "#/definitions/v1.ServicePort" } }, "annotations": { "description": "Additional annotations for the service\n+optional", "type": "object", "additionalProperties": { "type": "string" } }, "clusterIP": { "description": "ClusterIP is the clusterIP of service\n+optional", "type": "string" }, "exposeStatus": { "description": "Whether expose the status port\nOptional: Defaults to true\n+optional", "type": "boolean" }, "externalTrafficPolicy": { "description": "ExternalTrafficPolicy of the service\nOptional: Defaults to omitted\n+optional", "type": "string" }, "labels": { "description": "Additional labels for the service\n+optional", "type": "object", "additionalProperties": { "type": "string" } }, "loadBalancerIP": { "description": "LoadBalancerIP is the loadBalancerIP of service\nOptional: Defaults to omitted\n+optional", "type": "string" }, "loadBalancerSourceRanges": { "description": "LoadBalancerSourceRanges is the loadBalancerSourceRanges of service\nIf specified and supported by the platform, this will restrict traffic through the cloud-provider\nload-balancer will be restricted to the specified client IPs. This field will be ignored if the\ncloud-provider does not support the feature.\"\nMore info: https://kubernetes.io/docs/concepts/services-networking/service/#aws-nlb-support\nOptional: Defaults to omitted\n+optional", "type": "array", "items": { "type": "string" } }, "mysqlNodePort": { "description": "Expose the tidb cluster mysql port to MySQLNodePort\nOptional: Defaults to 0\n+optional", "type": "integer" }, "portName": { "description": "PortName is the name of service port\n+optional", "type": "string" }, "statusNodePort": { "description": "Expose the tidb status node port to StatusNodePort\nOptional: Defaults to 0\n+optional", "type": "integer" }, "type": { "description": "Type of the real kubernetes service", "type": "string" } } }, "v1alpha1.TiDBSlowLogTailerSpec": { "type": "object", "properties": { "image": { "description": "(Deprecated) Image used for slowlog tailer.\nUse `spec.helper.image` instead\n+k8s:openapi-gen=false", "type": "string" }, "imagePullPolicy": { "description": "(Deprecated) ImagePullPolicy of the component. Override the cluster-level imagePullPolicy if present\nUse `spec.helper.imagePullPolicy` instead\n+k8s:openapi-gen=false", "type": "string" }, "limits": { "description": "Limits describes the maximum amount of compute resources allowed.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/\n+optional", "$ref": "#/definitions/v1.ResourceList" }, "requests": { "description": "Requests describes the minimum amount of compute resources required.\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\notherwise to an implementation-defined value.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/\n+optional", "$ref": "#/definitions/v1.ResourceList" } } }, "v1alpha1.TiDBSpec": { "type": "object", "properties": { "additionalContainers": { "description": "Additional containers of the component.\n+optional", "type": "array", "items": { "$ref": "#/definitions/v1.Container" } }, "additionalVolumeMounts": { "description": "Additional volume mounts of component pod.", "type": "array", "items": { "$ref": "#/definitions/v1.VolumeMount" } }, "additionalVolumes": { "description": "Additional volumes of component pod.\n+optional", "type": "array", "items": { "$ref": "#/definitions/v1.Volume" } }, "affinity": { "description": "Affinity of the component. Override the cluster-level setting if present.\nOptional: Defaults to cluster-level setting\n+optional", "$ref": "#/definitions/v1.Affinity" }, "annotations": { "description": "Annotations for the component. Merge into the cluster-level annotations if non-empty\nOptional: Defaults to cluster-level setting\n+optional", "type": "object", "additionalProperties": { "type": "string" } }, "baseImage": { "description": "Base image of the component, image tag is now allowed during validation\n+kubebuilder:default=pingcap/tidb\n+optional", "type": "string" }, "binlogEnabled": { "description": "Whether enable TiDB Binlog, it is encouraged to not set this field and rely on the default behavior\nOptional: Defaults to true if PumpSpec is non-nil, otherwise false\n+optional", "type": "boolean" }, "config": { "description": "Config is the Configuration of tidb-servers\n+optional", "$ref": "#/definitions/v1alpha1.TiDBConfigWraper" }, "configUpdateStrategy": { "description": "ConfigUpdateStrategy of the component. Override the cluster-level updateStrategy if present\nOptional: Defaults to cluster-level setting\n+optional", "type": "string" }, "env": { "description": "List of environment variables to set in the container, like v1.Container.Env.\nNote that the following env names cannot be used and will be overridden by TiDB Operator builtin envs\n- NAMESPACE\n- TZ\n- SERVICE_NAME\n- PEER_SERVICE_NAME\n- HEADLESS_SERVICE_NAME\n- SET_NAME\n- HOSTNAME\n- CLUSTER_NAME\n- POD_NAME\n- BINLOG_ENABLED\n- SLOW_LOG_FILE\n+optional", "type": "array", "items": { "$ref": "#/definitions/v1.EnvVar" } }, "hostNetwork": { "description": "Whether Hostnetwork of the component is enabled. Override the cluster-level setting if present\nOptional: Defaults to cluster-level setting\n+optional", "type": "boolean" }, "image": { "description": "(Deprecated) Image of the component\nUse `baseImage` and `version` instead\n+k8s:openapi-gen=false", "type": "string" }, "imagePullPolicy": { "description": "ImagePullPolicy of the component. Override the cluster-level imagePullPolicy if present\nOptional: Defaults to cluster-level setting\n+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.\n+optional", "type": "array", "items": { "$ref": "#/definitions/v1.LocalObjectReference" } }, "initContainers": { "description": "Init containers of the components\n+optional", "type": "array", "items": { "$ref": "#/definitions/v1.Container" } }, "labels": { "description": "Labels for the component. Merge into the cluster-level labels if non-empty\nOptional: Defaults to cluster-level setting\n+optional", "type": "object", "additionalProperties": { "type": "string" } }, "lifecycle": { "description": "Lifecycle describes actions that the management system should take in response to container lifecycle\nevents. For the PostStart and PreStop lifecycle handlers, management of the container blocks\nuntil the action is complete, unless the container process fails, in which case the handler is aborted.\n+optional", "$ref": "#/definitions/v1.Lifecycle" }, "limits": { "description": "Limits describes the maximum amount of compute resources allowed.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/\n+optional", "$ref": "#/definitions/v1.ResourceList" }, "maxFailoverCount": { "description": "MaxFailoverCount limit the max replicas could be added in failover, 0 means no failover\nOptional: Defaults to 3\n+kubebuilder:validation:Minimum=0\n+optional", "type": "integer" }, "nodeSelector": { "description": "NodeSelector of the component. Merged into the cluster-level nodeSelector if non-empty\nOptional: Defaults to cluster-level setting\n+optional", "type": "object", "additionalProperties": { "type": "string" } }, "plugins": { "description": "Plugins is a list of plugins that are loaded by TiDB server, empty means plugin disabled\n+optional", "type": "array", "items": { "type": "string" } }, "podSecurityContext": { "description": "PodSecurityContext of the component\n+optional", "$ref": "#/definitions/v1.PodSecurityContext" }, "priorityClassName": { "description": "PriorityClassName of the component. Override the cluster-level one if present\nOptional: Defaults to cluster-level setting\n+optional", "type": "string" }, "readinessProbe": { "description": "ReadinessProbe describes actions that probe the tidb's readiness.\nthe default behavior is like setting type as \"tcp\"\n+optional", "$ref": "#/definitions/v1alpha1.TiDBProbe" }, "replicas": { "description": "The desired ready replicas\n+kubebuilder:validation:Minimum=0", "type": "integer" }, "requests": { "description": "Requests describes the minimum amount of compute resources required.\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\notherwise to an implementation-defined value.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/\n+optional", "$ref": "#/definitions/v1.ResourceList" }, "schedulerName": { "description": "SchedulerName of the component. Override the cluster-level one if present\nOptional: Defaults to cluster-level setting\n+optional", "type": "string" }, "separateSlowLog": { "description": "Whether output the slow log in an separate sidecar container\nOptional: Defaults to true\n+optional", "type": "boolean" }, "service": { "description": "Service defines a Kubernetes service of TiDB cluster.\nOptional: No kubernetes service will be created by default.\n+optional", "$ref": "#/definitions/v1alpha1.TiDBServiceSpec" }, "serviceAccount": { "description": "Specify a Service Account for tidb", "type": "string" }, "slowLogTailer": { "description": "The specification of the slow log tailer sidecar\n+optional", "$ref": "#/definitions/v1alpha1.TiDBSlowLogTailerSpec" }, "slowLogVolumeName": { "description": "Optional volume name configuration for slow query log.\n+optional", "type": "string" }, "statefulSetUpdateStrategy": { "description": "StatefulSetUpdateStrategy indicates the StatefulSetUpdateStrategy that will be\nemployed to update Pods in the StatefulSet when a revision is made to\nTemplate.\n+optional", "type": "string" }, "storageClassName": { "description": "The storageClassName of the persistent volume for TiDB data storage.\nDefaults to Kubernetes default storage class.\n+optional", "type": "string" }, "storageVolumes": { "description": "StorageVolumes configure additional storage for TiDB pods.\n+optional", "type": "array", "items": { "$ref": "#/definitions/v1alpha1.StorageVolume" } }, "terminationGracePeriodSeconds": { "description": "Optional duration in seconds the pod needs to terminate gracefully. May be decreased in delete request.\nValue must be non-negative integer. The value zero indicates delete immediately.\nIf this value is nil, the default grace period will be used instead.\nThe grace period is the duration in seconds after the processes running in the pod are sent\na termination signal and the time when the processes are forcibly halted with a kill signal.\nSet this value longer than the expected cleanup time for your process.\nDefaults to 30 seconds.\n+optional", "type": "integer" }, "tlsClient": { "description": "Whether enable the TLS connection between the SQL client and TiDB server\nOptional: Defaults to nil\n+optional", "$ref": "#/definitions/v1alpha1.TiDBTLSClient" }, "tolerations": { "description": "Tolerations of the component. Override the cluster-level tolerations if non-empty\nOptional: Defaults to cluster-level setting\n+optional", "type": "array", "items": { "$ref": "#/definitions/v1.Toleration" } }, "topologySpreadConstraints": { "description": "TopologySpreadConstraints describes how a group of pods ought to spread across topology\ndomains. Scheduler will schedule pods in a way which abides by the constraints.\nThis field is is only honored by clusters that enables the EvenPodsSpread feature.\nAll topologySpreadConstraints are ANDed.\n+optional\n+listType=map\n+listMapKey=topologyKey", "type": "array", "items": { "$ref": "#/definitions/v1alpha1.TopologySpreadConstraint" } }, "version": { "description": "Version of the component. Override the cluster-level version if non-empty\nOptional: Defaults to cluster-level setting\n+optional", "type": "string" } } }, "v1alpha1.TiDBTLSClient": { "type": "object", "properties": { "enabled": { "description": "When enabled, TiDB will accept TLS encrypted connections from MySQL client\nThe steps to enable this feature:\n 1. Generate a TiDB server-side certificate and a client-side certifiacete for the TiDB cluster.\n There are multiple ways to generate certificates:\n - user-provided certificates: https://pingcap.com/docs/stable/how-to/secure/enable-tls-clients/\n - use the K8s built-in certificate signing system signed certificates: https://kubernetes.io/docs/tasks/tls/managing-tls-in-a-cluster/\n - or use cert-manager signed certificates: https://cert-manager.io/\n 2. Create a K8s Secret object which contains the TiDB server-side certificate created above.\n The name of this Secret must be: \u003cclusterName\u003e-tidb-server-secret.\n kubectl create secret generic \u003cclusterName\u003e-tidb-server-secret --namespace=\u003cnamespace\u003e --from-file=tls.crt=\u003cpath/to/tls.crt\u003e --from-file=tls.key=\u003cpath/to/tls.key\u003e --from-file=ca.crt=\u003cpath/to/ca.crt\u003e\n 3. Create a K8s Secret object which contains the TiDB client-side certificate created above which will be used by TiDB Operator.\n The name of this Secret must be: \u003cclusterName\u003e-tidb-client-secret.\n kubectl create secret generic \u003cclusterName\u003e-tidb-client-secret --namespace=\u003cnamespace\u003e --from-file=tls.crt=\u003cpath/to/tls.crt\u003e --from-file=tls.key=\u003cpath/to/tls.key\u003e --from-file=ca.crt=\u003cpath/to/ca.crt\u003e\n 4. Set Enabled to `true`.\n+optional", "type": "boolean" } } }, "v1alpha1.TiFlashCommonConfigWraper": { "type": "object", "properties": { "mp": { "description": "Export this field to make \"apiequality.Semantic.DeepEqual\" happy now.\nUser of GenericConfig should not directly access this field.", "type": "object", "additionalProperties": true } } }, "v1alpha1.TiFlashConfigWraper": { "type": "object", "properties": { "config": { "$ref": "#/definitions/v1alpha1.TiFlashCommonConfigWraper" }, "proxy": { "$ref": "#/definitions/v1alpha1.TiFlashProxyConfigWraper" } } }, "v1alpha1.TiFlashProxyConfigWraper": { "type": "object", "properties": { "mp": { "description": "Export this field to make \"apiequality.Semantic.DeepEqual\" happy now.\nUser of GenericConfig should not directly access this field.", "type": "object", "additionalProperties": true } } }, "v1alpha1.TiFlashSpec": { "type": "object", "properties": { "additionalContainers": { "description": "Additional containers of the component.\n+optional", "type": "array", "items": { "$ref": "#/definitions/v1.Container" } }, "additionalVolumeMounts": { "description": "Additional volume mounts of component pod.", "type": "array", "items": { "$ref": "#/definitions/v1.VolumeMount" } }, "additionalVolumes": { "description": "Additional volumes of component pod.\n+optional", "type": "array", "items": { "$ref": "#/definitions/v1.Volume" } }, "affinity": { "description": "Affinity of the component. Override the cluster-level setting if present.\nOptional: Defaults to cluster-level setting\n+optional", "$ref": "#/definitions/v1.Affinity" }, "annotations": { "description": "Annotations for the component. Merge into the cluster-level annotations if non-empty\nOptional: Defaults to cluster-level setting\n+optional", "type": "object", "additionalProperties": { "type": "string" } }, "baseImage": { "description": "Base image of the component, image tag is now allowed during validation\n+kubebuilder:default=pingcap/tiflash\n+optional", "type": "string" }, "config": { "description": "Config is the Configuration of TiFlash\n+optional", "$ref": "#/definitions/v1alpha1.TiFlashConfigWraper" }, "configUpdateStrategy": { "description": "ConfigUpdateStrategy of the component. Override the cluster-level updateStrategy if present\nOptional: Defaults to cluster-level setting\n+optional", "type": "string" }, "env": { "description": "List of environment variables to set in the container, like v1.Container.Env.\nNote that the following env names cannot be used and will be overridden by TiDB Operator builtin envs\n- NAMESPACE\n- TZ\n- SERVICE_NAME\n- PEER_SERVICE_NAME\n- HEADLESS_SERVICE_NAME\n- SET_NAME\n- HOSTNAME\n- CLUSTER_NAME\n- POD_NAME\n- BINLOG_ENABLED\n- SLOW_LOG_FILE\n+optional", "type": "array", "items": { "$ref": "#/definitions/v1.EnvVar" } }, "hostNetwork": { "description": "Whether Hostnetwork of the component is enabled. Override the cluster-level setting if present\nOptional: Defaults to cluster-level setting\n+optional", "type": "boolean" }, "image": { "description": "(Deprecated) Image of the component\nUse `baseImage` and `version` instead\n+k8s:openapi-gen=false", "type": "string" }, "imagePullPolicy": { "description": "ImagePullPolicy of the component. Override the cluster-level imagePullPolicy if present\nOptional: Defaults to cluster-level setting\n+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.\n+optional", "type": "array", "items": { "$ref": "#/definitions/v1.LocalObjectReference" } }, "initContainers": { "description": "Init containers of the components\n+optional", "type": "array", "items": { "$ref": "#/definitions/v1.Container" } }, "labels": { "description": "Labels for the component. Merge into the cluster-level labels if non-empty\nOptional: Defaults to cluster-level setting\n+optional", "type": "object", "additionalProperties": { "type": "string" } }, "limits": { "description": "Limits describes the maximum amount of compute resources allowed.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/\n+optional", "$ref": "#/definitions/v1.ResourceList" }, "logTailer": { "description": "LogTailer is the configurations of the log tailers for TiFlash\n+optional", "$ref": "#/definitions/v1alpha1.LogTailerSpec" }, "maxFailoverCount": { "description": "MaxFailoverCount limit the max replicas could be added in failover, 0 means no failover\nOptional: Defaults to 3\n+kubebuilder:validation:Minimum=0\n+optional", "type": "integer" }, "nodeSelector": { "description": "NodeSelector of the component. Merged into the cluster-level nodeSelector if non-empty\nOptional: Defaults to cluster-level setting\n+optional", "type": "object", "additionalProperties": { "type": "string" } }, "podSecurityContext": { "description": "PodSecurityContext of the component\n+optional", "$ref": "#/definitions/v1.PodSecurityContext" }, "priorityClassName": { "description": "PriorityClassName of the component. Override the cluster-level one if present\nOptional: Defaults to cluster-level setting\n+optional", "type": "string" }, "privileged": { "description": "Whether create the TiFlash container in privileged mode, it is highly discouraged to enable this in\ncritical environment.\nOptional: defaults to false\n+optional", "type": "boolean" }, "recoverFailover": { "description": "RecoverFailover indicates that Operator can recover the failover Pods\n+optional", "type": "boolean" }, "replicas": { "description": "The desired ready replicas\n+kubebuilder:validation:Minimum=1", "type": "integer" }, "requests": { "description": "Requests describes the minimum amount of compute resources required.\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\notherwise to an implementation-defined value.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/\n+optional", "$ref": "#/definitions/v1.ResourceList" }, "schedulerName": { "description": "SchedulerName of the component. Override the cluster-level one if present\nOptional: Defaults to cluster-level setting\n+optional", "type": "string" }, "serviceAccount": { "description": "Specify a Service Account for TiFlash", "type": "string" }, "statefulSetUpdateStrategy": { "description": "StatefulSetUpdateStrategy indicates the StatefulSetUpdateStrategy that will be\nemployed to update Pods in the StatefulSet when a revision is made to\nTemplate.\n+optional", "type": "string" }, "storageClaims": { "description": "The persistent volume claims of the TiFlash data storages.\nTiFlash supports multiple disks.", "type": "array", "items": { "$ref": "#/definitions/v1alpha1.StorageClaim" } }, "terminationGracePeriodSeconds": { "description": "Optional duration in seconds the pod needs to terminate gracefully. May be decreased in delete request.\nValue must be non-negative integer. The value zero indicates delete immediately.\nIf this value is nil, the default grace period will be used instead.\nThe grace period is the duration in seconds after the processes running in the pod are sent\na termination signal and the time when the processes are forcibly halted with a kill signal.\nSet this value longer than the expected cleanup time for your process.\nDefaults to 30 seconds.\n+optional", "type": "integer" }, "tolerations": { "description": "Tolerations of the component. Override the cluster-level tolerations if non-empty\nOptional: Defaults to cluster-level setting\n+optional", "type": "array", "items": { "$ref": "#/definitions/v1.Toleration" } }, "topologySpreadConstraints": { "description": "TopologySpreadConstraints describes how a group of pods ought to spread across topology\ndomains. Scheduler will schedule pods in a way which abides by the constraints.\nThis field is is only honored by clusters that enables the EvenPodsSpread feature.\nAll topologySpreadConstraints are ANDed.\n+optional\n+listType=map\n+listMapKey=topologyKey", "type": "array", "items": { "$ref": "#/definitions/v1alpha1.TopologySpreadConstraint" } }, "version": { "description": "Version of the component. Override the cluster-level version if non-empty\nOptional: Defaults to cluster-level setting\n+optional", "type": "string" } } }, "v1alpha1.TiKVConfigWraper": { "type": "object", "properties": { "mp": { "description": "Export this field to make \"apiequality.Semantic.DeepEqual\" happy now.\nUser of GenericConfig should not directly access this field.", "type": "object", "additionalProperties": true } } }, "v1alpha1.TiKVSpec": { "type": "object", "properties": { "additionalContainers": { "description": "Additional containers of the component.\n+optional", "type": "array", "items": { "$ref": "#/definitions/v1.Container" } }, "additionalVolumeMounts": { "description": "Additional volume mounts of component pod.", "type": "array", "items": { "$ref": "#/definitions/v1.VolumeMount" } }, "additionalVolumes": { "description": "Additional volumes of component pod.\n+optional", "type": "array", "items": { "$ref": "#/definitions/v1.Volume" } }, "affinity": { "description": "Affinity of the component. Override the cluster-level setting if present.\nOptional: Defaults to cluster-level setting\n+optional", "$ref": "#/definitions/v1.Affinity" }, "annotations": { "description": "Annotations for the component. Merge into the cluster-level annotations if non-empty\nOptional: Defaults to cluster-level setting\n+optional", "type": "object", "additionalProperties": { "type": "string" } }, "baseImage": { "description": "Base image of the component, image tag is now allowed during validation\n+kubebuilder:default=pingcap/tikv\n+optional", "type": "string" }, "config": { "description": "Config is the Configuration of tikv-servers\n+optional", "$ref": "#/definitions/v1alpha1.TiKVConfigWraper" }, "configUpdateStrategy": { "description": "ConfigUpdateStrategy of the component. Override the cluster-level updateStrategy if present\nOptional: Defaults to cluster-level setting\n+optional", "type": "string" }, "dataSubDir": { "description": "Subdirectory within the volume to store TiKV Data. By default, the data\nis stored in the root directory of volume which is mounted at\n/var/lib/tikv.\nSpecifying this will change the data directory to a subdirectory, e.g.\n/var/lib/tikv/data if you set the value to \"data\".\nIt's dangerous to change this value for a running cluster as it will\nupgrade your cluster to use a new storage directory.\nDefaults to \"\" (volume's root).\n+optional", "type": "string" }, "enableNamedStatusPort": { "description": "EnableNamedStatusPort enables status port(20180) in the Pod spec.\nIf 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.\nNote that the following env names cannot be used and will be overridden by TiDB Operator builtin envs\n- NAMESPACE\n- TZ\n- SERVICE_NAME\n- PEER_SERVICE_NAME\n- HEADLESS_SERVICE_NAME\n- SET_NAME\n- HOSTNAME\n- CLUSTER_NAME\n- POD_NAME\n- BINLOG_ENABLED\n- SLOW_LOG_FILE\n+optional", "type": "array", "items": { "$ref": "#/definitions/v1.EnvVar" } }, "evictLeaderTimeout": { "description": "EvictLeaderTimeout indicates the timeout to evict tikv leader, in the format of Go Duration.\nDefaults to 10m\n+optional", "type": "string" }, "hostNetwork": { "description": "Whether Hostnetwork of the component is enabled. Override the cluster-level setting if present\nOptional: Defaults to cluster-level setting\n+optional", "type": "boolean" }, "image": { "description": "(Deprecated) Image of the component\nUse `baseImage` and `version` instead\n+k8s:openapi-gen=false", "type": "string" }, "imagePullPolicy": { "description": "ImagePullPolicy of the component. Override the cluster-level imagePullPolicy if present\nOptional: Defaults to cluster-level setting\n+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.\n+optional", "type": "array", "items": { "$ref": "#/definitions/v1.LocalObjectReference" } }, "initContainers": { "description": "Init containers of the components\n+optional", "type": "array", "items": { "$ref": "#/definitions/v1.Container" } }, "labels": { "description": "Labels for the component. Merge into the cluster-level labels if non-empty\nOptional: Defaults to cluster-level setting\n+optional", "type": "object", "additionalProperties": { "type": "string" } }, "limits": { "description": "Limits describes the maximum amount of compute resources allowed.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/\n+optional", "$ref": "#/definitions/v1.ResourceList" }, "logTailer": { "description": "LogTailer is the configurations of the log tailers for TiKV\n+optional", "$ref": "#/definitions/v1alpha1.LogTailerSpec" }, "maxFailoverCount": { "description": "MaxFailoverCount limit the max replicas could be added in failover, 0 means no failover\nOptional: Defaults to 3\n+kubebuilder:validation:Minimum=0\n+optional", "type": "integer" }, "mountClusterClientSecret": { "description": "MountClusterClientSecret indicates whether to mount `cluster-client-secret` to the Pod\n+optional", "type": "boolean" }, "nodeSelector": { "description": "NodeSelector of the component. Merged into the cluster-level nodeSelector if non-empty\nOptional: Defaults to cluster-level setting\n+optional", "type": "object", "additionalProperties": { "type": "string" } }, "podSecurityContext": { "description": "PodSecurityContext of the component\n+optional", "$ref": "#/definitions/v1.PodSecurityContext" }, "priorityClassName": { "description": "PriorityClassName of the component. Override the cluster-level one if present\nOptional: Defaults to cluster-level setting\n+optional", "type": "string" }, "privileged": { "description": "Whether create the TiKV container in privileged mode, it is highly discouraged to enable this in\ncritical environment.\nOptional: defaults to false\n+optional", "type": "boolean" }, "recoverFailover": { "description": "RecoverFailover indicates that Operator can recover the failed Pods\n+optional", "type": "boolean" }, "replicas": { "description": "The desired ready replicas\n+kubebuilder:validation:Minimum=1", "type": "integer" }, "requests": { "description": "Requests describes the minimum amount of compute resources required.\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\notherwise to an implementation-defined value.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/\n+optional", "$ref": "#/definitions/v1.ResourceList" }, "schedulerName": { "description": "SchedulerName of the component. Override the cluster-level one if present\nOptional: Defaults to cluster-level setting\n+optional", "type": "string" }, "separateRaftLog": { "description": "Whether output the Raft log in a separate sidecar container\nOptional: Defaults to false\n+optional", "type": "boolean" }, "separateRocksDBLog": { "description": "Whether output the RocksDB log in a separate sidecar container\nOptional: Defaults to false\n+optional", "type": "boolean" }, "serviceAccount": { "description": "Specify a Service Account for tikv", "type": "string" }, "statefulSetUpdateStrategy": { "description": "StatefulSetUpdateStrategy indicates the StatefulSetUpdateStrategy that will be\nemployed to update Pods in the StatefulSet when a revision is made to\nTemplate.\n+optional", "type": "string" }, "storageClassName": { "description": "The storageClassName of the persistent volume for TiKV data storage.\nDefaults to Kubernetes default storage class.\n+optional", "type": "string" }, "storageVolumes": { "description": "StorageVolumes configure additional storage for TiKV pods.\n+optional", "type": "array", "items": { "$ref": "#/definitions/v1alpha1.StorageVolume" } }, "storeLabels": { "description": "StoreLabels configures additional labels for TiKV stores.\n+optional", "type": "array", "items": { "type": "string" } }, "terminationGracePeriodSeconds": { "description": "Optional duration in seconds the pod needs to terminate gracefully. May be decreased in delete request.\nValue must be non-negative integer. The value zero indicates delete immediately.\nIf this value is nil, the default grace period will be used instead.\nThe grace period is the duration in seconds after the processes running in the pod are sent\na termination signal and the time when the processes are forcibly halted with a kill signal.\nSet this value longer than the expected cleanup time for your process.\nDefaults to 30 seconds.\n+optional", "type": "integer" }, "tolerations": { "description": "Tolerations of the component. Override the cluster-level tolerations if non-empty\nOptional: Defaults to cluster-level setting\n+optional", "type": "array", "items": { "$ref": "#/definitions/v1.Toleration" } }, "topologySpreadConstraints": { "description": "TopologySpreadConstraints describes how a group of pods ought to spread across topology\ndomains. Scheduler will schedule pods in a way which abides by the constraints.\nThis field is is only honored by clusters that enables the EvenPodsSpread feature.\nAll topologySpreadConstraints are ANDed.\n+optional\n+listType=map\n+listMapKey=topologyKey", "type": "array", "items": { "$ref": "#/definitions/v1alpha1.TopologySpreadConstraint" } }, "version": { "description": "Version of the component. Override the cluster-level version if non-empty\nOptional: Defaults to cluster-level setting\n+optional", "type": "string" } } }, "v1alpha1.TidbClusterRef": { "type": "object", "properties": { "clusterDomain": { "description": "ClusterDomain is the domain of TidbCluster object\n+optional", "type": "string" }, "name": { "description": "Name is the name of TidbCluster object", "type": "string" }, "namespace": { "description": "Namespace is the namespace that TidbCluster object locates,\ndefault to the same namespace with TidbMonitor\n+optional", "type": "string" } } }, "v1alpha1.TidbClusterSpec": { "type": "object", "properties": { "affinity": { "description": "Affinity of TiDB cluster Pods.\nWill be overwritten by each cluster component's specific affinity setting, e.g. `spec.tidb.affinity`\n+optional", "$ref": "#/definitions/v1.Affinity" }, "annotations": { "description": "Base annotations for TiDB cluster, all Pods in the cluster should have these annotations.\nCan be overrode by annotations in the specific component spec.\n+optional", "type": "object", "additionalProperties": { "type": "string" } }, "cluster": { "description": "Cluster is the external cluster, if configured, the components in this TidbCluster will join to this configured cluster.\n+optional", "$ref": "#/definitions/v1alpha1.TidbClusterRef" }, "clusterDomain": { "description": "ClusterDomain is the Kubernetes Cluster Domain of TiDB cluster\nOptional: Defaults to \"\"\n+optional", "type": "string" }, "configUpdateStrategy": { "description": "ConfigUpdateStrategy determines how the configuration change is applied to the cluster.\nUpdateStrategyInPlace will update the ConfigMap of configuration in-place and an extra rolling-update of the\ncluster component is needed to reload the configuration change.\nUpdateStrategyRollingUpdate will create a new ConfigMap with the new configuration and rolling-update the\nrelated components to use the new ConfigMap, that is, the new configuration will be applied automatically.\n+kubebuilder:validation:Enum=InPlace,RollingUpdate\n+kubebuilder:default=InPlacne", "type": "string" }, "discovery": { "description": "Discovery spec", "$ref": "#/definitions/v1alpha1.DiscoverySpec" }, "enableDynamicConfiguration": { "description": "EnableDynamicConfiguration indicates whether to append `--advertise-status-addr` to the startup parameters of TiKV.\n+optional", "type": "boolean" }, "enablePVReclaim": { "description": "Whether enable PVC reclaim for orphan PVC left by statefulset scale-in\nOptional: Defaults to false\n+optional", "type": "boolean" }, "helper": { "description": "Helper spec\n+optional", "$ref": "#/definitions/v1alpha1.HelperSpec" }, "hostNetwork": { "description": "Whether Hostnetwork is enabled for TiDB cluster Pods\nOptional: Defaults to false\n+optional", "type": "boolean" }, "imagePullPolicy": { "description": "ImagePullPolicy of TiDB cluster Pods\n+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.\n+optional", "type": "array", "items": { "$ref": "#/definitions/v1.LocalObjectReference" } }, "labels": { "description": "Base labels for TiDB cluster, all Pods in the cluster should have these labels.\nCan be overrode by labels in the specific component spec.\n+optional", "type": "object", "additionalProperties": { "type": "string" } }, "nodeSelector": { "description": "Base node selectors of TiDB cluster Pods, components may add or override selectors upon this respectively\n+optional", "type": "object", "additionalProperties": { "type": "string" } }, "paused": { "description": "Indicates that the tidb cluster is paused and will not be processed by\nthe controller.\n+optional", "type": "boolean" }, "pd": { "description": "PD cluster spec\n+optional", "$ref": "#/definitions/v1alpha1.PDSpec" }, "pdAddresses": { "description": "PDAddresses are the external PD addresses, if configured, the PDs in this TidbCluster will join to the configured PD cluster.\n+optional", "type": "array", "items": { "type": "string" } }, "podSecurityContext": { "description": "PodSecurityContext of the component\n+optional", "$ref": "#/definitions/v1.PodSecurityContext" }, "priorityClassName": { "description": "PriorityClassName of TiDB cluster Pods\nOptional: Defaults to omitted\n+optional", "type": "string" }, "pump": { "description": "Pump cluster spec\n+optional", "$ref": "#/definitions/v1alpha1.PumpSpec" }, "pvReclaimPolicy": { "description": "Persistent volume reclaim policy applied to the PVs that consumed by TiDB cluster\n+kubebuilder:default=Retain", "type": "string" }, "schedulerName": { "description": "SchedulerName of TiDB cluster Pods\n+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\n+k8s:openapi-gen=false", "type": "array", "items": { "$ref": "#/definitions/v1alpha1.Service" } }, "statefulSetUpdateStrategy": { "description": "StatefulSetUpdateStrategy of TiDB cluster StatefulSets\n+optional", "type": "string" }, "ticdc": { "description": "TiCDC cluster spec\n+optional", "$ref": "#/definitions/v1alpha1.TiCDCSpec" }, "tidb": { "description": "TiDB cluster spec\n+optional", "$ref": "#/definitions/v1alpha1.TiDBSpec" }, "tiflash": { "description": "TiFlash cluster spec\n+optional", "$ref": "#/definitions/v1alpha1.TiFlashSpec" }, "tikv": { "description": "TiKV cluster spec\n+optional", "$ref": "#/definitions/v1alpha1.TiKVSpec" }, "timezone": { "description": "Time zone of TiDB cluster Pods\nOptional: Defaults to UTC\n+optional", "type": "string" }, "tlsCluster": { "description": "Whether enable the TLS connection between TiDB server components\nOptional: Defaults to nil\n+optional", "$ref": "#/definitions/v1alpha1.TLSCluster" }, "tolerations": { "description": "Base tolerations of TiDB cluster Pods, components may add more tolerations upon this respectively\n+optional", "type": "array", "items": { "$ref": "#/definitions/v1.Toleration" } }, "topologySpreadConstraints": { "description": "TopologySpreadConstraints describes how a group of pods ought to spread across topology\ndomains. Scheduler will schedule pods in a way which abides by the constraints.\nThis field is is only honored by clusters that enables the EvenPodsSpread feature.\nAll topologySpreadConstraints are ANDed.\n+optional\n+listType=map\n+listMapKey=topologyKey", "type": "array", "items": { "$ref": "#/definitions/v1alpha1.TopologySpreadConstraint" } }, "version": { "description": "TiDB cluster version\n+optional", "type": "string" } } }, "v1alpha1.TopologySpreadConstraint": { "type": "object", "properties": { "topologyKey": { "description": "TopologyKey is the key of node labels. Nodes that have a label with this key\nand identical values are considered to be in the same topology.\nWe consider each \u003ckey, value\u003e as a \"bucket\", and try to put balanced number\nof pods into each bucket.\nMaxSkew is default set to 1\nWhenUnsatisfiable is default set to DoNotSchedule\nLabelSelector is generated by component type\nSee pkg/apis/pingcap/v1alpha1/tidbcluster_component.go#TopologySpreadConstraints()", "type": "string" } } } } }