| false | +|||
| maxConcurrentPods | +integer | +
+ MaxConcurrentPods specifies the maximum number of pods to process concurrently in a rack.
+If not set or set to 0 defaults to 1. + |
+ false |
| restartPolicy | string |
- RestartPolicy indicates the behavior n case of failure. Default is Never. + RestartPolicy indicates the behavior n case of failure. Default is OnFailure. + |
+ false | +
| retries | +integer | +
+ Retries specifies the maximum number of times a failed pod operation can be retried.
+This is only relevant if the RestartPolicy is set to OnFailure. If not set,
+the default value is 1. |
false |
| false | +|||
| fast | +boolean | +
+ Fast modifies the behavior of rolling restart to restart multiple nodes (or entire rack) at the same time.
+If the cluster is degraded in availability, the fast path isn't used + |
+ false | +
| force | +boolean | +
+ Force is used to force the execution of a command even if the operator thinks it is unsafe + |
+ false |
| jobs | integer | @@ -25021,6 +25053,14 @@ More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to The number of pods which reached phase Failed.false | +|
| podStatuses | +map[string]object | +
+ PodStatuses tracks the processing status of each pod for bookkeeping.
+Keys are pod names (not including pod UID to handle recreation scenarios). + |
+ false |
| startTime | string | @@ -25120,6 +25160,72 @@ with respect to the current state of the instance.
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| status | +string | +
+ Status of the pod processing. + |
+ true | +
| completionTime | +string | +
+ Represents time when the pod was completed (success or fail). + + Format: date-time + |
+ false | +
| error | +string | +
+ Error message if failed. + |
+ false | +
| jobId | +string | +
+ JobID for async operations (mgmt-api). + |
+ false | +
| retries | +integer | +
+ Retry count + |
+ false | +
| startTime | +string | +
+ Represents time when the job controller started processing this pod. + + Format: date-time + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| status | +string | +
+ Status of the pod processing. + |
+ true | +
| completionTime | +string | +
+ Represents time when the pod was completed (success or fail). + + Format: date-time + |
+ false | +
| error | +string | +
+ Error message if failed. + |
+ false | +
| jobId | +string | +
+ JobID for async operations (mgmt-api). + |
+ false | +
| retries | +integer | +
+ Retry count + |
+ false | +
| startTime | +string | +
+ Represents time when the job controller started processing this pod. + + Format: date-time + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| status | +string | +
+ Status of the pod processing. + |
+ true | +
| completionTime | +string | +
+ Represents time when the pod was completed (success or fail). + + Format: date-time + |
+ false | +
| error | +string | +
+ Error message if failed. + |
+ false | +
| jobId | +string | +
+ JobID for async operations (mgmt-api). + |
+ false | +
| retries | +integer | +
+ Retry count + |
+ false | +
| startTime | +string | +
+ Represents time when the job controller started processing this pod. + + Format: date-time + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| key | +string | +
+ The key within the env file. An invalid key will prevent the pod from starting.
+The keys defined within a source may consist of any printable ASCII characters except '='.
+During Alpha stage of the EnvFiles feature gate, the key size is limited to 128 characters. + |
+ true | +
| path | +string | +
+ The path within the volume from which to select the file.
+Must be relative and may not contain the '..' path or start with '..'. + |
+ true | +
| volumeName | +string | +
+ The name of the volume mount containing the env file. + |
+ true | +
| optional | +boolean | +
+ Specify whether the file or its key must be defined. If the file or key
+does not exist, then the env var is not published.
+If optional is set to true and the specified key does not exist,
+the environment variable will not be set in the Pod's containers.
+
+If optional is set to false and the specified key does not exist,
+an error will be returned during Pod creation. + + Default: false + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| action | +string | +
+ Specifies the action taken on a container exit if the requirements
+are satisfied. The only possible value is "Restart" to restart the
+container. + |
+ true | +
| exitCodes | +object | +
+ Represents the exit codes to check on container exits. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| operator | +string | +
+ Represents the relationship between the container exit code(s) and the
+specified values. Possible values are:
+- In: the requirement is satisfied if the container exit code is in the
+ set of specified values.
+- NotIn: the requirement is satisfied if the container exit code is
+ not in the set of specified values. + |
+ true | +
| values | +[]integer | +
+ Specifies the set of values to check for container exit codes.
+At most 255 elements are allowed. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| key | +string | +
+ The key within the env file. An invalid key will prevent the pod from starting.
+The keys defined within a source may consist of any printable ASCII characters except '='.
+During Alpha stage of the EnvFiles feature gate, the key size is limited to 128 characters. + |
+ true | +
| path | +string | +
+ The path within the volume from which to select the file.
+Must be relative and may not contain the '..' path or start with '..'. + |
+ true | +
| volumeName | +string | +
+ The name of the volume mount containing the env file. + |
+ true | +
| optional | +boolean | +
+ Specify whether the file or its key must be defined. If the file or key
+does not exist, then the env var is not published.
+If optional is set to true and the specified key does not exist,
+the environment variable will not be set in the Pod's containers.
+
+If optional is set to false and the specified key does not exist,
+an error will be returned during Pod creation. + + Default: false + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| action | +string | +
+ Specifies the action taken on a container exit if the requirements
+are satisfied. The only possible value is "Restart" to restart the
+container. + |
+ true | +
| exitCodes | +object | +
+ Represents the exit codes to check on container exits. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| operator | +string | +
+ Represents the relationship between the container exit code(s) and the
+specified values. Possible values are:
+- In: the requirement is satisfied if the container exit code is in the
+ set of specified values.
+- NotIn: the requirement is satisfied if the container exit code is
+ not in the set of specified values. + |
+ true | +
| values | +[]integer | +
+ Specifies the set of values to check for container exit codes.
+At most 255 elements are allowed. + |
+ false | +
| endpoints | string |
- endpoints is the endpoint name that details Glusterfs topology.
-More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod + endpoints is the endpoint name that details Glusterfs topology. |
true | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| false | +|||
| podCertificate | +object | +
+ Projects an auto-rotating credential bundle (private key and certificate
+chain) that the pod can use either as a TLS client or server.
+
+Kubelet generates a private key and uses it to send a
+PodCertificateRequest to the named signer. Once the signer approves the
+request and issues a certificate chain, Kubelet writes the key and
+certificate chain to the pod filesystem. The pod does not start until
+certificates have been issued for each podCertificate projected volume
+source in its spec.
+
+Kubelet will begin trying to rotate the certificate at the time indicated
+by the signer using the PodCertificateRequest.Status.BeginRefreshAt
+timestamp.
+
+Kubelet can write a single file, indicated by the credentialBundlePath
+field, or separate files, indicated by the keyPath and
+certificateChainPath fields.
+
+The credential bundle is a single file in PEM format. The first PEM
+entry is the private key (in PKCS#8 format), and the remaining PEM
+entries are the certificate chain issued by the signer (typically,
+signers will return their certificate chain in leaf-to-root order).
+
+Prefer using the credential bundle format, since your application code
+can read it atomically. If you use keyPath and certificateChainPath,
+your application must make two separate file reads. If these coincide
+with a certificate rotation, it is possible that the private key and leaf
+certificate you read may not correspond to each other. Your application
+will need to check for this condition, and re-read until they are
+consistent.
+
+The named signer controls chooses the format of the certificate it
+issues; consult the signer implementation's documentation to learn how to
+use the certificates it issues. + |
+ false |
| secret | object | @@ -13049,6 +13601,142 @@ Selects a resource of the container: only resources limits and requests
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| keyType | +string | +
+ The type of keypair Kubelet will generate for the pod.
+
+Valid values are "RSA3072", "RSA4096", "ECDSAP256", "ECDSAP384",
+"ECDSAP521", and "ED25519". + |
+ true | +
| signerName | +string | +
+ Kubelet's generated CSRs will be addressed to this signer. + |
+ true | +
| certificateChainPath | +string | +
+ Write the certificate chain at this path in the projected volume.
+
+Most applications should use credentialBundlePath. When using keyPath
+and certificateChainPath, your application needs to check that the key
+and leaf certificate are consistent, because it is possible to read the
+files mid-rotation. + |
+ false | +
| credentialBundlePath | +string | +
+ Write the credential bundle at this path in the projected volume.
+
+The credential bundle is a single file that contains multiple PEM blocks.
+The first PEM block is a PRIVATE KEY block, containing a PKCS#8 private
+key.
+
+The remaining blocks are CERTIFICATE blocks, containing the issued
+certificate chain from the signer (leaf and any intermediates).
+
+Using credentialBundlePath lets your Pod's application code make a single
+atomic read that retrieves a consistent key and certificate chain. If you
+project them to separate files, your application code will need to
+additionally check that the leaf certificate was issued to the key. + |
+ false | +
| keyPath | +string | +
+ Write the key at this path in the projected volume.
+
+Most applications should use credentialBundlePath. When using keyPath
+and certificateChainPath, your application needs to check that the key
+and leaf certificate are consistent, because it is possible to read the
+files mid-rotation. + |
+ false | +
| maxExpirationSeconds | +integer | +
+ maxExpirationSeconds is the maximum lifetime permitted for the
+certificate.
+
+Kubelet copies this value verbatim into the PodCertificateRequests it
+generates for this projection.
+
+If omitted, kube-apiserver will set it to 86400(24 hours). kube-apiserver
+will reject values shorter than 3600 (1 hour). The maximum allowable
+value is 7862400 (91 days).
+
+The signer implementation is then free to issue a certificate with any
+lifetime *shorter* than MaxExpirationSeconds, but no shorter than 3600
+seconds (1 hour). This constraint is enforced by kube-apiserver.
+`kubernetes.io` signers will never issue certificates with a lifetime
+longer than 24 hours. + + Format: int32 + |
+ false | +
| object |
glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime.
-Deprecated: Glusterfs is deprecated and the in-tree glusterfs type is no longer supported.
-More info: https://examples.k8s.io/volumes/glusterfs/README.md +Deprecated: Glusterfs is deprecated and the in-tree glusterfs type is no longer supported. |
false | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
iscsi represents an ISCSI Disk resource that is attached to a
kubelet's host machine and then exposed to the pod.
-More info: https://examples.k8s.io/volumes/iscsi/README.md +More info: https://kubernetes.io/docs/concepts/storage/volumes/#iscsi |
false | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| object |
rbd represents a Rados Block Device mount on the host that shares a pod's lifetime.
-Deprecated: RBD is deprecated and the in-tree rbd type is no longer supported.
-More info: https://examples.k8s.io/volumes/rbd/README.md +Deprecated: RBD is deprecated and the in-tree rbd type is no longer supported. |
false | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| false | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| endpoints | string |
- endpoints is the endpoint name that details Glusterfs topology.
-More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod + endpoints is the endpoint name that details Glusterfs topology. |
true | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| false | +|||
| podCertificate | +object | +
+ Projects an auto-rotating credential bundle (private key and certificate
+chain) that the pod can use either as a TLS client or server.
+
+Kubelet generates a private key and uses it to send a
+PodCertificateRequest to the named signer. Once the signer approves the
+request and issues a certificate chain, Kubelet writes the key and
+certificate chain to the pod filesystem. The pod does not start until
+certificates have been issued for each podCertificate projected volume
+source in its spec.
+
+Kubelet will begin trying to rotate the certificate at the time indicated
+by the signer using the PodCertificateRequest.Status.BeginRefreshAt
+timestamp.
+
+Kubelet can write a single file, indicated by the credentialBundlePath
+field, or separate files, indicated by the keyPath and
+certificateChainPath fields.
+
+The credential bundle is a single file in PEM format. The first PEM
+entry is the private key (in PKCS#8 format), and the remaining PEM
+entries are the certificate chain issued by the signer (typically,
+signers will return their certificate chain in leaf-to-root order).
+
+Prefer using the credential bundle format, since your application code
+can read it atomically. If you use keyPath and certificateChainPath,
+your application must make two separate file reads. If these coincide
+with a certificate rotation, it is possible that the private key and leaf
+certificate you read may not correspond to each other. Your application
+will need to check for this condition, and re-read until they are
+consistent.
+
+The named signer controls chooses the format of the certificate it
+issues; consult the signer implementation's documentation to learn how to
+use the certificates it issues. + |
+ false |
| secret | object | @@ -16756,6 +17477,142 @@ Selects a resource of the container: only resources limits and requests
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| keyType | +string | +
+ The type of keypair Kubelet will generate for the pod.
+
+Valid values are "RSA3072", "RSA4096", "ECDSAP256", "ECDSAP384",
+"ECDSAP521", and "ED25519". + |
+ true | +
| signerName | +string | +
+ Kubelet's generated CSRs will be addressed to this signer. + |
+ true | +
| certificateChainPath | +string | +
+ Write the certificate chain at this path in the projected volume.
+
+Most applications should use credentialBundlePath. When using keyPath
+and certificateChainPath, your application needs to check that the key
+and leaf certificate are consistent, because it is possible to read the
+files mid-rotation. + |
+ false | +
| credentialBundlePath | +string | +
+ Write the credential bundle at this path in the projected volume.
+
+The credential bundle is a single file that contains multiple PEM blocks.
+The first PEM block is a PRIVATE KEY block, containing a PKCS#8 private
+key.
+
+The remaining blocks are CERTIFICATE blocks, containing the issued
+certificate chain from the signer (leaf and any intermediates).
+
+Using credentialBundlePath lets your Pod's application code make a single
+atomic read that retrieves a consistent key and certificate chain. If you
+project them to separate files, your application code will need to
+additionally check that the leaf certificate was issued to the key. + |
+ false | +
| keyPath | +string | +
+ Write the key at this path in the projected volume.
+
+Most applications should use credentialBundlePath. When using keyPath
+and certificateChainPath, your application needs to check that the key
+and leaf certificate are consistent, because it is possible to read the
+files mid-rotation. + |
+ false | +
| maxExpirationSeconds | +integer | +
+ maxExpirationSeconds is the maximum lifetime permitted for the
+certificate.
+
+Kubelet copies this value verbatim into the PodCertificateRequests it
+generates for this projection.
+
+If omitted, kube-apiserver will set it to 86400(24 hours). kube-apiserver
+will reject values shorter than 3600 (1 hour). The maximum allowable
+value is 7862400 (91 days).
+
+The signer implementation is then free to issue a certificate with any
+lifetime *shorter* than MaxExpirationSeconds, but no shorter than 3600
+seconds (1 hour). This constraint is enforced by kube-apiserver.
+`kubernetes.io` signers will never issue certificates with a lifetime
+longer than 24 hours. + + Format: int32 + |
+ false | +
| []object |
List of sources to populate environment variables in the container.
-The keys defined within a source must be a C_IDENTIFIER. All invalid keys
-will be reported as an event when the container is starting. When a key exists in multiple
+The keys defined within a source may consist of any printable ASCII characters except '='.
+When a key exists in multiple
sources, the value associated with the last source will take precedence.
Values defined by an Env with a duplicate key will take precedence.
Cannot be updated. @@ -17676,10 +18532,10 @@ More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-co | string |
RestartPolicy defines the restart behavior of individual containers in a pod.
-This field may only be set for init containers, and the only allowed value is "Always".
-For non-init containers or when this field is not specified,
+This overrides the pod-level restart policy. When this field is not specified,
the restart behavior is defined by the Pod's restart policy and the container type.
-Setting the RestartPolicy as "Always" for the init container will have the following effect:
+Additionally, setting the RestartPolicy as "Always" for the init container will
+have the following effect:
this init container will be continually restarted on
exit until all regular containers have terminated. Once all regular
containers have completed, all init containers with restartPolicy "Always"
@@ -17692,6 +18548,23 @@ init container is started, or after any startupProbe has successfully
completed. |
false | +|
| restartPolicyRules | +[]object | +
+ Represents a list of rules to be checked to determine if the
+container should be restarted on exit. The rules are evaluated in
+order. Once a rule matches a container exit condition, the remaining
+rules are ignored. If no rule matches the container exit condition,
+the Container-level restart policy determines the whether the container
+is restarted or not. Constraints on the rules:
+- At most 20 rules are allowed.
+- Rules can have the same action.
+- Identical rules are not forbidden in validations.
+When rules are specified, container MUST set RestartPolicy explicitly
+even it if matches the Pod's RestartPolicy. + |
+ false | ||
| securityContext | object | @@ -17819,7 +18692,8 @@ EnvVar represents an environment variable present in a Container.name | string |
- Name of the environment variable. Must be a C_IDENTIFIER. + Name of the environment variable. +May consist of any printable ASCII characters except '='. |
true |
| false | +|||||
| fileKeyRef | +object | +
+ FileKeyRef selects a key of the env file.
+Requires the EnvFiles feature gate to be enabled. + |
+ false | ||
| resourceFieldRef | object | @@ -17980,6 +18862,66 @@ spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podI
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| key | +string | +
+ The key within the env file. An invalid key will prevent the pod from starting.
+The keys defined within a source may consist of any printable ASCII characters except '='.
+During Alpha stage of the EnvFiles feature gate, the key size is limited to 128 characters. + |
+ true | +
| path | +string | +
+ The path within the volume from which to select the file.
+Must be relative and may not contain the '..' path or start with '..'. + |
+ true | +
| volumeName | +string | +
+ The name of the volume mount containing the env file. + |
+ true | +
| optional | +boolean | +
+ Specify whether the file or its key must be defined. If the file or key
+does not exist, then the env var is not published.
+If optional is set to true and the specified key does not exist,
+the environment variable will not be set in the Pod's containers.
+
+If optional is set to false and the specified key does not exist,
+an error will be returned during Pod creation. + + Default: false + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| action | +string | +
+ Specifies the action taken on a container exit if the requirements
+are satisfied. The only possible value is "Restart" to restart the
+container. + |
+ true | +
| exitCodes | +object | +
+ Represents the exit codes to check on container exits. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| operator | +string | +
+ Represents the relationship between the container exit code(s) and the
+specified values. Possible values are:
+- In: the requirement is satisfied if the container exit code is in the
+ set of specified values.
+- NotIn: the requirement is satisfied if the container exit code is
+ not in the set of specified values. + |
+ true | +
| values | +[]integer | +
+ Specifies the set of values to check for container exit codes.
+At most 255 elements are allowed. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| maxConcurrentRebuilds | +integer | +
+ MaxConcurrentRebuilds specifies the maximum number of pods to rebuild
+concurrently per rack during datacenter rebuild operations.
+Defaults to 1 if not set.
+If set to a positive value, at most that many pods per rack will be rebuilt in parallel.
+If set to 0, all pods in the rack will be rebuilt in parallel. + + Minimum: 0 + |
+ false | +
| sourceDc | +string | +
+ SourceDC tells the operation the DC from which to stream when rebuilding a DC. If not set the operator will choose the first DC. The value for
+this field must specify the name of a CassandraDatacenter whose Ready condition is true. + |
+ false | +
| endpoints | string |
- endpoints is the endpoint name that details Glusterfs topology.
-More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod + endpoints is the endpoint name that details Glusterfs topology. |
true | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| false | +|||
| podCertificate | +object | +
+ Projects an auto-rotating credential bundle (private key and certificate
+chain) that the pod can use either as a TLS client or server.
+
+Kubelet generates a private key and uses it to send a
+PodCertificateRequest to the named signer. Once the signer approves the
+request and issues a certificate chain, Kubelet writes the key and
+certificate chain to the pod filesystem. The pod does not start until
+certificates have been issued for each podCertificate projected volume
+source in its spec.
+
+Kubelet will begin trying to rotate the certificate at the time indicated
+by the signer using the PodCertificateRequest.Status.BeginRefreshAt
+timestamp.
+
+Kubelet can write a single file, indicated by the credentialBundlePath
+field, or separate files, indicated by the keyPath and
+certificateChainPath fields.
+
+The credential bundle is a single file in PEM format. The first PEM
+entry is the private key (in PKCS#8 format), and the remaining PEM
+entries are the certificate chain issued by the signer (typically,
+signers will return their certificate chain in leaf-to-root order).
+
+Prefer using the credential bundle format, since your application code
+can read it atomically. If you use keyPath and certificateChainPath,
+your application must make two separate file reads. If these coincide
+with a certificate rotation, it is possible that the private key and leaf
+certificate you read may not correspond to each other. Your application
+will need to check for this condition, and re-read until they are
+consistent.
+
+The named signer controls chooses the format of the certificate it
+issues; consult the signer implementation's documentation to learn how to
+use the certificates it issues. + |
+ false |
| secret | object | @@ -33775,6 +34883,142 @@ Selects a resource of the container: only resources limits and requests
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| keyType | +string | +
+ The type of keypair Kubelet will generate for the pod.
+
+Valid values are "RSA3072", "RSA4096", "ECDSAP256", "ECDSAP384",
+"ECDSAP521", and "ED25519". + |
+ true | +
| signerName | +string | +
+ Kubelet's generated CSRs will be addressed to this signer. + |
+ true | +
| certificateChainPath | +string | +
+ Write the certificate chain at this path in the projected volume.
+
+Most applications should use credentialBundlePath. When using keyPath
+and certificateChainPath, your application needs to check that the key
+and leaf certificate are consistent, because it is possible to read the
+files mid-rotation. + |
+ false | +
| credentialBundlePath | +string | +
+ Write the credential bundle at this path in the projected volume.
+
+The credential bundle is a single file that contains multiple PEM blocks.
+The first PEM block is a PRIVATE KEY block, containing a PKCS#8 private
+key.
+
+The remaining blocks are CERTIFICATE blocks, containing the issued
+certificate chain from the signer (leaf and any intermediates).
+
+Using credentialBundlePath lets your Pod's application code make a single
+atomic read that retrieves a consistent key and certificate chain. If you
+project them to separate files, your application code will need to
+additionally check that the leaf certificate was issued to the key. + |
+ false | +
| keyPath | +string | +
+ Write the key at this path in the projected volume.
+
+Most applications should use credentialBundlePath. When using keyPath
+and certificateChainPath, your application needs to check that the key
+and leaf certificate are consistent, because it is possible to read the
+files mid-rotation. + |
+ false | +
| maxExpirationSeconds | +integer | +
+ maxExpirationSeconds is the maximum lifetime permitted for the
+certificate.
+
+Kubelet copies this value verbatim into the PodCertificateRequests it
+generates for this projection.
+
+If omitted, kube-apiserver will set it to 86400(24 hours). kube-apiserver
+will reject values shorter than 3600 (1 hour). The maximum allowable
+value is 7862400 (91 days).
+
+The signer implementation is then free to issue a certificate with any
+lifetime *shorter* than MaxExpirationSeconds, but no shorter than 3600
+seconds (1 hour). This constraint is enforced by kube-apiserver.
+`kubernetes.io` signers will never issue certificates with a lifetime
+longer than 24 hours. + + Format: int32 + |
+ false | +
| false | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| false | +|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| config | +string | +
+ Config is raw TOML merged into the generated Vector configuration.
+This can be used to set global Vector options or anything that does not fit the components model. + |
+ false | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| enabled | boolean | @@ -35505,7 +36754,7 @@ Resources is the resource requirements for the Vector agent. Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. -This is an alpha field and requires enabling the +This field depends on the DynamicResourceAllocation feature gate. This field is immutable. It can only be set for containers.false | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| object |
glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime.
-Deprecated: Glusterfs is deprecated and the in-tree glusterfs type is no longer supported.
-More info: https://examples.k8s.io/volumes/glusterfs/README.md +Deprecated: Glusterfs is deprecated and the in-tree glusterfs type is no longer supported. |
false | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
iscsi represents an ISCSI Disk resource that is attached to a
kubelet's host machine and then exposed to the pod.
-More info: https://examples.k8s.io/volumes/iscsi/README.md +More info: https://kubernetes.io/docs/concepts/storage/volumes/#iscsi |
false | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| object |
rbd represents a Rados Block Device mount on the host that shares a pod's lifetime.
-Deprecated: RBD is deprecated and the in-tree rbd type is no longer supported.
-More info: https://examples.k8s.io/volumes/rbd/README.md +Deprecated: RBD is deprecated and the in-tree rbd type is no longer supported. |
false | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| false | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| endpoints | string |
- endpoints is the endpoint name that details Glusterfs topology.
-More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod + endpoints is the endpoint name that details Glusterfs topology. |
true | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| false | +|||
| podCertificate | +object | +
+ Projects an auto-rotating credential bundle (private key and certificate
+chain) that the pod can use either as a TLS client or server.
+
+Kubelet generates a private key and uses it to send a
+PodCertificateRequest to the named signer. Once the signer approves the
+request and issues a certificate chain, Kubelet writes the key and
+certificate chain to the pod filesystem. The pod does not start until
+certificates have been issued for each podCertificate projected volume
+source in its spec.
+
+Kubelet will begin trying to rotate the certificate at the time indicated
+by the signer using the PodCertificateRequest.Status.BeginRefreshAt
+timestamp.
+
+Kubelet can write a single file, indicated by the credentialBundlePath
+field, or separate files, indicated by the keyPath and
+certificateChainPath fields.
+
+The credential bundle is a single file in PEM format. The first PEM
+entry is the private key (in PKCS#8 format), and the remaining PEM
+entries are the certificate chain issued by the signer (typically,
+signers will return their certificate chain in leaf-to-root order).
+
+Prefer using the credential bundle format, since your application code
+can read it atomically. If you use keyPath and certificateChainPath,
+your application must make two separate file reads. If these coincide
+with a certificate rotation, it is possible that the private key and leaf
+certificate you read may not correspond to each other. Your application
+will need to check for this condition, and re-read until they are
+consistent.
+
+The named signer controls chooses the format of the certificate it
+issues; consult the signer implementation's documentation to learn how to
+use the certificates it issues. + |
+ false |
| secret | object | @@ -39075,6 +40356,142 @@ Selects a resource of the container: only resources limits and requests
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| keyType | +string | +
+ The type of keypair Kubelet will generate for the pod.
+
+Valid values are "RSA3072", "RSA4096", "ECDSAP256", "ECDSAP384",
+"ECDSAP521", and "ED25519". + |
+ true | +
| signerName | +string | +
+ Kubelet's generated CSRs will be addressed to this signer. + |
+ true | +
| certificateChainPath | +string | +
+ Write the certificate chain at this path in the projected volume.
+
+Most applications should use credentialBundlePath. When using keyPath
+and certificateChainPath, your application needs to check that the key
+and leaf certificate are consistent, because it is possible to read the
+files mid-rotation. + |
+ false | +
| credentialBundlePath | +string | +
+ Write the credential bundle at this path in the projected volume.
+
+The credential bundle is a single file that contains multiple PEM blocks.
+The first PEM block is a PRIVATE KEY block, containing a PKCS#8 private
+key.
+
+The remaining blocks are CERTIFICATE blocks, containing the issued
+certificate chain from the signer (leaf and any intermediates).
+
+Using credentialBundlePath lets your Pod's application code make a single
+atomic read that retrieves a consistent key and certificate chain. If you
+project them to separate files, your application code will need to
+additionally check that the leaf certificate was issued to the key. + |
+ false | +
| keyPath | +string | +
+ Write the key at this path in the projected volume.
+
+Most applications should use credentialBundlePath. When using keyPath
+and certificateChainPath, your application needs to check that the key
+and leaf certificate are consistent, because it is possible to read the
+files mid-rotation. + |
+ false | +
| maxExpirationSeconds | +integer | +
+ maxExpirationSeconds is the maximum lifetime permitted for the
+certificate.
+
+Kubelet copies this value verbatim into the PodCertificateRequests it
+generates for this projection.
+
+If omitted, kube-apiserver will set it to 86400(24 hours). kube-apiserver
+will reject values shorter than 3600 (1 hour). The maximum allowable
+value is 7862400 (91 days).
+
+The signer implementation is then free to issue a certificate with any
+lifetime *shorter* than MaxExpirationSeconds, but no shorter than 3600
+seconds (1 hour). This constraint is enforced by kube-apiserver.
+`kubernetes.io` signers will never issue certificates with a lifetime
+longer than 24 hours. + + Format: int32 + |
+ false | +
| object |
glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime.
-Deprecated: Glusterfs is deprecated and the in-tree glusterfs type is no longer supported.
-More info: https://examples.k8s.io/volumes/glusterfs/README.md +Deprecated: Glusterfs is deprecated and the in-tree glusterfs type is no longer supported. |
false | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
iscsi represents an ISCSI Disk resource that is attached to a
kubelet's host machine and then exposed to the pod.
-More info: https://examples.k8s.io/volumes/iscsi/README.md +More info: https://kubernetes.io/docs/concepts/storage/volumes/#iscsi |
false | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| object |
rbd represents a Rados Block Device mount on the host that shares a pod's lifetime.
-Deprecated: RBD is deprecated and the in-tree rbd type is no longer supported.
-More info: https://examples.k8s.io/volumes/rbd/README.md +Deprecated: RBD is deprecated and the in-tree rbd type is no longer supported. |
false | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| false | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| endpoints | string |
- endpoints is the endpoint name that details Glusterfs topology.
-More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod + endpoints is the endpoint name that details Glusterfs topology. |
true | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| false | +|||
| podCertificate | +object | +
+ Projects an auto-rotating credential bundle (private key and certificate
+chain) that the pod can use either as a TLS client or server.
+
+Kubelet generates a private key and uses it to send a
+PodCertificateRequest to the named signer. Once the signer approves the
+request and issues a certificate chain, Kubelet writes the key and
+certificate chain to the pod filesystem. The pod does not start until
+certificates have been issued for each podCertificate projected volume
+source in its spec.
+
+Kubelet will begin trying to rotate the certificate at the time indicated
+by the signer using the PodCertificateRequest.Status.BeginRefreshAt
+timestamp.
+
+Kubelet can write a single file, indicated by the credentialBundlePath
+field, or separate files, indicated by the keyPath and
+certificateChainPath fields.
+
+The credential bundle is a single file in PEM format. The first PEM
+entry is the private key (in PKCS#8 format), and the remaining PEM
+entries are the certificate chain issued by the signer (typically,
+signers will return their certificate chain in leaf-to-root order).
+
+Prefer using the credential bundle format, since your application code
+can read it atomically. If you use keyPath and certificateChainPath,
+your application must make two separate file reads. If these coincide
+with a certificate rotation, it is possible that the private key and leaf
+certificate you read may not correspond to each other. Your application
+will need to check for this condition, and re-read until they are
+consistent.
+
+The named signer controls chooses the format of the certificate it
+issues; consult the signer implementation's documentation to learn how to
+use the certificates it issues. + |
+ false |
| secret | object | @@ -42782,6 +44232,142 @@ Selects a resource of the container: only resources limits and requests
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| keyType | +string | +
+ The type of keypair Kubelet will generate for the pod.
+
+Valid values are "RSA3072", "RSA4096", "ECDSAP256", "ECDSAP384",
+"ECDSAP521", and "ED25519". + |
+ true | +
| signerName | +string | +
+ Kubelet's generated CSRs will be addressed to this signer. + |
+ true | +
| certificateChainPath | +string | +
+ Write the certificate chain at this path in the projected volume.
+
+Most applications should use credentialBundlePath. When using keyPath
+and certificateChainPath, your application needs to check that the key
+and leaf certificate are consistent, because it is possible to read the
+files mid-rotation. + |
+ false | +
| credentialBundlePath | +string | +
+ Write the credential bundle at this path in the projected volume.
+
+The credential bundle is a single file that contains multiple PEM blocks.
+The first PEM block is a PRIVATE KEY block, containing a PKCS#8 private
+key.
+
+The remaining blocks are CERTIFICATE blocks, containing the issued
+certificate chain from the signer (leaf and any intermediates).
+
+Using credentialBundlePath lets your Pod's application code make a single
+atomic read that retrieves a consistent key and certificate chain. If you
+project them to separate files, your application code will need to
+additionally check that the leaf certificate was issued to the key. + |
+ false | +
| keyPath | +string | +
+ Write the key at this path in the projected volume.
+
+Most applications should use credentialBundlePath. When using keyPath
+and certificateChainPath, your application needs to check that the key
+and leaf certificate are consistent, because it is possible to read the
+files mid-rotation. + |
+ false | +
| maxExpirationSeconds | +integer | +
+ maxExpirationSeconds is the maximum lifetime permitted for the
+certificate.
+
+Kubelet copies this value verbatim into the PodCertificateRequests it
+generates for this projection.
+
+If omitted, kube-apiserver will set it to 86400(24 hours). kube-apiserver
+will reject values shorter than 3600 (1 hour). The maximum allowable
+value is 7862400 (91 days).
+
+The signer implementation is then free to issue a certificate with any
+lifetime *shorter* than MaxExpirationSeconds, but no shorter than 3600
+seconds (1 hour). This constraint is enforced by kube-apiserver.
+`kubernetes.io` signers will never issue certificates with a lifetime
+longer than 24 hours. + + Format: int32 + |
+ false | +
| []object |
List of sources to populate environment variables in the container.
-The keys defined within a source must be a C_IDENTIFIER. All invalid keys
-will be reported as an event when the container is starting. When a key exists in multiple
+The keys defined within a source may consist of any printable ASCII characters except '='.
+When a key exists in multiple
sources, the value associated with the last source will take precedence.
Values defined by an Env with a duplicate key will take precedence.
Cannot be updated. @@ -43702,10 +45287,10 @@ More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-co | string |
RestartPolicy defines the restart behavior of individual containers in a pod.
-This field may only be set for init containers, and the only allowed value is "Always".
-For non-init containers or when this field is not specified,
+This overrides the pod-level restart policy. When this field is not specified,
the restart behavior is defined by the Pod's restart policy and the container type.
-Setting the RestartPolicy as "Always" for the init container will have the following effect:
+Additionally, setting the RestartPolicy as "Always" for the init container will
+have the following effect:
this init container will be continually restarted on
exit until all regular containers have terminated. Once all regular
containers have completed, all init containers with restartPolicy "Always"
@@ -43718,6 +45303,23 @@ init container is started, or after any startupProbe has successfully
completed. |
false | +|
| restartPolicyRules | +[]object | +
+ Represents a list of rules to be checked to determine if the
+container should be restarted on exit. The rules are evaluated in
+order. Once a rule matches a container exit condition, the remaining
+rules are ignored. If no rule matches the container exit condition,
+the Container-level restart policy determines the whether the container
+is restarted or not. Constraints on the rules:
+- At most 20 rules are allowed.
+- Rules can have the same action.
+- Identical rules are not forbidden in validations.
+When rules are specified, container MUST set RestartPolicy explicitly
+even it if matches the Pod's RestartPolicy. + |
+ false | ||
| securityContext | object | @@ -43845,7 +45447,8 @@ EnvVar represents an environment variable present in a Container.name | string |
- Name of the environment variable. Must be a C_IDENTIFIER. + Name of the environment variable. +May consist of any printable ASCII characters except '='. |
true |
| false | +|||||
| fileKeyRef | +object | +
+ FileKeyRef selects a key of the env file.
+Requires the EnvFiles feature gate to be enabled. + |
+ false | ||
| resourceFieldRef | object | @@ -44006,6 +45617,66 @@ spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podI
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| key | +string | +
+ The key within the env file. An invalid key will prevent the pod from starting.
+The keys defined within a source may consist of any printable ASCII characters except '='.
+During Alpha stage of the EnvFiles feature gate, the key size is limited to 128 characters. + |
+ true | +
| path | +string | +
+ The path within the volume from which to select the file.
+Must be relative and may not contain the '..' path or start with '..'. + |
+ true | +
| volumeName | +string | +
+ The name of the volume mount containing the env file. + |
+ true | +
| optional | +boolean | +
+ Specify whether the file or its key must be defined. If the file or key
+does not exist, then the env var is not published.
+If optional is set to true and the specified key does not exist,
+the environment variable will not be set in the Pod's containers.
+
+If optional is set to false and the specified key does not exist,
+an error will be returned during Pod creation. + + Default: false + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| action | +string | +
+ Specifies the action taken on a container exit if the requirements
+are satisfied. The only possible value is "Restart" to restart the
+container. + |
+ true | +
| exitCodes | +object | +
+ Represents the exit codes to check on container exits. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| operator | +string | +
+ Represents the relationship between the container exit code(s) and the
+specified values. Possible values are:
+- In: the requirement is satisfied if the container exit code is in the
+ set of specified values.
+- NotIn: the requirement is satisfied if the container exit code is
+ not in the set of specified values. + |
+ true | +
| values | +[]integer | +
+ Specifies the set of values to check for container exit codes.
+At most 255 elements are allowed. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| maxConcurrentRebuilds | +integer | +
+ MaxConcurrentRebuilds specifies the maximum number of pods to rebuild
+concurrently per rack during datacenter rebuild operations.
+Defaults to 1 if not set.
+If set to a positive value, at most that many pods per rack will be rebuilt in parallel.
+If set to 0, all pods in the rack will be rebuilt in parallel. + + Minimum: 0 + |
+ false | +
| sourceDc | +string | +
+ SourceDC tells the operation the DC from which to stream when rebuilding a DC. If not set the operator will choose the first DC. The value for
+this field must specify the name of a CassandraDatacenter whose Ready condition is true. + |
+ false | +
| endpoints | string |
- endpoints is the endpoint name that details Glusterfs topology.
-More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod + endpoints is the endpoint name that details Glusterfs topology. |
true | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| false | +|||
| podCertificate | +object | +
+ Projects an auto-rotating credential bundle (private key and certificate
+chain) that the pod can use either as a TLS client or server.
+
+Kubelet generates a private key and uses it to send a
+PodCertificateRequest to the named signer. Once the signer approves the
+request and issues a certificate chain, Kubelet writes the key and
+certificate chain to the pod filesystem. The pod does not start until
+certificates have been issued for each podCertificate projected volume
+source in its spec.
+
+Kubelet will begin trying to rotate the certificate at the time indicated
+by the signer using the PodCertificateRequest.Status.BeginRefreshAt
+timestamp.
+
+Kubelet can write a single file, indicated by the credentialBundlePath
+field, or separate files, indicated by the keyPath and
+certificateChainPath fields.
+
+The credential bundle is a single file in PEM format. The first PEM
+entry is the private key (in PKCS#8 format), and the remaining PEM
+entries are the certificate chain issued by the signer (typically,
+signers will return their certificate chain in leaf-to-root order).
+
+Prefer using the credential bundle format, since your application code
+can read it atomically. If you use keyPath and certificateChainPath,
+your application must make two separate file reads. If these coincide
+with a certificate rotation, it is possible that the private key and leaf
+certificate you read may not correspond to each other. Your application
+will need to check for this condition, and re-read until they are
+consistent.
+
+The named signer controls chooses the format of the certificate it
+issues; consult the signer implementation's documentation to learn how to
+use the certificates it issues. + |
+ false |
| secret | object | @@ -52833,6 +54654,142 @@ Selects a resource of the container: only resources limits and requests
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| keyType | +string | +
+ The type of keypair Kubelet will generate for the pod.
+
+Valid values are "RSA3072", "RSA4096", "ECDSAP256", "ECDSAP384",
+"ECDSAP521", and "ED25519". + |
+ true | +
| signerName | +string | +
+ Kubelet's generated CSRs will be addressed to this signer. + |
+ true | +
| certificateChainPath | +string | +
+ Write the certificate chain at this path in the projected volume.
+
+Most applications should use credentialBundlePath. When using keyPath
+and certificateChainPath, your application needs to check that the key
+and leaf certificate are consistent, because it is possible to read the
+files mid-rotation. + |
+ false | +
| credentialBundlePath | +string | +
+ Write the credential bundle at this path in the projected volume.
+
+The credential bundle is a single file that contains multiple PEM blocks.
+The first PEM block is a PRIVATE KEY block, containing a PKCS#8 private
+key.
+
+The remaining blocks are CERTIFICATE blocks, containing the issued
+certificate chain from the signer (leaf and any intermediates).
+
+Using credentialBundlePath lets your Pod's application code make a single
+atomic read that retrieves a consistent key and certificate chain. If you
+project them to separate files, your application code will need to
+additionally check that the leaf certificate was issued to the key. + |
+ false | +
| keyPath | +string | +
+ Write the key at this path in the projected volume.
+
+Most applications should use credentialBundlePath. When using keyPath
+and certificateChainPath, your application needs to check that the key
+and leaf certificate are consistent, because it is possible to read the
+files mid-rotation. + |
+ false | +
| maxExpirationSeconds | +integer | +
+ maxExpirationSeconds is the maximum lifetime permitted for the
+certificate.
+
+Kubelet copies this value verbatim into the PodCertificateRequests it
+generates for this projection.
+
+If omitted, kube-apiserver will set it to 86400(24 hours). kube-apiserver
+will reject values shorter than 3600 (1 hour). The maximum allowable
+value is 7862400 (91 days).
+
+The signer implementation is then free to issue a certificate with any
+lifetime *shorter* than MaxExpirationSeconds, but no shorter than 3600
+seconds (1 hour). This constraint is enforced by kube-apiserver.
+`kubernetes.io` signers will never issue certificates with a lifetime
+longer than 24 hours. + + Format: int32 + |
+ false | +
| false | |||||
| false | +|||||
| config | +string | +
+ Config is raw TOML merged into the generated Vector configuration.
+This can be used to set global Vector options or anything that does not fit the components model. + |
+ false | ||
| enabled | boolean | @@ -54598,7 +56560,7 @@ Resources is the resource requirements for the Vector agent. Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. -This is an alpha field and requires enabling the +This field depends on the DynamicResourceAllocation feature gate. This field is immutable. It can only be set for containers.name | string |
- Name of the environment variable. Must be a C_IDENTIFIER. + Name of the environment variable. +May consist of any printable ASCII characters except '='. |
true |
| false | +|||||
| fileKeyRef | +object | +
+ FileKeyRef selects a key of the env file.
+Requires the EnvFiles feature gate to be enabled. + |
+ false | ||
| resourceFieldRef | object | @@ -57302,6 +59273,66 @@ spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podI
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| key | +string | +
+ The key within the env file. An invalid key will prevent the pod from starting.
+The keys defined within a source may consist of any printable ASCII characters except '='.
+During Alpha stage of the EnvFiles feature gate, the key size is limited to 128 characters. + |
+ true | +
| path | +string | +
+ The path within the volume from which to select the file.
+Must be relative and may not contain the '..' path or start with '..'. + |
+ true | +
| volumeName | +string | +
+ The name of the volume mount containing the env file. + |
+ true | +
| optional | +boolean | +
+ Specify whether the file or its key must be defined. If the file or key
+does not exist, then the env var is not published.
+If optional is set to true and the specified key does not exist,
+the environment variable will not be set in the Pod's containers.
+
+If optional is set to false and the specified key does not exist,
+an error will be returned during Pod creation. + + Default: false + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| key | +string | +
+ The key within the env file. An invalid key will prevent the pod from starting.
+The keys defined within a source may consist of any printable ASCII characters except '='.
+During Alpha stage of the EnvFiles feature gate, the key size is limited to 128 characters. + |
+ true | +
| path | +string | +
+ The path within the volume from which to select the file.
+Must be relative and may not contain the '..' path or start with '..'. + |
+ true | +
| volumeName | +string | +
+ The name of the volume mount containing the env file. + |
+ true | +
| optional | +boolean | +
+ Specify whether the file or its key must be defined. If the file or key
+does not exist, then the env var is not published.
+If optional is set to true and the specified key does not exist,
+the environment variable will not be set in the Pod's containers.
+
+If optional is set to false and the specified key does not exist,
+an error will be returned during Pod creation. + + Default: false + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| apiVersion | +string | +cassandra.datastax.com/v1beta1 | +true | +
| kind | +string | +CassandraDatacenter | +true | +
| metadata | +object | +Refer to the Kubernetes API documentation for the fields of the `metadata` field. | +true | +
| spec | +object | +
+ CassandraDatacenterSpec defines the desired state of a CassandraDatacenter + |
+ false | +
| status | +object | +
+ CassandraDatacenterStatus defines the observed state of CassandraDatacenter + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| clusterName | +string | +
+ The name by which CQL clients and instances will know the cluster. If the same
+cluster name is shared by multiple Datacenters in the same Kubernetes namespace,
+they will join together in a multi-datacenter cluster. + |
+ true | +
| serverType | +enum | +
+ Server type: "cassandra", "dse" or "hcd" + + Enum: cassandra, dse, hcd + |
+ true | +
| serverVersion | +string | +
+ Version string for config builder,
+used to generate Cassandra server configuration + |
+ true | +
| size | +integer | +
+ Desired number of Cassandra server nodes + + Format: int32 + Minimum: 1 + |
+ true | +
| storageConfig | +object | +
+ StorageConfig describes the persistent storage request of each server node + |
+ true | +
| additionalAnnotations | +map[string]string | +
+ Additional Annotations allows to define additional labels that will be included in all objects created by the operator. Note, user can override values set by default from the cass-operator and doing so could break cass-operator functionality. + |
+ false | +
| additionalLabels | +map[string]string | +
+ Additional Labels allows to define additional labels that will be included in all objects created by the operator. Note, user can override values set by default from the cass-operator and doing so could break cass-operator functionality. + |
+ false | +
| additionalSeeds | +[]string | +
+ + |
+ false | +
| additionalServiceConfig | +object | +
+ AdditionalServiceConfig allows to define additional parameters that are included in the created Services. Note, user can override values set by cass-operator and doing so could break cass-operator functionality.
+Avoid label "cass-operator" and anything that starts with "cassandra.datastax.com/" + |
+ false | +
| allowMultipleNodesPerWorker | +boolean | +
+ Turning this option on allows multiple server pods to be created on a k8s worker node, by removing the default pod anti affinity rules.
+By default the operator creates just one server pod per k8s worker node. Using custom affinity rules might require turning this
+option on in which case the defaults are not set. + |
+ false | +
| canaryUpgrade | +boolean | +
+ Indicates that configuration and container image changes should only be pushed to
+the first rack of the datacenter + |
+ false | +
| canaryUpgradeCount | +integer | +
+ The number of nodes that will be updated when CanaryUpgrade is true. Note that the value is
+either 0 or greater than the rack size, then all nodes in the rack will get updated. + + Format: int32 + |
+ false | +
| cdc | +object | +
+ Deprecated this field is deprecated and will be removed in the future. DeprecatedCDC allows configuration of the change data capture agent which can run within the Management API container. Use it to send data to Pulsar. + |
+ false | +
| config | +string | +
+ Config for the server, in YAML format + + Format: byte + |
+ false | +
| configBuilderImage | +string | +
+ Container image for the config builder init container. Overrides value from ImageConfig ConfigBuilderImage + |
+ false | +
| configBuilderResources | +object | +
+ Kubernetes resource requests and limits per server config initialization container. + |
+ false | +
| configSecret | +string | +
+ ConfigSecret is the name of a secret that contains configuration for Cassandra. The
+secret is expected to have a property named config whose value should be a JSON
+formatted string that should look like this:
+
+ config: |-
+ {
+ "cassandra-yaml": {
+ "read_request_timeout_in_ms": 10000
+ },
+ "jmv-options": {
+ "max_heap_size": 1024M
+ }
+ }
+
+ConfigSecret is mutually exclusive with Config. ConfigSecret takes precedence and
+will be used exclusively if both properties are set. The operator sets a watch such
+that an update to the secret will trigger an update of the StatefulSets. + |
+ false | +
| datacenterName | +string | +
+ DatacenterName allows to override the name of the Cassandra datacenter. In Cassandra the DC name will be overridden by this value.
+This setting can create conflicts if multiple DCs coexist in the same namespace if metadata.name for a DC with no override is set to the same value as the override name of another DC.
+Use cautiously. + |
+ false | +
| disableSystemLoggerSidecar | +boolean | +
+ Configuration for disabling the simple log tailing sidecar container. Our default is to have it enabled. + |
+ false | +
| dockerImageRunsAsCassandra | +boolean | +
+ DEPRECATED This setting does nothing and defaults to true. Use SecurityContext instead. + |
+ false | +
| dseWorkloads | +object | +
+ + |
+ false | +
| forceUpgradeRacks | +[]string | +
+ Rack names in this list are set to the latest StatefulSet configuration
+even if Cassandra nodes are down. Use this to recover from an upgrade that couldn't
+roll out. + |
+ false | +
| managementApiAuth | +object | +
+ Config for the Management API certificates + |
+ false | +
| minReadySeconds | +integer | +
+ MinReadySeconds sets the minimum number of seconds for which a newly created pod should be ready without any of its containers crashing, for it to be considered available. Defaults to 5 seconds and is set in the StatefulSet spec.
+Setting to 0 might cause multiple Cassandra pods to restart at the same time despite PodDisruptionBudget settings. + + Format: int32 + |
+ false | +
| networking | +object | +
+ + |
+ false | +
| nodeAffinityLabels | +map[string]string | +
+ NodeAffinityLabels to pin the Datacenter, using node affinity + |
+ false | +
| nodeSelector | +map[string]string | +
+ A map of label keys and values to restrict Cassandra node scheduling to k8s workers
+with matchiing labels.
+More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/#nodeselector + |
+ false | +
| podTemplateSpec | +object | +
+ PodTemplate provides customisation options (labels, annotations, affinity rules, resource requests, and so on) for the cassandra pods + |
+ false | +
| racks | +[]object | +
+ A list of the named racks in the datacenter, representing independent failure domains. The
+number of racks should match the replication factor in the keyspaces you plan to create, and
+the number of racks cannot easily be changed once a datacenter is deployed. + |
+ false | +
| readOnlyRootFilesystem | +boolean | +
+ ReadOnlyRootFilesystem makes the cassandra container to be run with a read-only root filesystem. This is enabled by default when using OSS Cassandra 4.1.0 and or newer, DSE 6.8 and newer (from datastax/dse-mgmtapi-6_8 repository) or HCD.
+If serverImage override is used, this setting defaults to false. + |
+ false | +
| replaceNodes | +[]string | +
+ Deprecated Use CassandraTask replacenode to achieve correct node replacement. A list of pod names that need to be replaced. + |
+ false | +
| resources | +object | +
+ Kubernetes resource requests and limits, per pod + |
+ false | +
| rollingRestartRequested | +boolean | +
+ Deprecated. Use CassandraTask for rolling restarts. Whether to do a rolling restart at the next opportunity. The operator will set this back
+to false once the restart is in progress. + |
+ false | +
| serverImage | +string | +
+ Cassandra server image name. Use of ImageConfig to match ServerVersion is recommended instead of this value.
+This value will override anything set in the ImageConfig matching the ServerVersion
+More info: https://kubernetes.io/docs/concepts/containers/images + |
+ false | +
| serviceAccount | +string | +
+ Deprecated DeprecatedServiceAccount Use ServiceAccountName instead, which takes precedence. The k8s service account to use for the server pods + |
+ false | +
| serviceAccountName | +string | +
+ ServiceAccountName is the Kubernetes service account to use for the server pods. This takes presedence over DeprecatedServiceAccount and both take precedence over
+setting it in the PodTemplateSpec. + |
+ false | +
| stopped | +boolean | +
+ A stopped CassandraDatacenter will have no running server pods, like using "stop" with
+traditional System V init scripts. Other Kubernetes resources will be left intact, and volumes
+will re-attach when the CassandraDatacenter workload is resumed. + |
+ false | +
| superuserSecretName | +string | +
+ This secret defines the username and password for the Cassandra server superuser.
+If it is omitted, we will generate a secret instead. + |
+ false | +
| systemLoggerImage | +string | +
+ Container image for the log tailing sidecar container. Overrides value from ImageConfig SystemLoggerImage + |
+ false | +
| systemLoggerResources | +object | +
+ Kubernetes resource requests and limits per system logger container. + |
+ false | +
| tolerations | +[]object | +
+ Tolerations applied to the Cassandra pod. Note that these cannot be overridden with PodTemplateSpec. + |
+ false | +
| users | +[]object | +
+ Cassandra users to bootstrap + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| additionalVolumes | +[]object | +
+ + |
+ false | +
| cassandraDataVolumeClaimSpec | +object | +
+ PersistentVolumeClaimSpec describes the common attributes of storage devices
+and allows a Source for provider-specific attributes + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| mountPath | +string | +
+ Mount path into cassandra container + |
+ true | +
| name | +string | +
+ Name of the pvc / volume + |
+ true | +
| pvcSpec | +object | +
+ PVCSpec is a persistent volume claim spec. Either this or VolumeSource is required. + |
+ false | +
| volumeSource | +object | +
+ VolumeSource to mount the volume from (such as ConfigMap / Secret). This or PVCSpec is required. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| accessModes | +[]string | +
+ accessModes contains the desired access modes the volume should have.
+More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1 + |
+ false | +
| dataSource | +object | +
+ dataSource field can be used to specify either:
+* An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot)
+* An existing PVC (PersistentVolumeClaim)
+If the provisioner or an external controller can support the specified data source,
+it will create a new volume based on the contents of the specified data source.
+When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef,
+and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified.
+If the namespace is specified, then dataSourceRef will not be copied to dataSource. + |
+ false | +
| dataSourceRef | +object | +
+ dataSourceRef specifies the object from which to populate the volume with data, if a non-empty
+volume is desired. This may be any object from a non-empty API group (non
+core object) or a PersistentVolumeClaim object.
+When this field is specified, volume binding will only succeed if the type of
+the specified object matches some installed volume populator or dynamic
+provisioner.
+This field will replace the functionality of the dataSource field and as such
+if both fields are non-empty, they must have the same value. For backwards
+compatibility, when namespace isn't specified in dataSourceRef,
+both fields (dataSource and dataSourceRef) will be set to the same
+value automatically if one of them is empty and the other is non-empty.
+When namespace is specified in dataSourceRef,
+dataSource isn't set to the same value and must be empty.
+There are three important differences between dataSource and dataSourceRef:
+* While dataSource only allows two specific types of objects, dataSourceRef
+ allows any non-core object, as well as PersistentVolumeClaim objects.
+* While dataSource ignores disallowed values (dropping them), dataSourceRef
+ preserves all values, and generates an error if a disallowed value is
+ specified.
+* While dataSource only allows local objects, dataSourceRef allows objects
+ in any namespaces.
+(Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled.
+(Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled. + |
+ false | +
| resources | +object | +
+ resources represents the minimum resources the volume should have.
+If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements
+that are lower than previous value but must still be higher than capacity recorded in the
+status field of the claim.
+More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources + |
+ false | +
| selector | +object | +
+ selector is a label query over volumes to consider for binding. + |
+ false | +
| storageClassName | +string | +
+ storageClassName is the name of the StorageClass required by the claim.
+More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1 + |
+ false | +
| volumeAttributesClassName | +string | +
+ volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim.
+If specified, the CSI driver will create or update the volume with the attributes defined
+in the corresponding VolumeAttributesClass. This has a different purpose than storageClassName,
+it can be changed after the claim is created. An empty string or nil value indicates that no
+VolumeAttributesClass will be applied to the claim. If the claim enters an Infeasible error state,
+this field can be reset to its previous value (including nil) to cancel the modification.
+If the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be
+set to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource
+exists.
+More info: https://kubernetes.io/docs/concepts/storage/volume-attributes-classes/ + |
+ false | +
| volumeMode | +string | +
+ volumeMode defines what type of volume is required by the claim.
+Value of Filesystem is implied when not included in claim spec. + |
+ false | +
| volumeName | +string | +
+ volumeName is the binding reference to the PersistentVolume backing this claim. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| kind | +string | +
+ Kind is the type of resource being referenced + |
+ true | +
| name | +string | +
+ Name is the name of resource being referenced + |
+ true | +
| apiGroup | +string | +
+ APIGroup is the group for the resource being referenced.
+If APIGroup is not specified, the specified Kind must be in the core API group.
+For any other third-party types, APIGroup is required. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| kind | +string | +
+ Kind is the type of resource being referenced + |
+ true | +
| name | +string | +
+ Name is the name of resource being referenced + |
+ true | +
| apiGroup | +string | +
+ APIGroup is the group for the resource being referenced.
+If APIGroup is not specified, the specified Kind must be in the core API group.
+For any other third-party types, APIGroup is required. + |
+ false | +
| namespace | +string | +
+ Namespace is the namespace of resource being referenced
+Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details.
+(Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| limits | +map[string]int or string | +
+ Limits describes the maximum amount of compute resources allowed.
+More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ + |
+ false | +
| requests | +map[string]int or string | +
+ Requests describes the minimum amount of compute resources required.
+If Requests is omitted for a container, it defaults to Limits if that is explicitly specified,
+otherwise to an implementation-defined value. Requests cannot exceed Limits.
+More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| matchExpressions | +[]object | +
+ matchExpressions is a list of label selector requirements. The requirements are ANDed. + |
+ false | +
| matchLabels | +map[string]string | +
+ matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
+map is equivalent to an element of matchExpressions, whose key field is "key", the
+operator is "In", and the values array contains only "value". The requirements are ANDed. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| key | +string | +
+ key is the label key that the selector applies to. + |
+ true | +
| operator | +string | +
+ operator represents a key's relationship to a set of values.
+Valid operators are In, NotIn, Exists and DoesNotExist. + |
+ true | +
| values | +[]string | +
+ values is an array of string values. If the operator is In or NotIn,
+the values array must be non-empty. If the operator is Exists or DoesNotExist,
+the values array must be empty. This array is replaced during a strategic
+merge patch. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| awsElasticBlockStore | +object | +
+ awsElasticBlockStore represents an AWS Disk resource that is attached to a
+kubelet's host machine and then exposed to the pod.
+Deprecated: AWSElasticBlockStore is deprecated. All operations for the in-tree
+awsElasticBlockStore type are redirected to the ebs.csi.aws.com CSI driver.
+More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore + |
+ false | +
| azureDisk | +object | +
+ azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.
+Deprecated: AzureDisk is deprecated. All operations for the in-tree azureDisk type
+are redirected to the disk.csi.azure.com CSI driver. + |
+ false | +
| azureFile | +object | +
+ azureFile represents an Azure File Service mount on the host and bind mount to the pod.
+Deprecated: AzureFile is deprecated. All operations for the in-tree azureFile type
+are redirected to the file.csi.azure.com CSI driver. + |
+ false | +
| cephfs | +object | +
+ cephFS represents a Ceph FS mount on the host that shares a pod's lifetime.
+Deprecated: CephFS is deprecated and the in-tree cephfs type is no longer supported. + |
+ false | +
| cinder | +object | +
+ cinder represents a cinder volume attached and mounted on kubelets host machine.
+Deprecated: Cinder is deprecated. All operations for the in-tree cinder type
+are redirected to the cinder.csi.openstack.org CSI driver.
+More info: https://examples.k8s.io/mysql-cinder-pd/README.md + |
+ false | +
| configMap | +object | +
+ configMap represents a configMap that should populate this volume + |
+ false | +
| csi | +object | +
+ csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers. + |
+ false | +
| downwardAPI | +object | +
+ downwardAPI represents downward API about the pod that should populate this volume + |
+ false | +
| emptyDir | +object | +
+ emptyDir represents a temporary directory that shares a pod's lifetime.
+More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir + |
+ false | +
| ephemeral | +object | +
+ ephemeral represents a volume that is handled by a cluster storage driver.
+The volume's lifecycle is tied to the pod that defines it - it will be created before the pod starts,
+and deleted when the pod is removed.
+
+Use this if:
+a) the volume is only needed while the pod runs,
+b) features of normal volumes like restoring from snapshot or capacity
+ tracking are needed,
+c) the storage driver is specified through a storage class, and
+d) the storage driver supports dynamic volume provisioning through
+ a PersistentVolumeClaim (see EphemeralVolumeSource for more
+ information on the connection between this volume type
+ and PersistentVolumeClaim).
+
+Use PersistentVolumeClaim or one of the vendor-specific
+APIs for volumes that persist for longer than the lifecycle
+of an individual pod.
+
+Use CSI for light-weight local ephemeral volumes if the CSI driver is meant to
+be used that way - see the documentation of the driver for
+more information.
+
+A pod can use both types of ephemeral volumes and
+persistent volumes at the same time. + |
+ false | +
| fc | +object | +
+ fc represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod. + |
+ false | +
| flexVolume | +object | +
+ flexVolume represents a generic volume resource that is
+provisioned/attached using an exec based plugin.
+Deprecated: FlexVolume is deprecated. Consider using a CSIDriver instead. + |
+ false | +
| flocker | +object | +
+ flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running.
+Deprecated: Flocker is deprecated and the in-tree flocker type is no longer supported. + |
+ false | +
| gcePersistentDisk | +object | +
+ gcePersistentDisk represents a GCE Disk resource that is attached to a
+kubelet's host machine and then exposed to the pod.
+Deprecated: GCEPersistentDisk is deprecated. All operations for the in-tree
+gcePersistentDisk type are redirected to the pd.csi.storage.gke.io CSI driver.
+More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk + |
+ false | +
| gitRepo | +object | +
+ gitRepo represents a git repository at a particular revision.
+Deprecated: GitRepo is deprecated. To provision a container with a git repo, mount an
+EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir
+into the Pod's container. + |
+ false | +
| glusterfs | +object | +
+ glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime.
+Deprecated: Glusterfs is deprecated and the in-tree glusterfs type is no longer supported. + |
+ false | +
| hostPath | +object | +
+ hostPath represents a pre-existing file or directory on the host
+machine that is directly exposed to the container. This is generally
+used for system agents or other privileged things that are allowed
+to see the host machine. Most containers will NOT need this.
+More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath + |
+ false | +
| image | +object | +
+ image represents an OCI object (a container image or artifact) pulled and mounted on the kubelet's host machine.
+The volume is resolved at pod startup depending on which PullPolicy value is provided:
+
+- Always: the kubelet always attempts to pull the reference. Container creation will fail If the pull fails.
+- Never: the kubelet never pulls the reference and only uses a local image or artifact. Container creation will fail if the reference isn't present.
+- IfNotPresent: the kubelet pulls if the reference isn't already present on disk. Container creation will fail if the reference isn't present and the pull fails.
+
+The volume gets re-resolved if the pod gets deleted and recreated, which means that new remote content will become available on pod recreation.
+A failure to resolve or pull the image during pod startup will block containers from starting and may add significant latency. Failures will be retried using normal volume backoff and will be reported on the pod reason and message.
+The types of objects that may be mounted by this volume are defined by the container runtime implementation on a host machine and at minimum must include all valid types supported by the container image field.
+The OCI object gets mounted in a single directory (spec.containers[*].volumeMounts.mountPath) by merging the manifest layers in the same way as for container images.
+The volume will be mounted read-only (ro) and non-executable files (noexec).
+Sub path mounts for containers are not supported (spec.containers[*].volumeMounts.subpath) before 1.33.
+The field spec.securityContext.fsGroupChangePolicy has no effect on this volume type. + |
+ false | +
| iscsi | +object | +
+ iscsi represents an ISCSI Disk resource that is attached to a
+kubelet's host machine and then exposed to the pod.
+More info: https://kubernetes.io/docs/concepts/storage/volumes/#iscsi + |
+ false | +
| nfs | +object | +
+ nfs represents an NFS mount on the host that shares a pod's lifetime
+More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs + |
+ false | +
| persistentVolumeClaim | +object | +
+ persistentVolumeClaimVolumeSource represents a reference to a
+PersistentVolumeClaim in the same namespace.
+More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims + |
+ false | +
| photonPersistentDisk | +object | +
+ photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine.
+Deprecated: PhotonPersistentDisk is deprecated and the in-tree photonPersistentDisk type is no longer supported. + |
+ false | +
| portworxVolume | +object | +
+ portworxVolume represents a portworx volume attached and mounted on kubelets host machine.
+Deprecated: PortworxVolume is deprecated. All operations for the in-tree portworxVolume type
+are redirected to the pxd.portworx.com CSI driver when the CSIMigrationPortworx feature-gate
+is on. + |
+ false | +
| projected | +object | +
+ projected items for all in one resources secrets, configmaps, and downward API + |
+ false | +
| quobyte | +object | +
+ quobyte represents a Quobyte mount on the host that shares a pod's lifetime.
+Deprecated: Quobyte is deprecated and the in-tree quobyte type is no longer supported. + |
+ false | +
| rbd | +object | +
+ rbd represents a Rados Block Device mount on the host that shares a pod's lifetime.
+Deprecated: RBD is deprecated and the in-tree rbd type is no longer supported. + |
+ false | +
| scaleIO | +object | +
+ scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.
+Deprecated: ScaleIO is deprecated and the in-tree scaleIO type is no longer supported. + |
+ false | +
| secret | +object | +
+ secret represents a secret that should populate this volume.
+More info: https://kubernetes.io/docs/concepts/storage/volumes#secret + |
+ false | +
| storageos | +object | +
+ storageOS represents a StorageOS volume attached and mounted on Kubernetes nodes.
+Deprecated: StorageOS is deprecated and the in-tree storageos type is no longer supported. + |
+ false | +
| vsphereVolume | +object | +
+ vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine.
+Deprecated: VsphereVolume is deprecated. All operations for the in-tree vsphereVolume type
+are redirected to the csi.vsphere.vmware.com CSI driver. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| volumeID | +string | +
+ volumeID is unique ID of the persistent disk resource in AWS (Amazon EBS volume).
+More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore + |
+ true | +
| fsType | +string | +
+ fsType is the filesystem type of the volume that you want to mount.
+Tip: Ensure that the filesystem type is supported by the host operating system.
+Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
+More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore + |
+ false | +
| partition | +integer | +
+ partition is the partition in the volume that you want to mount.
+If omitted, the default is to mount by volume name.
+Examples: For volume /dev/sda1, you specify the partition as "1".
+Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). + + Format: int32 + |
+ false | +
| readOnly | +boolean | +
+ readOnly value true will force the readOnly setting in VolumeMounts.
+More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| diskName | +string | +
+ diskName is the Name of the data disk in the blob storage + |
+ true | +
| diskURI | +string | +
+ diskURI is the URI of data disk in the blob storage + |
+ true | +
| cachingMode | +string | +
+ cachingMode is the Host Caching mode: None, Read Only, Read Write. + |
+ false | +
| fsType | +string | +
+ fsType is Filesystem type to mount.
+Must be a filesystem type supported by the host operating system.
+Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. + + Default: ext4 + |
+ false | +
| kind | +string | +
+ kind expected values are 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 + |
+ false | +
| readOnly | +boolean | +
+ readOnly Defaults to false (read/write). ReadOnly here will force
+the ReadOnly setting in VolumeMounts. + + Default: false + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| secretName | +string | +
+ secretName is the name of secret that contains Azure Storage Account Name and Key + |
+ true | +
| shareName | +string | +
+ shareName is the azure share Name + |
+ true | +
| readOnly | +boolean | +
+ readOnly defaults to false (read/write). ReadOnly here will force
+the ReadOnly setting in VolumeMounts. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| monitors | +[]string | +
+ monitors is Required: Monitors is a collection of Ceph monitors
+More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it + |
+ true | +
| path | +string | +
+ path is Optional: Used as the mounted root, rather than the full Ceph tree, default is / + |
+ false | +
| readOnly | +boolean | +
+ readOnly is Optional: Defaults to false (read/write). ReadOnly here will force
+the ReadOnly setting in VolumeMounts.
+More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it + |
+ false | +
| secretFile | +string | +
+ secretFile is Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret
+More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it + |
+ false | +
| secretRef | +object | +
+ secretRef is Optional: SecretRef is reference to the authentication secret for User, default is empty.
+More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it + |
+ false | +
| user | +string | +
+ user is optional: User is the rados user name, default is admin
+More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ Name of the referent.
+This field is effectively required, but due to backwards compatibility is
+allowed to be empty. Instances of this type with an empty value here are
+almost certainly wrong.
+More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + + Default: + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| volumeID | +string | +
+ volumeID used to identify the volume in cinder.
+More info: https://examples.k8s.io/mysql-cinder-pd/README.md + |
+ true | +
| fsType | +string | +
+ fsType is the filesystem type to mount.
+Must be a filesystem type supported by the host operating system.
+Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
+More info: https://examples.k8s.io/mysql-cinder-pd/README.md + |
+ false | +
| readOnly | +boolean | +
+ readOnly defaults to false (read/write). ReadOnly here will force
+the ReadOnly setting in VolumeMounts.
+More info: https://examples.k8s.io/mysql-cinder-pd/README.md + |
+ false | +
| secretRef | +object | +
+ secretRef is optional: points to a secret object containing parameters used to connect
+to OpenStack. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ Name of the referent.
+This field is effectively required, but due to backwards compatibility is
+allowed to be empty. Instances of this type with an empty value here are
+almost certainly wrong.
+More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + + Default: + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| defaultMode | +integer | +
+ defaultMode is optional: mode bits used to set permissions on created files by default.
+Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511.
+YAML accepts both octal and decimal values, JSON requires decimal values for mode bits.
+Defaults to 0644.
+Directories within the path are not affected by this setting.
+This might be in conflict with other options that affect the file
+mode, like fsGroup, and the result can be other mode bits set. + + Format: int32 + |
+ false | +
| items | +[]object | +
+ items if unspecified, each key-value pair in the Data field of the referenced
+ConfigMap will be projected into the volume as a file whose name is the
+key and content is the value. If specified, the listed keys will be
+projected into the specified paths, and unlisted keys will not be
+present. If a key is specified which is not present in the ConfigMap,
+the volume setup will error unless it is marked optional. Paths must be
+relative and may not contain the '..' path or start with '..'. + |
+ false | +
| name | +string | +
+ Name of the referent.
+This field is effectively required, but due to backwards compatibility is
+allowed to be empty. Instances of this type with an empty value here are
+almost certainly wrong.
+More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + + Default: + |
+ false | +
| optional | +boolean | +
+ optional specify whether the ConfigMap or its keys must be defined + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| key | +string | +
+ key is the key to project. + |
+ true | +
| path | +string | +
+ path is the relative path of the file to map the key to.
+May not be an absolute path.
+May not contain the path element '..'.
+May not start with the string '..'. + |
+ true | +
| mode | +integer | +
+ mode is Optional: mode bits used to set permissions on this file.
+Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511.
+YAML accepts both octal and decimal values, JSON requires decimal values for mode bits.
+If not specified, the volume defaultMode will be used.
+This might be in conflict with other options that affect the file
+mode, like fsGroup, and the result can be other mode bits set. + + Format: int32 + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| driver | +string | +
+ driver is the name of the CSI driver that handles this volume.
+Consult with your admin for the correct name as registered in the cluster. + |
+ true | +
| fsType | +string | +
+ fsType to mount. Ex. "ext4", "xfs", "ntfs".
+If not provided, the empty value is passed to the associated CSI driver
+which will determine the default filesystem to apply. + |
+ false | +
| nodePublishSecretRef | +object | +
+ nodePublishSecretRef is a reference to the secret object containing
+sensitive information to pass to the CSI driver to complete the CSI
+NodePublishVolume and NodeUnpublishVolume calls.
+This field is optional, and may be empty if no secret is required. If the
+secret object contains more than one secret, all secret references are passed. + |
+ false | +
| readOnly | +boolean | +
+ readOnly specifies a read-only configuration for the volume.
+Defaults to false (read/write). + |
+ false | +
| volumeAttributes | +map[string]string | +
+ volumeAttributes stores driver-specific properties that are passed to the CSI
+driver. Consult your driver's documentation for supported values. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ Name of the referent.
+This field is effectively required, but due to backwards compatibility is
+allowed to be empty. Instances of this type with an empty value here are
+almost certainly wrong.
+More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + + Default: + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| defaultMode | +integer | +
+ Optional: mode bits to use on created files by default. Must be a
+Optional: mode bits used to set permissions on created files by default.
+Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511.
+YAML accepts both octal and decimal values, JSON requires decimal values for mode bits.
+Defaults to 0644.
+Directories within the path are not affected by this setting.
+This might be in conflict with other options that affect the file
+mode, like fsGroup, and the result can be other mode bits set. + + Format: int32 + |
+ false | +
| items | +[]object | +
+ Items is a list of downward API volume file + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| path | +string | +
+ Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..' + |
+ true | +
| fieldRef | +object | +
+ Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported. + |
+ false | +
| mode | +integer | +
+ Optional: mode bits used to set permissions on this file, must be an octal value
+between 0000 and 0777 or a decimal value between 0 and 511.
+YAML accepts both octal and decimal values, JSON requires decimal values for mode bits.
+If not specified, the volume defaultMode will be used.
+This might be in conflict with other options that affect the file
+mode, like fsGroup, and the result can be other mode bits set. + + Format: int32 + |
+ false | +
| resourceFieldRef | +object | +
+ Selects a resource of the container: only resources limits and requests
+(limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| fieldPath | +string | +
+ Path of the field to select in the specified API version. + |
+ true | +
| apiVersion | +string | +
+ Version of the schema the FieldPath is written in terms of, defaults to "v1". + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| resource | +string | +
+ Required: resource to select + |
+ true | +
| containerName | +string | +
+ Container name: required for volumes, optional for env vars + |
+ false | +
| divisor | +int or string | +
+ Specifies the output format of the exposed resources, defaults to "1" + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| medium | +string | +
+ medium represents what type of storage medium should back this directory.
+The default is "" which means to use the node's default medium.
+Must be an empty string (default) or Memory.
+More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir + |
+ false | +
| sizeLimit | +int or string | +
+ sizeLimit is the total amount of local storage required for this EmptyDir volume.
+The size limit is also applicable for memory medium.
+The maximum usage on memory medium EmptyDir would be the minimum value between
+the SizeLimit specified here and the sum of memory limits of all containers in a pod.
+The default is nil which means that the limit is undefined.
+More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| volumeClaimTemplate | +object | +
+ Will be used to create a stand-alone PVC to provision the volume.
+The pod in which this EphemeralVolumeSource is embedded will be the
+owner of the PVC, i.e. the PVC will be deleted together with the
+pod. The name of the PVC will be ` + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| spec | +object | +
+ The specification for the PersistentVolumeClaim. The entire content is
+copied unchanged into the PVC that gets created from this
+template. The same fields as in a PersistentVolumeClaim
+are also valid here. + |
+ true | +
| metadata | +object | +
+ May contain labels and annotations that will be copied into the PVC
+when creating it. No other fields are allowed and will be rejected during
+validation. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| accessModes | +[]string | +
+ accessModes contains the desired access modes the volume should have.
+More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1 + |
+ false | +
| dataSource | +object | +
+ dataSource field can be used to specify either:
+* An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot)
+* An existing PVC (PersistentVolumeClaim)
+If the provisioner or an external controller can support the specified data source,
+it will create a new volume based on the contents of the specified data source.
+When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef,
+and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified.
+If the namespace is specified, then dataSourceRef will not be copied to dataSource. + |
+ false | +
| dataSourceRef | +object | +
+ dataSourceRef specifies the object from which to populate the volume with data, if a non-empty
+volume is desired. This may be any object from a non-empty API group (non
+core object) or a PersistentVolumeClaim object.
+When this field is specified, volume binding will only succeed if the type of
+the specified object matches some installed volume populator or dynamic
+provisioner.
+This field will replace the functionality of the dataSource field and as such
+if both fields are non-empty, they must have the same value. For backwards
+compatibility, when namespace isn't specified in dataSourceRef,
+both fields (dataSource and dataSourceRef) will be set to the same
+value automatically if one of them is empty and the other is non-empty.
+When namespace is specified in dataSourceRef,
+dataSource isn't set to the same value and must be empty.
+There are three important differences between dataSource and dataSourceRef:
+* While dataSource only allows two specific types of objects, dataSourceRef
+ allows any non-core object, as well as PersistentVolumeClaim objects.
+* While dataSource ignores disallowed values (dropping them), dataSourceRef
+ preserves all values, and generates an error if a disallowed value is
+ specified.
+* While dataSource only allows local objects, dataSourceRef allows objects
+ in any namespaces.
+(Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled.
+(Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled. + |
+ false | +
| resources | +object | +
+ resources represents the minimum resources the volume should have.
+If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements
+that are lower than previous value but must still be higher than capacity recorded in the
+status field of the claim.
+More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources + |
+ false | +
| selector | +object | +
+ selector is a label query over volumes to consider for binding. + |
+ false | +
| storageClassName | +string | +
+ storageClassName is the name of the StorageClass required by the claim.
+More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1 + |
+ false | +
| volumeAttributesClassName | +string | +
+ volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim.
+If specified, the CSI driver will create or update the volume with the attributes defined
+in the corresponding VolumeAttributesClass. This has a different purpose than storageClassName,
+it can be changed after the claim is created. An empty string or nil value indicates that no
+VolumeAttributesClass will be applied to the claim. If the claim enters an Infeasible error state,
+this field can be reset to its previous value (including nil) to cancel the modification.
+If the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be
+set to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource
+exists.
+More info: https://kubernetes.io/docs/concepts/storage/volume-attributes-classes/ + |
+ false | +
| volumeMode | +string | +
+ volumeMode defines what type of volume is required by the claim.
+Value of Filesystem is implied when not included in claim spec. + |
+ false | +
| volumeName | +string | +
+ volumeName is the binding reference to the PersistentVolume backing this claim. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| kind | +string | +
+ Kind is the type of resource being referenced + |
+ true | +
| name | +string | +
+ Name is the name of resource being referenced + |
+ true | +
| apiGroup | +string | +
+ APIGroup is the group for the resource being referenced.
+If APIGroup is not specified, the specified Kind must be in the core API group.
+For any other third-party types, APIGroup is required. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| kind | +string | +
+ Kind is the type of resource being referenced + |
+ true | +
| name | +string | +
+ Name is the name of resource being referenced + |
+ true | +
| apiGroup | +string | +
+ APIGroup is the group for the resource being referenced.
+If APIGroup is not specified, the specified Kind must be in the core API group.
+For any other third-party types, APIGroup is required. + |
+ false | +
| namespace | +string | +
+ Namespace is the namespace of resource being referenced
+Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details.
+(Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| limits | +map[string]int or string | +
+ Limits describes the maximum amount of compute resources allowed.
+More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ + |
+ false | +
| requests | +map[string]int or string | +
+ Requests describes the minimum amount of compute resources required.
+If Requests is omitted for a container, it defaults to Limits if that is explicitly specified,
+otherwise to an implementation-defined value. Requests cannot exceed Limits.
+More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| matchExpressions | +[]object | +
+ matchExpressions is a list of label selector requirements. The requirements are ANDed. + |
+ false | +
| matchLabels | +map[string]string | +
+ matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
+map is equivalent to an element of matchExpressions, whose key field is "key", the
+operator is "In", and the values array contains only "value". The requirements are ANDed. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| key | +string | +
+ key is the label key that the selector applies to. + |
+ true | +
| operator | +string | +
+ operator represents a key's relationship to a set of values.
+Valid operators are In, NotIn, Exists and DoesNotExist. + |
+ true | +
| values | +[]string | +
+ values is an array of string values. If the operator is In or NotIn,
+the values array must be non-empty. If the operator is Exists or DoesNotExist,
+the values array must be empty. This array is replaced during a strategic
+merge patch. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| annotations | +map[string]string | +
+ + |
+ false | +
| finalizers | +[]string | +
+ + |
+ false | +
| labels | +map[string]string | +
+ + |
+ false | +
| name | +string | +
+ + |
+ false | +
| namespace | +string | +
+ + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| fsType | +string | +
+ fsType is the filesystem type to mount.
+Must be a filesystem type supported by the host operating system.
+Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. + |
+ false | +
| lun | +integer | +
+ lun is Optional: FC target lun number + + Format: int32 + |
+ false | +
| readOnly | +boolean | +
+ readOnly is Optional: Defaults to false (read/write). ReadOnly here will force
+the ReadOnly setting in VolumeMounts. + |
+ false | +
| targetWWNs | +[]string | +
+ targetWWNs is Optional: FC target worldwide names (WWNs) + |
+ false | +
| wwids | +[]string | +
+ wwids Optional: FC volume world wide identifiers (wwids)
+Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| driver | +string | +
+ driver is the name of the driver to use for this volume. + |
+ true | +
| fsType | +string | +
+ fsType is the filesystem type to mount.
+Must be a filesystem type supported by the host operating system.
+Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script. + |
+ false | +
| options | +map[string]string | +
+ options is Optional: this field holds extra command options if any. + |
+ false | +
| readOnly | +boolean | +
+ readOnly is Optional: defaults to false (read/write). ReadOnly here will force
+the ReadOnly setting in VolumeMounts. + |
+ false | +
| secretRef | +object | +
+ secretRef is Optional: secretRef is reference to the secret object containing
+sensitive information to pass to the plugin scripts. This may be
+empty if no secret object is specified. If the secret object
+contains more than one secret, all secrets are passed to the plugin
+scripts. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ Name of the referent.
+This field is effectively required, but due to backwards compatibility is
+allowed to be empty. Instances of this type with an empty value here are
+almost certainly wrong.
+More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + + Default: + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| datasetName | +string | +
+ datasetName is Name of the dataset stored as metadata -> name on the dataset for Flocker
+should be considered as deprecated + |
+ false | +
| datasetUUID | +string | +
+ datasetUUID is the UUID of the dataset. This is unique identifier of a Flocker dataset + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| pdName | +string | +
+ pdName is unique name of the PD resource in GCE. Used to identify the disk in GCE.
+More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk + |
+ true | +
| fsType | +string | +
+ fsType is filesystem type of the volume that you want to mount.
+Tip: Ensure that the filesystem type is supported by the host operating system.
+Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
+More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk + |
+ false | +
| partition | +integer | +
+ partition is the partition in the volume that you want to mount.
+If omitted, the default is to mount by volume name.
+Examples: For volume /dev/sda1, you specify the partition as "1".
+Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty).
+More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk + + Format: int32 + |
+ false | +
| readOnly | +boolean | +
+ readOnly here will force the ReadOnly setting in VolumeMounts.
+Defaults to false.
+More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| repository | +string | +
+ repository is the URL + |
+ true | +
| directory | +string | +
+ directory is the target directory name.
+Must not contain or start with '..'. If '.' is supplied, the volume directory will be the
+git repository. Otherwise, if specified, the volume will contain the git repository in
+the subdirectory with the given name. + |
+ false | +
| revision | +string | +
+ revision is the commit hash for the specified revision. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| endpoints | +string | +
+ endpoints is the endpoint name that details Glusterfs topology. + |
+ true | +
| path | +string | +
+ path is the Glusterfs volume path.
+More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod + |
+ true | +
| readOnly | +boolean | +
+ readOnly here will force the Glusterfs volume to be mounted with read-only permissions.
+Defaults to false.
+More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| path | +string | +
+ path of the directory on the host.
+If the path is a symlink, it will follow the link to the real path.
+More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath + |
+ true | +
| type | +string | +
+ type for HostPath Volume
+Defaults to ""
+More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| pullPolicy | +string | +
+ Policy for pulling OCI objects. Possible values are:
+Always: the kubelet always attempts to pull the reference. Container creation will fail If the pull fails.
+Never: the kubelet never pulls the reference and only uses a local image or artifact. Container creation will fail if the reference isn't present.
+IfNotPresent: the kubelet pulls if the reference isn't already present on disk. Container creation will fail if the reference isn't present and the pull fails.
+Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. + |
+ false | +
| reference | +string | +
+ Required: Image or artifact reference to be used.
+Behaves in the same way as pod.spec.containers[*].image.
+Pull secrets will be assembled in the same way as for the container image by looking up node credentials, SA image pull secrets, and pod spec image pull secrets.
+More info: https://kubernetes.io/docs/concepts/containers/images
+This field is optional to allow higher level config management to default or override
+container images in workload controllers like Deployments and StatefulSets. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| iqn | +string | +
+ iqn is the target iSCSI Qualified Name. + |
+ true | +
| lun | +integer | +
+ lun represents iSCSI Target Lun number. + + Format: int32 + |
+ true | +
| targetPortal | +string | +
+ targetPortal is iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port
+is other than default (typically TCP ports 860 and 3260). + |
+ true | +
| chapAuthDiscovery | +boolean | +
+ chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication + |
+ false | +
| chapAuthSession | +boolean | +
+ chapAuthSession defines whether support iSCSI Session CHAP authentication + |
+ false | +
| fsType | +string | +
+ fsType is the filesystem type of the volume that you want to mount.
+Tip: Ensure that the filesystem type is supported by the host operating system.
+Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
+More info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi + |
+ false | +
| initiatorName | +string | +
+ initiatorName is the custom iSCSI Initiator Name.
+If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface
+ + |
+ false | +
| iscsiInterface | +string | +
+ iscsiInterface is the interface Name that uses an iSCSI transport.
+Defaults to 'default' (tcp). + + Default: default + |
+ false | +
| portals | +[]string | +
+ portals is the iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port
+is other than default (typically TCP ports 860 and 3260). + |
+ false | +
| readOnly | +boolean | +
+ readOnly here will force the ReadOnly setting in VolumeMounts.
+Defaults to false. + |
+ false | +
| secretRef | +object | +
+ secretRef is the CHAP Secret for iSCSI target and initiator authentication + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ Name of the referent.
+This field is effectively required, but due to backwards compatibility is
+allowed to be empty. Instances of this type with an empty value here are
+almost certainly wrong.
+More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + + Default: + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| path | +string | +
+ path that is exported by the NFS server.
+More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs + |
+ true | +
| server | +string | +
+ server is the hostname or IP address of the NFS server.
+More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs + |
+ true | +
| readOnly | +boolean | +
+ readOnly here will force the NFS export to be mounted with read-only permissions.
+Defaults to false.
+More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| claimName | +string | +
+ claimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume.
+More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims + |
+ true | +
| readOnly | +boolean | +
+ readOnly Will force the ReadOnly setting in VolumeMounts.
+Default false. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| pdID | +string | +
+ pdID is the ID that identifies Photon Controller persistent disk + |
+ true | +
| fsType | +string | +
+ fsType is the filesystem type to mount.
+Must be a filesystem type supported by the host operating system.
+Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| volumeID | +string | +
+ volumeID uniquely identifies a Portworx volume + |
+ true | +
| fsType | +string | +
+ fSType represents the filesystem type to mount
+Must be a filesystem type supported by the host operating system.
+Ex. "ext4", "xfs". Implicitly inferred to be "ext4" if unspecified. + |
+ false | +
| readOnly | +boolean | +
+ readOnly defaults to false (read/write). ReadOnly here will force
+the ReadOnly setting in VolumeMounts. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| defaultMode | +integer | +
+ defaultMode are the mode bits used to set permissions on created files by default.
+Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511.
+YAML accepts both octal and decimal values, JSON requires decimal values for mode bits.
+Directories within the path are not affected by this setting.
+This might be in conflict with other options that affect the file
+mode, like fsGroup, and the result can be other mode bits set. + + Format: int32 + |
+ false | +
| sources | +[]object | +
+ sources is the list of volume projections. Each entry in this list
+handles one source. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| clusterTrustBundle | +object | +
+ ClusterTrustBundle allows a pod to access the `.spec.trustBundle` field
+of ClusterTrustBundle objects in an auto-updating file.
+
+Alpha, gated by the ClusterTrustBundleProjection feature gate.
+
+ClusterTrustBundle objects can either be selected by name, or by the
+combination of signer name and a label selector.
+
+Kubelet performs aggressive normalization of the PEM contents written
+into the pod filesystem. Esoteric PEM features such as inter-block
+comments and block headers are stripped. Certificates are deduplicated.
+The ordering of certificates within the file is arbitrary, and Kubelet
+may change the order over time. + |
+ false | +
| configMap | +object | +
+ configMap information about the configMap data to project + |
+ false | +
| downwardAPI | +object | +
+ downwardAPI information about the downwardAPI data to project + |
+ false | +
| podCertificate | +object | +
+ Projects an auto-rotating credential bundle (private key and certificate
+chain) that the pod can use either as a TLS client or server.
+
+Kubelet generates a private key and uses it to send a
+PodCertificateRequest to the named signer. Once the signer approves the
+request and issues a certificate chain, Kubelet writes the key and
+certificate chain to the pod filesystem. The pod does not start until
+certificates have been issued for each podCertificate projected volume
+source in its spec.
+
+Kubelet will begin trying to rotate the certificate at the time indicated
+by the signer using the PodCertificateRequest.Status.BeginRefreshAt
+timestamp.
+
+Kubelet can write a single file, indicated by the credentialBundlePath
+field, or separate files, indicated by the keyPath and
+certificateChainPath fields.
+
+The credential bundle is a single file in PEM format. The first PEM
+entry is the private key (in PKCS#8 format), and the remaining PEM
+entries are the certificate chain issued by the signer (typically,
+signers will return their certificate chain in leaf-to-root order).
+
+Prefer using the credential bundle format, since your application code
+can read it atomically. If you use keyPath and certificateChainPath,
+your application must make two separate file reads. If these coincide
+with a certificate rotation, it is possible that the private key and leaf
+certificate you read may not correspond to each other. Your application
+will need to check for this condition, and re-read until they are
+consistent.
+
+The named signer controls chooses the format of the certificate it
+issues; consult the signer implementation's documentation to learn how to
+use the certificates it issues. + |
+ false | +
| secret | +object | +
+ secret information about the secret data to project + |
+ false | +
| serviceAccountToken | +object | +
+ serviceAccountToken is information about the serviceAccountToken data to project + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| path | +string | +
+ Relative path from the volume root to write the bundle. + |
+ true | +
| labelSelector | +object | +
+ Select all ClusterTrustBundles that match this label selector. Only has
+effect if signerName is set. Mutually-exclusive with name. If unset,
+interpreted as "match nothing". If set but empty, interpreted as "match
+everything". + |
+ false | +
| name | +string | +
+ Select a single ClusterTrustBundle by object name. Mutually-exclusive
+with signerName and labelSelector. + |
+ false | +
| optional | +boolean | +
+ If true, don't block pod startup if the referenced ClusterTrustBundle(s)
+aren't available. If using name, then the named ClusterTrustBundle is
+allowed not to exist. If using signerName, then the combination of
+signerName and labelSelector is allowed to match zero
+ClusterTrustBundles. + |
+ false | +
| signerName | +string | +
+ Select all ClusterTrustBundles that match this signer name.
+Mutually-exclusive with name. The contents of all selected
+ClusterTrustBundles will be unified and deduplicated. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| matchExpressions | +[]object | +
+ matchExpressions is a list of label selector requirements. The requirements are ANDed. + |
+ false | +
| matchLabels | +map[string]string | +
+ matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
+map is equivalent to an element of matchExpressions, whose key field is "key", the
+operator is "In", and the values array contains only "value". The requirements are ANDed. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| key | +string | +
+ key is the label key that the selector applies to. + |
+ true | +
| operator | +string | +
+ operator represents a key's relationship to a set of values.
+Valid operators are In, NotIn, Exists and DoesNotExist. + |
+ true | +
| values | +[]string | +
+ values is an array of string values. If the operator is In or NotIn,
+the values array must be non-empty. If the operator is Exists or DoesNotExist,
+the values array must be empty. This array is replaced during a strategic
+merge patch. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| items | +[]object | +
+ items if unspecified, each key-value pair in the Data field of the referenced
+ConfigMap will be projected into the volume as a file whose name is the
+key and content is the value. If specified, the listed keys will be
+projected into the specified paths, and unlisted keys will not be
+present. If a key is specified which is not present in the ConfigMap,
+the volume setup will error unless it is marked optional. Paths must be
+relative and may not contain the '..' path or start with '..'. + |
+ false | +
| name | +string | +
+ Name of the referent.
+This field is effectively required, but due to backwards compatibility is
+allowed to be empty. Instances of this type with an empty value here are
+almost certainly wrong.
+More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + + Default: + |
+ false | +
| optional | +boolean | +
+ optional specify whether the ConfigMap or its keys must be defined + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| key | +string | +
+ key is the key to project. + |
+ true | +
| path | +string | +
+ path is the relative path of the file to map the key to.
+May not be an absolute path.
+May not contain the path element '..'.
+May not start with the string '..'. + |
+ true | +
| mode | +integer | +
+ mode is Optional: mode bits used to set permissions on this file.
+Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511.
+YAML accepts both octal and decimal values, JSON requires decimal values for mode bits.
+If not specified, the volume defaultMode will be used.
+This might be in conflict with other options that affect the file
+mode, like fsGroup, and the result can be other mode bits set. + + Format: int32 + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| items | +[]object | +
+ Items is a list of DownwardAPIVolume file + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| path | +string | +
+ Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..' + |
+ true | +
| fieldRef | +object | +
+ Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported. + |
+ false | +
| mode | +integer | +
+ Optional: mode bits used to set permissions on this file, must be an octal value
+between 0000 and 0777 or a decimal value between 0 and 511.
+YAML accepts both octal and decimal values, JSON requires decimal values for mode bits.
+If not specified, the volume defaultMode will be used.
+This might be in conflict with other options that affect the file
+mode, like fsGroup, and the result can be other mode bits set. + + Format: int32 + |
+ false | +
| resourceFieldRef | +object | +
+ Selects a resource of the container: only resources limits and requests
+(limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| fieldPath | +string | +
+ Path of the field to select in the specified API version. + |
+ true | +
| apiVersion | +string | +
+ Version of the schema the FieldPath is written in terms of, defaults to "v1". + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| resource | +string | +
+ Required: resource to select + |
+ true | +
| containerName | +string | +
+ Container name: required for volumes, optional for env vars + |
+ false | +
| divisor | +int or string | +
+ Specifies the output format of the exposed resources, defaults to "1" + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| keyType | +string | +
+ The type of keypair Kubelet will generate for the pod.
+
+Valid values are "RSA3072", "RSA4096", "ECDSAP256", "ECDSAP384",
+"ECDSAP521", and "ED25519". + |
+ true | +
| signerName | +string | +
+ Kubelet's generated CSRs will be addressed to this signer. + |
+ true | +
| certificateChainPath | +string | +
+ Write the certificate chain at this path in the projected volume.
+
+Most applications should use credentialBundlePath. When using keyPath
+and certificateChainPath, your application needs to check that the key
+and leaf certificate are consistent, because it is possible to read the
+files mid-rotation. + |
+ false | +
| credentialBundlePath | +string | +
+ Write the credential bundle at this path in the projected volume.
+
+The credential bundle is a single file that contains multiple PEM blocks.
+The first PEM block is a PRIVATE KEY block, containing a PKCS#8 private
+key.
+
+The remaining blocks are CERTIFICATE blocks, containing the issued
+certificate chain from the signer (leaf and any intermediates).
+
+Using credentialBundlePath lets your Pod's application code make a single
+atomic read that retrieves a consistent key and certificate chain. If you
+project them to separate files, your application code will need to
+additionally check that the leaf certificate was issued to the key. + |
+ false | +
| keyPath | +string | +
+ Write the key at this path in the projected volume.
+
+Most applications should use credentialBundlePath. When using keyPath
+and certificateChainPath, your application needs to check that the key
+and leaf certificate are consistent, because it is possible to read the
+files mid-rotation. + |
+ false | +
| maxExpirationSeconds | +integer | +
+ maxExpirationSeconds is the maximum lifetime permitted for the
+certificate.
+
+Kubelet copies this value verbatim into the PodCertificateRequests it
+generates for this projection.
+
+If omitted, kube-apiserver will set it to 86400(24 hours). kube-apiserver
+will reject values shorter than 3600 (1 hour). The maximum allowable
+value is 7862400 (91 days).
+
+The signer implementation is then free to issue a certificate with any
+lifetime *shorter* than MaxExpirationSeconds, but no shorter than 3600
+seconds (1 hour). This constraint is enforced by kube-apiserver.
+`kubernetes.io` signers will never issue certificates with a lifetime
+longer than 24 hours. + + Format: int32 + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| items | +[]object | +
+ items if unspecified, each key-value pair in the Data field of the referenced
+Secret will be projected into the volume as a file whose name is the
+key and content is the value. If specified, the listed keys will be
+projected into the specified paths, and unlisted keys will not be
+present. If a key is specified which is not present in the Secret,
+the volume setup will error unless it is marked optional. Paths must be
+relative and may not contain the '..' path or start with '..'. + |
+ false | +
| name | +string | +
+ Name of the referent.
+This field is effectively required, but due to backwards compatibility is
+allowed to be empty. Instances of this type with an empty value here are
+almost certainly wrong.
+More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + + Default: + |
+ false | +
| optional | +boolean | +
+ optional field specify whether the Secret or its key must be defined + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| key | +string | +
+ key is the key to project. + |
+ true | +
| path | +string | +
+ path is the relative path of the file to map the key to.
+May not be an absolute path.
+May not contain the path element '..'.
+May not start with the string '..'. + |
+ true | +
| mode | +integer | +
+ mode is Optional: mode bits used to set permissions on this file.
+Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511.
+YAML accepts both octal and decimal values, JSON requires decimal values for mode bits.
+If not specified, the volume defaultMode will be used.
+This might be in conflict with other options that affect the file
+mode, like fsGroup, and the result can be other mode bits set. + + Format: int32 + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| path | +string | +
+ path is the path relative to the mount point of the file to project the
+token into. + |
+ true | +
| audience | +string | +
+ audience is the intended audience of the token. A recipient of a token
+must identify itself with an identifier specified in the audience of the
+token, and otherwise should reject the token. The audience defaults to the
+identifier of the apiserver. + |
+ false | +
| expirationSeconds | +integer | +
+ expirationSeconds is the requested duration of validity of the service
+account token. As the token approaches expiration, the kubelet volume
+plugin will proactively rotate the service account token. The kubelet will
+start trying to rotate the token if the token is older than 80 percent of
+its time to live or if the token is older than 24 hours.Defaults to 1 hour
+and must be at least 10 minutes. + + Format: int64 + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| registry | +string | +
+ registry represents a single or multiple Quobyte Registry services
+specified as a string as host:port pair (multiple entries are separated with commas)
+which acts as the central registry for volumes + |
+ true | +
| volume | +string | +
+ volume is a string that references an already created Quobyte volume by name. + |
+ true | +
| group | +string | +
+ group to map volume access to
+Default is no group + |
+ false | +
| readOnly | +boolean | +
+ readOnly here will force the Quobyte volume to be mounted with read-only permissions.
+Defaults to false. + |
+ false | +
| tenant | +string | +
+ tenant owning the given Quobyte volume in the Backend
+Used with dynamically provisioned Quobyte volumes, value is set by the plugin + |
+ false | +
| user | +string | +
+ user to map volume access to
+Defaults to serivceaccount user + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| image | +string | +
+ image is the rados image name.
+More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it + |
+ true | +
| monitors | +[]string | +
+ monitors is a collection of Ceph monitors.
+More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it + |
+ true | +
| fsType | +string | +
+ fsType is the filesystem type of the volume that you want to mount.
+Tip: Ensure that the filesystem type is supported by the host operating system.
+Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
+More info: https://kubernetes.io/docs/concepts/storage/volumes#rbd + |
+ false | +
| keyring | +string | +
+ keyring is the path to key ring for RBDUser.
+Default is /etc/ceph/keyring.
+More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it + + Default: /etc/ceph/keyring + |
+ false | +
| pool | +string | +
+ pool is the rados pool name.
+Default is rbd.
+More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it + + Default: rbd + |
+ false | +
| readOnly | +boolean | +
+ readOnly here will force the ReadOnly setting in VolumeMounts.
+Defaults to false.
+More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it + |
+ false | +
| secretRef | +object | +
+ secretRef is name of the authentication secret for RBDUser. If provided
+overrides keyring.
+Default is nil.
+More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it + |
+ false | +
| user | +string | +
+ user is the rados user name.
+Default is admin.
+More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it + + Default: admin + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ Name of the referent.
+This field is effectively required, but due to backwards compatibility is
+allowed to be empty. Instances of this type with an empty value here are
+almost certainly wrong.
+More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + + Default: + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| gateway | +string | +
+ gateway is the host address of the ScaleIO API Gateway. + |
+ true | +
| secretRef | +object | +
+ secretRef references to the secret for ScaleIO user and other
+sensitive information. If this is not provided, Login operation will fail. + |
+ true | +
| system | +string | +
+ system is the name of the storage system as configured in ScaleIO. + |
+ true | +
| fsType | +string | +
+ fsType is the filesystem type to mount.
+Must be a filesystem type supported by the host operating system.
+Ex. "ext4", "xfs", "ntfs".
+Default is "xfs". + + Default: xfs + |
+ false | +
| protectionDomain | +string | +
+ protectionDomain is the name of the ScaleIO Protection Domain for the configured storage. + |
+ false | +
| readOnly | +boolean | +
+ readOnly Defaults to false (read/write). ReadOnly here will force
+the ReadOnly setting in VolumeMounts. + |
+ false | +
| sslEnabled | +boolean | +
+ sslEnabled Flag enable/disable SSL communication with Gateway, default false + |
+ false | +
| storageMode | +string | +
+ storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned.
+Default is ThinProvisioned. + + Default: ThinProvisioned + |
+ false | +
| storagePool | +string | +
+ storagePool is the ScaleIO Storage Pool associated with the protection domain. + |
+ false | +
| volumeName | +string | +
+ volumeName is the name of a volume already created in the ScaleIO system
+that is associated with this volume source. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ Name of the referent.
+This field is effectively required, but due to backwards compatibility is
+allowed to be empty. Instances of this type with an empty value here are
+almost certainly wrong.
+More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + + Default: + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| defaultMode | +integer | +
+ defaultMode is Optional: mode bits used to set permissions on created files by default.
+Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511.
+YAML accepts both octal and decimal values, JSON requires decimal values
+for mode bits. Defaults to 0644.
+Directories within the path are not affected by this setting.
+This might be in conflict with other options that affect the file
+mode, like fsGroup, and the result can be other mode bits set. + + Format: int32 + |
+ false | +
| items | +[]object | +
+ items If unspecified, each key-value pair in the Data field of the referenced
+Secret will be projected into the volume as a file whose name is the
+key and content is the value. If specified, the listed keys will be
+projected into the specified paths, and unlisted keys will not be
+present. If a key is specified which is not present in the Secret,
+the volume setup will error unless it is marked optional. Paths must be
+relative and may not contain the '..' path or start with '..'. + |
+ false | +
| optional | +boolean | +
+ optional field specify whether the Secret or its keys must be defined + |
+ false | +
| secretName | +string | +
+ secretName is the name of the secret in the pod's namespace to use.
+More info: https://kubernetes.io/docs/concepts/storage/volumes#secret + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| key | +string | +
+ key is the key to project. + |
+ true | +
| path | +string | +
+ path is the relative path of the file to map the key to.
+May not be an absolute path.
+May not contain the path element '..'.
+May not start with the string '..'. + |
+ true | +
| mode | +integer | +
+ mode is Optional: mode bits used to set permissions on this file.
+Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511.
+YAML accepts both octal and decimal values, JSON requires decimal values for mode bits.
+If not specified, the volume defaultMode will be used.
+This might be in conflict with other options that affect the file
+mode, like fsGroup, and the result can be other mode bits set. + + Format: int32 + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| fsType | +string | +
+ fsType is the filesystem type to mount.
+Must be a filesystem type supported by the host operating system.
+Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. + |
+ false | +
| readOnly | +boolean | +
+ readOnly defaults to false (read/write). ReadOnly here will force
+the ReadOnly setting in VolumeMounts. + |
+ false | +
| secretRef | +object | +
+ secretRef specifies the secret to use for obtaining the StorageOS API
+credentials. If not specified, default values will be attempted. + |
+ false | +
| volumeName | +string | +
+ volumeName is the human-readable name of the StorageOS volume. Volume
+names are only unique within a namespace. + |
+ false | +
| volumeNamespace | +string | +
+ volumeNamespace specifies the scope of the volume within StorageOS. If no
+namespace is specified then the Pod's namespace will be used. This allows the
+Kubernetes name scoping to be mirrored within StorageOS for tighter integration.
+Set VolumeName to any name to override the default behaviour.
+Set to "default" if you are not using namespaces within StorageOS.
+Namespaces that do not pre-exist within StorageOS will be created. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ Name of the referent.
+This field is effectively required, but due to backwards compatibility is
+allowed to be empty. Instances of this type with an empty value here are
+almost certainly wrong.
+More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + + Default: + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| volumePath | +string | +
+ volumePath is the path that identifies vSphere volume vmdk + |
+ true | +
| fsType | +string | +
+ fsType is filesystem type to mount.
+Must be a filesystem type supported by the host operating system.
+Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. + |
+ false | +
| storagePolicyID | +string | +
+ storagePolicyID is the storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName. + |
+ false | +
| storagePolicyName | +string | +
+ storagePolicyName is the storage Policy Based Management (SPBM) profile name. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| accessModes | +[]string | +
+ accessModes contains the desired access modes the volume should have.
+More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1 + |
+ false | +
| dataSource | +object | +
+ dataSource field can be used to specify either:
+* An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot)
+* An existing PVC (PersistentVolumeClaim)
+If the provisioner or an external controller can support the specified data source,
+it will create a new volume based on the contents of the specified data source.
+When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef,
+and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified.
+If the namespace is specified, then dataSourceRef will not be copied to dataSource. + |
+ false | +
| dataSourceRef | +object | +
+ dataSourceRef specifies the object from which to populate the volume with data, if a non-empty
+volume is desired. This may be any object from a non-empty API group (non
+core object) or a PersistentVolumeClaim object.
+When this field is specified, volume binding will only succeed if the type of
+the specified object matches some installed volume populator or dynamic
+provisioner.
+This field will replace the functionality of the dataSource field and as such
+if both fields are non-empty, they must have the same value. For backwards
+compatibility, when namespace isn't specified in dataSourceRef,
+both fields (dataSource and dataSourceRef) will be set to the same
+value automatically if one of them is empty and the other is non-empty.
+When namespace is specified in dataSourceRef,
+dataSource isn't set to the same value and must be empty.
+There are three important differences between dataSource and dataSourceRef:
+* While dataSource only allows two specific types of objects, dataSourceRef
+ allows any non-core object, as well as PersistentVolumeClaim objects.
+* While dataSource ignores disallowed values (dropping them), dataSourceRef
+ preserves all values, and generates an error if a disallowed value is
+ specified.
+* While dataSource only allows local objects, dataSourceRef allows objects
+ in any namespaces.
+(Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled.
+(Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled. + |
+ false | +
| resources | +object | +
+ resources represents the minimum resources the volume should have.
+If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements
+that are lower than previous value but must still be higher than capacity recorded in the
+status field of the claim.
+More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources + |
+ false | +
| selector | +object | +
+ selector is a label query over volumes to consider for binding. + |
+ false | +
| storageClassName | +string | +
+ storageClassName is the name of the StorageClass required by the claim.
+More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1 + |
+ false | +
| volumeAttributesClassName | +string | +
+ volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim.
+If specified, the CSI driver will create or update the volume with the attributes defined
+in the corresponding VolumeAttributesClass. This has a different purpose than storageClassName,
+it can be changed after the claim is created. An empty string or nil value indicates that no
+VolumeAttributesClass will be applied to the claim. If the claim enters an Infeasible error state,
+this field can be reset to its previous value (including nil) to cancel the modification.
+If the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be
+set to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource
+exists.
+More info: https://kubernetes.io/docs/concepts/storage/volume-attributes-classes/ + |
+ false | +
| volumeMode | +string | +
+ volumeMode defines what type of volume is required by the claim.
+Value of Filesystem is implied when not included in claim spec. + |
+ false | +
| volumeName | +string | +
+ volumeName is the binding reference to the PersistentVolume backing this claim. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| kind | +string | +
+ Kind is the type of resource being referenced + |
+ true | +
| name | +string | +
+ Name is the name of resource being referenced + |
+ true | +
| apiGroup | +string | +
+ APIGroup is the group for the resource being referenced.
+If APIGroup is not specified, the specified Kind must be in the core API group.
+For any other third-party types, APIGroup is required. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| kind | +string | +
+ Kind is the type of resource being referenced + |
+ true | +
| name | +string | +
+ Name is the name of resource being referenced + |
+ true | +
| apiGroup | +string | +
+ APIGroup is the group for the resource being referenced.
+If APIGroup is not specified, the specified Kind must be in the core API group.
+For any other third-party types, APIGroup is required. + |
+ false | +
| namespace | +string | +
+ Namespace is the namespace of resource being referenced
+Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details.
+(Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| limits | +map[string]int or string | +
+ Limits describes the maximum amount of compute resources allowed.
+More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ + |
+ false | +
| requests | +map[string]int or string | +
+ Requests describes the minimum amount of compute resources required.
+If Requests is omitted for a container, it defaults to Limits if that is explicitly specified,
+otherwise to an implementation-defined value. Requests cannot exceed Limits.
+More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| matchExpressions | +[]object | +
+ matchExpressions is a list of label selector requirements. The requirements are ANDed. + |
+ false | +
| matchLabels | +map[string]string | +
+ matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
+map is equivalent to an element of matchExpressions, whose key field is "key", the
+operator is "In", and the values array contains only "value". The requirements are ANDed. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| key | +string | +
+ key is the label key that the selector applies to. + |
+ true | +
| operator | +string | +
+ operator represents a key's relationship to a set of values.
+Valid operators are In, NotIn, Exists and DoesNotExist. + |
+ true | +
| values | +[]string | +
+ values is an array of string values. If the operator is In or NotIn,
+the values array must be non-empty. If the operator is Exists or DoesNotExist,
+the values array must be empty. This array is replaced during a strategic
+merge patch. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| additionalSeedService | +object | +
+ ServiceConfigAdditions exposes additional options for each service + |
+ false | +
| allpodsService | +object | +
+ ServiceConfigAdditions exposes additional options for each service + |
+ false | +
| dcService | +object | +
+ ServiceConfigAdditions exposes additional options for each service + |
+ false | +
| nodePortService | +object | +
+ ServiceConfigAdditions exposes additional options for each service + |
+ false | +
| seedService | +object | +
+ ServiceConfigAdditions exposes additional options for each service + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| additionalAnnotations | +map[string]string | +
+ + |
+ false | +
| additionalLabels | +map[string]string | +
+ + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| additionalAnnotations | +map[string]string | +
+ + |
+ false | +
| additionalLabels | +map[string]string | +
+ + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| additionalAnnotations | +map[string]string | +
+ + |
+ false | +
| additionalLabels | +map[string]string | +
+ + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| additionalAnnotations | +map[string]string | +
+ + |
+ false | +
| additionalLabels | +map[string]string | +
+ + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| additionalAnnotations | +map[string]string | +
+ + |
+ false | +
| additionalLabels | +map[string]string | +
+ + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| pulsarServiceUrl | +string | +
+ + |
+ true | +
| cdcConcurrentProcessors | +integer | +
+ + |
+ false | +
| cdcPollIntervalM | +integer | +
+ + |
+ false | +
| cdcWorkingDir | +string | +
+ + |
+ false | +
| errorCommitLogReprocessEnabled | +boolean | +
+ + |
+ false | +
| pulsarAuthParams | +string | +
+ + |
+ false | +
| pulsarAuthPluginClassName | +string | +
+ + |
+ false | +
| pulsarBatchDelayInMs | +integer | +
+ + |
+ false | +
| pulsarKeyBasedBatcher | +boolean | +
+ + |
+ false | +
| pulsarMaxPendingMessages | +integer | +
+ + |
+ false | +
| pulsarMaxPendingMessagesAcrossPartitions | +integer | +
+ + |
+ false | +
| sslAllowInsecureConnection | +string | +
+ + |
+ false | +
| sslCipherSuites | +string | +
+ + |
+ false | +
| sslEnabledProtocols | +string | +
+ + |
+ false | +
| sslHostnameVerificationEnable | +string | +
+ + |
+ false | +
| sslKeystorePassword | +string | +
+ + |
+ false | +
| sslKeystorePath | +string | +
+ + |
+ false | +
| sslProvider | +string | +
+ + |
+ false | +
| sslTruststorePassword | +string | +
+ + |
+ false | +
| sslTruststorePath | +string | +
+ + |
+ false | +
| sslTruststoreType | +string | +
+ + |
+ false | +
| topicPrefix | +string | +
+ + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| claims | +[]object | +
+ Claims lists the names of resources, defined in spec.resourceClaims,
+that are used by this container.
+
+This field depends on the
+DynamicResourceAllocation feature gate.
+
+This field is immutable. It can only be set for containers. + |
+ false | +
| limits | +map[string]int or string | +
+ Limits describes the maximum amount of compute resources allowed.
+More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ + |
+ false | +
| requests | +map[string]int or string | +
+ Requests describes the minimum amount of compute resources required.
+If Requests is omitted for a container, it defaults to Limits if that is explicitly specified,
+otherwise to an implementation-defined value. Requests cannot exceed Limits.
+More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ Name must match the name of one entry in pod.spec.resourceClaims of
+the Pod where this field is used. It makes that resource available
+inside a container. + |
+ true | +
| request | +string | +
+ Request is the name chosen for a request in the referenced claim.
+If empty, everything from the claim is made available, otherwise
+only the result of this request. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| analyticsEnabled | +boolean | +
+ + |
+ false | +
| graphEnabled | +boolean | +
+ + |
+ false | +
| searchEnabled | +boolean | +
+ + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| insecure | +object | +
+ + |
+ false | +
| manual | +object | +
+ + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| clientSecretName | +string | +
+ + |
+ true | +
| serverSecretName | +string | +
+ + |
+ true | +
| skipSecretValidation | +boolean | +
+ + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| hostNetwork | +boolean | +
+ + |
+ false | +
| nodePort | +object | +
+ + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| internode | +integer | +
+ + |
+ false | +
| internodeSSL | +integer | +
+ + |
+ false | +
| native | +integer | +
+ + |
+ false | +
| nativeSSL | +integer | +
+ + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| metadata | +object | +
+ Standard object's metadata.
+More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + |
+ false | +
| spec | +object | +
+ Specification of the desired behavior of the pod.
+More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| annotations | +map[string]string | +
+ + |
+ false | +
| finalizers | +[]string | +
+ + |
+ false | +
| labels | +map[string]string | +
+ + |
+ false | +
| name | +string | +
+ + |
+ false | +
| namespace | +string | +
+ + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| containers | +[]object | +
+ List of containers belonging to the pod.
+Containers cannot currently be added or removed.
+There must be at least one container in a Pod.
+Cannot be updated. + |
+ true | +
| activeDeadlineSeconds | +integer | +
+ Optional duration in seconds the pod may be active on the node relative to
+StartTime before the system will actively try to mark it failed and kill associated containers.
+Value must be a positive integer. + + Format: int64 + |
+ false | +
| affinity | +object | +
+ If specified, the pod's scheduling constraints + |
+ false | +
| automountServiceAccountToken | +boolean | +
+ AutomountServiceAccountToken indicates whether a service account token should be automatically mounted. + |
+ false | +
| dnsConfig | +object | +
+ Specifies the DNS parameters of a pod.
+Parameters specified here will be merged to the generated DNS
+configuration based on DNSPolicy. + |
+ false | +
| dnsPolicy | +string | +
+ Set DNS policy for the pod.
+Defaults to "ClusterFirst".
+Valid values are 'ClusterFirstWithHostNet', 'ClusterFirst', 'Default' or 'None'.
+DNS parameters given in DNSConfig will be merged with the policy selected with DNSPolicy.
+To have DNS options set along with hostNetwork, you have to specify DNS policy
+explicitly to 'ClusterFirstWithHostNet'. + |
+ false | +
| enableServiceLinks | +boolean | +
+ EnableServiceLinks indicates whether information about services should be injected into pod's
+environment variables, matching the syntax of Docker links.
+Optional: Defaults to true. + |
+ false | +
| ephemeralContainers | +[]object | +
+ List of ephemeral containers run in this pod. Ephemeral containers may be run in an existing
+pod to perform user-initiated actions such as debugging. This list cannot be specified when
+creating a pod, and it cannot be modified by updating the pod spec. In order to add an
+ephemeral container to an existing pod, use the pod's ephemeralcontainers subresource. + |
+ false | +
| hostAliases | +[]object | +
+ HostAliases is an optional list of hosts and IPs that will be injected into the pod's hosts
+file if specified. + |
+ false | +
| hostIPC | +boolean | +
+ Use the host's ipc namespace.
+Optional: Default to false. + |
+ false | +
| hostNetwork | +boolean | +
+ Host networking requested for this pod. Use the host's network namespace.
+When using HostNetwork you should specify ports so the scheduler is aware.
+When `hostNetwork` is true, specified `hostPort` fields in port definitions must match `containerPort`,
+and unspecified `hostPort` fields in port definitions are defaulted to match `containerPort`.
+Default to false. + |
+ false | +
| hostPID | +boolean | +
+ Use the host's pid namespace.
+Optional: Default to false. + |
+ false | +
| hostUsers | +boolean | +
+ Use the host's user namespace.
+Optional: Default to true.
+If set to true or not present, the pod will be run in the host user namespace, useful
+for when the pod needs a feature only available to the host user namespace, such as
+loading a kernel module with CAP_SYS_MODULE.
+When set to false, a new userns is created for the pod. Setting false is useful for
+mitigating container breakout vulnerabilities even allowing users to run their
+containers as root without actually having root privileges on the host.
+This field is alpha-level and is only honored by servers that enable the UserNamespacesSupport feature. + |
+ false | +
| hostname | +string | +
+ Specifies the hostname of the Pod
+If not specified, the pod's hostname will be set to a system-defined value. + |
+ false | +
| hostnameOverride | +string | +
+ HostnameOverride specifies an explicit override for the pod's hostname as perceived by the pod.
+This field only specifies the pod's hostname and does not affect its DNS records.
+When this field is set to a non-empty string:
+- It takes precedence over the values set in `hostname` and `subdomain`.
+- The Pod's hostname will be set to this value.
+- `setHostnameAsFQDN` must be nil or set to false.
+- `hostNetwork` must be set to false.
+
+This field must be a valid DNS subdomain as defined in RFC 1123 and contain at most 64 characters.
+Requires the HostnameOverride feature gate to be enabled. + |
+ false | +
| imagePullSecrets | +[]object | +
+ ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec.
+If specified, these secrets will be passed to individual puller implementations for them to use.
+More info: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod + |
+ false | +
| initContainers | +[]object | +
+ List of initialization containers belonging to the pod.
+Init containers are executed in order prior to containers being started. If any
+init container fails, the pod is considered to have failed and is handled according
+to its restartPolicy. The name for an init container or normal container must be
+unique among all containers.
+Init containers may not have Lifecycle actions, Readiness probes, Liveness probes, or Startup probes.
+The resourceRequirements of an init container are taken into account during scheduling
+by finding the highest request/limit for each resource type, and then using the max of
+that value or the sum of the normal containers. Limits are applied to init containers
+in a similar fashion.
+Init containers cannot currently be added or removed.
+Cannot be updated.
+More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/ + |
+ false | +
| nodeName | +string | +
+ NodeName indicates in which node this pod is scheduled.
+If empty, this pod is a candidate for scheduling by the scheduler defined in schedulerName.
+Once this field is set, the kubelet for this node becomes responsible for the lifecycle of this pod.
+This field should not be used to express a desire for the pod to be scheduled on a specific node.
+https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#nodename + |
+ false | +
| nodeSelector | +map[string]string | +
+ NodeSelector is a selector which must be true for the pod to fit on a node.
+Selector which must match a node's labels for the pod to be scheduled on that node.
+More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/ + |
+ false | +
| os | +object | +
+ Specifies the OS of the containers in the pod.
+Some pod and container fields are restricted if this is set.
+
+If the OS field is set to linux, the following fields must be unset:
+-securityContext.windowsOptions
+
+If the OS field is set to windows, following fields must be unset:
+- spec.hostPID
+- spec.hostIPC
+- spec.hostUsers
+- spec.resources
+- spec.securityContext.appArmorProfile
+- spec.securityContext.seLinuxOptions
+- spec.securityContext.seccompProfile
+- spec.securityContext.fsGroup
+- spec.securityContext.fsGroupChangePolicy
+- spec.securityContext.sysctls
+- spec.shareProcessNamespace
+- spec.securityContext.runAsUser
+- spec.securityContext.runAsGroup
+- spec.securityContext.supplementalGroups
+- spec.securityContext.supplementalGroupsPolicy
+- spec.containers[*].securityContext.appArmorProfile
+- spec.containers[*].securityContext.seLinuxOptions
+- spec.containers[*].securityContext.seccompProfile
+- spec.containers[*].securityContext.capabilities
+- spec.containers[*].securityContext.readOnlyRootFilesystem
+- spec.containers[*].securityContext.privileged
+- spec.containers[*].securityContext.allowPrivilegeEscalation
+- spec.containers[*].securityContext.procMount
+- spec.containers[*].securityContext.runAsUser
+- spec.containers[*].securityContext.runAsGroup + |
+ false | +
| overhead | +map[string]int or string | +
+ Overhead represents the resource overhead associated with running a pod for a given RuntimeClass.
+This field will be autopopulated at admission time by the RuntimeClass admission controller. If
+the RuntimeClass admission controller is enabled, overhead must not be set in Pod create requests.
+The RuntimeClass admission controller will reject Pod create requests which have the overhead already
+set. If RuntimeClass is configured and selected in the PodSpec, Overhead will be set to the value
+defined in the corresponding RuntimeClass, otherwise it will remain unset and treated as zero.
+More info: https://git.k8s.io/enhancements/keps/sig-node/688-pod-overhead/README.md + |
+ false | +
| preemptionPolicy | +string | +
+ PreemptionPolicy is the Policy for preempting pods with lower priority.
+One of Never, PreemptLowerPriority.
+Defaults to PreemptLowerPriority if unset. + |
+ false | +
| priority | +integer | +
+ The priority value. Various system components use this field to find the
+priority of the pod. When Priority Admission Controller is enabled, it
+prevents users from setting this field. The admission controller populates
+this field from PriorityClassName.
+The higher the value, the higher the priority. + + Format: int32 + |
+ false | +
| priorityClassName | +string | +
+ If specified, indicates the pod's priority. "system-node-critical" and
+"system-cluster-critical" are two special keywords which indicate the
+highest priorities with the former being the highest priority. Any other
+name must be defined by creating a PriorityClass object with that name.
+If not specified, the pod priority will be default or zero if there is no
+default. + |
+ false | +
| readinessGates | +[]object | +
+ If specified, all readiness gates will be evaluated for pod readiness.
+A pod is ready when all its containers are ready AND
+all conditions specified in the readiness gates have status equal to "True"
+More info: https://git.k8s.io/enhancements/keps/sig-network/580-pod-readiness-gates + |
+ false | +
| resourceClaims | +[]object | +
+ ResourceClaims defines which ResourceClaims must be allocated
+and reserved before the Pod is allowed to start. The resources
+will be made available to those containers which consume them
+by name.
+
+This is an alpha field and requires enabling the
+DynamicResourceAllocation feature gate.
+
+This field is immutable. + |
+ false | +
| resources | +object | +
+ Resources is the total amount of CPU and Memory resources required by all
+containers in the pod. It supports specifying Requests and Limits for
+"cpu", "memory" and "hugepages-" resource names only. ResourceClaims are not supported.
+
+This field enables fine-grained control over resource allocation for the
+entire pod, allowing resource sharing among containers in a pod.
+
+This is an alpha field and requires enabling the PodLevelResources feature
+gate. + |
+ false | +
| restartPolicy | +string | +
+ Restart policy for all containers within the pod.
+One of Always, OnFailure, Never. In some contexts, only a subset of those values may be permitted.
+Default to Always.
+More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy + |
+ false | +
| runtimeClassName | +string | +
+ RuntimeClassName refers to a RuntimeClass object in the node.k8s.io group, which should be used
+to run this pod. If no RuntimeClass resource matches the named class, the pod will not be run.
+If unset or empty, the "legacy" RuntimeClass will be used, which is an implicit class with an
+empty definition that uses the default runtime handler.
+More info: https://git.k8s.io/enhancements/keps/sig-node/585-runtime-class + |
+ false | +
| schedulerName | +string | +
+ If specified, the pod will be dispatched by specified scheduler.
+If not specified, the pod will be dispatched by default scheduler. + |
+ false | +
| schedulingGates | +[]object | +
+ SchedulingGates is an opaque list of values that if specified will block scheduling the pod.
+If schedulingGates is not empty, the pod will stay in the SchedulingGated state and the
+scheduler will not attempt to schedule the pod.
+
+SchedulingGates can only be set at pod creation time, and be removed only afterwards. + |
+ false | +
| securityContext | +object | +
+ SecurityContext holds pod-level security attributes and common container settings.
+Optional: Defaults to empty. See type description for default values of each field. + |
+ false | +
| serviceAccount | +string | +
+ DeprecatedServiceAccount is a deprecated alias for ServiceAccountName.
+Deprecated: Use serviceAccountName instead. + |
+ false | +
| serviceAccountName | +string | +
+ ServiceAccountName is the name of the ServiceAccount to use to run this pod.
+More info: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/ + |
+ false | +
| setHostnameAsFQDN | +boolean | +
+ If true the pod's hostname will be configured as the pod's FQDN, rather than the leaf name (the default).
+In Linux containers, this means setting the FQDN in the hostname field of the kernel (the nodename field of struct utsname).
+In Windows containers, this means setting the registry value of hostname for the registry key HKEY_LOCAL_MACHINE\\SYSTEM\\CurrentControlSet\\Services\\Tcpip\\Parameters to FQDN.
+If a pod does not have FQDN, this has no effect.
+Default to false. + |
+ false | +
| shareProcessNamespace | +boolean | +
+ Share a single process namespace between all of the containers in a pod.
+When this is set containers will be able to view and signal processes from other containers
+in the same pod, and the first process in each container will not be assigned PID 1.
+HostPID and ShareProcessNamespace cannot both be set.
+Optional: Default to false. + |
+ false | +
| subdomain | +string | +
+ If specified, the fully qualified Pod hostname will be " + |
+ false | +
| terminationGracePeriodSeconds | +integer | +
+ Optional duration in seconds the pod needs to terminate gracefully. May be decreased in delete request.
+Value must be non-negative integer. The value zero indicates stop immediately via
+the kill signal (no opportunity to shut down).
+If this value is nil, the default grace period will be used instead.
+The grace period is the duration in seconds after the processes running in the pod are sent
+a termination signal and the time when the processes are forcibly halted with a kill signal.
+Set this value longer than the expected cleanup time for your process.
+Defaults to 30 seconds. + + Format: int64 + |
+ false | +
| tolerations | +[]object | +
+ If specified, the pod's tolerations. + |
+ false | +
| topologySpreadConstraints | +[]object | +
+ TopologySpreadConstraints describes how a group of pods ought to spread across topology
+domains. Scheduler will schedule pods in a way which abides by the constraints.
+All topologySpreadConstraints are ANDed. + |
+ false | +
| volumes | +[]object | +
+ List of volumes that can be mounted by containers belonging to the pod.
+More info: https://kubernetes.io/docs/concepts/storage/volumes + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ Name of the container specified as a DNS_LABEL.
+Each container in a pod must have a unique name (DNS_LABEL).
+Cannot be updated. + |
+ true | +
| args | +[]string | +
+ Arguments to the entrypoint.
+The container image's CMD is used if this is not provided.
+Variable references $(VAR_NAME) are expanded using the container's environment. If a variable
+cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced
+to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will
+produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless
+of whether the variable exists or not. Cannot be updated.
+More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell + |
+ false | +
| command | +[]string | +
+ Entrypoint array. Not executed within a shell.
+The container image's ENTRYPOINT is used if this is not provided.
+Variable references $(VAR_NAME) are expanded using the container's environment. If a variable
+cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced
+to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will
+produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless
+of whether the variable exists or not. Cannot be updated.
+More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell + |
+ false | +
| env | +[]object | +
+ List of environment variables to set in the container.
+Cannot be updated. + |
+ false | +
| envFrom | +[]object | +
+ List of sources to populate environment variables in the container.
+The keys defined within a source may consist of any printable ASCII characters except '='.
+When a key exists in multiple
+sources, the value associated with the last source will take precedence.
+Values defined by an Env with a duplicate key will take precedence.
+Cannot be updated. + |
+ false | +
| image | +string | +
+ Container image name.
+More info: https://kubernetes.io/docs/concepts/containers/images
+This field is optional to allow higher level config management to default or override
+container images in workload controllers like Deployments and StatefulSets. + |
+ false | +
| imagePullPolicy | +string | +
+ Image pull policy.
+One of Always, Never, IfNotPresent.
+Defaults to Always if :latest tag is specified, or IfNotPresent otherwise.
+Cannot be updated.
+More info: https://kubernetes.io/docs/concepts/containers/images#updating-images + |
+ false | +
| lifecycle | +object | +
+ Actions that the management system should take in response to container lifecycle events.
+Cannot be updated. + |
+ false | +
| livenessProbe | +object | +
+ Periodic probe of container liveness.
+Container will be restarted if the probe fails.
+Cannot be updated.
+More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + |
+ false | +
| ports | +[]object | +
+ List of ports to expose from the container. Not specifying a port here
+DOES NOT prevent that port from being exposed. Any port which is
+listening on the default "0.0.0.0" address inside a container will be
+accessible from the network.
+Modifying this array with strategic merge patch may corrupt the data.
+For more information See https://github.com/kubernetes/kubernetes/issues/108255.
+Cannot be updated. + |
+ false | +
| readinessProbe | +object | +
+ Periodic probe of container service readiness.
+Container will be removed from service endpoints if the probe fails.
+Cannot be updated.
+More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + |
+ false | +
| resizePolicy | +[]object | +
+ Resources resize policy for the container. + |
+ false | +
| resources | +object | +
+ Compute Resources required by this container.
+Cannot be updated.
+More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ + |
+ false | +
| restartPolicy | +string | +
+ RestartPolicy defines the restart behavior of individual containers in a pod.
+This overrides the pod-level restart policy. When this field is not specified,
+the restart behavior is defined by the Pod's restart policy and the container type.
+Additionally, setting the RestartPolicy as "Always" for the init container will
+have the following effect:
+this init container will be continually restarted on
+exit until all regular containers have terminated. Once all regular
+containers have completed, all init containers with restartPolicy "Always"
+will be shut down. This lifecycle differs from normal init containers and
+is often referred to as a "sidecar" container. Although this init
+container still starts in the init container sequence, it does not wait
+for the container to complete before proceeding to the next init
+container. Instead, the next init container starts immediately after this
+init container is started, or after any startupProbe has successfully
+completed. + |
+ false | +
| restartPolicyRules | +[]object | +
+ Represents a list of rules to be checked to determine if the
+container should be restarted on exit. The rules are evaluated in
+order. Once a rule matches a container exit condition, the remaining
+rules are ignored. If no rule matches the container exit condition,
+the Container-level restart policy determines the whether the container
+is restarted or not. Constraints on the rules:
+- At most 20 rules are allowed.
+- Rules can have the same action.
+- Identical rules are not forbidden in validations.
+When rules are specified, container MUST set RestartPolicy explicitly
+even it if matches the Pod's RestartPolicy. + |
+ false | +
| securityContext | +object | +
+ SecurityContext defines the security options the container should be run with.
+If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext.
+More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/ + |
+ false | +
| startupProbe | +object | +
+ StartupProbe indicates that the Pod has successfully initialized.
+If specified, no other probes are executed until this completes successfully.
+If this probe fails, the Pod will be restarted, just as if the livenessProbe failed.
+This can be used to provide different probe parameters at the beginning of a Pod's lifecycle,
+when it might take a long time to load data or warm a cache, than during steady-state operation.
+This cannot be updated.
+More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + |
+ false | +
| stdin | +boolean | +
+ Whether this container should allocate a buffer for stdin in the container runtime. If this
+is not set, reads from stdin in the container will always result in EOF.
+Default is false. + |
+ false | +
| stdinOnce | +boolean | +
+ Whether the container runtime should close the stdin channel after it has been opened by
+a single attach. When stdin is true the stdin stream will remain open across multiple attach
+sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the
+first client attaches to stdin, and then remains open and accepts data until the client disconnects,
+at which time stdin is closed and remains closed until the container is restarted. If this
+flag is false, a container processes that reads from stdin will never receive an EOF.
+Default is false + |
+ false | +
| terminationMessagePath | +string | +
+ Optional: Path at which the file to which the container's termination message
+will be written is mounted into the container's filesystem.
+Message written is intended to be brief final status, such as an assertion failure message.
+Will be truncated by the node if greater than 4096 bytes. The total message length across
+all containers will be limited to 12kb.
+Defaults to /dev/termination-log.
+Cannot be updated. + |
+ false | +
| terminationMessagePolicy | +string | +
+ Indicate how the termination message should be populated. File will use the contents of
+terminationMessagePath to populate the container status message on both success and failure.
+FallbackToLogsOnError will use the last chunk of container log output if the termination
+message file is empty and the container exited with an error.
+The log output is limited to 2048 bytes or 80 lines, whichever is smaller.
+Defaults to File.
+Cannot be updated. + |
+ false | +
| tty | +boolean | +
+ Whether this container should allocate a TTY for itself, also requires 'stdin' to be true.
+Default is false. + |
+ false | +
| volumeDevices | +[]object | +
+ volumeDevices is the list of block devices to be used by the container. + |
+ false | +
| volumeMounts | +[]object | +
+ Pod volumes to mount into the container's filesystem.
+Cannot be updated. + |
+ false | +
| workingDir | +string | +
+ Container's working directory.
+If not specified, the container runtime's default will be used, which
+might be configured in the container image.
+Cannot be updated. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ Name of the environment variable.
+May consist of any printable ASCII characters except '='. + |
+ true | +
| value | +string | +
+ Variable references $(VAR_NAME) are expanded
+using the previously defined environment variables in the container and
+any service environment variables. If a variable cannot be resolved,
+the reference in the input string will be unchanged. Double $$ are reduced
+to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e.
+"$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)".
+Escaped references will never be expanded, regardless of whether the variable
+exists or not.
+Defaults to "". + |
+ false | +
| valueFrom | +object | +
+ Source for the environment variable's value. Cannot be used if value is not empty. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| configMapKeyRef | +object | +
+ Selects a key of a ConfigMap. + |
+ false | +
| fieldRef | +object | +
+ Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels[' + |
+ false | +
| fileKeyRef | +object | +
+ FileKeyRef selects a key of the env file.
+Requires the EnvFiles feature gate to be enabled. + |
+ false | +
| resourceFieldRef | +object | +
+ Selects a resource of the container: only resources limits and requests
+(limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. + |
+ false | +
| secretKeyRef | +object | +
+ Selects a key of a secret in the pod's namespace + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| key | +string | +
+ The key to select. + |
+ true | +
| name | +string | +
+ Name of the referent.
+This field is effectively required, but due to backwards compatibility is
+allowed to be empty. Instances of this type with an empty value here are
+almost certainly wrong.
+More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + + Default: + |
+ false | +
| optional | +boolean | +
+ Specify whether the ConfigMap or its key must be defined + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| fieldPath | +string | +
+ Path of the field to select in the specified API version. + |
+ true | +
| apiVersion | +string | +
+ Version of the schema the FieldPath is written in terms of, defaults to "v1". + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| key | +string | +
+ The key within the env file. An invalid key will prevent the pod from starting.
+The keys defined within a source may consist of any printable ASCII characters except '='.
+During Alpha stage of the EnvFiles feature gate, the key size is limited to 128 characters. + |
+ true | +
| path | +string | +
+ The path within the volume from which to select the file.
+Must be relative and may not contain the '..' path or start with '..'. + |
+ true | +
| volumeName | +string | +
+ The name of the volume mount containing the env file. + |
+ true | +
| optional | +boolean | +
+ Specify whether the file or its key must be defined. If the file or key
+does not exist, then the env var is not published.
+If optional is set to true and the specified key does not exist,
+the environment variable will not be set in the Pod's containers.
+
+If optional is set to false and the specified key does not exist,
+an error will be returned during Pod creation. + + Default: false + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| resource | +string | +
+ Required: resource to select + |
+ true | +
| containerName | +string | +
+ Container name: required for volumes, optional for env vars + |
+ false | +
| divisor | +int or string | +
+ Specifies the output format of the exposed resources, defaults to "1" + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| key | +string | +
+ The key of the secret to select from. Must be a valid secret key. + |
+ true | +
| name | +string | +
+ Name of the referent.
+This field is effectively required, but due to backwards compatibility is
+allowed to be empty. Instances of this type with an empty value here are
+almost certainly wrong.
+More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + + Default: + |
+ false | +
| optional | +boolean | +
+ Specify whether the Secret or its key must be defined + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| configMapRef | +object | +
+ The ConfigMap to select from + |
+ false | +
| prefix | +string | +
+ Optional text to prepend to the name of each environment variable.
+May consist of any printable ASCII characters except '='. + |
+ false | +
| secretRef | +object | +
+ The Secret to select from + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ Name of the referent.
+This field is effectively required, but due to backwards compatibility is
+allowed to be empty. Instances of this type with an empty value here are
+almost certainly wrong.
+More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + + Default: + |
+ false | +
| optional | +boolean | +
+ Specify whether the ConfigMap must be defined + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ Name of the referent.
+This field is effectively required, but due to backwards compatibility is
+allowed to be empty. Instances of this type with an empty value here are
+almost certainly wrong.
+More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + + Default: + |
+ false | +
| optional | +boolean | +
+ Specify whether the Secret must be defined + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| postStart | +object | +
+ PostStart is called immediately after a container is created. If the handler fails,
+the container is terminated and restarted according to its restart policy.
+Other management of the container blocks until the hook completes.
+More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks + |
+ false | +
| preStop | +object | +
+ PreStop is called immediately before a container is terminated due to an
+API request or management event such as liveness/startup probe failure,
+preemption, resource contention, etc. The handler is not called if the
+container crashes or exits. The Pod's termination grace period countdown begins before the
+PreStop hook is executed. Regardless of the outcome of the handler, the
+container will eventually terminate within the Pod's termination grace
+period (unless delayed by finalizers). Other management of the container blocks until the hook completes
+or until the termination grace period is reached.
+More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks + |
+ false | +
| stopSignal | +string | +
+ StopSignal defines which signal will be sent to a container when it is being stopped.
+If not specified, the default is defined by the container runtime in use.
+StopSignal can only be set for Pods with a non-empty .spec.os.name + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| exec | +object | +
+ Exec specifies a command to execute in the container. + |
+ false | +
| httpGet | +object | +
+ HTTPGet specifies an HTTP GET request to perform. + |
+ false | +
| sleep | +object | +
+ Sleep represents a duration that the container should sleep. + |
+ false | +
| tcpSocket | +object | +
+ Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept
+for backward compatibility. There is no validation of this field and
+lifecycle hooks will fail at runtime when it is specified. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| command | +[]string | +
+ Command is the command line to execute inside the container, the working directory for the
+command is root ('/') in the container's filesystem. The command is simply exec'd, it is
+not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
+a shell, you need to explicitly call out to that shell.
+Exit status of 0 is treated as live/healthy and non-zero is unhealthy. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| port | +int or string | +
+ Name or number of the port to access on the container.
+Number must be in the range 1 to 65535.
+Name must be an IANA_SVC_NAME. + |
+ true | +
| host | +string | +
+ Host name to connect to, defaults to the pod IP. You probably want to set
+"Host" in httpHeaders instead. + |
+ false | +
| httpHeaders | +[]object | +
+ Custom headers to set in the request. HTTP allows repeated headers. + |
+ false | +
| path | +string | +
+ Path to access on the HTTP server. + |
+ false | +
| scheme | +string | +
+ Scheme to use for connecting to the host.
+Defaults to HTTP. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ The header field name.
+This will be canonicalized upon output, so case-variant names will be understood as the same header. + |
+ true | +
| value | +string | +
+ The header field value + |
+ true | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| seconds | +integer | +
+ Seconds is the number of seconds to sleep. + + Format: int64 + |
+ true | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| port | +int or string | +
+ Number or name of the port to access on the container.
+Number must be in the range 1 to 65535.
+Name must be an IANA_SVC_NAME. + |
+ true | +
| host | +string | +
+ Optional: Host name to connect to, defaults to the pod IP. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| exec | +object | +
+ Exec specifies a command to execute in the container. + |
+ false | +
| httpGet | +object | +
+ HTTPGet specifies an HTTP GET request to perform. + |
+ false | +
| sleep | +object | +
+ Sleep represents a duration that the container should sleep. + |
+ false | +
| tcpSocket | +object | +
+ Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept
+for backward compatibility. There is no validation of this field and
+lifecycle hooks will fail at runtime when it is specified. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| command | +[]string | +
+ Command is the command line to execute inside the container, the working directory for the
+command is root ('/') in the container's filesystem. The command is simply exec'd, it is
+not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
+a shell, you need to explicitly call out to that shell.
+Exit status of 0 is treated as live/healthy and non-zero is unhealthy. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| port | +int or string | +
+ Name or number of the port to access on the container.
+Number must be in the range 1 to 65535.
+Name must be an IANA_SVC_NAME. + |
+ true | +
| host | +string | +
+ Host name to connect to, defaults to the pod IP. You probably want to set
+"Host" in httpHeaders instead. + |
+ false | +
| httpHeaders | +[]object | +
+ Custom headers to set in the request. HTTP allows repeated headers. + |
+ false | +
| path | +string | +
+ Path to access on the HTTP server. + |
+ false | +
| scheme | +string | +
+ Scheme to use for connecting to the host.
+Defaults to HTTP. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ The header field name.
+This will be canonicalized upon output, so case-variant names will be understood as the same header. + |
+ true | +
| value | +string | +
+ The header field value + |
+ true | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| seconds | +integer | +
+ Seconds is the number of seconds to sleep. + + Format: int64 + |
+ true | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| port | +int or string | +
+ Number or name of the port to access on the container.
+Number must be in the range 1 to 65535.
+Name must be an IANA_SVC_NAME. + |
+ true | +
| host | +string | +
+ Optional: Host name to connect to, defaults to the pod IP. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| exec | +object | +
+ Exec specifies a command to execute in the container. + |
+ false | +
| failureThreshold | +integer | +
+ Minimum consecutive failures for the probe to be considered failed after having succeeded.
+Defaults to 3. Minimum value is 1. + + Format: int32 + |
+ false | +
| grpc | +object | +
+ GRPC specifies a GRPC HealthCheckRequest. + |
+ false | +
| httpGet | +object | +
+ HTTPGet specifies an HTTP GET request to perform. + |
+ false | +
| initialDelaySeconds | +integer | +
+ Number of seconds after the container has started before liveness probes are initiated.
+More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + + Format: int32 + |
+ false | +
| periodSeconds | +integer | +
+ How often (in seconds) to perform the probe.
+Default to 10 seconds. Minimum value is 1. + + Format: int32 + |
+ false | +
| successThreshold | +integer | +
+ Minimum consecutive successes for the probe to be considered successful after having failed.
+Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. + + Format: int32 + |
+ false | +
| tcpSocket | +object | +
+ TCPSocket specifies a connection to a TCP port. + |
+ false | +
| terminationGracePeriodSeconds | +integer | +
+ Optional duration in seconds the pod needs to terminate gracefully upon probe failure.
+The grace period is the duration in seconds after the processes running in the pod are sent
+a termination signal and the time when the processes are forcibly halted with a kill signal.
+Set this value longer than the expected cleanup time for your process.
+If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this
+value overrides the value provided by the pod spec.
+Value must be non-negative integer. The value zero indicates stop immediately via
+the kill signal (no opportunity to shut down).
+This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.
+Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. + + Format: int64 + |
+ false | +
| timeoutSeconds | +integer | +
+ Number of seconds after which the probe times out.
+Defaults to 1 second. Minimum value is 1.
+More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + + Format: int32 + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| command | +[]string | +
+ Command is the command line to execute inside the container, the working directory for the
+command is root ('/') in the container's filesystem. The command is simply exec'd, it is
+not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
+a shell, you need to explicitly call out to that shell.
+Exit status of 0 is treated as live/healthy and non-zero is unhealthy. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| port | +integer | +
+ Port number of the gRPC service. Number must be in the range 1 to 65535. + + Format: int32 + |
+ true | +
| service | +string | +
+ Service is the name of the service to place in the gRPC HealthCheckRequest
+(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).
+
+If this is not specified, the default behavior is defined by gRPC. + + Default: + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| port | +int or string | +
+ Name or number of the port to access on the container.
+Number must be in the range 1 to 65535.
+Name must be an IANA_SVC_NAME. + |
+ true | +
| host | +string | +
+ Host name to connect to, defaults to the pod IP. You probably want to set
+"Host" in httpHeaders instead. + |
+ false | +
| httpHeaders | +[]object | +
+ Custom headers to set in the request. HTTP allows repeated headers. + |
+ false | +
| path | +string | +
+ Path to access on the HTTP server. + |
+ false | +
| scheme | +string | +
+ Scheme to use for connecting to the host.
+Defaults to HTTP. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ The header field name.
+This will be canonicalized upon output, so case-variant names will be understood as the same header. + |
+ true | +
| value | +string | +
+ The header field value + |
+ true | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| port | +int or string | +
+ Number or name of the port to access on the container.
+Number must be in the range 1 to 65535.
+Name must be an IANA_SVC_NAME. + |
+ true | +
| host | +string | +
+ Optional: Host name to connect to, defaults to the pod IP. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| containerPort | +integer | +
+ Number of port to expose on the pod's IP address.
+This must be a valid port number, 0 < x < 65536. + + Format: int32 + |
+ true | +
| hostIP | +string | +
+ What host IP to bind the external port to. + |
+ false | +
| hostPort | +integer | +
+ Number of port to expose on the host.
+If specified, this must be a valid port number, 0 < x < 65536.
+If HostNetwork is specified, this must match ContainerPort.
+Most containers do not need this. + + Format: int32 + |
+ false | +
| name | +string | +
+ If specified, this must be an IANA_SVC_NAME and unique within the pod. Each
+named port in a pod must have a unique name. Name for the port that can be
+referred to by services. + |
+ false | +
| protocol | +string | +
+ Protocol for port. Must be UDP, TCP, or SCTP.
+Defaults to "TCP". + + Default: TCP + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| exec | +object | +
+ Exec specifies a command to execute in the container. + |
+ false | +
| failureThreshold | +integer | +
+ Minimum consecutive failures for the probe to be considered failed after having succeeded.
+Defaults to 3. Minimum value is 1. + + Format: int32 + |
+ false | +
| grpc | +object | +
+ GRPC specifies a GRPC HealthCheckRequest. + |
+ false | +
| httpGet | +object | +
+ HTTPGet specifies an HTTP GET request to perform. + |
+ false | +
| initialDelaySeconds | +integer | +
+ Number of seconds after the container has started before liveness probes are initiated.
+More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + + Format: int32 + |
+ false | +
| periodSeconds | +integer | +
+ How often (in seconds) to perform the probe.
+Default to 10 seconds. Minimum value is 1. + + Format: int32 + |
+ false | +
| successThreshold | +integer | +
+ Minimum consecutive successes for the probe to be considered successful after having failed.
+Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. + + Format: int32 + |
+ false | +
| tcpSocket | +object | +
+ TCPSocket specifies a connection to a TCP port. + |
+ false | +
| terminationGracePeriodSeconds | +integer | +
+ Optional duration in seconds the pod needs to terminate gracefully upon probe failure.
+The grace period is the duration in seconds after the processes running in the pod are sent
+a termination signal and the time when the processes are forcibly halted with a kill signal.
+Set this value longer than the expected cleanup time for your process.
+If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this
+value overrides the value provided by the pod spec.
+Value must be non-negative integer. The value zero indicates stop immediately via
+the kill signal (no opportunity to shut down).
+This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.
+Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. + + Format: int64 + |
+ false | +
| timeoutSeconds | +integer | +
+ Number of seconds after which the probe times out.
+Defaults to 1 second. Minimum value is 1.
+More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + + Format: int32 + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| command | +[]string | +
+ Command is the command line to execute inside the container, the working directory for the
+command is root ('/') in the container's filesystem. The command is simply exec'd, it is
+not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
+a shell, you need to explicitly call out to that shell.
+Exit status of 0 is treated as live/healthy and non-zero is unhealthy. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| port | +integer | +
+ Port number of the gRPC service. Number must be in the range 1 to 65535. + + Format: int32 + |
+ true | +
| service | +string | +
+ Service is the name of the service to place in the gRPC HealthCheckRequest
+(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).
+
+If this is not specified, the default behavior is defined by gRPC. + + Default: + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| port | +int or string | +
+ Name or number of the port to access on the container.
+Number must be in the range 1 to 65535.
+Name must be an IANA_SVC_NAME. + |
+ true | +
| host | +string | +
+ Host name to connect to, defaults to the pod IP. You probably want to set
+"Host" in httpHeaders instead. + |
+ false | +
| httpHeaders | +[]object | +
+ Custom headers to set in the request. HTTP allows repeated headers. + |
+ false | +
| path | +string | +
+ Path to access on the HTTP server. + |
+ false | +
| scheme | +string | +
+ Scheme to use for connecting to the host.
+Defaults to HTTP. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ The header field name.
+This will be canonicalized upon output, so case-variant names will be understood as the same header. + |
+ true | +
| value | +string | +
+ The header field value + |
+ true | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| port | +int or string | +
+ Number or name of the port to access on the container.
+Number must be in the range 1 to 65535.
+Name must be an IANA_SVC_NAME. + |
+ true | +
| host | +string | +
+ Optional: Host name to connect to, defaults to the pod IP. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| resourceName | +string | +
+ Name of the resource to which this resource resize policy applies.
+Supported values: cpu, memory. + |
+ true | +
| restartPolicy | +string | +
+ Restart policy to apply when specified resource is resized.
+If not specified, it defaults to NotRequired. + |
+ true | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| claims | +[]object | +
+ Claims lists the names of resources, defined in spec.resourceClaims,
+that are used by this container.
+
+This field depends on the
+DynamicResourceAllocation feature gate.
+
+This field is immutable. It can only be set for containers. + |
+ false | +
| limits | +map[string]int or string | +
+ Limits describes the maximum amount of compute resources allowed.
+More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ + |
+ false | +
| requests | +map[string]int or string | +
+ Requests describes the minimum amount of compute resources required.
+If Requests is omitted for a container, it defaults to Limits if that is explicitly specified,
+otherwise to an implementation-defined value. Requests cannot exceed Limits.
+More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ Name must match the name of one entry in pod.spec.resourceClaims of
+the Pod where this field is used. It makes that resource available
+inside a container. + |
+ true | +
| request | +string | +
+ Request is the name chosen for a request in the referenced claim.
+If empty, everything from the claim is made available, otherwise
+only the result of this request. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| action | +string | +
+ Specifies the action taken on a container exit if the requirements
+are satisfied. The only possible value is "Restart" to restart the
+container. + |
+ true | +
| exitCodes | +object | +
+ Represents the exit codes to check on container exits. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| operator | +string | +
+ Represents the relationship between the container exit code(s) and the
+specified values. Possible values are:
+- In: the requirement is satisfied if the container exit code is in the
+ set of specified values.
+- NotIn: the requirement is satisfied if the container exit code is
+ not in the set of specified values. + |
+ true | +
| values | +[]integer | +
+ Specifies the set of values to check for container exit codes.
+At most 255 elements are allowed. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| allowPrivilegeEscalation | +boolean | +
+ AllowPrivilegeEscalation controls whether a process can gain more
+privileges than its parent process. This bool directly controls if
+the no_new_privs flag will be set on the container process.
+AllowPrivilegeEscalation is true always when the container is:
+1) run as Privileged
+2) has CAP_SYS_ADMIN
+Note that this field cannot be set when spec.os.name is windows. + |
+ false | +
| appArmorProfile | +object | +
+ appArmorProfile is the AppArmor options to use by this container. If set, this profile
+overrides the pod's appArmorProfile.
+Note that this field cannot be set when spec.os.name is windows. + |
+ false | +
| capabilities | +object | +
+ The capabilities to add/drop when running containers.
+Defaults to the default set of capabilities granted by the container runtime.
+Note that this field cannot be set when spec.os.name is windows. + |
+ false | +
| privileged | +boolean | +
+ Run container in privileged mode.
+Processes in privileged containers are essentially equivalent to root on the host.
+Defaults to false.
+Note that this field cannot be set when spec.os.name is windows. + |
+ false | +
| procMount | +string | +
+ procMount denotes the type of proc mount to use for the containers.
+The default value is Default which uses the container runtime defaults for
+readonly paths and masked paths.
+This requires the ProcMountType feature flag to be enabled.
+Note that this field cannot be set when spec.os.name is windows. + |
+ false | +
| readOnlyRootFilesystem | +boolean | +
+ Whether this container has a read-only root filesystem.
+Default is false.
+Note that this field cannot be set when spec.os.name is windows. + |
+ false | +
| runAsGroup | +integer | +
+ The GID to run the entrypoint of the container process.
+Uses runtime default if unset.
+May also be set in PodSecurityContext. If set in both SecurityContext and
+PodSecurityContext, the value specified in SecurityContext takes precedence.
+Note that this field cannot be set when spec.os.name is windows. + + Format: int64 + |
+ false | +
| runAsNonRoot | +boolean | +
+ Indicates that the container must run as a non-root user.
+If true, the Kubelet will validate the image at runtime to ensure that it
+does not run as UID 0 (root) and fail to start the container if it does.
+If unset or false, no such validation will be performed.
+May also be set in PodSecurityContext. If set in both SecurityContext and
+PodSecurityContext, the value specified in SecurityContext takes precedence. + |
+ false | +
| runAsUser | +integer | +
+ The UID to run the entrypoint of the container process.
+Defaults to user specified in image metadata if unspecified.
+May also be set in PodSecurityContext. If set in both SecurityContext and
+PodSecurityContext, the value specified in SecurityContext takes precedence.
+Note that this field cannot be set when spec.os.name is windows. + + Format: int64 + |
+ false | +
| seLinuxOptions | +object | +
+ The SELinux context to be applied to the container.
+If unspecified, the container runtime will allocate a random SELinux context for each
+container. May also be set in PodSecurityContext. If set in both SecurityContext and
+PodSecurityContext, the value specified in SecurityContext takes precedence.
+Note that this field cannot be set when spec.os.name is windows. + |
+ false | +
| seccompProfile | +object | +
+ The seccomp options to use by this container. If seccomp options are
+provided at both the pod & container level, the container options
+override the pod options.
+Note that this field cannot be set when spec.os.name is windows. + |
+ false | +
| windowsOptions | +object | +
+ The Windows specific settings applied to all containers.
+If unspecified, the options from the PodSecurityContext will be used.
+If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
+Note that this field cannot be set when spec.os.name is linux. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| type | +string | +
+ type indicates which kind of AppArmor profile will be applied.
+Valid options are:
+ Localhost - a profile pre-loaded on the node.
+ RuntimeDefault - the container runtime's default profile.
+ Unconfined - no AppArmor enforcement. + |
+ true | +
| localhostProfile | +string | +
+ localhostProfile indicates a profile loaded on the node that should be used.
+The profile must be preconfigured on the node to work.
+Must match the loaded name of the profile.
+Must be set if and only if type is "Localhost". + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| add | +[]string | +
+ Added capabilities + |
+ false | +
| drop | +[]string | +
+ Removed capabilities + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| level | +string | +
+ Level is SELinux level label that applies to the container. + |
+ false | +
| role | +string | +
+ Role is a SELinux role label that applies to the container. + |
+ false | +
| type | +string | +
+ Type is a SELinux type label that applies to the container. + |
+ false | +
| user | +string | +
+ User is a SELinux user label that applies to the container. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| type | +string | +
+ type indicates which kind of seccomp profile will be applied.
+Valid options are:
+
+Localhost - a profile defined in a file on the node should be used.
+RuntimeDefault - the container runtime default profile should be used.
+Unconfined - no profile should be applied. + |
+ true | +
| localhostProfile | +string | +
+ localhostProfile indicates a profile defined in a file on the node should be used.
+The profile must be preconfigured on the node to work.
+Must be a descending path, relative to the kubelet's configured seccomp profile location.
+Must be set if type is "Localhost". Must NOT be set for any other type. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| gmsaCredentialSpec | +string | +
+ GMSACredentialSpec is where the GMSA admission webhook
+(https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the
+GMSA credential spec named by the GMSACredentialSpecName field. + |
+ false | +
| gmsaCredentialSpecName | +string | +
+ GMSACredentialSpecName is the name of the GMSA credential spec to use. + |
+ false | +
| hostProcess | +boolean | +
+ HostProcess determines if a container should be run as a 'Host Process' container.
+All of a Pod's containers must have the same effective HostProcess value
+(it is not allowed to have a mix of HostProcess containers and non-HostProcess containers).
+In addition, if HostProcess is true then HostNetwork must also be set to true. + |
+ false | +
| runAsUserName | +string | +
+ The UserName in Windows to run the entrypoint of the container process.
+Defaults to the user specified in image metadata if unspecified.
+May also be set in PodSecurityContext. If set in both SecurityContext and
+PodSecurityContext, the value specified in SecurityContext takes precedence. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| exec | +object | +
+ Exec specifies a command to execute in the container. + |
+ false | +
| failureThreshold | +integer | +
+ Minimum consecutive failures for the probe to be considered failed after having succeeded.
+Defaults to 3. Minimum value is 1. + + Format: int32 + |
+ false | +
| grpc | +object | +
+ GRPC specifies a GRPC HealthCheckRequest. + |
+ false | +
| httpGet | +object | +
+ HTTPGet specifies an HTTP GET request to perform. + |
+ false | +
| initialDelaySeconds | +integer | +
+ Number of seconds after the container has started before liveness probes are initiated.
+More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + + Format: int32 + |
+ false | +
| periodSeconds | +integer | +
+ How often (in seconds) to perform the probe.
+Default to 10 seconds. Minimum value is 1. + + Format: int32 + |
+ false | +
| successThreshold | +integer | +
+ Minimum consecutive successes for the probe to be considered successful after having failed.
+Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. + + Format: int32 + |
+ false | +
| tcpSocket | +object | +
+ TCPSocket specifies a connection to a TCP port. + |
+ false | +
| terminationGracePeriodSeconds | +integer | +
+ Optional duration in seconds the pod needs to terminate gracefully upon probe failure.
+The grace period is the duration in seconds after the processes running in the pod are sent
+a termination signal and the time when the processes are forcibly halted with a kill signal.
+Set this value longer than the expected cleanup time for your process.
+If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this
+value overrides the value provided by the pod spec.
+Value must be non-negative integer. The value zero indicates stop immediately via
+the kill signal (no opportunity to shut down).
+This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.
+Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. + + Format: int64 + |
+ false | +
| timeoutSeconds | +integer | +
+ Number of seconds after which the probe times out.
+Defaults to 1 second. Minimum value is 1.
+More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + + Format: int32 + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| command | +[]string | +
+ Command is the command line to execute inside the container, the working directory for the
+command is root ('/') in the container's filesystem. The command is simply exec'd, it is
+not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
+a shell, you need to explicitly call out to that shell.
+Exit status of 0 is treated as live/healthy and non-zero is unhealthy. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| port | +integer | +
+ Port number of the gRPC service. Number must be in the range 1 to 65535. + + Format: int32 + |
+ true | +
| service | +string | +
+ Service is the name of the service to place in the gRPC HealthCheckRequest
+(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).
+
+If this is not specified, the default behavior is defined by gRPC. + + Default: + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| port | +int or string | +
+ Name or number of the port to access on the container.
+Number must be in the range 1 to 65535.
+Name must be an IANA_SVC_NAME. + |
+ true | +
| host | +string | +
+ Host name to connect to, defaults to the pod IP. You probably want to set
+"Host" in httpHeaders instead. + |
+ false | +
| httpHeaders | +[]object | +
+ Custom headers to set in the request. HTTP allows repeated headers. + |
+ false | +
| path | +string | +
+ Path to access on the HTTP server. + |
+ false | +
| scheme | +string | +
+ Scheme to use for connecting to the host.
+Defaults to HTTP. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ The header field name.
+This will be canonicalized upon output, so case-variant names will be understood as the same header. + |
+ true | +
| value | +string | +
+ The header field value + |
+ true | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| port | +int or string | +
+ Number or name of the port to access on the container.
+Number must be in the range 1 to 65535.
+Name must be an IANA_SVC_NAME. + |
+ true | +
| host | +string | +
+ Optional: Host name to connect to, defaults to the pod IP. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| devicePath | +string | +
+ devicePath is the path inside of the container that the device will be mapped to. + |
+ true | +
| name | +string | +
+ name must match the name of a persistentVolumeClaim in the pod + |
+ true | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| mountPath | +string | +
+ Path within the container at which the volume should be mounted. Must
+not contain ':'. + |
+ true | +
| name | +string | +
+ This must match the Name of a Volume. + |
+ true | +
| mountPropagation | +string | +
+ mountPropagation determines how mounts are propagated from the host
+to container and the other way around.
+When not set, MountPropagationNone is used.
+This field is beta in 1.10.
+When RecursiveReadOnly is set to IfPossible or to Enabled, MountPropagation must be None or unspecified
+(which defaults to None). + |
+ false | +
| readOnly | +boolean | +
+ Mounted read-only if true, read-write otherwise (false or unspecified).
+Defaults to false. + |
+ false | +
| recursiveReadOnly | +string | +
+ RecursiveReadOnly specifies whether read-only mounts should be handled
+recursively.
+
+If ReadOnly is false, this field has no meaning and must be unspecified.
+
+If ReadOnly is true, and this field is set to Disabled, the mount is not made
+recursively read-only. If this field is set to IfPossible, the mount is made
+recursively read-only, if it is supported by the container runtime. If this
+field is set to Enabled, the mount is made recursively read-only if it is
+supported by the container runtime, otherwise the pod will not be started and
+an error will be generated to indicate the reason.
+
+If this field is set to IfPossible or Enabled, MountPropagation must be set to
+None (or be unspecified, which defaults to None).
+
+If this field is not specified, it is treated as an equivalent of Disabled. + |
+ false | +
| subPath | +string | +
+ Path within the volume from which the container's volume should be mounted.
+Defaults to "" (volume's root). + |
+ false | +
| subPathExpr | +string | +
+ Expanded path within the volume from which the container's volume should be mounted.
+Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment.
+Defaults to "" (volume's root).
+SubPathExpr and SubPath are mutually exclusive. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| nodeAffinity | +object | +
+ Describes node affinity scheduling rules for the pod. + |
+ false | +
| podAffinity | +object | +
+ Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)). + |
+ false | +
| podAntiAffinity | +object | +
+ Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)). + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| preferredDuringSchedulingIgnoredDuringExecution | +[]object | +
+ The scheduler will prefer to schedule pods to nodes that satisfy
+the affinity expressions specified by this field, but it may choose
+a node that violates one or more of the expressions. The node that is
+most preferred is the one with the greatest sum of weights, i.e.
+for each node that meets all of the scheduling requirements (resource
+request, requiredDuringScheduling affinity expressions, etc.),
+compute a sum by iterating through the elements of this field and adding
+"weight" to the sum if the node matches the corresponding matchExpressions; the
+node(s) with the highest sum are the most preferred. + |
+ false | +
| requiredDuringSchedulingIgnoredDuringExecution | +object | +
+ If the affinity requirements specified by this field are not met at
+scheduling time, the pod will not be scheduled onto the node.
+If the affinity requirements specified by this field cease to be met
+at some point during pod execution (e.g. due to an update), the system
+may or may not try to eventually evict the pod from its node. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| preference | +object | +
+ A node selector term, associated with the corresponding weight. + |
+ true | +
| weight | +integer | +
+ Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100. + + Format: int32 + |
+ true | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| matchExpressions | +[]object | +
+ A list of node selector requirements by node's labels. + |
+ false | +
| matchFields | +[]object | +
+ A list of node selector requirements by node's fields. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| key | +string | +
+ The label key that the selector applies to. + |
+ true | +
| operator | +string | +
+ Represents a key's relationship to a set of values.
+Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. + |
+ true | +
| values | +[]string | +
+ An array of string values. If the operator is In or NotIn,
+the values array must be non-empty. If the operator is Exists or DoesNotExist,
+the values array must be empty. If the operator is Gt or Lt, the values
+array must have a single element, which will be interpreted as an integer.
+This array is replaced during a strategic merge patch. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| key | +string | +
+ The label key that the selector applies to. + |
+ true | +
| operator | +string | +
+ Represents a key's relationship to a set of values.
+Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. + |
+ true | +
| values | +[]string | +
+ An array of string values. If the operator is In or NotIn,
+the values array must be non-empty. If the operator is Exists or DoesNotExist,
+the values array must be empty. If the operator is Gt or Lt, the values
+array must have a single element, which will be interpreted as an integer.
+This array is replaced during a strategic merge patch. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| nodeSelectorTerms | +[]object | +
+ Required. A list of node selector terms. The terms are ORed. + |
+ true | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| matchExpressions | +[]object | +
+ A list of node selector requirements by node's labels. + |
+ false | +
| matchFields | +[]object | +
+ A list of node selector requirements by node's fields. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| key | +string | +
+ The label key that the selector applies to. + |
+ true | +
| operator | +string | +
+ Represents a key's relationship to a set of values.
+Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. + |
+ true | +
| values | +[]string | +
+ An array of string values. If the operator is In or NotIn,
+the values array must be non-empty. If the operator is Exists or DoesNotExist,
+the values array must be empty. If the operator is Gt or Lt, the values
+array must have a single element, which will be interpreted as an integer.
+This array is replaced during a strategic merge patch. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| key | +string | +
+ The label key that the selector applies to. + |
+ true | +
| operator | +string | +
+ Represents a key's relationship to a set of values.
+Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. + |
+ true | +
| values | +[]string | +
+ An array of string values. If the operator is In or NotIn,
+the values array must be non-empty. If the operator is Exists or DoesNotExist,
+the values array must be empty. If the operator is Gt or Lt, the values
+array must have a single element, which will be interpreted as an integer.
+This array is replaced during a strategic merge patch. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| preferredDuringSchedulingIgnoredDuringExecution | +[]object | +
+ The scheduler will prefer to schedule pods to nodes that satisfy
+the affinity expressions specified by this field, but it may choose
+a node that violates one or more of the expressions. The node that is
+most preferred is the one with the greatest sum of weights, i.e.
+for each node that meets all of the scheduling requirements (resource
+request, requiredDuringScheduling affinity expressions, etc.),
+compute a sum by iterating through the elements of this field and adding
+"weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the
+node(s) with the highest sum are the most preferred. + |
+ false | +
| requiredDuringSchedulingIgnoredDuringExecution | +[]object | +
+ If the affinity requirements specified by this field are not met at
+scheduling time, the pod will not be scheduled onto the node.
+If the affinity requirements specified by this field cease to be met
+at some point during pod execution (e.g. due to a pod label update), the
+system may or may not try to eventually evict the pod from its node.
+When there are multiple elements, the lists of nodes corresponding to each
+podAffinityTerm are intersected, i.e. all terms must be satisfied. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| podAffinityTerm | +object | +
+ Required. A pod affinity term, associated with the corresponding weight. + |
+ true | +
| weight | +integer | +
+ weight associated with matching the corresponding podAffinityTerm,
+in the range 1-100. + + Format: int32 + |
+ true | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| topologyKey | +string | +
+ This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching
+the labelSelector in the specified namespaces, where co-located is defined as running on a node
+whose value of the label with key topologyKey matches that of any node on which any of the
+selected pods is running.
+Empty topologyKey is not allowed. + |
+ true | +
| labelSelector | +object | +
+ A label query over a set of resources, in this case pods.
+If it's null, this PodAffinityTerm matches with no Pods. + |
+ false | +
| matchLabelKeys | +[]string | +
+ MatchLabelKeys is a set of pod label keys to select which pods will
+be taken into consideration. The keys are used to lookup values from the
+incoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)`
+to select the group of existing pods which pods will be taken into consideration
+for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming
+pod labels will be ignored. The default value is empty.
+The same key is forbidden to exist in both matchLabelKeys and labelSelector.
+Also, matchLabelKeys cannot be set when labelSelector isn't set. + |
+ false | +
| mismatchLabelKeys | +[]string | +
+ MismatchLabelKeys is a set of pod label keys to select which pods will
+be taken into consideration. The keys are used to lookup values from the
+incoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)`
+to select the group of existing pods which pods will be taken into consideration
+for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming
+pod labels will be ignored. The default value is empty.
+The same key is forbidden to exist in both mismatchLabelKeys and labelSelector.
+Also, mismatchLabelKeys cannot be set when labelSelector isn't set. + |
+ false | +
| namespaceSelector | +object | +
+ A label query over the set of namespaces that the term applies to.
+The term is applied to the union of the namespaces selected by this field
+and the ones listed in the namespaces field.
+null selector and null or empty namespaces list means "this pod's namespace".
+An empty selector ({}) matches all namespaces. + |
+ false | +
| namespaces | +[]string | +
+ namespaces specifies a static list of namespace names that the term applies to.
+The term is applied to the union of the namespaces listed in this field
+and the ones selected by namespaceSelector.
+null or empty namespaces list and null namespaceSelector means "this pod's namespace". + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| matchExpressions | +[]object | +
+ matchExpressions is a list of label selector requirements. The requirements are ANDed. + |
+ false | +
| matchLabels | +map[string]string | +
+ matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
+map is equivalent to an element of matchExpressions, whose key field is "key", the
+operator is "In", and the values array contains only "value". The requirements are ANDed. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| key | +string | +
+ key is the label key that the selector applies to. + |
+ true | +
| operator | +string | +
+ operator represents a key's relationship to a set of values.
+Valid operators are In, NotIn, Exists and DoesNotExist. + |
+ true | +
| values | +[]string | +
+ values is an array of string values. If the operator is In or NotIn,
+the values array must be non-empty. If the operator is Exists or DoesNotExist,
+the values array must be empty. This array is replaced during a strategic
+merge patch. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| matchExpressions | +[]object | +
+ matchExpressions is a list of label selector requirements. The requirements are ANDed. + |
+ false | +
| matchLabels | +map[string]string | +
+ matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
+map is equivalent to an element of matchExpressions, whose key field is "key", the
+operator is "In", and the values array contains only "value". The requirements are ANDed. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| key | +string | +
+ key is the label key that the selector applies to. + |
+ true | +
| operator | +string | +
+ operator represents a key's relationship to a set of values.
+Valid operators are In, NotIn, Exists and DoesNotExist. + |
+ true | +
| values | +[]string | +
+ values is an array of string values. If the operator is In or NotIn,
+the values array must be non-empty. If the operator is Exists or DoesNotExist,
+the values array must be empty. This array is replaced during a strategic
+merge patch. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| topologyKey | +string | +
+ This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching
+the labelSelector in the specified namespaces, where co-located is defined as running on a node
+whose value of the label with key topologyKey matches that of any node on which any of the
+selected pods is running.
+Empty topologyKey is not allowed. + |
+ true | +
| labelSelector | +object | +
+ A label query over a set of resources, in this case pods.
+If it's null, this PodAffinityTerm matches with no Pods. + |
+ false | +
| matchLabelKeys | +[]string | +
+ MatchLabelKeys is a set of pod label keys to select which pods will
+be taken into consideration. The keys are used to lookup values from the
+incoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)`
+to select the group of existing pods which pods will be taken into consideration
+for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming
+pod labels will be ignored. The default value is empty.
+The same key is forbidden to exist in both matchLabelKeys and labelSelector.
+Also, matchLabelKeys cannot be set when labelSelector isn't set. + |
+ false | +
| mismatchLabelKeys | +[]string | +
+ MismatchLabelKeys is a set of pod label keys to select which pods will
+be taken into consideration. The keys are used to lookup values from the
+incoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)`
+to select the group of existing pods which pods will be taken into consideration
+for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming
+pod labels will be ignored. The default value is empty.
+The same key is forbidden to exist in both mismatchLabelKeys and labelSelector.
+Also, mismatchLabelKeys cannot be set when labelSelector isn't set. + |
+ false | +
| namespaceSelector | +object | +
+ A label query over the set of namespaces that the term applies to.
+The term is applied to the union of the namespaces selected by this field
+and the ones listed in the namespaces field.
+null selector and null or empty namespaces list means "this pod's namespace".
+An empty selector ({}) matches all namespaces. + |
+ false | +
| namespaces | +[]string | +
+ namespaces specifies a static list of namespace names that the term applies to.
+The term is applied to the union of the namespaces listed in this field
+and the ones selected by namespaceSelector.
+null or empty namespaces list and null namespaceSelector means "this pod's namespace". + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| matchExpressions | +[]object | +
+ matchExpressions is a list of label selector requirements. The requirements are ANDed. + |
+ false | +
| matchLabels | +map[string]string | +
+ matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
+map is equivalent to an element of matchExpressions, whose key field is "key", the
+operator is "In", and the values array contains only "value". The requirements are ANDed. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| key | +string | +
+ key is the label key that the selector applies to. + |
+ true | +
| operator | +string | +
+ operator represents a key's relationship to a set of values.
+Valid operators are In, NotIn, Exists and DoesNotExist. + |
+ true | +
| values | +[]string | +
+ values is an array of string values. If the operator is In or NotIn,
+the values array must be non-empty. If the operator is Exists or DoesNotExist,
+the values array must be empty. This array is replaced during a strategic
+merge patch. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| matchExpressions | +[]object | +
+ matchExpressions is a list of label selector requirements. The requirements are ANDed. + |
+ false | +
| matchLabels | +map[string]string | +
+ matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
+map is equivalent to an element of matchExpressions, whose key field is "key", the
+operator is "In", and the values array contains only "value". The requirements are ANDed. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| key | +string | +
+ key is the label key that the selector applies to. + |
+ true | +
| operator | +string | +
+ operator represents a key's relationship to a set of values.
+Valid operators are In, NotIn, Exists and DoesNotExist. + |
+ true | +
| values | +[]string | +
+ values is an array of string values. If the operator is In or NotIn,
+the values array must be non-empty. If the operator is Exists or DoesNotExist,
+the values array must be empty. This array is replaced during a strategic
+merge patch. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| preferredDuringSchedulingIgnoredDuringExecution | +[]object | +
+ The scheduler will prefer to schedule pods to nodes that satisfy
+the anti-affinity expressions specified by this field, but it may choose
+a node that violates one or more of the expressions. The node that is
+most preferred is the one with the greatest sum of weights, i.e.
+for each node that meets all of the scheduling requirements (resource
+request, requiredDuringScheduling anti-affinity expressions, etc.),
+compute a sum by iterating through the elements of this field and subtracting
+"weight" from the sum if the node has pods which matches the corresponding podAffinityTerm; the
+node(s) with the highest sum are the most preferred. + |
+ false | +
| requiredDuringSchedulingIgnoredDuringExecution | +[]object | +
+ If the anti-affinity requirements specified by this field are not met at
+scheduling time, the pod will not be scheduled onto the node.
+If the anti-affinity requirements specified by this field cease to be met
+at some point during pod execution (e.g. due to a pod label update), the
+system may or may not try to eventually evict the pod from its node.
+When there are multiple elements, the lists of nodes corresponding to each
+podAffinityTerm are intersected, i.e. all terms must be satisfied. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| podAffinityTerm | +object | +
+ Required. A pod affinity term, associated with the corresponding weight. + |
+ true | +
| weight | +integer | +
+ weight associated with matching the corresponding podAffinityTerm,
+in the range 1-100. + + Format: int32 + |
+ true | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| topologyKey | +string | +
+ This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching
+the labelSelector in the specified namespaces, where co-located is defined as running on a node
+whose value of the label with key topologyKey matches that of any node on which any of the
+selected pods is running.
+Empty topologyKey is not allowed. + |
+ true | +
| labelSelector | +object | +
+ A label query over a set of resources, in this case pods.
+If it's null, this PodAffinityTerm matches with no Pods. + |
+ false | +
| matchLabelKeys | +[]string | +
+ MatchLabelKeys is a set of pod label keys to select which pods will
+be taken into consideration. The keys are used to lookup values from the
+incoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)`
+to select the group of existing pods which pods will be taken into consideration
+for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming
+pod labels will be ignored. The default value is empty.
+The same key is forbidden to exist in both matchLabelKeys and labelSelector.
+Also, matchLabelKeys cannot be set when labelSelector isn't set. + |
+ false | +
| mismatchLabelKeys | +[]string | +
+ MismatchLabelKeys is a set of pod label keys to select which pods will
+be taken into consideration. The keys are used to lookup values from the
+incoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)`
+to select the group of existing pods which pods will be taken into consideration
+for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming
+pod labels will be ignored. The default value is empty.
+The same key is forbidden to exist in both mismatchLabelKeys and labelSelector.
+Also, mismatchLabelKeys cannot be set when labelSelector isn't set. + |
+ false | +
| namespaceSelector | +object | +
+ A label query over the set of namespaces that the term applies to.
+The term is applied to the union of the namespaces selected by this field
+and the ones listed in the namespaces field.
+null selector and null or empty namespaces list means "this pod's namespace".
+An empty selector ({}) matches all namespaces. + |
+ false | +
| namespaces | +[]string | +
+ namespaces specifies a static list of namespace names that the term applies to.
+The term is applied to the union of the namespaces listed in this field
+and the ones selected by namespaceSelector.
+null or empty namespaces list and null namespaceSelector means "this pod's namespace". + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| matchExpressions | +[]object | +
+ matchExpressions is a list of label selector requirements. The requirements are ANDed. + |
+ false | +
| matchLabels | +map[string]string | +
+ matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
+map is equivalent to an element of matchExpressions, whose key field is "key", the
+operator is "In", and the values array contains only "value". The requirements are ANDed. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| key | +string | +
+ key is the label key that the selector applies to. + |
+ true | +
| operator | +string | +
+ operator represents a key's relationship to a set of values.
+Valid operators are In, NotIn, Exists and DoesNotExist. + |
+ true | +
| values | +[]string | +
+ values is an array of string values. If the operator is In or NotIn,
+the values array must be non-empty. If the operator is Exists or DoesNotExist,
+the values array must be empty. This array is replaced during a strategic
+merge patch. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| matchExpressions | +[]object | +
+ matchExpressions is a list of label selector requirements. The requirements are ANDed. + |
+ false | +
| matchLabels | +map[string]string | +
+ matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
+map is equivalent to an element of matchExpressions, whose key field is "key", the
+operator is "In", and the values array contains only "value". The requirements are ANDed. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| key | +string | +
+ key is the label key that the selector applies to. + |
+ true | +
| operator | +string | +
+ operator represents a key's relationship to a set of values.
+Valid operators are In, NotIn, Exists and DoesNotExist. + |
+ true | +
| values | +[]string | +
+ values is an array of string values. If the operator is In or NotIn,
+the values array must be non-empty. If the operator is Exists or DoesNotExist,
+the values array must be empty. This array is replaced during a strategic
+merge patch. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| topologyKey | +string | +
+ This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching
+the labelSelector in the specified namespaces, where co-located is defined as running on a node
+whose value of the label with key topologyKey matches that of any node on which any of the
+selected pods is running.
+Empty topologyKey is not allowed. + |
+ true | +
| labelSelector | +object | +
+ A label query over a set of resources, in this case pods.
+If it's null, this PodAffinityTerm matches with no Pods. + |
+ false | +
| matchLabelKeys | +[]string | +
+ MatchLabelKeys is a set of pod label keys to select which pods will
+be taken into consideration. The keys are used to lookup values from the
+incoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)`
+to select the group of existing pods which pods will be taken into consideration
+for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming
+pod labels will be ignored. The default value is empty.
+The same key is forbidden to exist in both matchLabelKeys and labelSelector.
+Also, matchLabelKeys cannot be set when labelSelector isn't set. + |
+ false | +
| mismatchLabelKeys | +[]string | +
+ MismatchLabelKeys is a set of pod label keys to select which pods will
+be taken into consideration. The keys are used to lookup values from the
+incoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)`
+to select the group of existing pods which pods will be taken into consideration
+for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming
+pod labels will be ignored. The default value is empty.
+The same key is forbidden to exist in both mismatchLabelKeys and labelSelector.
+Also, mismatchLabelKeys cannot be set when labelSelector isn't set. + |
+ false | +
| namespaceSelector | +object | +
+ A label query over the set of namespaces that the term applies to.
+The term is applied to the union of the namespaces selected by this field
+and the ones listed in the namespaces field.
+null selector and null or empty namespaces list means "this pod's namespace".
+An empty selector ({}) matches all namespaces. + |
+ false | +
| namespaces | +[]string | +
+ namespaces specifies a static list of namespace names that the term applies to.
+The term is applied to the union of the namespaces listed in this field
+and the ones selected by namespaceSelector.
+null or empty namespaces list and null namespaceSelector means "this pod's namespace". + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| matchExpressions | +[]object | +
+ matchExpressions is a list of label selector requirements. The requirements are ANDed. + |
+ false | +
| matchLabels | +map[string]string | +
+ matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
+map is equivalent to an element of matchExpressions, whose key field is "key", the
+operator is "In", and the values array contains only "value". The requirements are ANDed. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| key | +string | +
+ key is the label key that the selector applies to. + |
+ true | +
| operator | +string | +
+ operator represents a key's relationship to a set of values.
+Valid operators are In, NotIn, Exists and DoesNotExist. + |
+ true | +
| values | +[]string | +
+ values is an array of string values. If the operator is In or NotIn,
+the values array must be non-empty. If the operator is Exists or DoesNotExist,
+the values array must be empty. This array is replaced during a strategic
+merge patch. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| matchExpressions | +[]object | +
+ matchExpressions is a list of label selector requirements. The requirements are ANDed. + |
+ false | +
| matchLabels | +map[string]string | +
+ matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
+map is equivalent to an element of matchExpressions, whose key field is "key", the
+operator is "In", and the values array contains only "value". The requirements are ANDed. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| key | +string | +
+ key is the label key that the selector applies to. + |
+ true | +
| operator | +string | +
+ operator represents a key's relationship to a set of values.
+Valid operators are In, NotIn, Exists and DoesNotExist. + |
+ true | +
| values | +[]string | +
+ values is an array of string values. If the operator is In or NotIn,
+the values array must be non-empty. If the operator is Exists or DoesNotExist,
+the values array must be empty. This array is replaced during a strategic
+merge patch. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| nameservers | +[]string | +
+ A list of DNS name server IP addresses.
+This will be appended to the base nameservers generated from DNSPolicy.
+Duplicated nameservers will be removed. + |
+ false | +
| options | +[]object | +
+ A list of DNS resolver options.
+This will be merged with the base options generated from DNSPolicy.
+Duplicated entries will be removed. Resolution options given in Options
+will override those that appear in the base DNSPolicy. + |
+ false | +
| searches | +[]string | +
+ A list of DNS search domains for host-name lookup.
+This will be appended to the base search paths generated from DNSPolicy.
+Duplicated search paths will be removed. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ Name is this DNS resolver option's name.
+Required. + |
+ false | +
| value | +string | +
+ Value is this DNS resolver option's value. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ Name of the ephemeral container specified as a DNS_LABEL.
+This name must be unique among all containers, init containers and ephemeral containers. + |
+ true | +
| args | +[]string | +
+ Arguments to the entrypoint.
+The image's CMD is used if this is not provided.
+Variable references $(VAR_NAME) are expanded using the container's environment. If a variable
+cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced
+to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will
+produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless
+of whether the variable exists or not. Cannot be updated.
+More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell + |
+ false | +
| command | +[]string | +
+ Entrypoint array. Not executed within a shell.
+The image's ENTRYPOINT is used if this is not provided.
+Variable references $(VAR_NAME) are expanded using the container's environment. If a variable
+cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced
+to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will
+produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless
+of whether the variable exists or not. Cannot be updated.
+More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell + |
+ false | +
| env | +[]object | +
+ List of environment variables to set in the container.
+Cannot be updated. + |
+ false | +
| envFrom | +[]object | +
+ List of sources to populate environment variables in the container.
+The keys defined within a source may consist of any printable ASCII characters except '='.
+When a key exists in multiple
+sources, the value associated with the last source will take precedence.
+Values defined by an Env with a duplicate key will take precedence.
+Cannot be updated. + |
+ false | +
| image | +string | +
+ Container image name.
+More info: https://kubernetes.io/docs/concepts/containers/images + |
+ false | +
| imagePullPolicy | +string | +
+ Image pull policy.
+One of Always, Never, IfNotPresent.
+Defaults to Always if :latest tag is specified, or IfNotPresent otherwise.
+Cannot be updated.
+More info: https://kubernetes.io/docs/concepts/containers/images#updating-images + |
+ false | +
| lifecycle | +object | +
+ Lifecycle is not allowed for ephemeral containers. + |
+ false | +
| livenessProbe | +object | +
+ Probes are not allowed for ephemeral containers. + |
+ false | +
| ports | +[]object | +
+ Ports are not allowed for ephemeral containers. + |
+ false | +
| readinessProbe | +object | +
+ Probes are not allowed for ephemeral containers. + |
+ false | +
| resizePolicy | +[]object | +
+ Resources resize policy for the container. + |
+ false | +
| resources | +object | +
+ Resources are not allowed for ephemeral containers. Ephemeral containers use spare resources
+already allocated to the pod. + |
+ false | +
| restartPolicy | +string | +
+ Restart policy for the container to manage the restart behavior of each
+container within a pod.
+You cannot set this field on ephemeral containers. + |
+ false | +
| restartPolicyRules | +[]object | +
+ Represents a list of rules to be checked to determine if the
+container should be restarted on exit. You cannot set this field on
+ephemeral containers. + |
+ false | +
| securityContext | +object | +
+ Optional: SecurityContext defines the security options the ephemeral container should be run with.
+If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. + |
+ false | +
| startupProbe | +object | +
+ Probes are not allowed for ephemeral containers. + |
+ false | +
| stdin | +boolean | +
+ Whether this container should allocate a buffer for stdin in the container runtime. If this
+is not set, reads from stdin in the container will always result in EOF.
+Default is false. + |
+ false | +
| stdinOnce | +boolean | +
+ Whether the container runtime should close the stdin channel after it has been opened by
+a single attach. When stdin is true the stdin stream will remain open across multiple attach
+sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the
+first client attaches to stdin, and then remains open and accepts data until the client disconnects,
+at which time stdin is closed and remains closed until the container is restarted. If this
+flag is false, a container processes that reads from stdin will never receive an EOF.
+Default is false + |
+ false | +
| targetContainerName | +string | +
+ If set, the name of the container from PodSpec that this ephemeral container targets.
+The ephemeral container will be run in the namespaces (IPC, PID, etc) of this container.
+If not set then the ephemeral container uses the namespaces configured in the Pod spec.
+
+The container runtime must implement support for this feature. If the runtime does not
+support namespace targeting then the result of setting this field is undefined. + |
+ false | +
| terminationMessagePath | +string | +
+ Optional: Path at which the file to which the container's termination message
+will be written is mounted into the container's filesystem.
+Message written is intended to be brief final status, such as an assertion failure message.
+Will be truncated by the node if greater than 4096 bytes. The total message length across
+all containers will be limited to 12kb.
+Defaults to /dev/termination-log.
+Cannot be updated. + |
+ false | +
| terminationMessagePolicy | +string | +
+ Indicate how the termination message should be populated. File will use the contents of
+terminationMessagePath to populate the container status message on both success and failure.
+FallbackToLogsOnError will use the last chunk of container log output if the termination
+message file is empty and the container exited with an error.
+The log output is limited to 2048 bytes or 80 lines, whichever is smaller.
+Defaults to File.
+Cannot be updated. + |
+ false | +
| tty | +boolean | +
+ Whether this container should allocate a TTY for itself, also requires 'stdin' to be true.
+Default is false. + |
+ false | +
| volumeDevices | +[]object | +
+ volumeDevices is the list of block devices to be used by the container. + |
+ false | +
| volumeMounts | +[]object | +
+ Pod volumes to mount into the container's filesystem. Subpath mounts are not allowed for ephemeral containers.
+Cannot be updated. + |
+ false | +
| workingDir | +string | +
+ Container's working directory.
+If not specified, the container runtime's default will be used, which
+might be configured in the container image.
+Cannot be updated. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ Name of the environment variable.
+May consist of any printable ASCII characters except '='. + |
+ true | +
| value | +string | +
+ Variable references $(VAR_NAME) are expanded
+using the previously defined environment variables in the container and
+any service environment variables. If a variable cannot be resolved,
+the reference in the input string will be unchanged. Double $$ are reduced
+to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e.
+"$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)".
+Escaped references will never be expanded, regardless of whether the variable
+exists or not.
+Defaults to "". + |
+ false | +
| valueFrom | +object | +
+ Source for the environment variable's value. Cannot be used if value is not empty. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| configMapKeyRef | +object | +
+ Selects a key of a ConfigMap. + |
+ false | +
| fieldRef | +object | +
+ Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels[' + |
+ false | +
| fileKeyRef | +object | +
+ FileKeyRef selects a key of the env file.
+Requires the EnvFiles feature gate to be enabled. + |
+ false | +
| resourceFieldRef | +object | +
+ Selects a resource of the container: only resources limits and requests
+(limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. + |
+ false | +
| secretKeyRef | +object | +
+ Selects a key of a secret in the pod's namespace + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| key | +string | +
+ The key to select. + |
+ true | +
| name | +string | +
+ Name of the referent.
+This field is effectively required, but due to backwards compatibility is
+allowed to be empty. Instances of this type with an empty value here are
+almost certainly wrong.
+More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + + Default: + |
+ false | +
| optional | +boolean | +
+ Specify whether the ConfigMap or its key must be defined + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| fieldPath | +string | +
+ Path of the field to select in the specified API version. + |
+ true | +
| apiVersion | +string | +
+ Version of the schema the FieldPath is written in terms of, defaults to "v1". + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| key | +string | +
+ The key within the env file. An invalid key will prevent the pod from starting.
+The keys defined within a source may consist of any printable ASCII characters except '='.
+During Alpha stage of the EnvFiles feature gate, the key size is limited to 128 characters. + |
+ true | +
| path | +string | +
+ The path within the volume from which to select the file.
+Must be relative and may not contain the '..' path or start with '..'. + |
+ true | +
| volumeName | +string | +
+ The name of the volume mount containing the env file. + |
+ true | +
| optional | +boolean | +
+ Specify whether the file or its key must be defined. If the file or key
+does not exist, then the env var is not published.
+If optional is set to true and the specified key does not exist,
+the environment variable will not be set in the Pod's containers.
+
+If optional is set to false and the specified key does not exist,
+an error will be returned during Pod creation. + + Default: false + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| resource | +string | +
+ Required: resource to select + |
+ true | +
| containerName | +string | +
+ Container name: required for volumes, optional for env vars + |
+ false | +
| divisor | +int or string | +
+ Specifies the output format of the exposed resources, defaults to "1" + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| key | +string | +
+ The key of the secret to select from. Must be a valid secret key. + |
+ true | +
| name | +string | +
+ Name of the referent.
+This field is effectively required, but due to backwards compatibility is
+allowed to be empty. Instances of this type with an empty value here are
+almost certainly wrong.
+More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + + Default: + |
+ false | +
| optional | +boolean | +
+ Specify whether the Secret or its key must be defined + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| configMapRef | +object | +
+ The ConfigMap to select from + |
+ false | +
| prefix | +string | +
+ Optional text to prepend to the name of each environment variable.
+May consist of any printable ASCII characters except '='. + |
+ false | +
| secretRef | +object | +
+ The Secret to select from + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ Name of the referent.
+This field is effectively required, but due to backwards compatibility is
+allowed to be empty. Instances of this type with an empty value here are
+almost certainly wrong.
+More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + + Default: + |
+ false | +
| optional | +boolean | +
+ Specify whether the ConfigMap must be defined + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ Name of the referent.
+This field is effectively required, but due to backwards compatibility is
+allowed to be empty. Instances of this type with an empty value here are
+almost certainly wrong.
+More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + + Default: + |
+ false | +
| optional | +boolean | +
+ Specify whether the Secret must be defined + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| postStart | +object | +
+ PostStart is called immediately after a container is created. If the handler fails,
+the container is terminated and restarted according to its restart policy.
+Other management of the container blocks until the hook completes.
+More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks + |
+ false | +
| preStop | +object | +
+ PreStop is called immediately before a container is terminated due to an
+API request or management event such as liveness/startup probe failure,
+preemption, resource contention, etc. The handler is not called if the
+container crashes or exits. The Pod's termination grace period countdown begins before the
+PreStop hook is executed. Regardless of the outcome of the handler, the
+container will eventually terminate within the Pod's termination grace
+period (unless delayed by finalizers). Other management of the container blocks until the hook completes
+or until the termination grace period is reached.
+More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks + |
+ false | +
| stopSignal | +string | +
+ StopSignal defines which signal will be sent to a container when it is being stopped.
+If not specified, the default is defined by the container runtime in use.
+StopSignal can only be set for Pods with a non-empty .spec.os.name + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| exec | +object | +
+ Exec specifies a command to execute in the container. + |
+ false | +
| httpGet | +object | +
+ HTTPGet specifies an HTTP GET request to perform. + |
+ false | +
| sleep | +object | +
+ Sleep represents a duration that the container should sleep. + |
+ false | +
| tcpSocket | +object | +
+ Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept
+for backward compatibility. There is no validation of this field and
+lifecycle hooks will fail at runtime when it is specified. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| command | +[]string | +
+ Command is the command line to execute inside the container, the working directory for the
+command is root ('/') in the container's filesystem. The command is simply exec'd, it is
+not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
+a shell, you need to explicitly call out to that shell.
+Exit status of 0 is treated as live/healthy and non-zero is unhealthy. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| port | +int or string | +
+ Name or number of the port to access on the container.
+Number must be in the range 1 to 65535.
+Name must be an IANA_SVC_NAME. + |
+ true | +
| host | +string | +
+ Host name to connect to, defaults to the pod IP. You probably want to set
+"Host" in httpHeaders instead. + |
+ false | +
| httpHeaders | +[]object | +
+ Custom headers to set in the request. HTTP allows repeated headers. + |
+ false | +
| path | +string | +
+ Path to access on the HTTP server. + |
+ false | +
| scheme | +string | +
+ Scheme to use for connecting to the host.
+Defaults to HTTP. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ The header field name.
+This will be canonicalized upon output, so case-variant names will be understood as the same header. + |
+ true | +
| value | +string | +
+ The header field value + |
+ true | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| seconds | +integer | +
+ Seconds is the number of seconds to sleep. + + Format: int64 + |
+ true | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| port | +int or string | +
+ Number or name of the port to access on the container.
+Number must be in the range 1 to 65535.
+Name must be an IANA_SVC_NAME. + |
+ true | +
| host | +string | +
+ Optional: Host name to connect to, defaults to the pod IP. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| exec | +object | +
+ Exec specifies a command to execute in the container. + |
+ false | +
| httpGet | +object | +
+ HTTPGet specifies an HTTP GET request to perform. + |
+ false | +
| sleep | +object | +
+ Sleep represents a duration that the container should sleep. + |
+ false | +
| tcpSocket | +object | +
+ Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept
+for backward compatibility. There is no validation of this field and
+lifecycle hooks will fail at runtime when it is specified. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| command | +[]string | +
+ Command is the command line to execute inside the container, the working directory for the
+command is root ('/') in the container's filesystem. The command is simply exec'd, it is
+not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
+a shell, you need to explicitly call out to that shell.
+Exit status of 0 is treated as live/healthy and non-zero is unhealthy. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| port | +int or string | +
+ Name or number of the port to access on the container.
+Number must be in the range 1 to 65535.
+Name must be an IANA_SVC_NAME. + |
+ true | +
| host | +string | +
+ Host name to connect to, defaults to the pod IP. You probably want to set
+"Host" in httpHeaders instead. + |
+ false | +
| httpHeaders | +[]object | +
+ Custom headers to set in the request. HTTP allows repeated headers. + |
+ false | +
| path | +string | +
+ Path to access on the HTTP server. + |
+ false | +
| scheme | +string | +
+ Scheme to use for connecting to the host.
+Defaults to HTTP. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ The header field name.
+This will be canonicalized upon output, so case-variant names will be understood as the same header. + |
+ true | +
| value | +string | +
+ The header field value + |
+ true | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| seconds | +integer | +
+ Seconds is the number of seconds to sleep. + + Format: int64 + |
+ true | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| port | +int or string | +
+ Number or name of the port to access on the container.
+Number must be in the range 1 to 65535.
+Name must be an IANA_SVC_NAME. + |
+ true | +
| host | +string | +
+ Optional: Host name to connect to, defaults to the pod IP. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| exec | +object | +
+ Exec specifies a command to execute in the container. + |
+ false | +
| failureThreshold | +integer | +
+ Minimum consecutive failures for the probe to be considered failed after having succeeded.
+Defaults to 3. Minimum value is 1. + + Format: int32 + |
+ false | +
| grpc | +object | +
+ GRPC specifies a GRPC HealthCheckRequest. + |
+ false | +
| httpGet | +object | +
+ HTTPGet specifies an HTTP GET request to perform. + |
+ false | +
| initialDelaySeconds | +integer | +
+ Number of seconds after the container has started before liveness probes are initiated.
+More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + + Format: int32 + |
+ false | +
| periodSeconds | +integer | +
+ How often (in seconds) to perform the probe.
+Default to 10 seconds. Minimum value is 1. + + Format: int32 + |
+ false | +
| successThreshold | +integer | +
+ Minimum consecutive successes for the probe to be considered successful after having failed.
+Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. + + Format: int32 + |
+ false | +
| tcpSocket | +object | +
+ TCPSocket specifies a connection to a TCP port. + |
+ false | +
| terminationGracePeriodSeconds | +integer | +
+ Optional duration in seconds the pod needs to terminate gracefully upon probe failure.
+The grace period is the duration in seconds after the processes running in the pod are sent
+a termination signal and the time when the processes are forcibly halted with a kill signal.
+Set this value longer than the expected cleanup time for your process.
+If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this
+value overrides the value provided by the pod spec.
+Value must be non-negative integer. The value zero indicates stop immediately via
+the kill signal (no opportunity to shut down).
+This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.
+Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. + + Format: int64 + |
+ false | +
| timeoutSeconds | +integer | +
+ Number of seconds after which the probe times out.
+Defaults to 1 second. Minimum value is 1.
+More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + + Format: int32 + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| command | +[]string | +
+ Command is the command line to execute inside the container, the working directory for the
+command is root ('/') in the container's filesystem. The command is simply exec'd, it is
+not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
+a shell, you need to explicitly call out to that shell.
+Exit status of 0 is treated as live/healthy and non-zero is unhealthy. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| port | +integer | +
+ Port number of the gRPC service. Number must be in the range 1 to 65535. + + Format: int32 + |
+ true | +
| service | +string | +
+ Service is the name of the service to place in the gRPC HealthCheckRequest
+(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).
+
+If this is not specified, the default behavior is defined by gRPC. + + Default: + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| port | +int or string | +
+ Name or number of the port to access on the container.
+Number must be in the range 1 to 65535.
+Name must be an IANA_SVC_NAME. + |
+ true | +
| host | +string | +
+ Host name to connect to, defaults to the pod IP. You probably want to set
+"Host" in httpHeaders instead. + |
+ false | +
| httpHeaders | +[]object | +
+ Custom headers to set in the request. HTTP allows repeated headers. + |
+ false | +
| path | +string | +
+ Path to access on the HTTP server. + |
+ false | +
| scheme | +string | +
+ Scheme to use for connecting to the host.
+Defaults to HTTP. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ The header field name.
+This will be canonicalized upon output, so case-variant names will be understood as the same header. + |
+ true | +
| value | +string | +
+ The header field value + |
+ true | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| port | +int or string | +
+ Number or name of the port to access on the container.
+Number must be in the range 1 to 65535.
+Name must be an IANA_SVC_NAME. + |
+ true | +
| host | +string | +
+ Optional: Host name to connect to, defaults to the pod IP. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| containerPort | +integer | +
+ Number of port to expose on the pod's IP address.
+This must be a valid port number, 0 < x < 65536. + + Format: int32 + |
+ true | +
| hostIP | +string | +
+ What host IP to bind the external port to. + |
+ false | +
| hostPort | +integer | +
+ Number of port to expose on the host.
+If specified, this must be a valid port number, 0 < x < 65536.
+If HostNetwork is specified, this must match ContainerPort.
+Most containers do not need this. + + Format: int32 + |
+ false | +
| name | +string | +
+ If specified, this must be an IANA_SVC_NAME and unique within the pod. Each
+named port in a pod must have a unique name. Name for the port that can be
+referred to by services. + |
+ false | +
| protocol | +string | +
+ Protocol for port. Must be UDP, TCP, or SCTP.
+Defaults to "TCP". + + Default: TCP + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| exec | +object | +
+ Exec specifies a command to execute in the container. + |
+ false | +
| failureThreshold | +integer | +
+ Minimum consecutive failures for the probe to be considered failed after having succeeded.
+Defaults to 3. Minimum value is 1. + + Format: int32 + |
+ false | +
| grpc | +object | +
+ GRPC specifies a GRPC HealthCheckRequest. + |
+ false | +
| httpGet | +object | +
+ HTTPGet specifies an HTTP GET request to perform. + |
+ false | +
| initialDelaySeconds | +integer | +
+ Number of seconds after the container has started before liveness probes are initiated.
+More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + + Format: int32 + |
+ false | +
| periodSeconds | +integer | +
+ How often (in seconds) to perform the probe.
+Default to 10 seconds. Minimum value is 1. + + Format: int32 + |
+ false | +
| successThreshold | +integer | +
+ Minimum consecutive successes for the probe to be considered successful after having failed.
+Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. + + Format: int32 + |
+ false | +
| tcpSocket | +object | +
+ TCPSocket specifies a connection to a TCP port. + |
+ false | +
| terminationGracePeriodSeconds | +integer | +
+ Optional duration in seconds the pod needs to terminate gracefully upon probe failure.
+The grace period is the duration in seconds after the processes running in the pod are sent
+a termination signal and the time when the processes are forcibly halted with a kill signal.
+Set this value longer than the expected cleanup time for your process.
+If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this
+value overrides the value provided by the pod spec.
+Value must be non-negative integer. The value zero indicates stop immediately via
+the kill signal (no opportunity to shut down).
+This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.
+Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. + + Format: int64 + |
+ false | +
| timeoutSeconds | +integer | +
+ Number of seconds after which the probe times out.
+Defaults to 1 second. Minimum value is 1.
+More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + + Format: int32 + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| command | +[]string | +
+ Command is the command line to execute inside the container, the working directory for the
+command is root ('/') in the container's filesystem. The command is simply exec'd, it is
+not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
+a shell, you need to explicitly call out to that shell.
+Exit status of 0 is treated as live/healthy and non-zero is unhealthy. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| port | +integer | +
+ Port number of the gRPC service. Number must be in the range 1 to 65535. + + Format: int32 + |
+ true | +
| service | +string | +
+ Service is the name of the service to place in the gRPC HealthCheckRequest
+(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).
+
+If this is not specified, the default behavior is defined by gRPC. + + Default: + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| port | +int or string | +
+ Name or number of the port to access on the container.
+Number must be in the range 1 to 65535.
+Name must be an IANA_SVC_NAME. + |
+ true | +
| host | +string | +
+ Host name to connect to, defaults to the pod IP. You probably want to set
+"Host" in httpHeaders instead. + |
+ false | +
| httpHeaders | +[]object | +
+ Custom headers to set in the request. HTTP allows repeated headers. + |
+ false | +
| path | +string | +
+ Path to access on the HTTP server. + |
+ false | +
| scheme | +string | +
+ Scheme to use for connecting to the host.
+Defaults to HTTP. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ The header field name.
+This will be canonicalized upon output, so case-variant names will be understood as the same header. + |
+ true | +
| value | +string | +
+ The header field value + |
+ true | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| port | +int or string | +
+ Number or name of the port to access on the container.
+Number must be in the range 1 to 65535.
+Name must be an IANA_SVC_NAME. + |
+ true | +
| host | +string | +
+ Optional: Host name to connect to, defaults to the pod IP. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| resourceName | +string | +
+ Name of the resource to which this resource resize policy applies.
+Supported values: cpu, memory. + |
+ true | +
| restartPolicy | +string | +
+ Restart policy to apply when specified resource is resized.
+If not specified, it defaults to NotRequired. + |
+ true | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| claims | +[]object | +
+ Claims lists the names of resources, defined in spec.resourceClaims,
+that are used by this container.
+
+This field depends on the
+DynamicResourceAllocation feature gate.
+
+This field is immutable. It can only be set for containers. + |
+ false | +
| limits | +map[string]int or string | +
+ Limits describes the maximum amount of compute resources allowed.
+More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ + |
+ false | +
| requests | +map[string]int or string | +
+ Requests describes the minimum amount of compute resources required.
+If Requests is omitted for a container, it defaults to Limits if that is explicitly specified,
+otherwise to an implementation-defined value. Requests cannot exceed Limits.
+More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ Name must match the name of one entry in pod.spec.resourceClaims of
+the Pod where this field is used. It makes that resource available
+inside a container. + |
+ true | +
| request | +string | +
+ Request is the name chosen for a request in the referenced claim.
+If empty, everything from the claim is made available, otherwise
+only the result of this request. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| action | +string | +
+ Specifies the action taken on a container exit if the requirements
+are satisfied. The only possible value is "Restart" to restart the
+container. + |
+ true | +
| exitCodes | +object | +
+ Represents the exit codes to check on container exits. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| operator | +string | +
+ Represents the relationship between the container exit code(s) and the
+specified values. Possible values are:
+- In: the requirement is satisfied if the container exit code is in the
+ set of specified values.
+- NotIn: the requirement is satisfied if the container exit code is
+ not in the set of specified values. + |
+ true | +
| values | +[]integer | +
+ Specifies the set of values to check for container exit codes.
+At most 255 elements are allowed. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| allowPrivilegeEscalation | +boolean | +
+ AllowPrivilegeEscalation controls whether a process can gain more
+privileges than its parent process. This bool directly controls if
+the no_new_privs flag will be set on the container process.
+AllowPrivilegeEscalation is true always when the container is:
+1) run as Privileged
+2) has CAP_SYS_ADMIN
+Note that this field cannot be set when spec.os.name is windows. + |
+ false | +
| appArmorProfile | +object | +
+ appArmorProfile is the AppArmor options to use by this container. If set, this profile
+overrides the pod's appArmorProfile.
+Note that this field cannot be set when spec.os.name is windows. + |
+ false | +
| capabilities | +object | +
+ The capabilities to add/drop when running containers.
+Defaults to the default set of capabilities granted by the container runtime.
+Note that this field cannot be set when spec.os.name is windows. + |
+ false | +
| privileged | +boolean | +
+ Run container in privileged mode.
+Processes in privileged containers are essentially equivalent to root on the host.
+Defaults to false.
+Note that this field cannot be set when spec.os.name is windows. + |
+ false | +
| procMount | +string | +
+ procMount denotes the type of proc mount to use for the containers.
+The default value is Default which uses the container runtime defaults for
+readonly paths and masked paths.
+This requires the ProcMountType feature flag to be enabled.
+Note that this field cannot be set when spec.os.name is windows. + |
+ false | +
| readOnlyRootFilesystem | +boolean | +
+ Whether this container has a read-only root filesystem.
+Default is false.
+Note that this field cannot be set when spec.os.name is windows. + |
+ false | +
| runAsGroup | +integer | +
+ The GID to run the entrypoint of the container process.
+Uses runtime default if unset.
+May also be set in PodSecurityContext. If set in both SecurityContext and
+PodSecurityContext, the value specified in SecurityContext takes precedence.
+Note that this field cannot be set when spec.os.name is windows. + + Format: int64 + |
+ false | +
| runAsNonRoot | +boolean | +
+ Indicates that the container must run as a non-root user.
+If true, the Kubelet will validate the image at runtime to ensure that it
+does not run as UID 0 (root) and fail to start the container if it does.
+If unset or false, no such validation will be performed.
+May also be set in PodSecurityContext. If set in both SecurityContext and
+PodSecurityContext, the value specified in SecurityContext takes precedence. + |
+ false | +
| runAsUser | +integer | +
+ The UID to run the entrypoint of the container process.
+Defaults to user specified in image metadata if unspecified.
+May also be set in PodSecurityContext. If set in both SecurityContext and
+PodSecurityContext, the value specified in SecurityContext takes precedence.
+Note that this field cannot be set when spec.os.name is windows. + + Format: int64 + |
+ false | +
| seLinuxOptions | +object | +
+ The SELinux context to be applied to the container.
+If unspecified, the container runtime will allocate a random SELinux context for each
+container. May also be set in PodSecurityContext. If set in both SecurityContext and
+PodSecurityContext, the value specified in SecurityContext takes precedence.
+Note that this field cannot be set when spec.os.name is windows. + |
+ false | +
| seccompProfile | +object | +
+ The seccomp options to use by this container. If seccomp options are
+provided at both the pod & container level, the container options
+override the pod options.
+Note that this field cannot be set when spec.os.name is windows. + |
+ false | +
| windowsOptions | +object | +
+ The Windows specific settings applied to all containers.
+If unspecified, the options from the PodSecurityContext will be used.
+If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
+Note that this field cannot be set when spec.os.name is linux. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| type | +string | +
+ type indicates which kind of AppArmor profile will be applied.
+Valid options are:
+ Localhost - a profile pre-loaded on the node.
+ RuntimeDefault - the container runtime's default profile.
+ Unconfined - no AppArmor enforcement. + |
+ true | +
| localhostProfile | +string | +
+ localhostProfile indicates a profile loaded on the node that should be used.
+The profile must be preconfigured on the node to work.
+Must match the loaded name of the profile.
+Must be set if and only if type is "Localhost". + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| add | +[]string | +
+ Added capabilities + |
+ false | +
| drop | +[]string | +
+ Removed capabilities + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| level | +string | +
+ Level is SELinux level label that applies to the container. + |
+ false | +
| role | +string | +
+ Role is a SELinux role label that applies to the container. + |
+ false | +
| type | +string | +
+ Type is a SELinux type label that applies to the container. + |
+ false | +
| user | +string | +
+ User is a SELinux user label that applies to the container. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| type | +string | +
+ type indicates which kind of seccomp profile will be applied.
+Valid options are:
+
+Localhost - a profile defined in a file on the node should be used.
+RuntimeDefault - the container runtime default profile should be used.
+Unconfined - no profile should be applied. + |
+ true | +
| localhostProfile | +string | +
+ localhostProfile indicates a profile defined in a file on the node should be used.
+The profile must be preconfigured on the node to work.
+Must be a descending path, relative to the kubelet's configured seccomp profile location.
+Must be set if type is "Localhost". Must NOT be set for any other type. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| gmsaCredentialSpec | +string | +
+ GMSACredentialSpec is where the GMSA admission webhook
+(https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the
+GMSA credential spec named by the GMSACredentialSpecName field. + |
+ false | +
| gmsaCredentialSpecName | +string | +
+ GMSACredentialSpecName is the name of the GMSA credential spec to use. + |
+ false | +
| hostProcess | +boolean | +
+ HostProcess determines if a container should be run as a 'Host Process' container.
+All of a Pod's containers must have the same effective HostProcess value
+(it is not allowed to have a mix of HostProcess containers and non-HostProcess containers).
+In addition, if HostProcess is true then HostNetwork must also be set to true. + |
+ false | +
| runAsUserName | +string | +
+ The UserName in Windows to run the entrypoint of the container process.
+Defaults to the user specified in image metadata if unspecified.
+May also be set in PodSecurityContext. If set in both SecurityContext and
+PodSecurityContext, the value specified in SecurityContext takes precedence. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| exec | +object | +
+ Exec specifies a command to execute in the container. + |
+ false | +
| failureThreshold | +integer | +
+ Minimum consecutive failures for the probe to be considered failed after having succeeded.
+Defaults to 3. Minimum value is 1. + + Format: int32 + |
+ false | +
| grpc | +object | +
+ GRPC specifies a GRPC HealthCheckRequest. + |
+ false | +
| httpGet | +object | +
+ HTTPGet specifies an HTTP GET request to perform. + |
+ false | +
| initialDelaySeconds | +integer | +
+ Number of seconds after the container has started before liveness probes are initiated.
+More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + + Format: int32 + |
+ false | +
| periodSeconds | +integer | +
+ How often (in seconds) to perform the probe.
+Default to 10 seconds. Minimum value is 1. + + Format: int32 + |
+ false | +
| successThreshold | +integer | +
+ Minimum consecutive successes for the probe to be considered successful after having failed.
+Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. + + Format: int32 + |
+ false | +
| tcpSocket | +object | +
+ TCPSocket specifies a connection to a TCP port. + |
+ false | +
| terminationGracePeriodSeconds | +integer | +
+ Optional duration in seconds the pod needs to terminate gracefully upon probe failure.
+The grace period is the duration in seconds after the processes running in the pod are sent
+a termination signal and the time when the processes are forcibly halted with a kill signal.
+Set this value longer than the expected cleanup time for your process.
+If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this
+value overrides the value provided by the pod spec.
+Value must be non-negative integer. The value zero indicates stop immediately via
+the kill signal (no opportunity to shut down).
+This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.
+Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. + + Format: int64 + |
+ false | +
| timeoutSeconds | +integer | +
+ Number of seconds after which the probe times out.
+Defaults to 1 second. Minimum value is 1.
+More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + + Format: int32 + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| command | +[]string | +
+ Command is the command line to execute inside the container, the working directory for the
+command is root ('/') in the container's filesystem. The command is simply exec'd, it is
+not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
+a shell, you need to explicitly call out to that shell.
+Exit status of 0 is treated as live/healthy and non-zero is unhealthy. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| port | +integer | +
+ Port number of the gRPC service. Number must be in the range 1 to 65535. + + Format: int32 + |
+ true | +
| service | +string | +
+ Service is the name of the service to place in the gRPC HealthCheckRequest
+(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).
+
+If this is not specified, the default behavior is defined by gRPC. + + Default: + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| port | +int or string | +
+ Name or number of the port to access on the container.
+Number must be in the range 1 to 65535.
+Name must be an IANA_SVC_NAME. + |
+ true | +
| host | +string | +
+ Host name to connect to, defaults to the pod IP. You probably want to set
+"Host" in httpHeaders instead. + |
+ false | +
| httpHeaders | +[]object | +
+ Custom headers to set in the request. HTTP allows repeated headers. + |
+ false | +
| path | +string | +
+ Path to access on the HTTP server. + |
+ false | +
| scheme | +string | +
+ Scheme to use for connecting to the host.
+Defaults to HTTP. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ The header field name.
+This will be canonicalized upon output, so case-variant names will be understood as the same header. + |
+ true | +
| value | +string | +
+ The header field value + |
+ true | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| port | +int or string | +
+ Number or name of the port to access on the container.
+Number must be in the range 1 to 65535.
+Name must be an IANA_SVC_NAME. + |
+ true | +
| host | +string | +
+ Optional: Host name to connect to, defaults to the pod IP. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| devicePath | +string | +
+ devicePath is the path inside of the container that the device will be mapped to. + |
+ true | +
| name | +string | +
+ name must match the name of a persistentVolumeClaim in the pod + |
+ true | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| mountPath | +string | +
+ Path within the container at which the volume should be mounted. Must
+not contain ':'. + |
+ true | +
| name | +string | +
+ This must match the Name of a Volume. + |
+ true | +
| mountPropagation | +string | +
+ mountPropagation determines how mounts are propagated from the host
+to container and the other way around.
+When not set, MountPropagationNone is used.
+This field is beta in 1.10.
+When RecursiveReadOnly is set to IfPossible or to Enabled, MountPropagation must be None or unspecified
+(which defaults to None). + |
+ false | +
| readOnly | +boolean | +
+ Mounted read-only if true, read-write otherwise (false or unspecified).
+Defaults to false. + |
+ false | +
| recursiveReadOnly | +string | +
+ RecursiveReadOnly specifies whether read-only mounts should be handled
+recursively.
+
+If ReadOnly is false, this field has no meaning and must be unspecified.
+
+If ReadOnly is true, and this field is set to Disabled, the mount is not made
+recursively read-only. If this field is set to IfPossible, the mount is made
+recursively read-only, if it is supported by the container runtime. If this
+field is set to Enabled, the mount is made recursively read-only if it is
+supported by the container runtime, otherwise the pod will not be started and
+an error will be generated to indicate the reason.
+
+If this field is set to IfPossible or Enabled, MountPropagation must be set to
+None (or be unspecified, which defaults to None).
+
+If this field is not specified, it is treated as an equivalent of Disabled. + |
+ false | +
| subPath | +string | +
+ Path within the volume from which the container's volume should be mounted.
+Defaults to "" (volume's root). + |
+ false | +
| subPathExpr | +string | +
+ Expanded path within the volume from which the container's volume should be mounted.
+Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment.
+Defaults to "" (volume's root).
+SubPathExpr and SubPath are mutually exclusive. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| ip | +string | +
+ IP address of the host file entry. + |
+ true | +
| hostnames | +[]string | +
+ Hostnames for the above IP address. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ Name of the referent.
+This field is effectively required, but due to backwards compatibility is
+allowed to be empty. Instances of this type with an empty value here are
+almost certainly wrong.
+More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + + Default: + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ Name of the container specified as a DNS_LABEL.
+Each container in a pod must have a unique name (DNS_LABEL).
+Cannot be updated. + |
+ true | +
| args | +[]string | +
+ Arguments to the entrypoint.
+The container image's CMD is used if this is not provided.
+Variable references $(VAR_NAME) are expanded using the container's environment. If a variable
+cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced
+to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will
+produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless
+of whether the variable exists or not. Cannot be updated.
+More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell + |
+ false | +
| command | +[]string | +
+ Entrypoint array. Not executed within a shell.
+The container image's ENTRYPOINT is used if this is not provided.
+Variable references $(VAR_NAME) are expanded using the container's environment. If a variable
+cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced
+to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will
+produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless
+of whether the variable exists or not. Cannot be updated.
+More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell + |
+ false | +
| env | +[]object | +
+ List of environment variables to set in the container.
+Cannot be updated. + |
+ false | +
| envFrom | +[]object | +
+ List of sources to populate environment variables in the container.
+The keys defined within a source may consist of any printable ASCII characters except '='.
+When a key exists in multiple
+sources, the value associated with the last source will take precedence.
+Values defined by an Env with a duplicate key will take precedence.
+Cannot be updated. + |
+ false | +
| image | +string | +
+ Container image name.
+More info: https://kubernetes.io/docs/concepts/containers/images
+This field is optional to allow higher level config management to default or override
+container images in workload controllers like Deployments and StatefulSets. + |
+ false | +
| imagePullPolicy | +string | +
+ Image pull policy.
+One of Always, Never, IfNotPresent.
+Defaults to Always if :latest tag is specified, or IfNotPresent otherwise.
+Cannot be updated.
+More info: https://kubernetes.io/docs/concepts/containers/images#updating-images + |
+ false | +
| lifecycle | +object | +
+ Actions that the management system should take in response to container lifecycle events.
+Cannot be updated. + |
+ false | +
| livenessProbe | +object | +
+ Periodic probe of container liveness.
+Container will be restarted if the probe fails.
+Cannot be updated.
+More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + |
+ false | +
| ports | +[]object | +
+ List of ports to expose from the container. Not specifying a port here
+DOES NOT prevent that port from being exposed. Any port which is
+listening on the default "0.0.0.0" address inside a container will be
+accessible from the network.
+Modifying this array with strategic merge patch may corrupt the data.
+For more information See https://github.com/kubernetes/kubernetes/issues/108255.
+Cannot be updated. + |
+ false | +
| readinessProbe | +object | +
+ Periodic probe of container service readiness.
+Container will be removed from service endpoints if the probe fails.
+Cannot be updated.
+More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + |
+ false | +
| resizePolicy | +[]object | +
+ Resources resize policy for the container. + |
+ false | +
| resources | +object | +
+ Compute Resources required by this container.
+Cannot be updated.
+More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ + |
+ false | +
| restartPolicy | +string | +
+ RestartPolicy defines the restart behavior of individual containers in a pod.
+This overrides the pod-level restart policy. When this field is not specified,
+the restart behavior is defined by the Pod's restart policy and the container type.
+Additionally, setting the RestartPolicy as "Always" for the init container will
+have the following effect:
+this init container will be continually restarted on
+exit until all regular containers have terminated. Once all regular
+containers have completed, all init containers with restartPolicy "Always"
+will be shut down. This lifecycle differs from normal init containers and
+is often referred to as a "sidecar" container. Although this init
+container still starts in the init container sequence, it does not wait
+for the container to complete before proceeding to the next init
+container. Instead, the next init container starts immediately after this
+init container is started, or after any startupProbe has successfully
+completed. + |
+ false | +
| restartPolicyRules | +[]object | +
+ Represents a list of rules to be checked to determine if the
+container should be restarted on exit. The rules are evaluated in
+order. Once a rule matches a container exit condition, the remaining
+rules are ignored. If no rule matches the container exit condition,
+the Container-level restart policy determines the whether the container
+is restarted or not. Constraints on the rules:
+- At most 20 rules are allowed.
+- Rules can have the same action.
+- Identical rules are not forbidden in validations.
+When rules are specified, container MUST set RestartPolicy explicitly
+even it if matches the Pod's RestartPolicy. + |
+ false | +
| securityContext | +object | +
+ SecurityContext defines the security options the container should be run with.
+If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext.
+More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/ + |
+ false | +
| startupProbe | +object | +
+ StartupProbe indicates that the Pod has successfully initialized.
+If specified, no other probes are executed until this completes successfully.
+If this probe fails, the Pod will be restarted, just as if the livenessProbe failed.
+This can be used to provide different probe parameters at the beginning of a Pod's lifecycle,
+when it might take a long time to load data or warm a cache, than during steady-state operation.
+This cannot be updated.
+More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + |
+ false | +
| stdin | +boolean | +
+ Whether this container should allocate a buffer for stdin in the container runtime. If this
+is not set, reads from stdin in the container will always result in EOF.
+Default is false. + |
+ false | +
| stdinOnce | +boolean | +
+ Whether the container runtime should close the stdin channel after it has been opened by
+a single attach. When stdin is true the stdin stream will remain open across multiple attach
+sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the
+first client attaches to stdin, and then remains open and accepts data until the client disconnects,
+at which time stdin is closed and remains closed until the container is restarted. If this
+flag is false, a container processes that reads from stdin will never receive an EOF.
+Default is false + |
+ false | +
| terminationMessagePath | +string | +
+ Optional: Path at which the file to which the container's termination message
+will be written is mounted into the container's filesystem.
+Message written is intended to be brief final status, such as an assertion failure message.
+Will be truncated by the node if greater than 4096 bytes. The total message length across
+all containers will be limited to 12kb.
+Defaults to /dev/termination-log.
+Cannot be updated. + |
+ false | +
| terminationMessagePolicy | +string | +
+ Indicate how the termination message should be populated. File will use the contents of
+terminationMessagePath to populate the container status message on both success and failure.
+FallbackToLogsOnError will use the last chunk of container log output if the termination
+message file is empty and the container exited with an error.
+The log output is limited to 2048 bytes or 80 lines, whichever is smaller.
+Defaults to File.
+Cannot be updated. + |
+ false | +
| tty | +boolean | +
+ Whether this container should allocate a TTY for itself, also requires 'stdin' to be true.
+Default is false. + |
+ false | +
| volumeDevices | +[]object | +
+ volumeDevices is the list of block devices to be used by the container. + |
+ false | +
| volumeMounts | +[]object | +
+ Pod volumes to mount into the container's filesystem.
+Cannot be updated. + |
+ false | +
| workingDir | +string | +
+ Container's working directory.
+If not specified, the container runtime's default will be used, which
+might be configured in the container image.
+Cannot be updated. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ Name of the environment variable.
+May consist of any printable ASCII characters except '='. + |
+ true | +
| value | +string | +
+ Variable references $(VAR_NAME) are expanded
+using the previously defined environment variables in the container and
+any service environment variables. If a variable cannot be resolved,
+the reference in the input string will be unchanged. Double $$ are reduced
+to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e.
+"$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)".
+Escaped references will never be expanded, regardless of whether the variable
+exists or not.
+Defaults to "". + |
+ false | +
| valueFrom | +object | +
+ Source for the environment variable's value. Cannot be used if value is not empty. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| configMapKeyRef | +object | +
+ Selects a key of a ConfigMap. + |
+ false | +
| fieldRef | +object | +
+ Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels[' + |
+ false | +
| fileKeyRef | +object | +
+ FileKeyRef selects a key of the env file.
+Requires the EnvFiles feature gate to be enabled. + |
+ false | +
| resourceFieldRef | +object | +
+ Selects a resource of the container: only resources limits and requests
+(limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. + |
+ false | +
| secretKeyRef | +object | +
+ Selects a key of a secret in the pod's namespace + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| key | +string | +
+ The key to select. + |
+ true | +
| name | +string | +
+ Name of the referent.
+This field is effectively required, but due to backwards compatibility is
+allowed to be empty. Instances of this type with an empty value here are
+almost certainly wrong.
+More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + + Default: + |
+ false | +
| optional | +boolean | +
+ Specify whether the ConfigMap or its key must be defined + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| fieldPath | +string | +
+ Path of the field to select in the specified API version. + |
+ true | +
| apiVersion | +string | +
+ Version of the schema the FieldPath is written in terms of, defaults to "v1". + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| key | +string | +
+ The key within the env file. An invalid key will prevent the pod from starting.
+The keys defined within a source may consist of any printable ASCII characters except '='.
+During Alpha stage of the EnvFiles feature gate, the key size is limited to 128 characters. + |
+ true | +
| path | +string | +
+ The path within the volume from which to select the file.
+Must be relative and may not contain the '..' path or start with '..'. + |
+ true | +
| volumeName | +string | +
+ The name of the volume mount containing the env file. + |
+ true | +
| optional | +boolean | +
+ Specify whether the file or its key must be defined. If the file or key
+does not exist, then the env var is not published.
+If optional is set to true and the specified key does not exist,
+the environment variable will not be set in the Pod's containers.
+
+If optional is set to false and the specified key does not exist,
+an error will be returned during Pod creation. + + Default: false + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| resource | +string | +
+ Required: resource to select + |
+ true | +
| containerName | +string | +
+ Container name: required for volumes, optional for env vars + |
+ false | +
| divisor | +int or string | +
+ Specifies the output format of the exposed resources, defaults to "1" + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| key | +string | +
+ The key of the secret to select from. Must be a valid secret key. + |
+ true | +
| name | +string | +
+ Name of the referent.
+This field is effectively required, but due to backwards compatibility is
+allowed to be empty. Instances of this type with an empty value here are
+almost certainly wrong.
+More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + + Default: + |
+ false | +
| optional | +boolean | +
+ Specify whether the Secret or its key must be defined + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| configMapRef | +object | +
+ The ConfigMap to select from + |
+ false | +
| prefix | +string | +
+ Optional text to prepend to the name of each environment variable.
+May consist of any printable ASCII characters except '='. + |
+ false | +
| secretRef | +object | +
+ The Secret to select from + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ Name of the referent.
+This field is effectively required, but due to backwards compatibility is
+allowed to be empty. Instances of this type with an empty value here are
+almost certainly wrong.
+More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + + Default: + |
+ false | +
| optional | +boolean | +
+ Specify whether the ConfigMap must be defined + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ Name of the referent.
+This field is effectively required, but due to backwards compatibility is
+allowed to be empty. Instances of this type with an empty value here are
+almost certainly wrong.
+More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + + Default: + |
+ false | +
| optional | +boolean | +
+ Specify whether the Secret must be defined + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| postStart | +object | +
+ PostStart is called immediately after a container is created. If the handler fails,
+the container is terminated and restarted according to its restart policy.
+Other management of the container blocks until the hook completes.
+More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks + |
+ false | +
| preStop | +object | +
+ PreStop is called immediately before a container is terminated due to an
+API request or management event such as liveness/startup probe failure,
+preemption, resource contention, etc. The handler is not called if the
+container crashes or exits. The Pod's termination grace period countdown begins before the
+PreStop hook is executed. Regardless of the outcome of the handler, the
+container will eventually terminate within the Pod's termination grace
+period (unless delayed by finalizers). Other management of the container blocks until the hook completes
+or until the termination grace period is reached.
+More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks + |
+ false | +
| stopSignal | +string | +
+ StopSignal defines which signal will be sent to a container when it is being stopped.
+If not specified, the default is defined by the container runtime in use.
+StopSignal can only be set for Pods with a non-empty .spec.os.name + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| exec | +object | +
+ Exec specifies a command to execute in the container. + |
+ false | +
| httpGet | +object | +
+ HTTPGet specifies an HTTP GET request to perform. + |
+ false | +
| sleep | +object | +
+ Sleep represents a duration that the container should sleep. + |
+ false | +
| tcpSocket | +object | +
+ Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept
+for backward compatibility. There is no validation of this field and
+lifecycle hooks will fail at runtime when it is specified. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| command | +[]string | +
+ Command is the command line to execute inside the container, the working directory for the
+command is root ('/') in the container's filesystem. The command is simply exec'd, it is
+not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
+a shell, you need to explicitly call out to that shell.
+Exit status of 0 is treated as live/healthy and non-zero is unhealthy. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| port | +int or string | +
+ Name or number of the port to access on the container.
+Number must be in the range 1 to 65535.
+Name must be an IANA_SVC_NAME. + |
+ true | +
| host | +string | +
+ Host name to connect to, defaults to the pod IP. You probably want to set
+"Host" in httpHeaders instead. + |
+ false | +
| httpHeaders | +[]object | +
+ Custom headers to set in the request. HTTP allows repeated headers. + |
+ false | +
| path | +string | +
+ Path to access on the HTTP server. + |
+ false | +
| scheme | +string | +
+ Scheme to use for connecting to the host.
+Defaults to HTTP. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ The header field name.
+This will be canonicalized upon output, so case-variant names will be understood as the same header. + |
+ true | +
| value | +string | +
+ The header field value + |
+ true | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| seconds | +integer | +
+ Seconds is the number of seconds to sleep. + + Format: int64 + |
+ true | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| port | +int or string | +
+ Number or name of the port to access on the container.
+Number must be in the range 1 to 65535.
+Name must be an IANA_SVC_NAME. + |
+ true | +
| host | +string | +
+ Optional: Host name to connect to, defaults to the pod IP. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| exec | +object | +
+ Exec specifies a command to execute in the container. + |
+ false | +
| httpGet | +object | +
+ HTTPGet specifies an HTTP GET request to perform. + |
+ false | +
| sleep | +object | +
+ Sleep represents a duration that the container should sleep. + |
+ false | +
| tcpSocket | +object | +
+ Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept
+for backward compatibility. There is no validation of this field and
+lifecycle hooks will fail at runtime when it is specified. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| command | +[]string | +
+ Command is the command line to execute inside the container, the working directory for the
+command is root ('/') in the container's filesystem. The command is simply exec'd, it is
+not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
+a shell, you need to explicitly call out to that shell.
+Exit status of 0 is treated as live/healthy and non-zero is unhealthy. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| port | +int or string | +
+ Name or number of the port to access on the container.
+Number must be in the range 1 to 65535.
+Name must be an IANA_SVC_NAME. + |
+ true | +
| host | +string | +
+ Host name to connect to, defaults to the pod IP. You probably want to set
+"Host" in httpHeaders instead. + |
+ false | +
| httpHeaders | +[]object | +
+ Custom headers to set in the request. HTTP allows repeated headers. + |
+ false | +
| path | +string | +
+ Path to access on the HTTP server. + |
+ false | +
| scheme | +string | +
+ Scheme to use for connecting to the host.
+Defaults to HTTP. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ The header field name.
+This will be canonicalized upon output, so case-variant names will be understood as the same header. + |
+ true | +
| value | +string | +
+ The header field value + |
+ true | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| seconds | +integer | +
+ Seconds is the number of seconds to sleep. + + Format: int64 + |
+ true | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| port | +int or string | +
+ Number or name of the port to access on the container.
+Number must be in the range 1 to 65535.
+Name must be an IANA_SVC_NAME. + |
+ true | +
| host | +string | +
+ Optional: Host name to connect to, defaults to the pod IP. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| exec | +object | +
+ Exec specifies a command to execute in the container. + |
+ false | +
| failureThreshold | +integer | +
+ Minimum consecutive failures for the probe to be considered failed after having succeeded.
+Defaults to 3. Minimum value is 1. + + Format: int32 + |
+ false | +
| grpc | +object | +
+ GRPC specifies a GRPC HealthCheckRequest. + |
+ false | +
| httpGet | +object | +
+ HTTPGet specifies an HTTP GET request to perform. + |
+ false | +
| initialDelaySeconds | +integer | +
+ Number of seconds after the container has started before liveness probes are initiated.
+More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + + Format: int32 + |
+ false | +
| periodSeconds | +integer | +
+ How often (in seconds) to perform the probe.
+Default to 10 seconds. Minimum value is 1. + + Format: int32 + |
+ false | +
| successThreshold | +integer | +
+ Minimum consecutive successes for the probe to be considered successful after having failed.
+Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. + + Format: int32 + |
+ false | +
| tcpSocket | +object | +
+ TCPSocket specifies a connection to a TCP port. + |
+ false | +
| terminationGracePeriodSeconds | +integer | +
+ Optional duration in seconds the pod needs to terminate gracefully upon probe failure.
+The grace period is the duration in seconds after the processes running in the pod are sent
+a termination signal and the time when the processes are forcibly halted with a kill signal.
+Set this value longer than the expected cleanup time for your process.
+If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this
+value overrides the value provided by the pod spec.
+Value must be non-negative integer. The value zero indicates stop immediately via
+the kill signal (no opportunity to shut down).
+This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.
+Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. + + Format: int64 + |
+ false | +
| timeoutSeconds | +integer | +
+ Number of seconds after which the probe times out.
+Defaults to 1 second. Minimum value is 1.
+More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + + Format: int32 + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| command | +[]string | +
+ Command is the command line to execute inside the container, the working directory for the
+command is root ('/') in the container's filesystem. The command is simply exec'd, it is
+not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
+a shell, you need to explicitly call out to that shell.
+Exit status of 0 is treated as live/healthy and non-zero is unhealthy. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| port | +integer | +
+ Port number of the gRPC service. Number must be in the range 1 to 65535. + + Format: int32 + |
+ true | +
| service | +string | +
+ Service is the name of the service to place in the gRPC HealthCheckRequest
+(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).
+
+If this is not specified, the default behavior is defined by gRPC. + + Default: + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| port | +int or string | +
+ Name or number of the port to access on the container.
+Number must be in the range 1 to 65535.
+Name must be an IANA_SVC_NAME. + |
+ true | +
| host | +string | +
+ Host name to connect to, defaults to the pod IP. You probably want to set
+"Host" in httpHeaders instead. + |
+ false | +
| httpHeaders | +[]object | +
+ Custom headers to set in the request. HTTP allows repeated headers. + |
+ false | +
| path | +string | +
+ Path to access on the HTTP server. + |
+ false | +
| scheme | +string | +
+ Scheme to use for connecting to the host.
+Defaults to HTTP. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ The header field name.
+This will be canonicalized upon output, so case-variant names will be understood as the same header. + |
+ true | +
| value | +string | +
+ The header field value + |
+ true | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| port | +int or string | +
+ Number or name of the port to access on the container.
+Number must be in the range 1 to 65535.
+Name must be an IANA_SVC_NAME. + |
+ true | +
| host | +string | +
+ Optional: Host name to connect to, defaults to the pod IP. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| containerPort | +integer | +
+ Number of port to expose on the pod's IP address.
+This must be a valid port number, 0 < x < 65536. + + Format: int32 + |
+ true | +
| hostIP | +string | +
+ What host IP to bind the external port to. + |
+ false | +
| hostPort | +integer | +
+ Number of port to expose on the host.
+If specified, this must be a valid port number, 0 < x < 65536.
+If HostNetwork is specified, this must match ContainerPort.
+Most containers do not need this. + + Format: int32 + |
+ false | +
| name | +string | +
+ If specified, this must be an IANA_SVC_NAME and unique within the pod. Each
+named port in a pod must have a unique name. Name for the port that can be
+referred to by services. + |
+ false | +
| protocol | +string | +
+ Protocol for port. Must be UDP, TCP, or SCTP.
+Defaults to "TCP". + + Default: TCP + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| exec | +object | +
+ Exec specifies a command to execute in the container. + |
+ false | +
| failureThreshold | +integer | +
+ Minimum consecutive failures for the probe to be considered failed after having succeeded.
+Defaults to 3. Minimum value is 1. + + Format: int32 + |
+ false | +
| grpc | +object | +
+ GRPC specifies a GRPC HealthCheckRequest. + |
+ false | +
| httpGet | +object | +
+ HTTPGet specifies an HTTP GET request to perform. + |
+ false | +
| initialDelaySeconds | +integer | +
+ Number of seconds after the container has started before liveness probes are initiated.
+More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + + Format: int32 + |
+ false | +
| periodSeconds | +integer | +
+ How often (in seconds) to perform the probe.
+Default to 10 seconds. Minimum value is 1. + + Format: int32 + |
+ false | +
| successThreshold | +integer | +
+ Minimum consecutive successes for the probe to be considered successful after having failed.
+Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. + + Format: int32 + |
+ false | +
| tcpSocket | +object | +
+ TCPSocket specifies a connection to a TCP port. + |
+ false | +
| terminationGracePeriodSeconds | +integer | +
+ Optional duration in seconds the pod needs to terminate gracefully upon probe failure.
+The grace period is the duration in seconds after the processes running in the pod are sent
+a termination signal and the time when the processes are forcibly halted with a kill signal.
+Set this value longer than the expected cleanup time for your process.
+If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this
+value overrides the value provided by the pod spec.
+Value must be non-negative integer. The value zero indicates stop immediately via
+the kill signal (no opportunity to shut down).
+This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.
+Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. + + Format: int64 + |
+ false | +
| timeoutSeconds | +integer | +
+ Number of seconds after which the probe times out.
+Defaults to 1 second. Minimum value is 1.
+More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + + Format: int32 + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| command | +[]string | +
+ Command is the command line to execute inside the container, the working directory for the
+command is root ('/') in the container's filesystem. The command is simply exec'd, it is
+not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
+a shell, you need to explicitly call out to that shell.
+Exit status of 0 is treated as live/healthy and non-zero is unhealthy. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| port | +integer | +
+ Port number of the gRPC service. Number must be in the range 1 to 65535. + + Format: int32 + |
+ true | +
| service | +string | +
+ Service is the name of the service to place in the gRPC HealthCheckRequest
+(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).
+
+If this is not specified, the default behavior is defined by gRPC. + + Default: + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| port | +int or string | +
+ Name or number of the port to access on the container.
+Number must be in the range 1 to 65535.
+Name must be an IANA_SVC_NAME. + |
+ true | +
| host | +string | +
+ Host name to connect to, defaults to the pod IP. You probably want to set
+"Host" in httpHeaders instead. + |
+ false | +
| httpHeaders | +[]object | +
+ Custom headers to set in the request. HTTP allows repeated headers. + |
+ false | +
| path | +string | +
+ Path to access on the HTTP server. + |
+ false | +
| scheme | +string | +
+ Scheme to use for connecting to the host.
+Defaults to HTTP. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ The header field name.
+This will be canonicalized upon output, so case-variant names will be understood as the same header. + |
+ true | +
| value | +string | +
+ The header field value + |
+ true | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| port | +int or string | +
+ Number or name of the port to access on the container.
+Number must be in the range 1 to 65535.
+Name must be an IANA_SVC_NAME. + |
+ true | +
| host | +string | +
+ Optional: Host name to connect to, defaults to the pod IP. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| resourceName | +string | +
+ Name of the resource to which this resource resize policy applies.
+Supported values: cpu, memory. + |
+ true | +
| restartPolicy | +string | +
+ Restart policy to apply when specified resource is resized.
+If not specified, it defaults to NotRequired. + |
+ true | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| claims | +[]object | +
+ Claims lists the names of resources, defined in spec.resourceClaims,
+that are used by this container.
+
+This field depends on the
+DynamicResourceAllocation feature gate.
+
+This field is immutable. It can only be set for containers. + |
+ false | +
| limits | +map[string]int or string | +
+ Limits describes the maximum amount of compute resources allowed.
+More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ + |
+ false | +
| requests | +map[string]int or string | +
+ Requests describes the minimum amount of compute resources required.
+If Requests is omitted for a container, it defaults to Limits if that is explicitly specified,
+otherwise to an implementation-defined value. Requests cannot exceed Limits.
+More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ Name must match the name of one entry in pod.spec.resourceClaims of
+the Pod where this field is used. It makes that resource available
+inside a container. + |
+ true | +
| request | +string | +
+ Request is the name chosen for a request in the referenced claim.
+If empty, everything from the claim is made available, otherwise
+only the result of this request. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| action | +string | +
+ Specifies the action taken on a container exit if the requirements
+are satisfied. The only possible value is "Restart" to restart the
+container. + |
+ true | +
| exitCodes | +object | +
+ Represents the exit codes to check on container exits. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| operator | +string | +
+ Represents the relationship between the container exit code(s) and the
+specified values. Possible values are:
+- In: the requirement is satisfied if the container exit code is in the
+ set of specified values.
+- NotIn: the requirement is satisfied if the container exit code is
+ not in the set of specified values. + |
+ true | +
| values | +[]integer | +
+ Specifies the set of values to check for container exit codes.
+At most 255 elements are allowed. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| allowPrivilegeEscalation | +boolean | +
+ AllowPrivilegeEscalation controls whether a process can gain more
+privileges than its parent process. This bool directly controls if
+the no_new_privs flag will be set on the container process.
+AllowPrivilegeEscalation is true always when the container is:
+1) run as Privileged
+2) has CAP_SYS_ADMIN
+Note that this field cannot be set when spec.os.name is windows. + |
+ false | +
| appArmorProfile | +object | +
+ appArmorProfile is the AppArmor options to use by this container. If set, this profile
+overrides the pod's appArmorProfile.
+Note that this field cannot be set when spec.os.name is windows. + |
+ false | +
| capabilities | +object | +
+ The capabilities to add/drop when running containers.
+Defaults to the default set of capabilities granted by the container runtime.
+Note that this field cannot be set when spec.os.name is windows. + |
+ false | +
| privileged | +boolean | +
+ Run container in privileged mode.
+Processes in privileged containers are essentially equivalent to root on the host.
+Defaults to false.
+Note that this field cannot be set when spec.os.name is windows. + |
+ false | +
| procMount | +string | +
+ procMount denotes the type of proc mount to use for the containers.
+The default value is Default which uses the container runtime defaults for
+readonly paths and masked paths.
+This requires the ProcMountType feature flag to be enabled.
+Note that this field cannot be set when spec.os.name is windows. + |
+ false | +
| readOnlyRootFilesystem | +boolean | +
+ Whether this container has a read-only root filesystem.
+Default is false.
+Note that this field cannot be set when spec.os.name is windows. + |
+ false | +
| runAsGroup | +integer | +
+ The GID to run the entrypoint of the container process.
+Uses runtime default if unset.
+May also be set in PodSecurityContext. If set in both SecurityContext and
+PodSecurityContext, the value specified in SecurityContext takes precedence.
+Note that this field cannot be set when spec.os.name is windows. + + Format: int64 + |
+ false | +
| runAsNonRoot | +boolean | +
+ Indicates that the container must run as a non-root user.
+If true, the Kubelet will validate the image at runtime to ensure that it
+does not run as UID 0 (root) and fail to start the container if it does.
+If unset or false, no such validation will be performed.
+May also be set in PodSecurityContext. If set in both SecurityContext and
+PodSecurityContext, the value specified in SecurityContext takes precedence. + |
+ false | +
| runAsUser | +integer | +
+ The UID to run the entrypoint of the container process.
+Defaults to user specified in image metadata if unspecified.
+May also be set in PodSecurityContext. If set in both SecurityContext and
+PodSecurityContext, the value specified in SecurityContext takes precedence.
+Note that this field cannot be set when spec.os.name is windows. + + Format: int64 + |
+ false | +
| seLinuxOptions | +object | +
+ The SELinux context to be applied to the container.
+If unspecified, the container runtime will allocate a random SELinux context for each
+container. May also be set in PodSecurityContext. If set in both SecurityContext and
+PodSecurityContext, the value specified in SecurityContext takes precedence.
+Note that this field cannot be set when spec.os.name is windows. + |
+ false | +
| seccompProfile | +object | +
+ The seccomp options to use by this container. If seccomp options are
+provided at both the pod & container level, the container options
+override the pod options.
+Note that this field cannot be set when spec.os.name is windows. + |
+ false | +
| windowsOptions | +object | +
+ The Windows specific settings applied to all containers.
+If unspecified, the options from the PodSecurityContext will be used.
+If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
+Note that this field cannot be set when spec.os.name is linux. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| type | +string | +
+ type indicates which kind of AppArmor profile will be applied.
+Valid options are:
+ Localhost - a profile pre-loaded on the node.
+ RuntimeDefault - the container runtime's default profile.
+ Unconfined - no AppArmor enforcement. + |
+ true | +
| localhostProfile | +string | +
+ localhostProfile indicates a profile loaded on the node that should be used.
+The profile must be preconfigured on the node to work.
+Must match the loaded name of the profile.
+Must be set if and only if type is "Localhost". + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| add | +[]string | +
+ Added capabilities + |
+ false | +
| drop | +[]string | +
+ Removed capabilities + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| level | +string | +
+ Level is SELinux level label that applies to the container. + |
+ false | +
| role | +string | +
+ Role is a SELinux role label that applies to the container. + |
+ false | +
| type | +string | +
+ Type is a SELinux type label that applies to the container. + |
+ false | +
| user | +string | +
+ User is a SELinux user label that applies to the container. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| type | +string | +
+ type indicates which kind of seccomp profile will be applied.
+Valid options are:
+
+Localhost - a profile defined in a file on the node should be used.
+RuntimeDefault - the container runtime default profile should be used.
+Unconfined - no profile should be applied. + |
+ true | +
| localhostProfile | +string | +
+ localhostProfile indicates a profile defined in a file on the node should be used.
+The profile must be preconfigured on the node to work.
+Must be a descending path, relative to the kubelet's configured seccomp profile location.
+Must be set if type is "Localhost". Must NOT be set for any other type. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| gmsaCredentialSpec | +string | +
+ GMSACredentialSpec is where the GMSA admission webhook
+(https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the
+GMSA credential spec named by the GMSACredentialSpecName field. + |
+ false | +
| gmsaCredentialSpecName | +string | +
+ GMSACredentialSpecName is the name of the GMSA credential spec to use. + |
+ false | +
| hostProcess | +boolean | +
+ HostProcess determines if a container should be run as a 'Host Process' container.
+All of a Pod's containers must have the same effective HostProcess value
+(it is not allowed to have a mix of HostProcess containers and non-HostProcess containers).
+In addition, if HostProcess is true then HostNetwork must also be set to true. + |
+ false | +
| runAsUserName | +string | +
+ The UserName in Windows to run the entrypoint of the container process.
+Defaults to the user specified in image metadata if unspecified.
+May also be set in PodSecurityContext. If set in both SecurityContext and
+PodSecurityContext, the value specified in SecurityContext takes precedence. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| exec | +object | +
+ Exec specifies a command to execute in the container. + |
+ false | +
| failureThreshold | +integer | +
+ Minimum consecutive failures for the probe to be considered failed after having succeeded.
+Defaults to 3. Minimum value is 1. + + Format: int32 + |
+ false | +
| grpc | +object | +
+ GRPC specifies a GRPC HealthCheckRequest. + |
+ false | +
| httpGet | +object | +
+ HTTPGet specifies an HTTP GET request to perform. + |
+ false | +
| initialDelaySeconds | +integer | +
+ Number of seconds after the container has started before liveness probes are initiated.
+More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + + Format: int32 + |
+ false | +
| periodSeconds | +integer | +
+ How often (in seconds) to perform the probe.
+Default to 10 seconds. Minimum value is 1. + + Format: int32 + |
+ false | +
| successThreshold | +integer | +
+ Minimum consecutive successes for the probe to be considered successful after having failed.
+Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. + + Format: int32 + |
+ false | +
| tcpSocket | +object | +
+ TCPSocket specifies a connection to a TCP port. + |
+ false | +
| terminationGracePeriodSeconds | +integer | +
+ Optional duration in seconds the pod needs to terminate gracefully upon probe failure.
+The grace period is the duration in seconds after the processes running in the pod are sent
+a termination signal and the time when the processes are forcibly halted with a kill signal.
+Set this value longer than the expected cleanup time for your process.
+If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this
+value overrides the value provided by the pod spec.
+Value must be non-negative integer. The value zero indicates stop immediately via
+the kill signal (no opportunity to shut down).
+This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.
+Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. + + Format: int64 + |
+ false | +
| timeoutSeconds | +integer | +
+ Number of seconds after which the probe times out.
+Defaults to 1 second. Minimum value is 1.
+More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + + Format: int32 + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| command | +[]string | +
+ Command is the command line to execute inside the container, the working directory for the
+command is root ('/') in the container's filesystem. The command is simply exec'd, it is
+not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
+a shell, you need to explicitly call out to that shell.
+Exit status of 0 is treated as live/healthy and non-zero is unhealthy. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| port | +integer | +
+ Port number of the gRPC service. Number must be in the range 1 to 65535. + + Format: int32 + |
+ true | +
| service | +string | +
+ Service is the name of the service to place in the gRPC HealthCheckRequest
+(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).
+
+If this is not specified, the default behavior is defined by gRPC. + + Default: + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| port | +int or string | +
+ Name or number of the port to access on the container.
+Number must be in the range 1 to 65535.
+Name must be an IANA_SVC_NAME. + |
+ true | +
| host | +string | +
+ Host name to connect to, defaults to the pod IP. You probably want to set
+"Host" in httpHeaders instead. + |
+ false | +
| httpHeaders | +[]object | +
+ Custom headers to set in the request. HTTP allows repeated headers. + |
+ false | +
| path | +string | +
+ Path to access on the HTTP server. + |
+ false | +
| scheme | +string | +
+ Scheme to use for connecting to the host.
+Defaults to HTTP. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ The header field name.
+This will be canonicalized upon output, so case-variant names will be understood as the same header. + |
+ true | +
| value | +string | +
+ The header field value + |
+ true | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| port | +int or string | +
+ Number or name of the port to access on the container.
+Number must be in the range 1 to 65535.
+Name must be an IANA_SVC_NAME. + |
+ true | +
| host | +string | +
+ Optional: Host name to connect to, defaults to the pod IP. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| devicePath | +string | +
+ devicePath is the path inside of the container that the device will be mapped to. + |
+ true | +
| name | +string | +
+ name must match the name of a persistentVolumeClaim in the pod + |
+ true | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| mountPath | +string | +
+ Path within the container at which the volume should be mounted. Must
+not contain ':'. + |
+ true | +
| name | +string | +
+ This must match the Name of a Volume. + |
+ true | +
| mountPropagation | +string | +
+ mountPropagation determines how mounts are propagated from the host
+to container and the other way around.
+When not set, MountPropagationNone is used.
+This field is beta in 1.10.
+When RecursiveReadOnly is set to IfPossible or to Enabled, MountPropagation must be None or unspecified
+(which defaults to None). + |
+ false | +
| readOnly | +boolean | +
+ Mounted read-only if true, read-write otherwise (false or unspecified).
+Defaults to false. + |
+ false | +
| recursiveReadOnly | +string | +
+ RecursiveReadOnly specifies whether read-only mounts should be handled
+recursively.
+
+If ReadOnly is false, this field has no meaning and must be unspecified.
+
+If ReadOnly is true, and this field is set to Disabled, the mount is not made
+recursively read-only. If this field is set to IfPossible, the mount is made
+recursively read-only, if it is supported by the container runtime. If this
+field is set to Enabled, the mount is made recursively read-only if it is
+supported by the container runtime, otherwise the pod will not be started and
+an error will be generated to indicate the reason.
+
+If this field is set to IfPossible or Enabled, MountPropagation must be set to
+None (or be unspecified, which defaults to None).
+
+If this field is not specified, it is treated as an equivalent of Disabled. + |
+ false | +
| subPath | +string | +
+ Path within the volume from which the container's volume should be mounted.
+Defaults to "" (volume's root). + |
+ false | +
| subPathExpr | +string | +
+ Expanded path within the volume from which the container's volume should be mounted.
+Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment.
+Defaults to "" (volume's root).
+SubPathExpr and SubPath are mutually exclusive. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ Name is the name of the operating system. The currently supported values are linux and windows.
+Additional value may be defined in future and can be one of:
+https://github.com/opencontainers/runtime-spec/blob/master/config.md#platform-specific-configuration
+Clients should expect to handle additional values and treat unrecognized values in this field as os: null + |
+ true | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| conditionType | +string | +
+ ConditionType refers to a condition in the pod's condition list with matching type. + |
+ true | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ Name uniquely identifies this resource claim inside the pod.
+This must be a DNS_LABEL. + |
+ true | +
| resourceClaimName | +string | +
+ ResourceClaimName is the name of a ResourceClaim object in the same
+namespace as this pod.
+
+Exactly one of ResourceClaimName and ResourceClaimTemplateName must
+be set. + |
+ false | +
| resourceClaimTemplateName | +string | +
+ ResourceClaimTemplateName is the name of a ResourceClaimTemplate
+object in the same namespace as this pod.
+
+The template will be used to create a new ResourceClaim, which will
+be bound to this pod. When this pod is deleted, the ResourceClaim
+will also be deleted. The pod name and resource name, along with a
+generated component, will be used to form a unique name for the
+ResourceClaim, which will be recorded in pod.status.resourceClaimStatuses.
+
+This field is immutable and no changes will be made to the
+corresponding ResourceClaim by the control plane after creating the
+ResourceClaim.
+
+Exactly one of ResourceClaimName and ResourceClaimTemplateName must
+be set. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| claims | +[]object | +
+ Claims lists the names of resources, defined in spec.resourceClaims,
+that are used by this container.
+
+This field depends on the
+DynamicResourceAllocation feature gate.
+
+This field is immutable. It can only be set for containers. + |
+ false | +
| limits | +map[string]int or string | +
+ Limits describes the maximum amount of compute resources allowed.
+More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ + |
+ false | +
| requests | +map[string]int or string | +
+ Requests describes the minimum amount of compute resources required.
+If Requests is omitted for a container, it defaults to Limits if that is explicitly specified,
+otherwise to an implementation-defined value. Requests cannot exceed Limits.
+More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ Name must match the name of one entry in pod.spec.resourceClaims of
+the Pod where this field is used. It makes that resource available
+inside a container. + |
+ true | +
| request | +string | +
+ Request is the name chosen for a request in the referenced claim.
+If empty, everything from the claim is made available, otherwise
+only the result of this request. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ Name of the scheduling gate.
+Each scheduling gate must have a unique name field. + |
+ true | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| appArmorProfile | +object | +
+ appArmorProfile is the AppArmor options to use by the containers in this pod.
+Note that this field cannot be set when spec.os.name is windows. + |
+ false | +
| fsGroup | +integer | +
+ A special supplemental group that applies to all containers in a pod.
+Some volume types allow the Kubelet to change the ownership of that volume
+to be owned by the pod:
+
+1. The owning GID will be the FSGroup
+2. The setgid bit is set (new files created in the volume will be owned by FSGroup)
+3. The permission bits are OR'd with rw-rw----
+
+If unset, the Kubelet will not modify the ownership and permissions of any volume.
+Note that this field cannot be set when spec.os.name is windows. + + Format: int64 + |
+ false | +
| fsGroupChangePolicy | +string | +
+ fsGroupChangePolicy defines behavior of changing ownership and permission of the volume
+before being exposed inside Pod. This field will only apply to
+volume types which support fsGroup based ownership(and permissions).
+It will have no effect on ephemeral volume types such as: secret, configmaps
+and emptydir.
+Valid values are "OnRootMismatch" and "Always". If not specified, "Always" is used.
+Note that this field cannot be set when spec.os.name is windows. + |
+ false | +
| runAsGroup | +integer | +
+ The GID to run the entrypoint of the container process.
+Uses runtime default if unset.
+May also be set in SecurityContext. If set in both SecurityContext and
+PodSecurityContext, the value specified in SecurityContext takes precedence
+for that container.
+Note that this field cannot be set when spec.os.name is windows. + + Format: int64 + |
+ false | +
| runAsNonRoot | +boolean | +
+ Indicates that the container must run as a non-root user.
+If true, the Kubelet will validate the image at runtime to ensure that it
+does not run as UID 0 (root) and fail to start the container if it does.
+If unset or false, no such validation will be performed.
+May also be set in SecurityContext. If set in both SecurityContext and
+PodSecurityContext, the value specified in SecurityContext takes precedence. + |
+ false | +
| runAsUser | +integer | +
+ The UID to run the entrypoint of the container process.
+Defaults to user specified in image metadata if unspecified.
+May also be set in SecurityContext. If set in both SecurityContext and
+PodSecurityContext, the value specified in SecurityContext takes precedence
+for that container.
+Note that this field cannot be set when spec.os.name is windows. + + Format: int64 + |
+ false | +
| seLinuxChangePolicy | +string | +
+ seLinuxChangePolicy defines how the container's SELinux label is applied to all volumes used by the Pod.
+It has no effect on nodes that do not support SELinux or to volumes does not support SELinux.
+Valid values are "MountOption" and "Recursive".
+
+"Recursive" means relabeling of all files on all Pod volumes by the container runtime.
+This may be slow for large volumes, but allows mixing privileged and unprivileged Pods sharing the same volume on the same node.
+
+"MountOption" mounts all eligible Pod volumes with `-o context` mount option.
+This requires all Pods that share the same volume to use the same SELinux label.
+It is not possible to share the same volume among privileged and unprivileged Pods.
+Eligible volumes are in-tree FibreChannel and iSCSI volumes, and all CSI volumes
+whose CSI driver announces SELinux support by setting spec.seLinuxMount: true in their
+CSIDriver instance. Other volumes are always re-labelled recursively.
+"MountOption" value is allowed only when SELinuxMount feature gate is enabled.
+
+If not specified and SELinuxMount feature gate is enabled, "MountOption" is used.
+If not specified and SELinuxMount feature gate is disabled, "MountOption" is used for ReadWriteOncePod volumes
+and "Recursive" for all other volumes.
+
+This field affects only Pods that have SELinux label set, either in PodSecurityContext or in SecurityContext of all containers.
+
+All Pods that use the same volume should use the same seLinuxChangePolicy, otherwise some pods can get stuck in ContainerCreating state.
+Note that this field cannot be set when spec.os.name is windows. + |
+ false | +
| seLinuxOptions | +object | +
+ The SELinux context to be applied to all containers.
+If unspecified, the container runtime will allocate a random SELinux context for each
+container. May also be set in SecurityContext. If set in
+both SecurityContext and PodSecurityContext, the value specified in SecurityContext
+takes precedence for that container.
+Note that this field cannot be set when spec.os.name is windows. + |
+ false | +
| seccompProfile | +object | +
+ The seccomp options to use by the containers in this pod.
+Note that this field cannot be set when spec.os.name is windows. + |
+ false | +
| supplementalGroups | +[]integer | +
+ A list of groups applied to the first process run in each container, in
+addition to the container's primary GID and fsGroup (if specified). If
+the SupplementalGroupsPolicy feature is enabled, the
+supplementalGroupsPolicy field determines whether these are in addition
+to or instead of any group memberships defined in the container image.
+If unspecified, no additional groups are added, though group memberships
+defined in the container image may still be used, depending on the
+supplementalGroupsPolicy field.
+Note that this field cannot be set when spec.os.name is windows. + |
+ false | +
| supplementalGroupsPolicy | +string | +
+ Defines how supplemental groups of the first container processes are calculated.
+Valid values are "Merge" and "Strict". If not specified, "Merge" is used.
+(Alpha) Using the field requires the SupplementalGroupsPolicy feature gate to be enabled
+and the container runtime must implement support for this feature.
+Note that this field cannot be set when spec.os.name is windows. + |
+ false | +
| sysctls | +[]object | +
+ Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported
+sysctls (by the container runtime) might fail to launch.
+Note that this field cannot be set when spec.os.name is windows. + |
+ false | +
| windowsOptions | +object | +
+ The Windows specific settings applied to all containers.
+If unspecified, the options within a container's SecurityContext will be used.
+If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
+Note that this field cannot be set when spec.os.name is linux. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| type | +string | +
+ type indicates which kind of AppArmor profile will be applied.
+Valid options are:
+ Localhost - a profile pre-loaded on the node.
+ RuntimeDefault - the container runtime's default profile.
+ Unconfined - no AppArmor enforcement. + |
+ true | +
| localhostProfile | +string | +
+ localhostProfile indicates a profile loaded on the node that should be used.
+The profile must be preconfigured on the node to work.
+Must match the loaded name of the profile.
+Must be set if and only if type is "Localhost". + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| level | +string | +
+ Level is SELinux level label that applies to the container. + |
+ false | +
| role | +string | +
+ Role is a SELinux role label that applies to the container. + |
+ false | +
| type | +string | +
+ Type is a SELinux type label that applies to the container. + |
+ false | +
| user | +string | +
+ User is a SELinux user label that applies to the container. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| type | +string | +
+ type indicates which kind of seccomp profile will be applied.
+Valid options are:
+
+Localhost - a profile defined in a file on the node should be used.
+RuntimeDefault - the container runtime default profile should be used.
+Unconfined - no profile should be applied. + |
+ true | +
| localhostProfile | +string | +
+ localhostProfile indicates a profile defined in a file on the node should be used.
+The profile must be preconfigured on the node to work.
+Must be a descending path, relative to the kubelet's configured seccomp profile location.
+Must be set if type is "Localhost". Must NOT be set for any other type. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ Name of a property to set + |
+ true | +
| value | +string | +
+ Value of a property to set + |
+ true | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| gmsaCredentialSpec | +string | +
+ GMSACredentialSpec is where the GMSA admission webhook
+(https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the
+GMSA credential spec named by the GMSACredentialSpecName field. + |
+ false | +
| gmsaCredentialSpecName | +string | +
+ GMSACredentialSpecName is the name of the GMSA credential spec to use. + |
+ false | +
| hostProcess | +boolean | +
+ HostProcess determines if a container should be run as a 'Host Process' container.
+All of a Pod's containers must have the same effective HostProcess value
+(it is not allowed to have a mix of HostProcess containers and non-HostProcess containers).
+In addition, if HostProcess is true then HostNetwork must also be set to true. + |
+ false | +
| runAsUserName | +string | +
+ The UserName in Windows to run the entrypoint of the container process.
+Defaults to the user specified in image metadata if unspecified.
+May also be set in PodSecurityContext. If set in both SecurityContext and
+PodSecurityContext, the value specified in SecurityContext takes precedence. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| effect | +string | +
+ Effect indicates the taint effect to match. Empty means match all taint effects.
+When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute. + |
+ false | +
| key | +string | +
+ Key is the taint key that the toleration applies to. Empty means match all taint keys.
+If the key is empty, operator must be Exists; this combination means to match all values and all keys. + |
+ false | +
| operator | +string | +
+ Operator represents a key's relationship to the value.
+Valid operators are Exists and Equal. Defaults to Equal.
+Exists is equivalent to wildcard for value, so that a pod can
+tolerate all taints of a particular category. + |
+ false | +
| tolerationSeconds | +integer | +
+ TolerationSeconds represents the period of time the toleration (which must be
+of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default,
+it is not set, which means tolerate the taint forever (do not evict). Zero and
+negative values will be treated as 0 (evict immediately) by the system. + + Format: int64 + |
+ false | +
| value | +string | +
+ Value is the taint value the toleration matches to.
+If the operator is Exists, the value should be empty, otherwise just a regular string. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| maxSkew | +integer | +
+ MaxSkew describes the degree to which pods may be unevenly distributed.
+When `whenUnsatisfiable=DoNotSchedule`, it is the maximum permitted difference
+between the number of matching pods in the target topology and the global minimum.
+The global minimum is the minimum number of matching pods in an eligible domain
+or zero if the number of eligible domains is less than MinDomains.
+For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same
+labelSelector spread as 2/2/1:
+In this case, the global minimum is 1.
+| zone1 | zone2 | zone3 |
+| P P | P P | P |
+- if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 2/2/2;
+scheduling it onto zone1(zone2) would make the ActualSkew(3-1) on zone1(zone2)
+violate MaxSkew(1).
+- if MaxSkew is 2, incoming pod can be scheduled onto any zone.
+When `whenUnsatisfiable=ScheduleAnyway`, it is used to give higher precedence
+to topologies that satisfy it.
+It's a required field. Default value is 1 and 0 is not allowed. + + Format: int32 + |
+ true | +
| topologyKey | +string | +
+ TopologyKey is the key of node labels. Nodes that have a label with this key
+and identical values are considered to be in the same topology.
+We consider each + |
+ true | +
| whenUnsatisfiable | +string | +
+ WhenUnsatisfiable indicates how to deal with a pod if it doesn't satisfy
+the spread constraint.
+- DoNotSchedule (default) tells the scheduler not to schedule it.
+- ScheduleAnyway tells the scheduler to schedule the pod in any location,
+ but giving higher precedence to topologies that would help reduce the
+ skew.
+A constraint is considered "Unsatisfiable" for an incoming pod
+if and only if every possible node assignment for that pod would violate
+"MaxSkew" on some topology.
+For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same
+labelSelector spread as 3/1/1:
+| zone1 | zone2 | zone3 |
+| P P P | P | P |
+If WhenUnsatisfiable is set to DoNotSchedule, incoming pod can only be scheduled
+to zone2(zone3) to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3) satisfies
+MaxSkew(1). In other words, the cluster can still be imbalanced, but scheduler
+won't make it *more* imbalanced.
+It's a required field. + |
+ true | +
| labelSelector | +object | +
+ LabelSelector is used to find matching pods.
+Pods that match this label selector are counted to determine the number of pods
+in their corresponding topology domain. + |
+ false | +
| matchLabelKeys | +[]string | +
+ MatchLabelKeys is a set of pod label keys to select the pods over which
+spreading will be calculated. The keys are used to lookup values from the
+incoming pod labels, those key-value labels are ANDed with labelSelector
+to select the group of existing pods over which spreading will be calculated
+for the incoming pod. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector.
+MatchLabelKeys cannot be set when LabelSelector isn't set.
+Keys that don't exist in the incoming pod labels will
+be ignored. A null or empty list means only match against labelSelector.
+
+This is a beta field and requires the MatchLabelKeysInPodTopologySpread feature gate to be enabled (enabled by default). + |
+ false | +
| minDomains | +integer | +
+ MinDomains indicates a minimum number of eligible domains.
+When the number of eligible domains with matching topology keys is less than minDomains,
+Pod Topology Spread treats "global minimum" as 0, and then the calculation of Skew is performed.
+And when the number of eligible domains with matching topology keys equals or greater than minDomains,
+this value has no effect on scheduling.
+As a result, when the number of eligible domains is less than minDomains,
+scheduler won't schedule more than maxSkew Pods to those domains.
+If value is nil, the constraint behaves as if MinDomains is equal to 1.
+Valid values are integers greater than 0.
+When value is not nil, WhenUnsatisfiable must be DoNotSchedule.
+
+For example, in a 3-zone cluster, MaxSkew is set to 2, MinDomains is set to 5 and pods with the same
+labelSelector spread as 2/2/2:
+| zone1 | zone2 | zone3 |
+| P P | P P | P P |
+The number of domains is less than 5(MinDomains), so "global minimum" is treated as 0.
+In this situation, new pod with the same labelSelector cannot be scheduled,
+because computed skew will be 3(3 - 0) if new Pod is scheduled to any of the three zones,
+it will violate MaxSkew. + + Format: int32 + |
+ false | +
| nodeAffinityPolicy | +string | +
+ NodeAffinityPolicy indicates how we will treat Pod's nodeAffinity/nodeSelector
+when calculating pod topology spread skew. Options are:
+- Honor: only nodes matching nodeAffinity/nodeSelector are included in the calculations.
+- Ignore: nodeAffinity/nodeSelector are ignored. All nodes are included in the calculations.
+
+If this value is nil, the behavior is equivalent to the Honor policy. + |
+ false | +
| nodeTaintsPolicy | +string | +
+ NodeTaintsPolicy indicates how we will treat node taints when calculating
+pod topology spread skew. Options are:
+- Honor: nodes without taints, along with tainted nodes for which the incoming pod
+has a toleration, are included.
+- Ignore: node taints are ignored. All nodes are included.
+
+If this value is nil, the behavior is equivalent to the Ignore policy. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| matchExpressions | +[]object | +
+ matchExpressions is a list of label selector requirements. The requirements are ANDed. + |
+ false | +
| matchLabels | +map[string]string | +
+ matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
+map is equivalent to an element of matchExpressions, whose key field is "key", the
+operator is "In", and the values array contains only "value". The requirements are ANDed. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| key | +string | +
+ key is the label key that the selector applies to. + |
+ true | +
| operator | +string | +
+ operator represents a key's relationship to a set of values.
+Valid operators are In, NotIn, Exists and DoesNotExist. + |
+ true | +
| values | +[]string | +
+ values is an array of string values. If the operator is In or NotIn,
+the values array must be non-empty. If the operator is Exists or DoesNotExist,
+the values array must be empty. This array is replaced during a strategic
+merge patch. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ name of the volume.
+Must be a DNS_LABEL and unique within the pod.
+More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + |
+ true | +
| awsElasticBlockStore | +object | +
+ awsElasticBlockStore represents an AWS Disk resource that is attached to a
+kubelet's host machine and then exposed to the pod.
+Deprecated: AWSElasticBlockStore is deprecated. All operations for the in-tree
+awsElasticBlockStore type are redirected to the ebs.csi.aws.com CSI driver.
+More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore + |
+ false | +
| azureDisk | +object | +
+ azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.
+Deprecated: AzureDisk is deprecated. All operations for the in-tree azureDisk type
+are redirected to the disk.csi.azure.com CSI driver. + |
+ false | +
| azureFile | +object | +
+ azureFile represents an Azure File Service mount on the host and bind mount to the pod.
+Deprecated: AzureFile is deprecated. All operations for the in-tree azureFile type
+are redirected to the file.csi.azure.com CSI driver. + |
+ false | +
| cephfs | +object | +
+ cephFS represents a Ceph FS mount on the host that shares a pod's lifetime.
+Deprecated: CephFS is deprecated and the in-tree cephfs type is no longer supported. + |
+ false | +
| cinder | +object | +
+ cinder represents a cinder volume attached and mounted on kubelets host machine.
+Deprecated: Cinder is deprecated. All operations for the in-tree cinder type
+are redirected to the cinder.csi.openstack.org CSI driver.
+More info: https://examples.k8s.io/mysql-cinder-pd/README.md + |
+ false | +
| configMap | +object | +
+ configMap represents a configMap that should populate this volume + |
+ false | +
| csi | +object | +
+ csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers. + |
+ false | +
| downwardAPI | +object | +
+ downwardAPI represents downward API about the pod that should populate this volume + |
+ false | +
| emptyDir | +object | +
+ emptyDir represents a temporary directory that shares a pod's lifetime.
+More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir + |
+ false | +
| ephemeral | +object | +
+ ephemeral represents a volume that is handled by a cluster storage driver.
+The volume's lifecycle is tied to the pod that defines it - it will be created before the pod starts,
+and deleted when the pod is removed.
+
+Use this if:
+a) the volume is only needed while the pod runs,
+b) features of normal volumes like restoring from snapshot or capacity
+ tracking are needed,
+c) the storage driver is specified through a storage class, and
+d) the storage driver supports dynamic volume provisioning through
+ a PersistentVolumeClaim (see EphemeralVolumeSource for more
+ information on the connection between this volume type
+ and PersistentVolumeClaim).
+
+Use PersistentVolumeClaim or one of the vendor-specific
+APIs for volumes that persist for longer than the lifecycle
+of an individual pod.
+
+Use CSI for light-weight local ephemeral volumes if the CSI driver is meant to
+be used that way - see the documentation of the driver for
+more information.
+
+A pod can use both types of ephemeral volumes and
+persistent volumes at the same time. + |
+ false | +
| fc | +object | +
+ fc represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod. + |
+ false | +
| flexVolume | +object | +
+ flexVolume represents a generic volume resource that is
+provisioned/attached using an exec based plugin.
+Deprecated: FlexVolume is deprecated. Consider using a CSIDriver instead. + |
+ false | +
| flocker | +object | +
+ flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running.
+Deprecated: Flocker is deprecated and the in-tree flocker type is no longer supported. + |
+ false | +
| gcePersistentDisk | +object | +
+ gcePersistentDisk represents a GCE Disk resource that is attached to a
+kubelet's host machine and then exposed to the pod.
+Deprecated: GCEPersistentDisk is deprecated. All operations for the in-tree
+gcePersistentDisk type are redirected to the pd.csi.storage.gke.io CSI driver.
+More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk + |
+ false | +
| gitRepo | +object | +
+ gitRepo represents a git repository at a particular revision.
+Deprecated: GitRepo is deprecated. To provision a container with a git repo, mount an
+EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir
+into the Pod's container. + |
+ false | +
| glusterfs | +object | +
+ glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime.
+Deprecated: Glusterfs is deprecated and the in-tree glusterfs type is no longer supported. + |
+ false | +
| hostPath | +object | +
+ hostPath represents a pre-existing file or directory on the host
+machine that is directly exposed to the container. This is generally
+used for system agents or other privileged things that are allowed
+to see the host machine. Most containers will NOT need this.
+More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath + |
+ false | +
| image | +object | +
+ image represents an OCI object (a container image or artifact) pulled and mounted on the kubelet's host machine.
+The volume is resolved at pod startup depending on which PullPolicy value is provided:
+
+- Always: the kubelet always attempts to pull the reference. Container creation will fail If the pull fails.
+- Never: the kubelet never pulls the reference and only uses a local image or artifact. Container creation will fail if the reference isn't present.
+- IfNotPresent: the kubelet pulls if the reference isn't already present on disk. Container creation will fail if the reference isn't present and the pull fails.
+
+The volume gets re-resolved if the pod gets deleted and recreated, which means that new remote content will become available on pod recreation.
+A failure to resolve or pull the image during pod startup will block containers from starting and may add significant latency. Failures will be retried using normal volume backoff and will be reported on the pod reason and message.
+The types of objects that may be mounted by this volume are defined by the container runtime implementation on a host machine and at minimum must include all valid types supported by the container image field.
+The OCI object gets mounted in a single directory (spec.containers[*].volumeMounts.mountPath) by merging the manifest layers in the same way as for container images.
+The volume will be mounted read-only (ro) and non-executable files (noexec).
+Sub path mounts for containers are not supported (spec.containers[*].volumeMounts.subpath) before 1.33.
+The field spec.securityContext.fsGroupChangePolicy has no effect on this volume type. + |
+ false | +
| iscsi | +object | +
+ iscsi represents an ISCSI Disk resource that is attached to a
+kubelet's host machine and then exposed to the pod.
+More info: https://kubernetes.io/docs/concepts/storage/volumes/#iscsi + |
+ false | +
| nfs | +object | +
+ nfs represents an NFS mount on the host that shares a pod's lifetime
+More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs + |
+ false | +
| persistentVolumeClaim | +object | +
+ persistentVolumeClaimVolumeSource represents a reference to a
+PersistentVolumeClaim in the same namespace.
+More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims + |
+ false | +
| photonPersistentDisk | +object | +
+ photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine.
+Deprecated: PhotonPersistentDisk is deprecated and the in-tree photonPersistentDisk type is no longer supported. + |
+ false | +
| portworxVolume | +object | +
+ portworxVolume represents a portworx volume attached and mounted on kubelets host machine.
+Deprecated: PortworxVolume is deprecated. All operations for the in-tree portworxVolume type
+are redirected to the pxd.portworx.com CSI driver when the CSIMigrationPortworx feature-gate
+is on. + |
+ false | +
| projected | +object | +
+ projected items for all in one resources secrets, configmaps, and downward API + |
+ false | +
| quobyte | +object | +
+ quobyte represents a Quobyte mount on the host that shares a pod's lifetime.
+Deprecated: Quobyte is deprecated and the in-tree quobyte type is no longer supported. + |
+ false | +
| rbd | +object | +
+ rbd represents a Rados Block Device mount on the host that shares a pod's lifetime.
+Deprecated: RBD is deprecated and the in-tree rbd type is no longer supported. + |
+ false | +
| scaleIO | +object | +
+ scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.
+Deprecated: ScaleIO is deprecated and the in-tree scaleIO type is no longer supported. + |
+ false | +
| secret | +object | +
+ secret represents a secret that should populate this volume.
+More info: https://kubernetes.io/docs/concepts/storage/volumes#secret + |
+ false | +
| storageos | +object | +
+ storageOS represents a StorageOS volume attached and mounted on Kubernetes nodes.
+Deprecated: StorageOS is deprecated and the in-tree storageos type is no longer supported. + |
+ false | +
| vsphereVolume | +object | +
+ vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine.
+Deprecated: VsphereVolume is deprecated. All operations for the in-tree vsphereVolume type
+are redirected to the csi.vsphere.vmware.com CSI driver. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| volumeID | +string | +
+ volumeID is unique ID of the persistent disk resource in AWS (Amazon EBS volume).
+More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore + |
+ true | +
| fsType | +string | +
+ fsType is the filesystem type of the volume that you want to mount.
+Tip: Ensure that the filesystem type is supported by the host operating system.
+Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
+More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore + |
+ false | +
| partition | +integer | +
+ partition is the partition in the volume that you want to mount.
+If omitted, the default is to mount by volume name.
+Examples: For volume /dev/sda1, you specify the partition as "1".
+Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). + + Format: int32 + |
+ false | +
| readOnly | +boolean | +
+ readOnly value true will force the readOnly setting in VolumeMounts.
+More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| diskName | +string | +
+ diskName is the Name of the data disk in the blob storage + |
+ true | +
| diskURI | +string | +
+ diskURI is the URI of data disk in the blob storage + |
+ true | +
| cachingMode | +string | +
+ cachingMode is the Host Caching mode: None, Read Only, Read Write. + |
+ false | +
| fsType | +string | +
+ fsType is Filesystem type to mount.
+Must be a filesystem type supported by the host operating system.
+Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. + + Default: ext4 + |
+ false | +
| kind | +string | +
+ kind expected values are 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 + |
+ false | +
| readOnly | +boolean | +
+ readOnly Defaults to false (read/write). ReadOnly here will force
+the ReadOnly setting in VolumeMounts. + + Default: false + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| secretName | +string | +
+ secretName is the name of secret that contains Azure Storage Account Name and Key + |
+ true | +
| shareName | +string | +
+ shareName is the azure share Name + |
+ true | +
| readOnly | +boolean | +
+ readOnly defaults to false (read/write). ReadOnly here will force
+the ReadOnly setting in VolumeMounts. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| monitors | +[]string | +
+ monitors is Required: Monitors is a collection of Ceph monitors
+More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it + |
+ true | +
| path | +string | +
+ path is Optional: Used as the mounted root, rather than the full Ceph tree, default is / + |
+ false | +
| readOnly | +boolean | +
+ readOnly is Optional: Defaults to false (read/write). ReadOnly here will force
+the ReadOnly setting in VolumeMounts.
+More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it + |
+ false | +
| secretFile | +string | +
+ secretFile is Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret
+More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it + |
+ false | +
| secretRef | +object | +
+ secretRef is Optional: SecretRef is reference to the authentication secret for User, default is empty.
+More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it + |
+ false | +
| user | +string | +
+ user is optional: User is the rados user name, default is admin
+More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ Name of the referent.
+This field is effectively required, but due to backwards compatibility is
+allowed to be empty. Instances of this type with an empty value here are
+almost certainly wrong.
+More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + + Default: + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| volumeID | +string | +
+ volumeID used to identify the volume in cinder.
+More info: https://examples.k8s.io/mysql-cinder-pd/README.md + |
+ true | +
| fsType | +string | +
+ fsType is the filesystem type to mount.
+Must be a filesystem type supported by the host operating system.
+Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
+More info: https://examples.k8s.io/mysql-cinder-pd/README.md + |
+ false | +
| readOnly | +boolean | +
+ readOnly defaults to false (read/write). ReadOnly here will force
+the ReadOnly setting in VolumeMounts.
+More info: https://examples.k8s.io/mysql-cinder-pd/README.md + |
+ false | +
| secretRef | +object | +
+ secretRef is optional: points to a secret object containing parameters used to connect
+to OpenStack. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ Name of the referent.
+This field is effectively required, but due to backwards compatibility is
+allowed to be empty. Instances of this type with an empty value here are
+almost certainly wrong.
+More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + + Default: + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| defaultMode | +integer | +
+ defaultMode is optional: mode bits used to set permissions on created files by default.
+Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511.
+YAML accepts both octal and decimal values, JSON requires decimal values for mode bits.
+Defaults to 0644.
+Directories within the path are not affected by this setting.
+This might be in conflict with other options that affect the file
+mode, like fsGroup, and the result can be other mode bits set. + + Format: int32 + |
+ false | +
| items | +[]object | +
+ items if unspecified, each key-value pair in the Data field of the referenced
+ConfigMap will be projected into the volume as a file whose name is the
+key and content is the value. If specified, the listed keys will be
+projected into the specified paths, and unlisted keys will not be
+present. If a key is specified which is not present in the ConfigMap,
+the volume setup will error unless it is marked optional. Paths must be
+relative and may not contain the '..' path or start with '..'. + |
+ false | +
| name | +string | +
+ Name of the referent.
+This field is effectively required, but due to backwards compatibility is
+allowed to be empty. Instances of this type with an empty value here are
+almost certainly wrong.
+More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + + Default: + |
+ false | +
| optional | +boolean | +
+ optional specify whether the ConfigMap or its keys must be defined + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| key | +string | +
+ key is the key to project. + |
+ true | +
| path | +string | +
+ path is the relative path of the file to map the key to.
+May not be an absolute path.
+May not contain the path element '..'.
+May not start with the string '..'. + |
+ true | +
| mode | +integer | +
+ mode is Optional: mode bits used to set permissions on this file.
+Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511.
+YAML accepts both octal and decimal values, JSON requires decimal values for mode bits.
+If not specified, the volume defaultMode will be used.
+This might be in conflict with other options that affect the file
+mode, like fsGroup, and the result can be other mode bits set. + + Format: int32 + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| driver | +string | +
+ driver is the name of the CSI driver that handles this volume.
+Consult with your admin for the correct name as registered in the cluster. + |
+ true | +
| fsType | +string | +
+ fsType to mount. Ex. "ext4", "xfs", "ntfs".
+If not provided, the empty value is passed to the associated CSI driver
+which will determine the default filesystem to apply. + |
+ false | +
| nodePublishSecretRef | +object | +
+ nodePublishSecretRef is a reference to the secret object containing
+sensitive information to pass to the CSI driver to complete the CSI
+NodePublishVolume and NodeUnpublishVolume calls.
+This field is optional, and may be empty if no secret is required. If the
+secret object contains more than one secret, all secret references are passed. + |
+ false | +
| readOnly | +boolean | +
+ readOnly specifies a read-only configuration for the volume.
+Defaults to false (read/write). + |
+ false | +
| volumeAttributes | +map[string]string | +
+ volumeAttributes stores driver-specific properties that are passed to the CSI
+driver. Consult your driver's documentation for supported values. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ Name of the referent.
+This field is effectively required, but due to backwards compatibility is
+allowed to be empty. Instances of this type with an empty value here are
+almost certainly wrong.
+More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + + Default: + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| defaultMode | +integer | +
+ Optional: mode bits to use on created files by default. Must be a
+Optional: mode bits used to set permissions on created files by default.
+Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511.
+YAML accepts both octal and decimal values, JSON requires decimal values for mode bits.
+Defaults to 0644.
+Directories within the path are not affected by this setting.
+This might be in conflict with other options that affect the file
+mode, like fsGroup, and the result can be other mode bits set. + + Format: int32 + |
+ false | +
| items | +[]object | +
+ Items is a list of downward API volume file + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| path | +string | +
+ Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..' + |
+ true | +
| fieldRef | +object | +
+ Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported. + |
+ false | +
| mode | +integer | +
+ Optional: mode bits used to set permissions on this file, must be an octal value
+between 0000 and 0777 or a decimal value between 0 and 511.
+YAML accepts both octal and decimal values, JSON requires decimal values for mode bits.
+If not specified, the volume defaultMode will be used.
+This might be in conflict with other options that affect the file
+mode, like fsGroup, and the result can be other mode bits set. + + Format: int32 + |
+ false | +
| resourceFieldRef | +object | +
+ Selects a resource of the container: only resources limits and requests
+(limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| fieldPath | +string | +
+ Path of the field to select in the specified API version. + |
+ true | +
| apiVersion | +string | +
+ Version of the schema the FieldPath is written in terms of, defaults to "v1". + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| resource | +string | +
+ Required: resource to select + |
+ true | +
| containerName | +string | +
+ Container name: required for volumes, optional for env vars + |
+ false | +
| divisor | +int or string | +
+ Specifies the output format of the exposed resources, defaults to "1" + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| medium | +string | +
+ medium represents what type of storage medium should back this directory.
+The default is "" which means to use the node's default medium.
+Must be an empty string (default) or Memory.
+More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir + |
+ false | +
| sizeLimit | +int or string | +
+ sizeLimit is the total amount of local storage required for this EmptyDir volume.
+The size limit is also applicable for memory medium.
+The maximum usage on memory medium EmptyDir would be the minimum value between
+the SizeLimit specified here and the sum of memory limits of all containers in a pod.
+The default is nil which means that the limit is undefined.
+More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| volumeClaimTemplate | +object | +
+ Will be used to create a stand-alone PVC to provision the volume.
+The pod in which this EphemeralVolumeSource is embedded will be the
+owner of the PVC, i.e. the PVC will be deleted together with the
+pod. The name of the PVC will be ` + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| spec | +object | +
+ The specification for the PersistentVolumeClaim. The entire content is
+copied unchanged into the PVC that gets created from this
+template. The same fields as in a PersistentVolumeClaim
+are also valid here. + |
+ true | +
| metadata | +object | +
+ May contain labels and annotations that will be copied into the PVC
+when creating it. No other fields are allowed and will be rejected during
+validation. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| accessModes | +[]string | +
+ accessModes contains the desired access modes the volume should have.
+More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1 + |
+ false | +
| dataSource | +object | +
+ dataSource field can be used to specify either:
+* An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot)
+* An existing PVC (PersistentVolumeClaim)
+If the provisioner or an external controller can support the specified data source,
+it will create a new volume based on the contents of the specified data source.
+When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef,
+and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified.
+If the namespace is specified, then dataSourceRef will not be copied to dataSource. + |
+ false | +
| dataSourceRef | +object | +
+ dataSourceRef specifies the object from which to populate the volume with data, if a non-empty
+volume is desired. This may be any object from a non-empty API group (non
+core object) or a PersistentVolumeClaim object.
+When this field is specified, volume binding will only succeed if the type of
+the specified object matches some installed volume populator or dynamic
+provisioner.
+This field will replace the functionality of the dataSource field and as such
+if both fields are non-empty, they must have the same value. For backwards
+compatibility, when namespace isn't specified in dataSourceRef,
+both fields (dataSource and dataSourceRef) will be set to the same
+value automatically if one of them is empty and the other is non-empty.
+When namespace is specified in dataSourceRef,
+dataSource isn't set to the same value and must be empty.
+There are three important differences between dataSource and dataSourceRef:
+* While dataSource only allows two specific types of objects, dataSourceRef
+ allows any non-core object, as well as PersistentVolumeClaim objects.
+* While dataSource ignores disallowed values (dropping them), dataSourceRef
+ preserves all values, and generates an error if a disallowed value is
+ specified.
+* While dataSource only allows local objects, dataSourceRef allows objects
+ in any namespaces.
+(Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled.
+(Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled. + |
+ false | +
| resources | +object | +
+ resources represents the minimum resources the volume should have.
+If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements
+that are lower than previous value but must still be higher than capacity recorded in the
+status field of the claim.
+More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources + |
+ false | +
| selector | +object | +
+ selector is a label query over volumes to consider for binding. + |
+ false | +
| storageClassName | +string | +
+ storageClassName is the name of the StorageClass required by the claim.
+More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1 + |
+ false | +
| volumeAttributesClassName | +string | +
+ volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim.
+If specified, the CSI driver will create or update the volume with the attributes defined
+in the corresponding VolumeAttributesClass. This has a different purpose than storageClassName,
+it can be changed after the claim is created. An empty string or nil value indicates that no
+VolumeAttributesClass will be applied to the claim. If the claim enters an Infeasible error state,
+this field can be reset to its previous value (including nil) to cancel the modification.
+If the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be
+set to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource
+exists.
+More info: https://kubernetes.io/docs/concepts/storage/volume-attributes-classes/ + |
+ false | +
| volumeMode | +string | +
+ volumeMode defines what type of volume is required by the claim.
+Value of Filesystem is implied when not included in claim spec. + |
+ false | +
| volumeName | +string | +
+ volumeName is the binding reference to the PersistentVolume backing this claim. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| kind | +string | +
+ Kind is the type of resource being referenced + |
+ true | +
| name | +string | +
+ Name is the name of resource being referenced + |
+ true | +
| apiGroup | +string | +
+ APIGroup is the group for the resource being referenced.
+If APIGroup is not specified, the specified Kind must be in the core API group.
+For any other third-party types, APIGroup is required. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| kind | +string | +
+ Kind is the type of resource being referenced + |
+ true | +
| name | +string | +
+ Name is the name of resource being referenced + |
+ true | +
| apiGroup | +string | +
+ APIGroup is the group for the resource being referenced.
+If APIGroup is not specified, the specified Kind must be in the core API group.
+For any other third-party types, APIGroup is required. + |
+ false | +
| namespace | +string | +
+ Namespace is the namespace of resource being referenced
+Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details.
+(Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| limits | +map[string]int or string | +
+ Limits describes the maximum amount of compute resources allowed.
+More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ + |
+ false | +
| requests | +map[string]int or string | +
+ Requests describes the minimum amount of compute resources required.
+If Requests is omitted for a container, it defaults to Limits if that is explicitly specified,
+otherwise to an implementation-defined value. Requests cannot exceed Limits.
+More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| matchExpressions | +[]object | +
+ matchExpressions is a list of label selector requirements. The requirements are ANDed. + |
+ false | +
| matchLabels | +map[string]string | +
+ matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
+map is equivalent to an element of matchExpressions, whose key field is "key", the
+operator is "In", and the values array contains only "value". The requirements are ANDed. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| key | +string | +
+ key is the label key that the selector applies to. + |
+ true | +
| operator | +string | +
+ operator represents a key's relationship to a set of values.
+Valid operators are In, NotIn, Exists and DoesNotExist. + |
+ true | +
| values | +[]string | +
+ values is an array of string values. If the operator is In or NotIn,
+the values array must be non-empty. If the operator is Exists or DoesNotExist,
+the values array must be empty. This array is replaced during a strategic
+merge patch. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| annotations | +map[string]string | +
+ + |
+ false | +
| finalizers | +[]string | +
+ + |
+ false | +
| labels | +map[string]string | +
+ + |
+ false | +
| name | +string | +
+ + |
+ false | +
| namespace | +string | +
+ + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| fsType | +string | +
+ fsType is the filesystem type to mount.
+Must be a filesystem type supported by the host operating system.
+Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. + |
+ false | +
| lun | +integer | +
+ lun is Optional: FC target lun number + + Format: int32 + |
+ false | +
| readOnly | +boolean | +
+ readOnly is Optional: Defaults to false (read/write). ReadOnly here will force
+the ReadOnly setting in VolumeMounts. + |
+ false | +
| targetWWNs | +[]string | +
+ targetWWNs is Optional: FC target worldwide names (WWNs) + |
+ false | +
| wwids | +[]string | +
+ wwids Optional: FC volume world wide identifiers (wwids)
+Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| driver | +string | +
+ driver is the name of the driver to use for this volume. + |
+ true | +
| fsType | +string | +
+ fsType is the filesystem type to mount.
+Must be a filesystem type supported by the host operating system.
+Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script. + |
+ false | +
| options | +map[string]string | +
+ options is Optional: this field holds extra command options if any. + |
+ false | +
| readOnly | +boolean | +
+ readOnly is Optional: defaults to false (read/write). ReadOnly here will force
+the ReadOnly setting in VolumeMounts. + |
+ false | +
| secretRef | +object | +
+ secretRef is Optional: secretRef is reference to the secret object containing
+sensitive information to pass to the plugin scripts. This may be
+empty if no secret object is specified. If the secret object
+contains more than one secret, all secrets are passed to the plugin
+scripts. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ Name of the referent.
+This field is effectively required, but due to backwards compatibility is
+allowed to be empty. Instances of this type with an empty value here are
+almost certainly wrong.
+More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + + Default: + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| datasetName | +string | +
+ datasetName is Name of the dataset stored as metadata -> name on the dataset for Flocker
+should be considered as deprecated + |
+ false | +
| datasetUUID | +string | +
+ datasetUUID is the UUID of the dataset. This is unique identifier of a Flocker dataset + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| pdName | +string | +
+ pdName is unique name of the PD resource in GCE. Used to identify the disk in GCE.
+More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk + |
+ true | +
| fsType | +string | +
+ fsType is filesystem type of the volume that you want to mount.
+Tip: Ensure that the filesystem type is supported by the host operating system.
+Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
+More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk + |
+ false | +
| partition | +integer | +
+ partition is the partition in the volume that you want to mount.
+If omitted, the default is to mount by volume name.
+Examples: For volume /dev/sda1, you specify the partition as "1".
+Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty).
+More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk + + Format: int32 + |
+ false | +
| readOnly | +boolean | +
+ readOnly here will force the ReadOnly setting in VolumeMounts.
+Defaults to false.
+More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| repository | +string | +
+ repository is the URL + |
+ true | +
| directory | +string | +
+ directory is the target directory name.
+Must not contain or start with '..'. If '.' is supplied, the volume directory will be the
+git repository. Otherwise, if specified, the volume will contain the git repository in
+the subdirectory with the given name. + |
+ false | +
| revision | +string | +
+ revision is the commit hash for the specified revision. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| endpoints | +string | +
+ endpoints is the endpoint name that details Glusterfs topology. + |
+ true | +
| path | +string | +
+ path is the Glusterfs volume path.
+More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod + |
+ true | +
| readOnly | +boolean | +
+ readOnly here will force the Glusterfs volume to be mounted with read-only permissions.
+Defaults to false.
+More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| path | +string | +
+ path of the directory on the host.
+If the path is a symlink, it will follow the link to the real path.
+More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath + |
+ true | +
| type | +string | +
+ type for HostPath Volume
+Defaults to ""
+More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| pullPolicy | +string | +
+ Policy for pulling OCI objects. Possible values are:
+Always: the kubelet always attempts to pull the reference. Container creation will fail If the pull fails.
+Never: the kubelet never pulls the reference and only uses a local image or artifact. Container creation will fail if the reference isn't present.
+IfNotPresent: the kubelet pulls if the reference isn't already present on disk. Container creation will fail if the reference isn't present and the pull fails.
+Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. + |
+ false | +
| reference | +string | +
+ Required: Image or artifact reference to be used.
+Behaves in the same way as pod.spec.containers[*].image.
+Pull secrets will be assembled in the same way as for the container image by looking up node credentials, SA image pull secrets, and pod spec image pull secrets.
+More info: https://kubernetes.io/docs/concepts/containers/images
+This field is optional to allow higher level config management to default or override
+container images in workload controllers like Deployments and StatefulSets. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| iqn | +string | +
+ iqn is the target iSCSI Qualified Name. + |
+ true | +
| lun | +integer | +
+ lun represents iSCSI Target Lun number. + + Format: int32 + |
+ true | +
| targetPortal | +string | +
+ targetPortal is iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port
+is other than default (typically TCP ports 860 and 3260). + |
+ true | +
| chapAuthDiscovery | +boolean | +
+ chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication + |
+ false | +
| chapAuthSession | +boolean | +
+ chapAuthSession defines whether support iSCSI Session CHAP authentication + |
+ false | +
| fsType | +string | +
+ fsType is the filesystem type of the volume that you want to mount.
+Tip: Ensure that the filesystem type is supported by the host operating system.
+Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
+More info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi + |
+ false | +
| initiatorName | +string | +
+ initiatorName is the custom iSCSI Initiator Name.
+If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface
+ + |
+ false | +
| iscsiInterface | +string | +
+ iscsiInterface is the interface Name that uses an iSCSI transport.
+Defaults to 'default' (tcp). + + Default: default + |
+ false | +
| portals | +[]string | +
+ portals is the iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port
+is other than default (typically TCP ports 860 and 3260). + |
+ false | +
| readOnly | +boolean | +
+ readOnly here will force the ReadOnly setting in VolumeMounts.
+Defaults to false. + |
+ false | +
| secretRef | +object | +
+ secretRef is the CHAP Secret for iSCSI target and initiator authentication + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ Name of the referent.
+This field is effectively required, but due to backwards compatibility is
+allowed to be empty. Instances of this type with an empty value here are
+almost certainly wrong.
+More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + + Default: + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| path | +string | +
+ path that is exported by the NFS server.
+More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs + |
+ true | +
| server | +string | +
+ server is the hostname or IP address of the NFS server.
+More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs + |
+ true | +
| readOnly | +boolean | +
+ readOnly here will force the NFS export to be mounted with read-only permissions.
+Defaults to false.
+More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| claimName | +string | +
+ claimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume.
+More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims + |
+ true | +
| readOnly | +boolean | +
+ readOnly Will force the ReadOnly setting in VolumeMounts.
+Default false. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| pdID | +string | +
+ pdID is the ID that identifies Photon Controller persistent disk + |
+ true | +
| fsType | +string | +
+ fsType is the filesystem type to mount.
+Must be a filesystem type supported by the host operating system.
+Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| volumeID | +string | +
+ volumeID uniquely identifies a Portworx volume + |
+ true | +
| fsType | +string | +
+ fSType represents the filesystem type to mount
+Must be a filesystem type supported by the host operating system.
+Ex. "ext4", "xfs". Implicitly inferred to be "ext4" if unspecified. + |
+ false | +
| readOnly | +boolean | +
+ readOnly defaults to false (read/write). ReadOnly here will force
+the ReadOnly setting in VolumeMounts. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| defaultMode | +integer | +
+ defaultMode are the mode bits used to set permissions on created files by default.
+Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511.
+YAML accepts both octal and decimal values, JSON requires decimal values for mode bits.
+Directories within the path are not affected by this setting.
+This might be in conflict with other options that affect the file
+mode, like fsGroup, and the result can be other mode bits set. + + Format: int32 + |
+ false | +
| sources | +[]object | +
+ sources is the list of volume projections. Each entry in this list
+handles one source. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| clusterTrustBundle | +object | +
+ ClusterTrustBundle allows a pod to access the `.spec.trustBundle` field
+of ClusterTrustBundle objects in an auto-updating file.
+
+Alpha, gated by the ClusterTrustBundleProjection feature gate.
+
+ClusterTrustBundle objects can either be selected by name, or by the
+combination of signer name and a label selector.
+
+Kubelet performs aggressive normalization of the PEM contents written
+into the pod filesystem. Esoteric PEM features such as inter-block
+comments and block headers are stripped. Certificates are deduplicated.
+The ordering of certificates within the file is arbitrary, and Kubelet
+may change the order over time. + |
+ false | +
| configMap | +object | +
+ configMap information about the configMap data to project + |
+ false | +
| downwardAPI | +object | +
+ downwardAPI information about the downwardAPI data to project + |
+ false | +
| podCertificate | +object | +
+ Projects an auto-rotating credential bundle (private key and certificate
+chain) that the pod can use either as a TLS client or server.
+
+Kubelet generates a private key and uses it to send a
+PodCertificateRequest to the named signer. Once the signer approves the
+request and issues a certificate chain, Kubelet writes the key and
+certificate chain to the pod filesystem. The pod does not start until
+certificates have been issued for each podCertificate projected volume
+source in its spec.
+
+Kubelet will begin trying to rotate the certificate at the time indicated
+by the signer using the PodCertificateRequest.Status.BeginRefreshAt
+timestamp.
+
+Kubelet can write a single file, indicated by the credentialBundlePath
+field, or separate files, indicated by the keyPath and
+certificateChainPath fields.
+
+The credential bundle is a single file in PEM format. The first PEM
+entry is the private key (in PKCS#8 format), and the remaining PEM
+entries are the certificate chain issued by the signer (typically,
+signers will return their certificate chain in leaf-to-root order).
+
+Prefer using the credential bundle format, since your application code
+can read it atomically. If you use keyPath and certificateChainPath,
+your application must make two separate file reads. If these coincide
+with a certificate rotation, it is possible that the private key and leaf
+certificate you read may not correspond to each other. Your application
+will need to check for this condition, and re-read until they are
+consistent.
+
+The named signer controls chooses the format of the certificate it
+issues; consult the signer implementation's documentation to learn how to
+use the certificates it issues. + |
+ false | +
| secret | +object | +
+ secret information about the secret data to project + |
+ false | +
| serviceAccountToken | +object | +
+ serviceAccountToken is information about the serviceAccountToken data to project + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| path | +string | +
+ Relative path from the volume root to write the bundle. + |
+ true | +
| labelSelector | +object | +
+ Select all ClusterTrustBundles that match this label selector. Only has
+effect if signerName is set. Mutually-exclusive with name. If unset,
+interpreted as "match nothing". If set but empty, interpreted as "match
+everything". + |
+ false | +
| name | +string | +
+ Select a single ClusterTrustBundle by object name. Mutually-exclusive
+with signerName and labelSelector. + |
+ false | +
| optional | +boolean | +
+ If true, don't block pod startup if the referenced ClusterTrustBundle(s)
+aren't available. If using name, then the named ClusterTrustBundle is
+allowed not to exist. If using signerName, then the combination of
+signerName and labelSelector is allowed to match zero
+ClusterTrustBundles. + |
+ false | +
| signerName | +string | +
+ Select all ClusterTrustBundles that match this signer name.
+Mutually-exclusive with name. The contents of all selected
+ClusterTrustBundles will be unified and deduplicated. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| matchExpressions | +[]object | +
+ matchExpressions is a list of label selector requirements. The requirements are ANDed. + |
+ false | +
| matchLabels | +map[string]string | +
+ matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
+map is equivalent to an element of matchExpressions, whose key field is "key", the
+operator is "In", and the values array contains only "value". The requirements are ANDed. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| key | +string | +
+ key is the label key that the selector applies to. + |
+ true | +
| operator | +string | +
+ operator represents a key's relationship to a set of values.
+Valid operators are In, NotIn, Exists and DoesNotExist. + |
+ true | +
| values | +[]string | +
+ values is an array of string values. If the operator is In or NotIn,
+the values array must be non-empty. If the operator is Exists or DoesNotExist,
+the values array must be empty. This array is replaced during a strategic
+merge patch. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| items | +[]object | +
+ items if unspecified, each key-value pair in the Data field of the referenced
+ConfigMap will be projected into the volume as a file whose name is the
+key and content is the value. If specified, the listed keys will be
+projected into the specified paths, and unlisted keys will not be
+present. If a key is specified which is not present in the ConfigMap,
+the volume setup will error unless it is marked optional. Paths must be
+relative and may not contain the '..' path or start with '..'. + |
+ false | +
| name | +string | +
+ Name of the referent.
+This field is effectively required, but due to backwards compatibility is
+allowed to be empty. Instances of this type with an empty value here are
+almost certainly wrong.
+More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + + Default: + |
+ false | +
| optional | +boolean | +
+ optional specify whether the ConfigMap or its keys must be defined + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| key | +string | +
+ key is the key to project. + |
+ true | +
| path | +string | +
+ path is the relative path of the file to map the key to.
+May not be an absolute path.
+May not contain the path element '..'.
+May not start with the string '..'. + |
+ true | +
| mode | +integer | +
+ mode is Optional: mode bits used to set permissions on this file.
+Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511.
+YAML accepts both octal and decimal values, JSON requires decimal values for mode bits.
+If not specified, the volume defaultMode will be used.
+This might be in conflict with other options that affect the file
+mode, like fsGroup, and the result can be other mode bits set. + + Format: int32 + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| items | +[]object | +
+ Items is a list of DownwardAPIVolume file + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| path | +string | +
+ Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..' + |
+ true | +
| fieldRef | +object | +
+ Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported. + |
+ false | +
| mode | +integer | +
+ Optional: mode bits used to set permissions on this file, must be an octal value
+between 0000 and 0777 or a decimal value between 0 and 511.
+YAML accepts both octal and decimal values, JSON requires decimal values for mode bits.
+If not specified, the volume defaultMode will be used.
+This might be in conflict with other options that affect the file
+mode, like fsGroup, and the result can be other mode bits set. + + Format: int32 + |
+ false | +
| resourceFieldRef | +object | +
+ Selects a resource of the container: only resources limits and requests
+(limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| fieldPath | +string | +
+ Path of the field to select in the specified API version. + |
+ true | +
| apiVersion | +string | +
+ Version of the schema the FieldPath is written in terms of, defaults to "v1". + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| resource | +string | +
+ Required: resource to select + |
+ true | +
| containerName | +string | +
+ Container name: required for volumes, optional for env vars + |
+ false | +
| divisor | +int or string | +
+ Specifies the output format of the exposed resources, defaults to "1" + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| keyType | +string | +
+ The type of keypair Kubelet will generate for the pod.
+
+Valid values are "RSA3072", "RSA4096", "ECDSAP256", "ECDSAP384",
+"ECDSAP521", and "ED25519". + |
+ true | +
| signerName | +string | +
+ Kubelet's generated CSRs will be addressed to this signer. + |
+ true | +
| certificateChainPath | +string | +
+ Write the certificate chain at this path in the projected volume.
+
+Most applications should use credentialBundlePath. When using keyPath
+and certificateChainPath, your application needs to check that the key
+and leaf certificate are consistent, because it is possible to read the
+files mid-rotation. + |
+ false | +
| credentialBundlePath | +string | +
+ Write the credential bundle at this path in the projected volume.
+
+The credential bundle is a single file that contains multiple PEM blocks.
+The first PEM block is a PRIVATE KEY block, containing a PKCS#8 private
+key.
+
+The remaining blocks are CERTIFICATE blocks, containing the issued
+certificate chain from the signer (leaf and any intermediates).
+
+Using credentialBundlePath lets your Pod's application code make a single
+atomic read that retrieves a consistent key and certificate chain. If you
+project them to separate files, your application code will need to
+additionally check that the leaf certificate was issued to the key. + |
+ false | +
| keyPath | +string | +
+ Write the key at this path in the projected volume.
+
+Most applications should use credentialBundlePath. When using keyPath
+and certificateChainPath, your application needs to check that the key
+and leaf certificate are consistent, because it is possible to read the
+files mid-rotation. + |
+ false | +
| maxExpirationSeconds | +integer | +
+ maxExpirationSeconds is the maximum lifetime permitted for the
+certificate.
+
+Kubelet copies this value verbatim into the PodCertificateRequests it
+generates for this projection.
+
+If omitted, kube-apiserver will set it to 86400(24 hours). kube-apiserver
+will reject values shorter than 3600 (1 hour). The maximum allowable
+value is 7862400 (91 days).
+
+The signer implementation is then free to issue a certificate with any
+lifetime *shorter* than MaxExpirationSeconds, but no shorter than 3600
+seconds (1 hour). This constraint is enforced by kube-apiserver.
+`kubernetes.io` signers will never issue certificates with a lifetime
+longer than 24 hours. + + Format: int32 + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| items | +[]object | +
+ items if unspecified, each key-value pair in the Data field of the referenced
+Secret will be projected into the volume as a file whose name is the
+key and content is the value. If specified, the listed keys will be
+projected into the specified paths, and unlisted keys will not be
+present. If a key is specified which is not present in the Secret,
+the volume setup will error unless it is marked optional. Paths must be
+relative and may not contain the '..' path or start with '..'. + |
+ false | +
| name | +string | +
+ Name of the referent.
+This field is effectively required, but due to backwards compatibility is
+allowed to be empty. Instances of this type with an empty value here are
+almost certainly wrong.
+More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + + Default: + |
+ false | +
| optional | +boolean | +
+ optional field specify whether the Secret or its key must be defined + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| key | +string | +
+ key is the key to project. + |
+ true | +
| path | +string | +
+ path is the relative path of the file to map the key to.
+May not be an absolute path.
+May not contain the path element '..'.
+May not start with the string '..'. + |
+ true | +
| mode | +integer | +
+ mode is Optional: mode bits used to set permissions on this file.
+Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511.
+YAML accepts both octal and decimal values, JSON requires decimal values for mode bits.
+If not specified, the volume defaultMode will be used.
+This might be in conflict with other options that affect the file
+mode, like fsGroup, and the result can be other mode bits set. + + Format: int32 + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| path | +string | +
+ path is the path relative to the mount point of the file to project the
+token into. + |
+ true | +
| audience | +string | +
+ audience is the intended audience of the token. A recipient of a token
+must identify itself with an identifier specified in the audience of the
+token, and otherwise should reject the token. The audience defaults to the
+identifier of the apiserver. + |
+ false | +
| expirationSeconds | +integer | +
+ expirationSeconds is the requested duration of validity of the service
+account token. As the token approaches expiration, the kubelet volume
+plugin will proactively rotate the service account token. The kubelet will
+start trying to rotate the token if the token is older than 80 percent of
+its time to live or if the token is older than 24 hours.Defaults to 1 hour
+and must be at least 10 minutes. + + Format: int64 + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| registry | +string | +
+ registry represents a single or multiple Quobyte Registry services
+specified as a string as host:port pair (multiple entries are separated with commas)
+which acts as the central registry for volumes + |
+ true | +
| volume | +string | +
+ volume is a string that references an already created Quobyte volume by name. + |
+ true | +
| group | +string | +
+ group to map volume access to
+Default is no group + |
+ false | +
| readOnly | +boolean | +
+ readOnly here will force the Quobyte volume to be mounted with read-only permissions.
+Defaults to false. + |
+ false | +
| tenant | +string | +
+ tenant owning the given Quobyte volume in the Backend
+Used with dynamically provisioned Quobyte volumes, value is set by the plugin + |
+ false | +
| user | +string | +
+ user to map volume access to
+Defaults to serivceaccount user + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| image | +string | +
+ image is the rados image name.
+More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it + |
+ true | +
| monitors | +[]string | +
+ monitors is a collection of Ceph monitors.
+More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it + |
+ true | +
| fsType | +string | +
+ fsType is the filesystem type of the volume that you want to mount.
+Tip: Ensure that the filesystem type is supported by the host operating system.
+Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
+More info: https://kubernetes.io/docs/concepts/storage/volumes#rbd + |
+ false | +
| keyring | +string | +
+ keyring is the path to key ring for RBDUser.
+Default is /etc/ceph/keyring.
+More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it + + Default: /etc/ceph/keyring + |
+ false | +
| pool | +string | +
+ pool is the rados pool name.
+Default is rbd.
+More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it + + Default: rbd + |
+ false | +
| readOnly | +boolean | +
+ readOnly here will force the ReadOnly setting in VolumeMounts.
+Defaults to false.
+More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it + |
+ false | +
| secretRef | +object | +
+ secretRef is name of the authentication secret for RBDUser. If provided
+overrides keyring.
+Default is nil.
+More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it + |
+ false | +
| user | +string | +
+ user is the rados user name.
+Default is admin.
+More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it + + Default: admin + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ Name of the referent.
+This field is effectively required, but due to backwards compatibility is
+allowed to be empty. Instances of this type with an empty value here are
+almost certainly wrong.
+More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + + Default: + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| gateway | +string | +
+ gateway is the host address of the ScaleIO API Gateway. + |
+ true | +
| secretRef | +object | +
+ secretRef references to the secret for ScaleIO user and other
+sensitive information. If this is not provided, Login operation will fail. + |
+ true | +
| system | +string | +
+ system is the name of the storage system as configured in ScaleIO. + |
+ true | +
| fsType | +string | +
+ fsType is the filesystem type to mount.
+Must be a filesystem type supported by the host operating system.
+Ex. "ext4", "xfs", "ntfs".
+Default is "xfs". + + Default: xfs + |
+ false | +
| protectionDomain | +string | +
+ protectionDomain is the name of the ScaleIO Protection Domain for the configured storage. + |
+ false | +
| readOnly | +boolean | +
+ readOnly Defaults to false (read/write). ReadOnly here will force
+the ReadOnly setting in VolumeMounts. + |
+ false | +
| sslEnabled | +boolean | +
+ sslEnabled Flag enable/disable SSL communication with Gateway, default false + |
+ false | +
| storageMode | +string | +
+ storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned.
+Default is ThinProvisioned. + + Default: ThinProvisioned + |
+ false | +
| storagePool | +string | +
+ storagePool is the ScaleIO Storage Pool associated with the protection domain. + |
+ false | +
| volumeName | +string | +
+ volumeName is the name of a volume already created in the ScaleIO system
+that is associated with this volume source. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ Name of the referent.
+This field is effectively required, but due to backwards compatibility is
+allowed to be empty. Instances of this type with an empty value here are
+almost certainly wrong.
+More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + + Default: + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| defaultMode | +integer | +
+ defaultMode is Optional: mode bits used to set permissions on created files by default.
+Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511.
+YAML accepts both octal and decimal values, JSON requires decimal values
+for mode bits. Defaults to 0644.
+Directories within the path are not affected by this setting.
+This might be in conflict with other options that affect the file
+mode, like fsGroup, and the result can be other mode bits set. + + Format: int32 + |
+ false | +
| items | +[]object | +
+ items If unspecified, each key-value pair in the Data field of the referenced
+Secret will be projected into the volume as a file whose name is the
+key and content is the value. If specified, the listed keys will be
+projected into the specified paths, and unlisted keys will not be
+present. If a key is specified which is not present in the Secret,
+the volume setup will error unless it is marked optional. Paths must be
+relative and may not contain the '..' path or start with '..'. + |
+ false | +
| optional | +boolean | +
+ optional field specify whether the Secret or its keys must be defined + |
+ false | +
| secretName | +string | +
+ secretName is the name of the secret in the pod's namespace to use.
+More info: https://kubernetes.io/docs/concepts/storage/volumes#secret + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| key | +string | +
+ key is the key to project. + |
+ true | +
| path | +string | +
+ path is the relative path of the file to map the key to.
+May not be an absolute path.
+May not contain the path element '..'.
+May not start with the string '..'. + |
+ true | +
| mode | +integer | +
+ mode is Optional: mode bits used to set permissions on this file.
+Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511.
+YAML accepts both octal and decimal values, JSON requires decimal values for mode bits.
+If not specified, the volume defaultMode will be used.
+This might be in conflict with other options that affect the file
+mode, like fsGroup, and the result can be other mode bits set. + + Format: int32 + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| fsType | +string | +
+ fsType is the filesystem type to mount.
+Must be a filesystem type supported by the host operating system.
+Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. + |
+ false | +
| readOnly | +boolean | +
+ readOnly defaults to false (read/write). ReadOnly here will force
+the ReadOnly setting in VolumeMounts. + |
+ false | +
| secretRef | +object | +
+ secretRef specifies the secret to use for obtaining the StorageOS API
+credentials. If not specified, default values will be attempted. + |
+ false | +
| volumeName | +string | +
+ volumeName is the human-readable name of the StorageOS volume. Volume
+names are only unique within a namespace. + |
+ false | +
| volumeNamespace | +string | +
+ volumeNamespace specifies the scope of the volume within StorageOS. If no
+namespace is specified then the Pod's namespace will be used. This allows the
+Kubernetes name scoping to be mirrored within StorageOS for tighter integration.
+Set VolumeName to any name to override the default behaviour.
+Set to "default" if you are not using namespaces within StorageOS.
+Namespaces that do not pre-exist within StorageOS will be created. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ Name of the referent.
+This field is effectively required, but due to backwards compatibility is
+allowed to be empty. Instances of this type with an empty value here are
+almost certainly wrong.
+More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + + Default: + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| volumePath | +string | +
+ volumePath is the path that identifies vSphere volume vmdk + |
+ true | +
| fsType | +string | +
+ fsType is filesystem type to mount.
+Must be a filesystem type supported by the host operating system.
+Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. + |
+ false | +
| storagePolicyID | +string | +
+ storagePolicyID is the storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName. + |
+ false | +
| storagePolicyName | +string | +
+ storagePolicyName is the storage Policy Based Management (SPBM) profile name. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ The rack name + |
+ true | +
| affinity | +object | +
+ Affinity rules to set for this rack only. Merged with values from PodTemplateSpec Affinity as well as NodeAffinityLabels. If you wish to override all the default
+PodAntiAffinity rules, set allowMultipleWorkers to true, otherwise defaults are applied and then these Affinity settings are merged. + |
+ false | +
| nodeAffinityLabels | +map[string]string | +
+ NodeAffinityLabels to pin the rack, using node affinity + |
+ false | +
| zone | +string | +
+ Deprecated. Use nodeAffinityLabels instead. DeprecatedZone name to pin the rack, using node affinity + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| nodeAffinity | +object | +
+ Describes node affinity scheduling rules for the pod. + |
+ false | +
| podAffinity | +object | +
+ Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)). + |
+ false | +
| podAntiAffinity | +object | +
+ Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)). + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| preferredDuringSchedulingIgnoredDuringExecution | +[]object | +
+ The scheduler will prefer to schedule pods to nodes that satisfy
+the affinity expressions specified by this field, but it may choose
+a node that violates one or more of the expressions. The node that is
+most preferred is the one with the greatest sum of weights, i.e.
+for each node that meets all of the scheduling requirements (resource
+request, requiredDuringScheduling affinity expressions, etc.),
+compute a sum by iterating through the elements of this field and adding
+"weight" to the sum if the node matches the corresponding matchExpressions; the
+node(s) with the highest sum are the most preferred. + |
+ false | +
| requiredDuringSchedulingIgnoredDuringExecution | +object | +
+ If the affinity requirements specified by this field are not met at
+scheduling time, the pod will not be scheduled onto the node.
+If the affinity requirements specified by this field cease to be met
+at some point during pod execution (e.g. due to an update), the system
+may or may not try to eventually evict the pod from its node. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| preference | +object | +
+ A node selector term, associated with the corresponding weight. + |
+ true | +
| weight | +integer | +
+ Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100. + + Format: int32 + |
+ true | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| matchExpressions | +[]object | +
+ A list of node selector requirements by node's labels. + |
+ false | +
| matchFields | +[]object | +
+ A list of node selector requirements by node's fields. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| key | +string | +
+ The label key that the selector applies to. + |
+ true | +
| operator | +string | +
+ Represents a key's relationship to a set of values.
+Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. + |
+ true | +
| values | +[]string | +
+ An array of string values. If the operator is In or NotIn,
+the values array must be non-empty. If the operator is Exists or DoesNotExist,
+the values array must be empty. If the operator is Gt or Lt, the values
+array must have a single element, which will be interpreted as an integer.
+This array is replaced during a strategic merge patch. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| key | +string | +
+ The label key that the selector applies to. + |
+ true | +
| operator | +string | +
+ Represents a key's relationship to a set of values.
+Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. + |
+ true | +
| values | +[]string | +
+ An array of string values. If the operator is In or NotIn,
+the values array must be non-empty. If the operator is Exists or DoesNotExist,
+the values array must be empty. If the operator is Gt or Lt, the values
+array must have a single element, which will be interpreted as an integer.
+This array is replaced during a strategic merge patch. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| nodeSelectorTerms | +[]object | +
+ Required. A list of node selector terms. The terms are ORed. + |
+ true | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| matchExpressions | +[]object | +
+ A list of node selector requirements by node's labels. + |
+ false | +
| matchFields | +[]object | +
+ A list of node selector requirements by node's fields. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| key | +string | +
+ The label key that the selector applies to. + |
+ true | +
| operator | +string | +
+ Represents a key's relationship to a set of values.
+Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. + |
+ true | +
| values | +[]string | +
+ An array of string values. If the operator is In or NotIn,
+the values array must be non-empty. If the operator is Exists or DoesNotExist,
+the values array must be empty. If the operator is Gt or Lt, the values
+array must have a single element, which will be interpreted as an integer.
+This array is replaced during a strategic merge patch. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| key | +string | +
+ The label key that the selector applies to. + |
+ true | +
| operator | +string | +
+ Represents a key's relationship to a set of values.
+Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. + |
+ true | +
| values | +[]string | +
+ An array of string values. If the operator is In or NotIn,
+the values array must be non-empty. If the operator is Exists or DoesNotExist,
+the values array must be empty. If the operator is Gt or Lt, the values
+array must have a single element, which will be interpreted as an integer.
+This array is replaced during a strategic merge patch. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| preferredDuringSchedulingIgnoredDuringExecution | +[]object | +
+ The scheduler will prefer to schedule pods to nodes that satisfy
+the affinity expressions specified by this field, but it may choose
+a node that violates one or more of the expressions. The node that is
+most preferred is the one with the greatest sum of weights, i.e.
+for each node that meets all of the scheduling requirements (resource
+request, requiredDuringScheduling affinity expressions, etc.),
+compute a sum by iterating through the elements of this field and adding
+"weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the
+node(s) with the highest sum are the most preferred. + |
+ false | +
| requiredDuringSchedulingIgnoredDuringExecution | +[]object | +
+ If the affinity requirements specified by this field are not met at
+scheduling time, the pod will not be scheduled onto the node.
+If the affinity requirements specified by this field cease to be met
+at some point during pod execution (e.g. due to a pod label update), the
+system may or may not try to eventually evict the pod from its node.
+When there are multiple elements, the lists of nodes corresponding to each
+podAffinityTerm are intersected, i.e. all terms must be satisfied. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| podAffinityTerm | +object | +
+ Required. A pod affinity term, associated with the corresponding weight. + |
+ true | +
| weight | +integer | +
+ weight associated with matching the corresponding podAffinityTerm,
+in the range 1-100. + + Format: int32 + |
+ true | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| topologyKey | +string | +
+ This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching
+the labelSelector in the specified namespaces, where co-located is defined as running on a node
+whose value of the label with key topologyKey matches that of any node on which any of the
+selected pods is running.
+Empty topologyKey is not allowed. + |
+ true | +
| labelSelector | +object | +
+ A label query over a set of resources, in this case pods.
+If it's null, this PodAffinityTerm matches with no Pods. + |
+ false | +
| matchLabelKeys | +[]string | +
+ MatchLabelKeys is a set of pod label keys to select which pods will
+be taken into consideration. The keys are used to lookup values from the
+incoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)`
+to select the group of existing pods which pods will be taken into consideration
+for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming
+pod labels will be ignored. The default value is empty.
+The same key is forbidden to exist in both matchLabelKeys and labelSelector.
+Also, matchLabelKeys cannot be set when labelSelector isn't set. + |
+ false | +
| mismatchLabelKeys | +[]string | +
+ MismatchLabelKeys is a set of pod label keys to select which pods will
+be taken into consideration. The keys are used to lookup values from the
+incoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)`
+to select the group of existing pods which pods will be taken into consideration
+for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming
+pod labels will be ignored. The default value is empty.
+The same key is forbidden to exist in both mismatchLabelKeys and labelSelector.
+Also, mismatchLabelKeys cannot be set when labelSelector isn't set. + |
+ false | +
| namespaceSelector | +object | +
+ A label query over the set of namespaces that the term applies to.
+The term is applied to the union of the namespaces selected by this field
+and the ones listed in the namespaces field.
+null selector and null or empty namespaces list means "this pod's namespace".
+An empty selector ({}) matches all namespaces. + |
+ false | +
| namespaces | +[]string | +
+ namespaces specifies a static list of namespace names that the term applies to.
+The term is applied to the union of the namespaces listed in this field
+and the ones selected by namespaceSelector.
+null or empty namespaces list and null namespaceSelector means "this pod's namespace". + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| matchExpressions | +[]object | +
+ matchExpressions is a list of label selector requirements. The requirements are ANDed. + |
+ false | +
| matchLabels | +map[string]string | +
+ matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
+map is equivalent to an element of matchExpressions, whose key field is "key", the
+operator is "In", and the values array contains only "value". The requirements are ANDed. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| key | +string | +
+ key is the label key that the selector applies to. + |
+ true | +
| operator | +string | +
+ operator represents a key's relationship to a set of values.
+Valid operators are In, NotIn, Exists and DoesNotExist. + |
+ true | +
| values | +[]string | +
+ values is an array of string values. If the operator is In or NotIn,
+the values array must be non-empty. If the operator is Exists or DoesNotExist,
+the values array must be empty. This array is replaced during a strategic
+merge patch. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| matchExpressions | +[]object | +
+ matchExpressions is a list of label selector requirements. The requirements are ANDed. + |
+ false | +
| matchLabels | +map[string]string | +
+ matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
+map is equivalent to an element of matchExpressions, whose key field is "key", the
+operator is "In", and the values array contains only "value". The requirements are ANDed. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| key | +string | +
+ key is the label key that the selector applies to. + |
+ true | +
| operator | +string | +
+ operator represents a key's relationship to a set of values.
+Valid operators are In, NotIn, Exists and DoesNotExist. + |
+ true | +
| values | +[]string | +
+ values is an array of string values. If the operator is In or NotIn,
+the values array must be non-empty. If the operator is Exists or DoesNotExist,
+the values array must be empty. This array is replaced during a strategic
+merge patch. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| topologyKey | +string | +
+ This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching
+the labelSelector in the specified namespaces, where co-located is defined as running on a node
+whose value of the label with key topologyKey matches that of any node on which any of the
+selected pods is running.
+Empty topologyKey is not allowed. + |
+ true | +
| labelSelector | +object | +
+ A label query over a set of resources, in this case pods.
+If it's null, this PodAffinityTerm matches with no Pods. + |
+ false | +
| matchLabelKeys | +[]string | +
+ MatchLabelKeys is a set of pod label keys to select which pods will
+be taken into consideration. The keys are used to lookup values from the
+incoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)`
+to select the group of existing pods which pods will be taken into consideration
+for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming
+pod labels will be ignored. The default value is empty.
+The same key is forbidden to exist in both matchLabelKeys and labelSelector.
+Also, matchLabelKeys cannot be set when labelSelector isn't set. + |
+ false | +
| mismatchLabelKeys | +[]string | +
+ MismatchLabelKeys is a set of pod label keys to select which pods will
+be taken into consideration. The keys are used to lookup values from the
+incoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)`
+to select the group of existing pods which pods will be taken into consideration
+for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming
+pod labels will be ignored. The default value is empty.
+The same key is forbidden to exist in both mismatchLabelKeys and labelSelector.
+Also, mismatchLabelKeys cannot be set when labelSelector isn't set. + |
+ false | +
| namespaceSelector | +object | +
+ A label query over the set of namespaces that the term applies to.
+The term is applied to the union of the namespaces selected by this field
+and the ones listed in the namespaces field.
+null selector and null or empty namespaces list means "this pod's namespace".
+An empty selector ({}) matches all namespaces. + |
+ false | +
| namespaces | +[]string | +
+ namespaces specifies a static list of namespace names that the term applies to.
+The term is applied to the union of the namespaces listed in this field
+and the ones selected by namespaceSelector.
+null or empty namespaces list and null namespaceSelector means "this pod's namespace". + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| matchExpressions | +[]object | +
+ matchExpressions is a list of label selector requirements. The requirements are ANDed. + |
+ false | +
| matchLabels | +map[string]string | +
+ matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
+map is equivalent to an element of matchExpressions, whose key field is "key", the
+operator is "In", and the values array contains only "value". The requirements are ANDed. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| key | +string | +
+ key is the label key that the selector applies to. + |
+ true | +
| operator | +string | +
+ operator represents a key's relationship to a set of values.
+Valid operators are In, NotIn, Exists and DoesNotExist. + |
+ true | +
| values | +[]string | +
+ values is an array of string values. If the operator is In or NotIn,
+the values array must be non-empty. If the operator is Exists or DoesNotExist,
+the values array must be empty. This array is replaced during a strategic
+merge patch. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| matchExpressions | +[]object | +
+ matchExpressions is a list of label selector requirements. The requirements are ANDed. + |
+ false | +
| matchLabels | +map[string]string | +
+ matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
+map is equivalent to an element of matchExpressions, whose key field is "key", the
+operator is "In", and the values array contains only "value". The requirements are ANDed. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| key | +string | +
+ key is the label key that the selector applies to. + |
+ true | +
| operator | +string | +
+ operator represents a key's relationship to a set of values.
+Valid operators are In, NotIn, Exists and DoesNotExist. + |
+ true | +
| values | +[]string | +
+ values is an array of string values. If the operator is In or NotIn,
+the values array must be non-empty. If the operator is Exists or DoesNotExist,
+the values array must be empty. This array is replaced during a strategic
+merge patch. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| preferredDuringSchedulingIgnoredDuringExecution | +[]object | +
+ The scheduler will prefer to schedule pods to nodes that satisfy
+the anti-affinity expressions specified by this field, but it may choose
+a node that violates one or more of the expressions. The node that is
+most preferred is the one with the greatest sum of weights, i.e.
+for each node that meets all of the scheduling requirements (resource
+request, requiredDuringScheduling anti-affinity expressions, etc.),
+compute a sum by iterating through the elements of this field and subtracting
+"weight" from the sum if the node has pods which matches the corresponding podAffinityTerm; the
+node(s) with the highest sum are the most preferred. + |
+ false | +
| requiredDuringSchedulingIgnoredDuringExecution | +[]object | +
+ If the anti-affinity requirements specified by this field are not met at
+scheduling time, the pod will not be scheduled onto the node.
+If the anti-affinity requirements specified by this field cease to be met
+at some point during pod execution (e.g. due to a pod label update), the
+system may or may not try to eventually evict the pod from its node.
+When there are multiple elements, the lists of nodes corresponding to each
+podAffinityTerm are intersected, i.e. all terms must be satisfied. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| podAffinityTerm | +object | +
+ Required. A pod affinity term, associated with the corresponding weight. + |
+ true | +
| weight | +integer | +
+ weight associated with matching the corresponding podAffinityTerm,
+in the range 1-100. + + Format: int32 + |
+ true | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| topologyKey | +string | +
+ This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching
+the labelSelector in the specified namespaces, where co-located is defined as running on a node
+whose value of the label with key topologyKey matches that of any node on which any of the
+selected pods is running.
+Empty topologyKey is not allowed. + |
+ true | +
| labelSelector | +object | +
+ A label query over a set of resources, in this case pods.
+If it's null, this PodAffinityTerm matches with no Pods. + |
+ false | +
| matchLabelKeys | +[]string | +
+ MatchLabelKeys is a set of pod label keys to select which pods will
+be taken into consideration. The keys are used to lookup values from the
+incoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)`
+to select the group of existing pods which pods will be taken into consideration
+for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming
+pod labels will be ignored. The default value is empty.
+The same key is forbidden to exist in both matchLabelKeys and labelSelector.
+Also, matchLabelKeys cannot be set when labelSelector isn't set. + |
+ false | +
| mismatchLabelKeys | +[]string | +
+ MismatchLabelKeys is a set of pod label keys to select which pods will
+be taken into consideration. The keys are used to lookup values from the
+incoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)`
+to select the group of existing pods which pods will be taken into consideration
+for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming
+pod labels will be ignored. The default value is empty.
+The same key is forbidden to exist in both mismatchLabelKeys and labelSelector.
+Also, mismatchLabelKeys cannot be set when labelSelector isn't set. + |
+ false | +
| namespaceSelector | +object | +
+ A label query over the set of namespaces that the term applies to.
+The term is applied to the union of the namespaces selected by this field
+and the ones listed in the namespaces field.
+null selector and null or empty namespaces list means "this pod's namespace".
+An empty selector ({}) matches all namespaces. + |
+ false | +
| namespaces | +[]string | +
+ namespaces specifies a static list of namespace names that the term applies to.
+The term is applied to the union of the namespaces listed in this field
+and the ones selected by namespaceSelector.
+null or empty namespaces list and null namespaceSelector means "this pod's namespace". + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| matchExpressions | +[]object | +
+ matchExpressions is a list of label selector requirements. The requirements are ANDed. + |
+ false | +
| matchLabels | +map[string]string | +
+ matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
+map is equivalent to an element of matchExpressions, whose key field is "key", the
+operator is "In", and the values array contains only "value". The requirements are ANDed. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| key | +string | +
+ key is the label key that the selector applies to. + |
+ true | +
| operator | +string | +
+ operator represents a key's relationship to a set of values.
+Valid operators are In, NotIn, Exists and DoesNotExist. + |
+ true | +
| values | +[]string | +
+ values is an array of string values. If the operator is In or NotIn,
+the values array must be non-empty. If the operator is Exists or DoesNotExist,
+the values array must be empty. This array is replaced during a strategic
+merge patch. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| matchExpressions | +[]object | +
+ matchExpressions is a list of label selector requirements. The requirements are ANDed. + |
+ false | +
| matchLabels | +map[string]string | +
+ matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
+map is equivalent to an element of matchExpressions, whose key field is "key", the
+operator is "In", and the values array contains only "value". The requirements are ANDed. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| key | +string | +
+ key is the label key that the selector applies to. + |
+ true | +
| operator | +string | +
+ operator represents a key's relationship to a set of values.
+Valid operators are In, NotIn, Exists and DoesNotExist. + |
+ true | +
| values | +[]string | +
+ values is an array of string values. If the operator is In or NotIn,
+the values array must be non-empty. If the operator is Exists or DoesNotExist,
+the values array must be empty. This array is replaced during a strategic
+merge patch. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| topologyKey | +string | +
+ This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching
+the labelSelector in the specified namespaces, where co-located is defined as running on a node
+whose value of the label with key topologyKey matches that of any node on which any of the
+selected pods is running.
+Empty topologyKey is not allowed. + |
+ true | +
| labelSelector | +object | +
+ A label query over a set of resources, in this case pods.
+If it's null, this PodAffinityTerm matches with no Pods. + |
+ false | +
| matchLabelKeys | +[]string | +
+ MatchLabelKeys is a set of pod label keys to select which pods will
+be taken into consideration. The keys are used to lookup values from the
+incoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)`
+to select the group of existing pods which pods will be taken into consideration
+for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming
+pod labels will be ignored. The default value is empty.
+The same key is forbidden to exist in both matchLabelKeys and labelSelector.
+Also, matchLabelKeys cannot be set when labelSelector isn't set. + |
+ false | +
| mismatchLabelKeys | +[]string | +
+ MismatchLabelKeys is a set of pod label keys to select which pods will
+be taken into consideration. The keys are used to lookup values from the
+incoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)`
+to select the group of existing pods which pods will be taken into consideration
+for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming
+pod labels will be ignored. The default value is empty.
+The same key is forbidden to exist in both mismatchLabelKeys and labelSelector.
+Also, mismatchLabelKeys cannot be set when labelSelector isn't set. + |
+ false | +
| namespaceSelector | +object | +
+ A label query over the set of namespaces that the term applies to.
+The term is applied to the union of the namespaces selected by this field
+and the ones listed in the namespaces field.
+null selector and null or empty namespaces list means "this pod's namespace".
+An empty selector ({}) matches all namespaces. + |
+ false | +
| namespaces | +[]string | +
+ namespaces specifies a static list of namespace names that the term applies to.
+The term is applied to the union of the namespaces listed in this field
+and the ones selected by namespaceSelector.
+null or empty namespaces list and null namespaceSelector means "this pod's namespace". + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| matchExpressions | +[]object | +
+ matchExpressions is a list of label selector requirements. The requirements are ANDed. + |
+ false | +
| matchLabels | +map[string]string | +
+ matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
+map is equivalent to an element of matchExpressions, whose key field is "key", the
+operator is "In", and the values array contains only "value". The requirements are ANDed. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| key | +string | +
+ key is the label key that the selector applies to. + |
+ true | +
| operator | +string | +
+ operator represents a key's relationship to a set of values.
+Valid operators are In, NotIn, Exists and DoesNotExist. + |
+ true | +
| values | +[]string | +
+ values is an array of string values. If the operator is In or NotIn,
+the values array must be non-empty. If the operator is Exists or DoesNotExist,
+the values array must be empty. This array is replaced during a strategic
+merge patch. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| matchExpressions | +[]object | +
+ matchExpressions is a list of label selector requirements. The requirements are ANDed. + |
+ false | +
| matchLabels | +map[string]string | +
+ matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
+map is equivalent to an element of matchExpressions, whose key field is "key", the
+operator is "In", and the values array contains only "value". The requirements are ANDed. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| key | +string | +
+ key is the label key that the selector applies to. + |
+ true | +
| operator | +string | +
+ operator represents a key's relationship to a set of values.
+Valid operators are In, NotIn, Exists and DoesNotExist. + |
+ true | +
| values | +[]string | +
+ values is an array of string values. If the operator is In or NotIn,
+the values array must be non-empty. If the operator is Exists or DoesNotExist,
+the values array must be empty. This array is replaced during a strategic
+merge patch. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| claims | +[]object | +
+ Claims lists the names of resources, defined in spec.resourceClaims,
+that are used by this container.
+
+This field depends on the
+DynamicResourceAllocation feature gate.
+
+This field is immutable. It can only be set for containers. + |
+ false | +
| limits | +map[string]int or string | +
+ Limits describes the maximum amount of compute resources allowed.
+More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ + |
+ false | +
| requests | +map[string]int or string | +
+ Requests describes the minimum amount of compute resources required.
+If Requests is omitted for a container, it defaults to Limits if that is explicitly specified,
+otherwise to an implementation-defined value. Requests cannot exceed Limits.
+More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ Name must match the name of one entry in pod.spec.resourceClaims of
+the Pod where this field is used. It makes that resource available
+inside a container. + |
+ true | +
| request | +string | +
+ Request is the name chosen for a request in the referenced claim.
+If empty, everything from the claim is made available, otherwise
+only the result of this request. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| claims | +[]object | +
+ Claims lists the names of resources, defined in spec.resourceClaims,
+that are used by this container.
+
+This field depends on the
+DynamicResourceAllocation feature gate.
+
+This field is immutable. It can only be set for containers. + |
+ false | +
| limits | +map[string]int or string | +
+ Limits describes the maximum amount of compute resources allowed.
+More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ + |
+ false | +
| requests | +map[string]int or string | +
+ Requests describes the minimum amount of compute resources required.
+If Requests is omitted for a container, it defaults to Limits if that is explicitly specified,
+otherwise to an implementation-defined value. Requests cannot exceed Limits.
+More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ Name must match the name of one entry in pod.spec.resourceClaims of
+the Pod where this field is used. It makes that resource available
+inside a container. + |
+ true | +
| request | +string | +
+ Request is the name chosen for a request in the referenced claim.
+If empty, everything from the claim is made available, otherwise
+only the result of this request. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| effect | +string | +
+ Effect indicates the taint effect to match. Empty means match all taint effects.
+When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute. + |
+ false | +
| key | +string | +
+ Key is the taint key that the toleration applies to. Empty means match all taint keys.
+If the key is empty, operator must be Exists; this combination means to match all values and all keys. + |
+ false | +
| operator | +string | +
+ Operator represents a key's relationship to the value.
+Valid operators are Exists and Equal. Defaults to Equal.
+Exists is equivalent to wildcard for value, so that a pod can
+tolerate all taints of a particular category. + |
+ false | +
| tolerationSeconds | +integer | +
+ TolerationSeconds represents the period of time the toleration (which must be
+of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default,
+it is not set, which means tolerate the taint forever (do not evict). Zero and
+negative values will be treated as 0 (evict immediately) by the system. + + Format: int64 + |
+ false | +
| value | +string | +
+ Value is the taint value the toleration matches to.
+If the operator is Exists, the value should be empty, otherwise just a regular string. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| secretName | +string | +
+ + |
+ true | +
| superuser | +boolean | +
+ + |
+ true | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| cassandraOperatorProgress | +string | +
+ Last known progress state of the Cassandra Operator + |
+ false | +
| conditions | +[]object | +
+ + |
+ false | +
| datacenterName | +string | +
+ DatacenterName is the name of the override used for the CassandraDatacenter
+This field is used to perform validation checks preventing a user from changing the override + |
+ false | +
| failedStarts | +[]string | +
+ FailedStarts tracks the pods that failed to start by the operator last time it tried + |
+ false | +
| lastRollingRestart | +string | +
+ + + Format: date-time + |
+ false | +
| lastServerNodeStarted | +string | +
+ The timestamp when the operator last started a Server node
+with the management API + + Format: date-time + |
+ false | +
| metadataVersion | +integer | +
+ + + Format: int64 + |
+ false | +
| nodeReplacements | +[]string | +
+ + |
+ false | +
| nodeStatuses | +map[string]object | +
+ + |
+ false | +
| observedGeneration | +integer | +
+ + + Format: int64 + |
+ false | +
| quietPeriod | +string | +
+ + + Format: date-time + |
+ false | +
| superUserUpserted | +string | +
+ Deprecated. Use usersUpserted instead. The timestamp at
+which CQL superuser credentials were last upserted to the
+management API + + Format: date-time + |
+ false | +
| trackedTasks | +[]object | +
+ TrackedTasks tracks the tasks for completion that were created by the cass-operator + |
+ false | +
| usersUpserted | +string | +
+ The timestamp at which managed cassandra users' credentials
+were last upserted to the management API + + Format: date-time + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| message | +string | +
+ + |
+ true | +
| reason | +string | +
+ + |
+ true | +
| status | +string | +
+ + |
+ true | +
| type | +string | +
+ + |
+ true | +
| lastTransitionTime | +string | +
+ + + Format: date-time + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| hostID | +string | +
+ + |
+ false | +
| ip | +string | +
+ + |
+ false | +
| rack | +string | +
+ + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| apiVersion | +string | +
+ API version of the referent. + |
+ false | +
| fieldPath | +string | +
+ If referring to a piece of an object instead of an entire object, this string
+should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2].
+For example, if the object reference is to a container within a pod, this would take on a value like:
+"spec.containers{name}" (where "name" refers to the name of the container that triggered
+the event) or if no container name is specified "spec.containers[2]" (container with
+index 2 in this pod). This syntax is chosen only to have some well-defined way of
+referencing a part of an object. + |
+ false | +
| kind | +string | +
+ Kind of the referent.
+More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + |
+ false | +
| name | +string | +
+ Name of the referent.
+More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + |
+ false | +
| namespace | +string | +
+ Namespace of the referent.
+More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ + |
+ false | +
| resourceVersion | +string | +
+ Specific resourceVersion to which this reference is made, if any.
+More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency + |
+ false | +
| uid | +string | +
+ UID of the referent.
+More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| apiVersion | +string | +control.k8ssandra.io/v1alpha1 | +true | +
| kind | +string | +CassandraTask | +true | +
| metadata | +object | +Refer to the Kubernetes API documentation for the fields of the `metadata` field. | +true | +
| spec | +object | +
+ CassandraTaskSpec defines the desired state of CassandraTask + |
+ false | +
| status | +object | +
+ CassandraTaskStatus defines the observed state of CassandraJob + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| concurrencyPolicy | +string | +
+ Specifics if this task can be run concurrently with other active tasks. Valid values are:
+- "Allow": allows multiple Tasks to run concurrently on Cassandra cluster
+- "Forbid" (default): only a single task is executed at once
+The "Allow" property is only valid if all the other active Tasks have "Allow" as well. + |
+ false | +
| datacenter | +object | +
+ Which datacenter this task is targeting. Note, this must be a datacenter which the current cass-operator
+can access + |
+ false | +
| jobs | +[]object | +
+ Jobs defines the jobs this task will execute (and their order) + |
+ false | +
| maxConcurrentPods | +integer | +
+ MaxConcurrentPods specifies the maximum number of pods to process concurrently in a rack.
+If not set or set to 0 defaults to 1. + |
+ false | +
| restartPolicy | +string | +
+ RestartPolicy indicates the behavior n case of failure. Default is OnFailure. + |
+ false | +
| retries | +integer | +
+ Retries specifies the maximum number of times a failed pod operation can be retried.
+This is only relevant if the RestartPolicy is set to OnFailure. If not set,
+the default value is 1. + |
+ false | +
| scheduledTime | +string | +
+ ScheduledTime indicates the earliest possible time this task is executed. This does not necessarily
+equal to the time it is actually executed (if other tasks are blocking for example). If not set,
+the task will be executed immediately. + + Format: date-time + |
+ false | +
| ttlSecondsAfterFinished | +integer | +
+ TTLSecondsAfterFinished defines how long the completed job will kept before being cleaned up. If set to 0
+the task will not be cleaned up by the cass-operator. If unset, the default time (86400s) is used. + + Format: int32 + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| apiVersion | +string | +
+ API version of the referent. + |
+ false | +
| fieldPath | +string | +
+ If referring to a piece of an object instead of an entire object, this string
+should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2].
+For example, if the object reference is to a container within a pod, this would take on a value like:
+"spec.containers{name}" (where "name" refers to the name of the container that triggered
+the event) or if no container name is specified "spec.containers[2]" (container with
+index 2 in this pod). This syntax is chosen only to have some well-defined way of
+referencing a part of an object. + |
+ false | +
| kind | +string | +
+ Kind of the referent.
+More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + |
+ false | +
| name | +string | +
+ Name of the referent.
+More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + |
+ false | +
| namespace | +string | +
+ Namespace of the referent.
+More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ + |
+ false | +
| resourceVersion | +string | +
+ Specific resourceVersion to which this reference is made, if any.
+More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency + |
+ false | +
| uid | +string | +
+ UID of the referent.
+More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| command | +string | +
+ Command defines what is run against Cassandra pods + |
+ true | +
| name | +string | +
+ + |
+ true | +
| args | +object | +
+ Arguments are additional parameters for the command + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| end_token | +string | +
+ + |
+ false | +
| fast | +boolean | +
+ Fast modifies the behavior of rolling restart to restart multiple nodes (or entire rack) at the same time.
+If the cluster is degraded in availability, the fast path isn't used + |
+ false | +
| force | +boolean | +
+ Force is used to force the execution of a command even if the operator thinks it is unsafe + |
+ false | +
| jobs | +integer | +
+ + |
+ false | +
| keyspace_name | +string | +
+ + |
+ false | +
| new_tokens | +map[string]string | +
+ NewTokens is a map of pod names to their newly-assigned tokens. Required for the move
+command, ignored otherwise. Pods referenced in this map must exist; any existing pod not
+referenced in this map will not be moved. + |
+ false | +
| no_snapshot | +boolean | +
+ + |
+ false | +
| no_validate | +boolean | +
+ Scrub arguments + |
+ false | +
| pod_name | +string | +
+ + |
+ false | +
| rack | +string | +
+ + |
+ false | +
| skip_corrupted | +boolean | +
+ + |
+ false | +
| source_datacenter | +string | +
+ + |
+ false | +
| split_output | +boolean | +
+ Compaction arguments + |
+ false | +
| start_token | +string | +
+ + |
+ false | +
| tables | +[]string | +
+ + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| active | +integer | +
+ The number of actively running pods. + |
+ false | +
| completionTime | +string | +
+ Represents time when the job was completed. It is not guaranteed to
+be set in happens-before order across separate operations.
+It is represented in RFC3339 form and is in UTC.
+The completion time is only set when the job finishes successfully. + + Format: date-time + |
+ false | +
| conditions | +[]object | +
+ The latest available observations of an object's current state. When a Job
+fails, one of the conditions will have type "Failed" and status true. When
+a Job is suspended, one of the conditions will have type "Suspended" and
+status true; when the Job is resumed, the status of this condition will
+become false. When a Job is completed, one of the conditions will have
+type "Complete" and status true.
+More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/ + |
+ false | +
| failed | +integer | +
+ The number of pods which reached phase Failed. + |
+ false | +
| podStatuses | +map[string]object | +
+ PodStatuses tracks the processing status of each pod for bookkeeping.
+Keys are pod names (not including pod UID to handle recreation scenarios). + |
+ false | +
| startTime | +string | +
+ Represents time when the job controller started processing a job. When a
+Job is created in the suspended state, this field is not set until the
+first time it is resumed. This field is reset every time a Job is resumed
+from suspension. It is represented in RFC3339 form and is in UTC. + + Format: date-time + |
+ false | +
| succeeded | +integer | +
+ The number of pods which reached phase Succeeded. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| lastTransitionTime | +string | +
+ lastTransitionTime is the last time the condition transitioned from one status to another.
+This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable. + + Format: date-time + |
+ true | +
| message | +string | +
+ message is a human readable message indicating details about the transition.
+This may be an empty string. + |
+ true | +
| reason | +string | +
+ reason contains a programmatic identifier indicating the reason for the condition's last transition.
+Producers of specific condition types may define expected values and meanings for this field,
+and whether the values are considered a guaranteed API.
+The value should be a CamelCase string.
+This field may not be empty. + |
+ true | +
| status | +enum | +
+ status of the condition, one of True, False, Unknown. + + Enum: True, False, Unknown + |
+ true | +
| type | +string | +
+ type of condition in CamelCase or in foo.example.com/CamelCase. + |
+ true | +
| observedGeneration | +integer | +
+ observedGeneration represents the .metadata.generation that the condition was set based upon.
+For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date
+with respect to the current state of the instance. + + Format: int64 + Minimum: 0 + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| status | +string | +
+ Status of the pod processing. + |
+ true | +
| completionTime | +string | +
+ Represents time when the pod was completed (success or fail). + + Format: date-time + |
+ false | +
| error | +string | +
+ Error message if failed. + |
+ false | +
| jobId | +string | +
+ JobID for async operations (mgmt-api). + |
+ false | +
| retries | +integer | +
+ Retry count + |
+ false | +
| startTime | +string | +
+ Represents time when the job controller started processing this pod. + + Format: date-time + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| apiVersion | +string | +control.k8ssandra.io/v1alpha1 | +true | +
| kind | +string | +ScheduledTask | +true | +
| metadata | +object | +Refer to the Kubernetes API documentation for the fields of the `metadata` field. | +true | +
| spec | +object | +
+ ScheduledTaskSpec defines the desired state of ScheduledTask + |
+ false | +
| status | +object | +
+ MedusaTaskStatus defines the observed state of MedusaTask + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| schedule | +string | +
+ + |
+ false | +
| taskDetails | +object | +
+ + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| concurrencyPolicy | +string | +
+ Specifics if this task can be run concurrently with other active tasks. Valid values are:
+- "Allow": allows multiple Tasks to run concurrently on Cassandra cluster
+- "Forbid" (default): only a single task is executed at once
+The "Allow" property is only valid if all the other active Tasks have "Allow" as well. + |
+ false | +
| datacenter | +object | +
+ Which datacenter this task is targeting. Note, this must be a datacenter which the current cass-operator
+can access + |
+ false | +
| jobs | +[]object | +
+ Jobs defines the jobs this task will execute (and their order) + |
+ false | +
| maxConcurrentPods | +integer | +
+ MaxConcurrentPods specifies the maximum number of pods to process concurrently in a rack.
+If not set or set to 0 defaults to 1. + |
+ false | +
| name | +string | +
+ Name of the task. Always populated. + |
+ false | +
| restartPolicy | +string | +
+ RestartPolicy indicates the behavior n case of failure. Default is OnFailure. + |
+ false | +
| retries | +integer | +
+ Retries specifies the maximum number of times a failed pod operation can be retried.
+This is only relevant if the RestartPolicy is set to OnFailure. If not set,
+the default value is 1. + |
+ false | +
| scheduledTime | +string | +
+ ScheduledTime indicates the earliest possible time this task is executed. This does not necessarily
+equal to the time it is actually executed (if other tasks are blocking for example). If not set,
+the task will be executed immediately. + + Format: date-time + |
+ false | +
| ttlSecondsAfterFinished | +integer | +
+ TTLSecondsAfterFinished defines how long the completed job will kept before being cleaned up. If set to 0
+the task will not be cleaned up by the cass-operator. If unset, the default time (86400s) is used. + + Format: int32 + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| apiVersion | +string | +
+ API version of the referent. + |
+ false | +
| fieldPath | +string | +
+ If referring to a piece of an object instead of an entire object, this string
+should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2].
+For example, if the object reference is to a container within a pod, this would take on a value like:
+"spec.containers{name}" (where "name" refers to the name of the container that triggered
+the event) or if no container name is specified "spec.containers[2]" (container with
+index 2 in this pod). This syntax is chosen only to have some well-defined way of
+referencing a part of an object. + |
+ false | +
| kind | +string | +
+ Kind of the referent.
+More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + |
+ false | +
| name | +string | +
+ Name of the referent.
+More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + |
+ false | +
| namespace | +string | +
+ Namespace of the referent.
+More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ + |
+ false | +
| resourceVersion | +string | +
+ Specific resourceVersion to which this reference is made, if any.
+More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency + |
+ false | +
| uid | +string | +
+ UID of the referent.
+More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| command | +string | +
+ Command defines what is run against Cassandra pods + |
+ true | +
| name | +string | +
+ + |
+ true | +
| args | +object | +
+ Arguments are additional parameters for the command + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| end_token | +string | +
+ + |
+ false | +
| fast | +boolean | +
+ Fast modifies the behavior of rolling restart to restart multiple nodes (or entire rack) at the same time.
+If the cluster is degraded in availability, the fast path isn't used + |
+ false | +
| force | +boolean | +
+ Force is used to force the execution of a command even if the operator thinks it is unsafe + |
+ false | +
| jobs | +integer | +
+ + |
+ false | +
| keyspace_name | +string | +
+ + |
+ false | +
| new_tokens | +map[string]string | +
+ NewTokens is a map of pod names to their newly-assigned tokens. Required for the move
+command, ignored otherwise. Pods referenced in this map must exist; any existing pod not
+referenced in this map will not be moved. + |
+ false | +
| no_snapshot | +boolean | +
+ + |
+ false | +
| no_validate | +boolean | +
+ Scrub arguments + |
+ false | +
| pod_name | +string | +
+ + |
+ false | +
| rack | +string | +
+ + |
+ false | +
| skip_corrupted | +boolean | +
+ + |
+ false | +
| source_datacenter | +string | +
+ + |
+ false | +
| split_output | +boolean | +
+ Compaction arguments + |
+ false | +
| start_token | +string | +
+ + |
+ false | +
| tables | +[]string | +
+ + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| lastExecution | +string | +
+ LastExecution tells when the backup was last time taken. If empty, the backup has never been taken + + Format: date-time + |
+ false | +
| nextSchedule | +string | +
+ NextSchedule indicates when the next backup is going to be done + + Format: date-time + |
+ false | +