From b646b50d74f481f2769446a07785af61dd670939 Mon Sep 17 00:00:00 2001 From: Alan Clucas Date: Wed, 3 Dec 2025 10:03:08 +0000 Subject: [PATCH 1/6] chore: clean up kubebuilder annotations in executor_swagger.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Add a Python script to make the generated executor swagger documentation more readable by converting annotations to a human-readable "Validation" section: - +optional → **Validation:** Optional. - +default=X → **Validation:** Default: X. - +kubebuilder:validation:Minimum=X → **Validation:** Minimum: X. - +kubebuilder:validation:Maximum=X → **Validation:** Maximum: X. - +kubebuilder:validation:MinLength=X → **Validation:** Minimum length: X. - +kubebuilder:validation:MaxLength=X → **Validation:** Maximum length: X. - +kubebuilder:validation:MinItems=X → **Validation:** Minimum items: X. - +kubebuilder:validation:MaxItems=X → **Validation:** Maximum items: X. - +kubebuilder:validation:Pattern=X → **Validation:** Pattern: X. - +kubebuilder:validation:Enum=A;B → **Validation:** Valid values: A, B. Internal annotations are removed: +patchStrategy, +patchMergeKey, +listType, +listMapKey, +featureGate, +structType, +protobuf, +union, +enum, +kubebuilder:validation:XValidation (complex CEL rules). Signed-off-by: Alan Clucas --- Makefile | 4 +- docs/executor_swagger.md | 659 +++++++++++++++----------------- hack/docgen/clean_swagger_md.py | 284 ++++++++++++++ 3 files changed, 591 insertions(+), 356 deletions(-) create mode 100755 hack/docgen/clean_swagger_md.py diff --git a/Makefile b/Makefile index 26b51881176d..d949eb64b132 100644 --- a/Makefile +++ b/Makefile @@ -353,8 +353,8 @@ argoexec-nonroot-image: codegen: types swagger manifests $(TOOL_MOCKERY) $(GENERATED_DOCS) ## Generate code via `go generate`, as well as SDKs go generate ./... $(TOOL_MOCKERY) --config .mockery.yaml - # The generated markdown contains links to nowhere for interfaces, so remove them - sed -i.bak 's/\[interface{}\](#interface)/`interface{}`/g' docs/executor_swagger.md && rm -f docs/executor_swagger.md.bak + # Clean up kubebuilder annotations and convert to human-readable validation section + python3 hack/docgen/clean_swagger_md.py docs/executor_swagger.md make --directory sdks/java USE_NIX=$(USE_NIX) generate make --directory sdks/python USE_NIX=$(USE_NIX) generate diff --git a/docs/executor_swagger.md b/docs/executor_swagger.md index 7da16dd7b991..4efb17e82ddd 100644 --- a/docs/executor_swagger.md +++ b/docs/executor_swagger.md @@ -81,9 +81,9 @@ ownership management and SELinux relabeling. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| -| fsType | string| `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
TODO: how do we prevent errors in the filesystem from compromising the machine
+optional | | -| partition | int32 (formatted integer)| `int32` | | | 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).
+optional | | -| readOnly | boolean| `bool` | | | readOnly value true will force the readOnly setting in VolumeMounts.
More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
+optional | | +| fsType | string| `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
TODO: how do we prevent errors in the filesystem from compromising the machine
**Validation:** Optional.| | +| partition | int32 (formatted integer)| `int32` | | | 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).
**Validation:** Optional.| | +| readOnly | boolean| `bool` | | | readOnly value true will force the readOnly setting in VolumeMounts.
More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
**Validation:** Optional.| | | volumeID | string| `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 | | @@ -108,7 +108,6 @@ ownership management and SELinux relabeling. ### Amount -> +kubebuilder:validation:Type=number @@ -133,7 +132,6 @@ It will marshall back to string - marshalling is not symmetric. ### AppArmorProfile -> +union @@ -144,7 +142,7 @@ It will marshall back to string - marshalling is not symmetric. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| -| localhostProfile | string| `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".
+optional | | +| localhostProfile | string| `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".
**Validation:** Optional.| | | type | [AppArmorProfileType](#app-armor-profile-type)| `AppArmorProfileType` | | | | | @@ -152,14 +150,13 @@ It will marshall back to string - marshalling is not symmetric. ### AppArmorProfileType -> +enum | Name | Type | Go type | Default | Description | Example | |------|------|---------| ------- |-------------|---------| -| AppArmorProfileType | string| string | | +enum | | +| AppArmorProfileType | string| string | | | | @@ -198,7 +195,7 @@ It will marshall back to string - marshalling is not symmetric. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| | artifacts | [Artifacts](#artifacts)| `Artifacts` | | | | | -| parameters | [][Parameter](#parameter)| `[]*Parameter` | | | Parameters is the list of parameters to pass to the template or workflow
+patchStrategy=merge
+patchMergeKey=name | | +| parameters | [][Parameter](#parameter)| `[]*Parameter` | | | Parameters is the list of parameters to pass to the template or workflow | | @@ -229,8 +226,8 @@ It will marshall back to string - marshalling is not symmetric. | globalName | string| `string` | | | GlobalName exports an output artifact to the global scope, making it available as
'{{workflow.outputs.artifacts.XXXX}} and in workflow.status.outputs.artifacts | | | hdfs | [HDFSArtifact](#h-d-f-s-artifact)| `HDFSArtifact` | | | | | | http | [HTTPArtifact](#http-artifact)| `HTTPArtifact` | | | | | -| mode | int32 (formatted integer)| `int32` | | | mode bits to use on this file, must be a value between 0 and 0777.
Set when loading input artifacts. It is recommended to set the mode value
to ensure the artifact has the expected permissions in your container.
+kubebuilder:validation:Minimum=0
+kubebuilder:validation:Maximum=511 | | -| name | string| `string` | | | name of the artifact. must be unique within a template's inputs/outputs.
+kubebuilder:validation:Pattern=`^[-a-zA-Z0-9_{}.]+$` | | +| mode | int32 (formatted integer)| `int32` | | | mode bits to use on this file, must be a value between 0 and 0777.
Set when loading input artifacts. It is recommended to set the mode value
to ensure the artifact has the expected permissions in your container.
**Validation:** Minimum: 0; Maximum: 511.| | +| name | string| `string` | | | name of the artifact. must be unique within a template's inputs/outputs.
**Validation:** Pattern: `^[-a-zA-Z0-9_{}.]+$`.| | | optional | boolean| `bool` | | | Make Artifacts optional, if Artifacts doesn't generate or exist | | | oss | [OSSArtifact](#o-s-s-artifact)| `OSSArtifact` | | | | | | path | string| `string` | | | Path is the container path to the artifact | | @@ -279,7 +276,6 @@ It will marshall back to string - marshalling is not symmetric. > It is used as single artifact in the context of inputs/outputs (e.g. outputs.artifacts.artname). It is also used to describe the location of multiple artifacts such as the archive location of a single workflow step, which the executor will use as a default location to store its files. -+kubebuilder:validation:XValidation:rule="(has(self.s3) ? 1 : 0) + (has(self.git) ? 1 : 0) + (has(self.http) ? 1 : 0) + (has(self.artifactory) ? 1 : 0) + (has(self.hdfs) ? 1 : 0) + (has(self.raw) ? 1 : 0) + (has(self.oss) ? 1 : 0) + (has(self.gcs) ? 1 : 0) + (has(self.azure) ? 1 : 0) + (has(self.plugin) ? 1 : 0) <= 1",message="at most one artifact location can be specified" @@ -331,8 +327,8 @@ of a single workflow step, which the executor will use as a default location to | globalName | string| `string` | | | GlobalName exports an output artifact to the global scope, making it available as
'{{workflow.outputs.artifacts.XXXX}} and in workflow.status.outputs.artifacts | | | hdfs | [HDFSArtifact](#h-d-f-s-artifact)| `HDFSArtifact` | | | | | | http | [HTTPArtifact](#http-artifact)| `HTTPArtifact` | | | | | -| mode | int32 (formatted integer)| `int32` | | | mode bits to use on this file, must be a value between 0 and 0777.
Set when loading input artifacts. It is recommended to set the mode value
to ensure the artifact has the expected permissions in your container.
+kubebuilder:validation:Minimum=0
+kubebuilder:validation:Maximum=511 | | -| name | string| `string` | | | name of the artifact. must be unique within a template's inputs/outputs.
+kubebuilder:validation:Pattern=`^[-a-zA-Z0-9_{}.]+$` | | +| mode | int32 (formatted integer)| `int32` | | | mode bits to use on this file, must be a value between 0 and 0777.
Set when loading input artifacts. It is recommended to set the mode value
to ensure the artifact has the expected permissions in your container.
**Validation:** Minimum: 0; Maximum: 511.| | +| name | string| `string` | | | name of the artifact. must be unique within a template's inputs/outputs.
**Validation:** Pattern: `^[-a-zA-Z0-9_{}.]+$`.| | | optional | boolean| `bool` | | | Make Artifacts optional, if Artifacts doesn't generate or exist | | | oss | [OSSArtifact](#o-s-s-artifact)| `OSSArtifact` | | | | | | path | string| `string` | | | Path is the container path to the artifact | | @@ -410,28 +406,26 @@ of a single workflow step, which the executor will use as a default location to ### AzureDataDiskCachingMode -> +enum | Name | Type | Go type | Default | Description | Example | |------|------|---------| ------- |-------------|---------| -| AzureDataDiskCachingMode | string| string | | +enum | | +| AzureDataDiskCachingMode | string| string | | | | ### AzureDataDiskKind -> +enum | Name | Type | Go type | Default | Description | Example | |------|------|---------| ------- |-------------|---------| -| AzureDataDiskKind | string| string | | +enum | | +| AzureDataDiskKind | string| string | | | | @@ -449,9 +443,9 @@ of a single workflow step, which the executor will use as a default location to | cachingMode | [AzureDataDiskCachingMode](#azure-data-disk-caching-mode)| `AzureDataDiskCachingMode` | | | | | | diskName | string| `string` | | | diskName is the Name of the data disk in the blob storage | | | diskURI | string| `string` | | | diskURI is the URI of data disk in the blob storage | | -| fsType | string| `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.
+optional
+default="ext4" | | +| fsType | string| `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.
**Validation:** Optional; Default: "ext4".| | | kind | [AzureDataDiskKind](#azure-data-disk-kind)| `AzureDataDiskKind` | | | | | -| readOnly | boolean| `bool` | | | readOnly Defaults to false (read/write). ReadOnly here will force
the ReadOnly setting in VolumeMounts.
+optional
+default=false | | +| readOnly | boolean| `bool` | | | readOnly Defaults to false (read/write). ReadOnly here will force
the ReadOnly setting in VolumeMounts.
**Validation:** Optional; Default: false.| | @@ -466,7 +460,7 @@ of a single workflow step, which the executor will use as a default location to | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| -| readOnly | boolean| `bool` | | | readOnly defaults to false (read/write). ReadOnly here will force
the ReadOnly setting in VolumeMounts.
+optional | | +| readOnly | boolean| `bool` | | | readOnly defaults to false (read/write). ReadOnly here will force
the ReadOnly setting in VolumeMounts.
**Validation:** Optional.| | | secretName | string| `string` | | | secretName is the name of secret that contains Azure Storage Account Name and Key | | | shareName | string| `string` | | | shareName is the azure share Name | | @@ -527,10 +521,10 @@ of a single workflow step, which the executor will use as a default location to | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| | driver | string| `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. | | -| fsType | string| `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.
+optional | | +| fsType | string| `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.
**Validation:** Optional.| | | nodePublishSecretRef | [LocalObjectReference](#local-object-reference)| `LocalObjectReference` | | | | | -| readOnly | boolean| `bool` | | | readOnly specifies a read-only configuration for the volume.
Defaults to false (read/write).
+optional | | -| volumeAttributes | map of string| `map[string]string` | | | volumeAttributes stores driver-specific properties that are passed to the CSI
driver. Consult your driver's documentation for supported values.
+optional | | +| readOnly | boolean| `bool` | | | readOnly specifies a read-only configuration for the volume.
Defaults to false (read/write).
**Validation:** Optional.| | +| volumeAttributes | map of string| `map[string]string` | | | volumeAttributes stores driver-specific properties that are passed to the CSI
driver. Consult your driver's documentation for supported values.
**Validation:** Optional.| | @@ -563,8 +557,8 @@ of a single workflow step, which the executor will use as a default location to | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| -| add | [][Capability](#capability)| `[]Capability` | | | Added capabilities
+optional
+listType=atomic | | -| drop | [][Capability](#capability)| `[]Capability` | | | Removed capabilities
+optional
+listType=atomic | | +| add | [][Capability](#capability)| `[]Capability` | | | Added capabilities
**Validation:** Optional.| | +| drop | [][Capability](#capability)| `[]Capability` | | | Removed capabilities
**Validation:** Optional.| | @@ -597,12 +591,12 @@ Cephfs volumes do not support ownership management or SELinux relabeling. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| -| monitors | []string| `[]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
+listType=atomic | | -| path | string| `string` | | | path is Optional: Used as the mounted root, rather than the full Ceph tree, default is /
+optional | | -| readOnly | boolean| `bool` | | | 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
+optional | | -| secretFile | string| `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
+optional | | +| monitors | []string| `[]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 | | +| path | string| `string` | | | path is Optional: Used as the mounted root, rather than the full Ceph tree, default is /
**Validation:** Optional.| | +| readOnly | boolean| `bool` | | | 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
**Validation:** Optional.| | +| secretFile | string| `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
**Validation:** Optional.| | | secretRef | [LocalObjectReference](#local-object-reference)| `LocalObjectReference` | | | | | -| user | string| `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
+optional | | +| user | string| `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
**Validation:** Optional.| | @@ -622,8 +616,8 @@ Cinder volumes support ownership management and SELinux relabeling. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| -| fsType | string| `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
+optional | | -| readOnly | boolean| `bool` | | | 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
+optional | | +| fsType | string| `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
**Validation:** Optional.| | +| readOnly | boolean| `bool` | | | 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
**Validation:** Optional.| | | secretRef | [LocalObjectReference](#local-object-reference)| `LocalObjectReference` | | | | | | volumeID | string| `string` | | | volumeID used to identify the volume in cinder.
More info: https://examples.k8s.io/mysql-cinder-pd/README.md | | @@ -665,10 +659,10 @@ filesystem. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| | labelSelector | [LabelSelector](#label-selector)| `LabelSelector` | | | | | -| name | string| `string` | | | Select a single ClusterTrustBundle by object name. Mutually-exclusive
with signerName and labelSelector.
+optional | | -| optional | boolean| `bool` | | | 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.
+optional | | +| name | string| `string` | | | Select a single ClusterTrustBundle by object name. Mutually-exclusive
with signerName and labelSelector.
**Validation:** Optional.| | +| optional | boolean| `bool` | | | 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.
**Validation:** Optional.| | | path | string| `string` | | | Relative path from the volume root to write the bundle. | | -| signerName | string| `string` | | | Select all ClusterTrustBundles that match this signer name.
Mutually-exclusive with name. The contents of all selected
ClusterTrustBundles will be unified and deduplicated.
+optional | | +| signerName | string| `string` | | | Select all ClusterTrustBundles that match this signer name.
Mutually-exclusive with name. The contents of all selected
ClusterTrustBundles will be unified and deduplicated.
**Validation:** Optional.| | @@ -687,15 +681,14 @@ key-value pairs as environment variables. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| -| name | string| `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
+optional
+default=""
+kubebuilder:default=""
TODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896. | | -| optional | boolean| `bool` | | | Specify whether the ConfigMap must be defined
+optional | | +| name | string| `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
TODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.
**Validation:** Optional; Default: "".| | +| optional | boolean| `bool` | | | Specify whether the ConfigMap must be defined
**Validation:** Optional.| | ### ConfigMapKeySelector -> +structType=atomic @@ -707,8 +700,8 @@ key-value pairs as environment variables. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| | key | string| `string` | | | The key to select. | | -| name | string| `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
+optional
+default=""
+kubebuilder:default=""
TODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896. | | -| optional | boolean| `bool` | | | Specify whether the ConfigMap or its key must be defined
+optional | | +| name | string| `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
TODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.
**Validation:** Optional; Default: "".| | +| optional | boolean| `bool` | | | Specify whether the ConfigMap or its key must be defined
**Validation:** Optional.| | @@ -730,9 +723,9 @@ mode. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| -| items | [][KeyToPath](#key-to-path)| `[]*KeyToPath` | | | 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 '..'.
+optional
+listType=atomic | | -| name | string| `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
+optional
+default=""
+kubebuilder:default=""
TODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896. | | -| optional | boolean| `bool` | | | optional specify whether the ConfigMap or its keys must be defined
+optional | | +| items | [][KeyToPath](#key-to-path)| `[]*KeyToPath` | | | 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 '..'.
**Validation:** Optional.| | +| name | string| `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
TODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.
**Validation:** Optional; Default: "".| | +| optional | boolean| `bool` | | | optional specify whether the ConfigMap or its keys must be defined
**Validation:** Optional.| | @@ -753,10 +746,10 @@ ConfigMap volumes support ownership management and SELinux relabeling. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| -| defaultMode | int32 (formatted integer)| `int32` | | | 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.
+optional | | -| items | [][KeyToPath](#key-to-path)| `[]*KeyToPath` | | | 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 '..'.
+optional
+listType=atomic | | -| name | string| `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
+optional
+default=""
+kubebuilder:default=""
TODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896. | | -| optional | boolean| `bool` | | | optional specify whether the ConfigMap or its keys must be defined
+optional | | +| defaultMode | int32 (formatted integer)| `int32` | | | 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.
**Validation:** Optional.| | +| items | [][KeyToPath](#key-to-path)| `[]*KeyToPath` | | | 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 '..'.
**Validation:** Optional.| | +| name | string| `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
TODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.
**Validation:** Optional; Default: "".| | +| optional | boolean| `bool` | | | optional specify whether the ConfigMap or its keys must be defined
**Validation:** Optional.| | @@ -771,30 +764,30 @@ ConfigMap volumes support ownership management and SELinux relabeling. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| -| args | []string| `[]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
+optional
+listType=atomic | | -| command | []string| `[]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
+optional
+listType=atomic | | -| env | [][EnvVar](#env-var)| `[]*EnvVar` | | | List of environment variables to set in the container.
Cannot be updated.
+optional
+patchMergeKey=name
+patchStrategy=merge
+listType=map
+listMapKey=name | | -| envFrom | [][EnvFromSource](#env-from-source)| `[]*EnvFromSource` | | | List of sources to populate environment variables in the container.
The keys defined within a source must be a C_IDENTIFIER. All invalid keys
will be reported as an event when the container is starting. When a key exists in multiple
sources, the value associated with the last source will take precedence.
Values defined by an Env with a duplicate key will take precedence.
Cannot be updated.
+optional
+listType=atomic | | -| image | string| `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.
+optional | | +| args | []string| `[]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
**Validation:** Optional.| | +| command | []string| `[]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
**Validation:** Optional.| | +| env | [][EnvVar](#env-var)| `[]*EnvVar` | | | List of environment variables to set in the container.
Cannot be updated.
**Validation:** Optional.| | +| envFrom | [][EnvFromSource](#env-from-source)| `[]*EnvFromSource` | | | List of sources to populate environment variables in the container.
The keys defined within a source must be a C_IDENTIFIER. All invalid keys
will be reported as an event when the container is starting. When a key exists in multiple
sources, the value associated with the last source will take precedence.
Values defined by an Env with a duplicate key will take precedence.
Cannot be updated.
**Validation:** Optional.| | +| image | string| `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.
**Validation:** Optional.| | | imagePullPolicy | [PullPolicy](#pull-policy)| `PullPolicy` | | | | | | lifecycle | [Lifecycle](#lifecycle)| `Lifecycle` | | | | | | livenessProbe | [Probe](#probe)| `Probe` | | | | | | name | string| `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. | | -| ports | [][ContainerPort](#container-port)| `[]*ContainerPort` | | | 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.
+optional
+patchMergeKey=containerPort
+patchStrategy=merge
+listType=map
+listMapKey=containerPort
+listMapKey=protocol | | +| ports | [][ContainerPort](#container-port)| `[]*ContainerPort` | | | 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.
**Validation:** Optional.| | | readinessProbe | [Probe](#probe)| `Probe` | | | | | -| resizePolicy | [][ContainerResizePolicy](#container-resize-policy)| `[]*ContainerResizePolicy` | | | Resources resize policy for the container.
+featureGate=InPlacePodVerticalScaling
+optional
+listType=atomic | | +| resizePolicy | [][ContainerResizePolicy](#container-resize-policy)| `[]*ContainerResizePolicy` | | | Resources resize policy for the container.
**Validation:** Optional.| | | resources | [ResourceRequirements](#resource-requirements)| `ResourceRequirements` | | | | | | restartPolicy | [ContainerRestartPolicy](#container-restart-policy)| `ContainerRestartPolicy` | | | | | | securityContext | [SecurityContext](#security-context)| `SecurityContext` | | | | | | startupProbe | [Probe](#probe)| `Probe` | | | | | -| stdin | boolean| `bool` | | | Whether this container should allocate a buffer for stdin in the container runtime. If this
is not set, reads from stdin in the container will always result in EOF.
Default is false.
+optional | | -| stdinOnce | boolean| `bool` | | | Whether the container runtime should close the stdin channel after it has been opened by
a single attach. When stdin is true the stdin stream will remain open across multiple attach
sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the
first client attaches to stdin, and then remains open and accepts data until the client disconnects,
at which time stdin is closed and remains closed until the container is restarted. If this
flag is false, a container processes that reads from stdin will never receive an EOF.
Default is false
+optional | | -| terminationMessagePath | string| `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.
+optional | | +| stdin | boolean| `bool` | | | 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.
**Validation:** Optional.| | +| stdinOnce | boolean| `bool` | | | 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
**Validation:** Optional.| | +| terminationMessagePath | string| `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.
**Validation:** Optional.| | | terminationMessagePolicy | [TerminationMessagePolicy](#termination-message-policy)| `TerminationMessagePolicy` | | | | | -| tty | boolean| `bool` | | | Whether this container should allocate a TTY for itself, also requires 'stdin' to be true.
Default is false.
+optional | | -| volumeDevices | [][VolumeDevice](#volume-device)| `[]*VolumeDevice` | | | volumeDevices is the list of block devices to be used by the container.
+patchMergeKey=devicePath
+patchStrategy=merge
+listType=map
+listMapKey=devicePath
+optional | | -| volumeMounts | [][VolumeMount](#volume-mount)| `[]*VolumeMount` | | | Pod volumes to mount into the container's filesystem.
Cannot be updated.
+optional
+patchMergeKey=mountPath
+patchStrategy=merge
+listType=map
+listMapKey=mountPath | | -| workingDir | string| `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.
+optional | | +| tty | boolean| `bool` | | | Whether this container should allocate a TTY for itself, also requires 'stdin' to be true.
Default is false.
**Validation:** Optional.| | +| volumeDevices | [][VolumeDevice](#volume-device)| `[]*VolumeDevice` | | | volumeDevices is the list of block devices to be used by the container.
**Validation:** Optional.| | +| volumeMounts | [][VolumeMount](#volume-mount)| `[]*VolumeMount` | | | Pod volumes to mount into the container's filesystem.
Cannot be updated.
**Validation:** Optional.| | +| workingDir | string| `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.
**Validation:** Optional.| | @@ -809,31 +802,31 @@ ConfigMap volumes support ownership management and SELinux relabeling. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| -| args | []string| `[]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
+optional
+listType=atomic | | -| command | []string| `[]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
+optional
+listType=atomic | | +| args | []string| `[]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
**Validation:** Optional.| | +| command | []string| `[]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
**Validation:** Optional.| | | dependencies | []string| `[]string` | | | | | -| env | [][EnvVar](#env-var)| `[]*EnvVar` | | | List of environment variables to set in the container.
Cannot be updated.
+optional
+patchMergeKey=name
+patchStrategy=merge
+listType=map
+listMapKey=name | | -| envFrom | [][EnvFromSource](#env-from-source)| `[]*EnvFromSource` | | | List of sources to populate environment variables in the container.
The keys defined within a source must be a C_IDENTIFIER. All invalid keys
will be reported as an event when the container is starting. When a key exists in multiple
sources, the value associated with the last source will take precedence.
Values defined by an Env with a duplicate key will take precedence.
Cannot be updated.
+optional
+listType=atomic | | -| image | string| `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.
+optional | | +| env | [][EnvVar](#env-var)| `[]*EnvVar` | | | List of environment variables to set in the container.
Cannot be updated.
**Validation:** Optional.| | +| envFrom | [][EnvFromSource](#env-from-source)| `[]*EnvFromSource` | | | List of sources to populate environment variables in the container.
The keys defined within a source must be a C_IDENTIFIER. All invalid keys
will be reported as an event when the container is starting. When a key exists in multiple
sources, the value associated with the last source will take precedence.
Values defined by an Env with a duplicate key will take precedence.
Cannot be updated.
**Validation:** Optional.| | +| image | string| `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.
**Validation:** Optional.| | | imagePullPolicy | [PullPolicy](#pull-policy)| `PullPolicy` | | | | | | lifecycle | [Lifecycle](#lifecycle)| `Lifecycle` | | | | | | livenessProbe | [Probe](#probe)| `Probe` | | | | | | name | string| `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. | | -| ports | [][ContainerPort](#container-port)| `[]*ContainerPort` | | | 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.
+optional
+patchMergeKey=containerPort
+patchStrategy=merge
+listType=map
+listMapKey=containerPort
+listMapKey=protocol | | +| ports | [][ContainerPort](#container-port)| `[]*ContainerPort` | | | 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.
**Validation:** Optional.| | | readinessProbe | [Probe](#probe)| `Probe` | | | | | -| resizePolicy | [][ContainerResizePolicy](#container-resize-policy)| `[]*ContainerResizePolicy` | | | Resources resize policy for the container.
+featureGate=InPlacePodVerticalScaling
+optional
+listType=atomic | | +| resizePolicy | [][ContainerResizePolicy](#container-resize-policy)| `[]*ContainerResizePolicy` | | | Resources resize policy for the container.
**Validation:** Optional.| | | resources | [ResourceRequirements](#resource-requirements)| `ResourceRequirements` | | | | | | restartPolicy | [ContainerRestartPolicy](#container-restart-policy)| `ContainerRestartPolicy` | | | | | | securityContext | [SecurityContext](#security-context)| `SecurityContext` | | | | | | startupProbe | [Probe](#probe)| `Probe` | | | | | -| stdin | boolean| `bool` | | | Whether this container should allocate a buffer for stdin in the container runtime. If this
is not set, reads from stdin in the container will always result in EOF.
Default is false.
+optional | | -| stdinOnce | boolean| `bool` | | | Whether the container runtime should close the stdin channel after it has been opened by
a single attach. When stdin is true the stdin stream will remain open across multiple attach
sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the
first client attaches to stdin, and then remains open and accepts data until the client disconnects,
at which time stdin is closed and remains closed until the container is restarted. If this
flag is false, a container processes that reads from stdin will never receive an EOF.
Default is false
+optional | | -| terminationMessagePath | string| `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.
+optional | | +| stdin | boolean| `bool` | | | 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.
**Validation:** Optional.| | +| stdinOnce | boolean| `bool` | | | 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
**Validation:** Optional.| | +| terminationMessagePath | string| `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.
**Validation:** Optional.| | | terminationMessagePolicy | [TerminationMessagePolicy](#termination-message-policy)| `TerminationMessagePolicy` | | | | | -| tty | boolean| `bool` | | | Whether this container should allocate a TTY for itself, also requires 'stdin' to be true.
Default is false.
+optional | | -| volumeDevices | [][VolumeDevice](#volume-device)| `[]*VolumeDevice` | | | volumeDevices is the list of block devices to be used by the container.
+patchMergeKey=devicePath
+patchStrategy=merge
+listType=map
+listMapKey=devicePath
+optional | | -| volumeMounts | [][VolumeMount](#volume-mount)| `[]*VolumeMount` | | | Pod volumes to mount into the container's filesystem.
Cannot be updated.
+optional
+patchMergeKey=mountPath
+patchStrategy=merge
+listType=map
+listMapKey=mountPath | | -| workingDir | string| `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.
+optional | | +| tty | boolean| `bool` | | | Whether this container should allocate a TTY for itself, also requires 'stdin' to be true.
Default is false.
**Validation:** Optional.| | +| volumeDevices | [][VolumeDevice](#volume-device)| `[]*VolumeDevice` | | | volumeDevices is the list of block devices to be used by the container.
**Validation:** Optional.| | +| volumeMounts | [][VolumeMount](#volume-mount)| `[]*VolumeMount` | | | Pod volumes to mount into the container's filesystem.
Cannot be updated.
**Validation:** Optional.| | +| workingDir | string| `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.
**Validation:** Optional.| | @@ -849,9 +842,9 @@ ConfigMap volumes support ownership management and SELinux relabeling. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| | containerPort | int32 (formatted integer)| `int32` | | | Number of port to expose on the pod's IP address.
This must be a valid port number, 0 < x < 65536. | | -| hostIP | string| `string` | | | What host IP to bind the external port to.
+optional | | -| hostPort | int32 (formatted integer)| `int32` | | | Number of port to expose on the host.
If specified, this must be a valid port number, 0 < x < 65536.
If HostNetwork is specified, this must match ContainerPort.
Most containers do not need this.
+optional | | -| name | string| `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.
+optional | | +| hostIP | string| `string` | | | What host IP to bind the external port to.
**Validation:** Optional.| | +| hostPort | int32 (formatted integer)| `int32` | | | 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.
**Validation:** Optional.| | +| name | string| `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.
**Validation:** Optional.| | | protocol | [Protocol](#protocol)| `Protocol` | | | | | @@ -936,8 +929,8 @@ ConfigMap volumes support ownership management and SELinux relabeling. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| -| error | boolean| `bool` | | | +optional | | -| failed | boolean| `bool` | | | +optional | | +| error | boolean| `bool` | | |
**Validation:** Optional.| | +| failed | boolean| `bool` | | |
**Validation:** Optional.| | @@ -955,7 +948,7 @@ ConfigMap volumes support ownership management and SELinux relabeling. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| -| value | string| `string` | | | Value is the value of the metric
+kubebuilder:validation:MinLength=1 | | +| value | string| `string` | | | Value is the value of the metric
**Validation:** Minimum length: 1.| | @@ -982,9 +975,6 @@ ConfigMap volumes support ownership management and SELinux relabeling. > DAGTask represents a node in the graph during DAG execution Note: CEL validation cannot check withItems (Schemaless) or inline (PreserveUnknownFields) fields. -+kubebuilder:validation:XValidation:rule="!has(self.depends) || !has(self.dependencies)",message="cannot use both 'depends' and 'dependencies'" -+kubebuilder:validation:XValidation:rule="!has(self.depends) || !has(self.continueOn)",message="cannot use 'continueOn' when using 'depends'" -+kubebuilder:validation:XValidation:rule="!(has(self.depends) || has(self.dependencies)) || !self.name.matches('^[0-9]')",message="task name cannot begin with a digit when using 'depends' or 'dependencies'" @@ -1001,12 +991,12 @@ Note: CEL validation cannot check withItems (Schemaless) or inline (PreserveUnkn | depends | string| `string` | | | Depends are name of other targets which this depends on | | | hooks | [LifecycleHooks](#lifecycle-hooks)| `LifecycleHooks` | | | | | | inline | [Template](#template)| `Template` | | | | | -| name | string| `string` | | | Name is the name of the target
+kubebuilder:validation:MaxLength=128
+kubebuilder:validation:Pattern=`^[a-zA-Z0-9][-a-zA-Z0-9]*$` | | +| name | string| `string` | | | Name is the name of the target
**Validation:** Maximum length: 128; Pattern: `^[a-zA-Z0-9][-a-zA-Z0-9]*$`.| | | onExit | string| `string` | | | OnExit is a template reference which is invoked at the end of the
template, irrespective of the success, failure, or error of the
primary template.
DEPRECATED: Use Hooks[exit].Template instead. | | | template | string| `string` | | | Name of template to execute | | | templateRef | [TemplateRef](#template-ref)| `TemplateRef` | | | | | | when | string| `string` | | | When is an expression in which the task should conditionally execute | | -| withItems | [][Item](#item)| `[]Item` | | | WithItems expands a task into multiple parallel tasks from the items in the list
Note: The structure of WithItems is free-form, so we need
"x-kubernetes-preserve-unknown-fields: true" in the validation schema.
+kubebuilder:validation:Schemaless
+kubebuilder:pruning:PreserveUnknownFields | | +| withItems | [][Item](#item)| `[]Item` | | | WithItems expands a task into multiple parallel tasks from the items in the list
Note: The structure of WithItems is free-form, so we need
"x-kubernetes-preserve-unknown-fields: true" in the validation schema. | | | withParam | string| `string` | | | WithParam expands a task into multiple parallel tasks from the value in the parameter,
which is expected to be a JSON list. | | | withSequence | [Sequence](#sequence)| `Sequence` | | | | | @@ -1028,7 +1018,7 @@ Note: CEL validation cannot check withItems (Schemaless) or inline (PreserveUnkn |------|------|---------|:--------:| ------- |-------------|---------| | failFast | boolean| `bool` | | | This flag is for DAG logic. The DAG logic has a built-in "fail fast" feature to stop scheduling new steps,
as soon as it detects that one of the DAG nodes is failed. Then it waits until all DAG nodes are completed
before failing the DAG itself.
The FailFast flag default is true, if set to false, it will allow a DAG to run all branches of the DAG to
completion (either success or failure), regardless of the failed outcomes of branches in the DAG.
More info and example about this feature at https://github.com/argoproj/argo-workflows/issues/1442 | | | target | string| `string` | | | Target are one or more names of targets to execute in a DAG | | -| tasks | [][DAGTask](#d-a-g-task)| `[]*DAGTask` | | | Tasks are a list of DAG tasks
MaxItems is an artificial limit to limit CEL validation costs - see note at top of file
+patchStrategy=merge
+patchMergeKey=name
+kubebuilder:validation:MinItems=1
+kubebuilder:validation:MaxItems=200 | | +| tasks | [][DAGTask](#d-a-g-task)| `[]*DAGTask` | | | Tasks are a list of DAG tasks
MaxItems is an artificial limit to limit CEL validation costs - see note at top of file
**Validation:** Minimum items: 1; Maximum items: 200.| | @@ -1084,7 +1074,7 @@ mode. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| -| items | [][DownwardAPIVolumeFile](#downward-api-volume-file)| `[]*DownwardAPIVolumeFile` | | | Items is a list of DownwardAPIVolume file
+optional
+listType=atomic | | +| items | [][DownwardAPIVolumeFile](#downward-api-volume-file)| `[]*DownwardAPIVolumeFile` | | | Items is a list of DownwardAPIVolume file
**Validation:** Optional.| | @@ -1103,7 +1093,7 @@ mode. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| | fieldRef | [ObjectFieldSelector](#object-field-selector)| `ObjectFieldSelector` | | | | | -| mode | int32 (formatted integer)| `int32` | | | 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.
+optional | | +| mode | int32 (formatted integer)| `int32` | | | 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.
**Validation:** Optional.| | | path | string| `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 '..' | | | resourceFieldRef | [ResourceFieldSelector](#resource-field-selector)| `ResourceFieldSelector` | | | | | @@ -1123,8 +1113,8 @@ mode. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| -| defaultMode | int32 (formatted integer)| `int32` | | | 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.
+optional | | -| items | [][DownwardAPIVolumeFile](#downward-api-volume-file)| `[]*DownwardAPIVolumeFile` | | | Items is a list of downward API volume file
+optional
+listType=atomic | | +| defaultMode | int32 (formatted integer)| `int32` | | | 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.
**Validation:** Optional.| | +| items | [][DownwardAPIVolumeFile](#downward-api-volume-file)| `[]*DownwardAPIVolumeFile` | | | Items is a list of downward API volume file
**Validation:** Optional.| | @@ -1174,7 +1164,7 @@ can be used as map keys in json. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| | configMapRef | [ConfigMapEnvSource](#config-map-env-source)| `ConfigMapEnvSource` | | | | | -| prefix | string| `string` | | | Optional text to prepend to the name of each environment variable. Must be a C_IDENTIFIER.
+optional | | +| prefix | string| `string` | | | Optional text to prepend to the name of each environment variable. Must be a C_IDENTIFIER.
**Validation:** Optional.| | | secretRef | [SecretEnvSource](#secret-env-source)| `SecretEnvSource` | | | | | @@ -1191,7 +1181,7 @@ can be used as map keys in json. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| | name | string| `string` | | | Name of the environment variable. Must be a C_IDENTIFIER. | | -| value | string| `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 "".
+optional | | +| value | string| `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 "".
**Validation:** Optional.| | | valueFrom | [EnvVarSource](#env-var-source)| `EnvVarSource` | | | | | @@ -1240,7 +1230,7 @@ can be used as map keys in json. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| -| command | []string| `[]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.
+optional
+listType=atomic | | +| command | []string| `[]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.
**Validation:** Optional.| | @@ -1306,11 +1296,11 @@ Fibre Channel volumes support ownership management and SELinux relabeling. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| -| fsType | string| `string` | | | fsType is the filesystem type to mount.
Must be a filesystem type supported by the host operating system.
Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
TODO: how do we prevent errors in the filesystem from compromising the machine
+optional | | -| lun | int32 (formatted integer)| `int32` | | | lun is Optional: FC target lun number
+optional | | -| readOnly | boolean| `bool` | | | readOnly is Optional: Defaults to false (read/write). ReadOnly here will force
the ReadOnly setting in VolumeMounts.
+optional | | -| targetWWNs | []string| `[]string` | | | targetWWNs is Optional: FC target worldwide names (WWNs)
+optional
+listType=atomic | | -| wwids | []string| `[]string` | | | wwids Optional: FC volume world wide identifiers (wwids)
Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously.
+optional
+listType=atomic | | +| fsType | string| `string` | | | fsType is the filesystem type to mount.
Must be a filesystem type supported by the host operating system.
Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
TODO: how do we prevent errors in the filesystem from compromising the machine
**Validation:** Optional.| | +| lun | int32 (formatted integer)| `int32` | | | lun is Optional: FC target lun number
**Validation:** Optional.| | +| readOnly | boolean| `bool` | | | readOnly is Optional: Defaults to false (read/write). ReadOnly here will force
the ReadOnly setting in VolumeMounts.
**Validation:** Optional.| | +| targetWWNs | []string| `[]string` | | | targetWWNs is Optional: FC target worldwide names (WWNs)
**Validation:** Optional.| | +| wwids | []string| `[]string` | | | wwids Optional: FC volume world wide identifiers (wwids)
Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously.
**Validation:** Optional.| | @@ -1326,7 +1316,6 @@ or a string representing a sub-field or item. The string will follow one of thes If a key maps to an empty Fields value, the field that key represents is part of the set. The exact format is defined in sigs.k8s.io/structured-merge-diff -+protobuf.options.(gogoproto.goproto_stringer)=false @@ -1349,9 +1338,9 @@ provisioned/attached using an exec based plugin. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| | driver | string| `string` | | | driver is the name of the driver to use for this volume. | | -| fsType | string| `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.
+optional | | -| options | map of string| `map[string]string` | | | options is Optional: this field holds extra command options if any.
+optional | | -| readOnly | boolean| `bool` | | | readOnly is Optional: defaults to false (read/write). ReadOnly here will force
the ReadOnly setting in VolumeMounts.
+optional | | +| fsType | string| `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.
**Validation:** Optional.| | +| options | map of string| `map[string]string` | | | options is Optional: this field holds extra command options if any.
**Validation:** Optional.| | +| readOnly | boolean| `bool` | | | readOnly is Optional: defaults to false (read/write). ReadOnly here will force
the ReadOnly setting in VolumeMounts.
**Validation:** Optional.| | | secretRef | [LocalObjectReference](#local-object-reference)| `LocalObjectReference` | | | | | @@ -1371,8 +1360,8 @@ Flocker volumes do not support ownership management or SELinux relabeling. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| -| datasetName | string| `string` | | | datasetName is Name of the dataset stored as metadata -> name on the dataset for Flocker
should be considered as deprecated
+optional | | -| datasetUUID | string| `string` | | | datasetUUID is the UUID of the dataset. This is unique identifier of a Flocker dataset
+optional | | +| datasetName | string| `string` | | | datasetName is Name of the dataset stored as metadata -> name on the dataset for Flocker
should be considered as deprecated
**Validation:** Optional.| | +| datasetUUID | string| `string` | | | datasetUUID is the UUID of the dataset. This is unique identifier of a Flocker dataset
**Validation:** Optional.| | @@ -1393,10 +1382,10 @@ PDs support ownership management and SELinux relabeling. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| -| fsType | string| `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
TODO: how do we prevent errors in the filesystem from compromising the machine
+optional | | -| partition | int32 (formatted integer)| `int32` | | | 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
+optional | | +| fsType | string| `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
TODO: how do we prevent errors in the filesystem from compromising the machine
**Validation:** Optional.| | +| partition | int32 (formatted integer)| `int32` | | | 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
**Validation:** Optional.| | | pdName | string| `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 | | -| readOnly | boolean| `bool` | | | readOnly here will force the ReadOnly setting in VolumeMounts.
Defaults to false.
More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
+optional | | +| readOnly | boolean| `bool` | | | readOnly here will force the ReadOnly setting in VolumeMounts.
Defaults to false.
More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
**Validation:** Optional.| | @@ -1432,7 +1421,7 @@ PDs support ownership management and SELinux relabeling. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| | port | int32 (formatted integer)| `int32` | | | Port number of the gRPC service. Number must be in the range 1 to 65535. | | -| service | string| `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.
+optional
+default="" | | +| service | string| `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.
**Validation:** Optional; Default: "".| | @@ -1440,7 +1429,6 @@ PDs support ownership management and SELinux relabeling. > Gauge is a Gauge prometheus metric -+kubebuilder:validation:XValidation:rule="!has(self.realtime) || !self.realtime || !self.value.contains('resourcesDuration.')",message="'resourcesDuration.*' metrics cannot be used in real-time gauges" @@ -1453,21 +1441,20 @@ PDs support ownership management and SELinux relabeling. |------|------|---------|:--------:| ------- |-------------|---------| | operation | [GaugeOperation](#gauge-operation)| `GaugeOperation` | | | | | | realtime | boolean| `bool` | | | Realtime emits this metric in real time if applicable | | -| value | string| `string` | | | Value is the value to be used in the operation with the metric's current value. If no operation is set,
value is the value of the metric
MaxLength is an artificial limit to limit CEL validation costs - see note at top of file
+kubebuilder:validation:MinLength=1
+kubebuilder:validation:MaxLength=256 | | +| value | string| `string` | | | Value is the value to be used in the operation with the metric's current value. If no operation is set,
value is the value of the metric
MaxLength is an artificial limit to limit CEL validation costs - see note at top of file
**Validation:** Minimum length: 1; Maximum length: 256.| | ### GaugeOperation -> +kubebuilder:validation:Enum=Set;Add;Sub | Name | Type | Go type | Default | Description | Example | |------|------|---------| ------- |-------------|---------| -| GaugeOperation | string| string | | +kubebuilder:validation:Enum=Set;Add;Sub | | +| GaugeOperation | string| string | |
**Validation:** Valid values: Set, Add, Sub.| | @@ -1516,9 +1503,9 @@ into the Pod's container. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| -| directory | string| `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.
+optional | | +| directory | string| `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.
**Validation:** Optional.| | | repository | string| `string` | | | repository is the URL | | -| revision | string| `string` | | | revision is the commit hash for the specified revision.
+optional | | +| revision | string| `string` | | | revision is the commit hash for the specified revision.
**Validation:** Optional.| | @@ -1538,7 +1525,7 @@ into the Pod's container. |------|------|---------|:--------:| ------- |-------------|---------| | endpoints | string| `string` | | | endpoints is the endpoint name that details Glusterfs topology.
More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod | | | path | string| `string` | | | path is the Glusterfs volume path.
More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod | | -| readOnly | boolean| `bool` | | | readOnly here will force the Glusterfs volume to be mounted with read-only permissions.
Defaults to false.
More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
+optional | | +| readOnly | boolean| `bool` | | | 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
**Validation:** Optional.| | @@ -1655,9 +1642,9 @@ into the Pod's container. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| -| host | string| `string` | | | Host name to connect to, defaults to the pod IP. You probably want to set
"Host" in httpHeaders instead.
+optional | | -| httpHeaders | [][HTTPHeader](#http-header)| `[]*HTTPHeader` | | | Custom headers to set in the request. HTTP allows repeated headers.
+optional
+listType=atomic | | -| path | string| `string` | | | Path to access on the HTTP server.
+optional | | +| host | string| `string` | | | Host name to connect to, defaults to the pod IP. You probably want to set
"Host" in httpHeaders instead.
**Validation:** Optional.| | +| httpHeaders | [][HTTPHeader](#http-header)| `[]*HTTPHeader` | | | Custom headers to set in the request. HTTP allows repeated headers.
**Validation:** Optional.| | +| path | string| `string` | | | Path to access on the HTTP server.
**Validation:** Optional.| | | port | [IntOrString](#int-or-string)| `IntOrString` | | | | | | scheme | [URIScheme](#uri-scheme)| `URIScheme` | | | | | @@ -1736,7 +1723,7 @@ into the Pod's container. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| | buckets | [][Amount](#amount)| `[]Amount` | | | Buckets is a list of bucket divisors for the histogram | | -| value | string| `string` | | | Value is the value of the metric
+kubebuilder:validation:MinLength=1 | | +| value | string| `string` | | | Value is the value of the metric
**Validation:** Minimum length: 1.| | @@ -1755,22 +1742,21 @@ pod's hosts file. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| -| hostnames | []string| `[]string` | | | Hostnames for the above IP address.
+listType=atomic | | -| ip | string| `string` | | | IP address of the host file entry.
+required | | +| hostnames | []string| `[]string` | | | Hostnames for the above IP address. | | +| ip | string| `string` | | | IP address of the host file entry.
**Validation:** Required.| | ### HostPathType -> +enum | Name | Type | Go type | Default | Description | Example | |------|------|---------| ------- |-------------|---------| -| HostPathType | string| string | | +enum | | +| HostPathType | string| string | | | | @@ -1808,15 +1794,15 @@ ISCSI volumes support ownership management and SELinux relabeling. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| -| chapAuthDiscovery | boolean| `bool` | | | chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication
+optional | | -| chapAuthSession | boolean| `bool` | | | chapAuthSession defines whether support iSCSI Session CHAP authentication
+optional | | -| fsType | string| `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
TODO: how do we prevent errors in the filesystem from compromising the machine
+optional | | -| initiatorName | string| `string` | | | initiatorName is the custom iSCSI Initiator Name.
If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface
: will be created for the connection.
+optional | | +| chapAuthDiscovery | boolean| `bool` | | | chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication
**Validation:** Optional.| | +| chapAuthSession | boolean| `bool` | | | chapAuthSession defines whether support iSCSI Session CHAP authentication
**Validation:** Optional.| | +| fsType | string| `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
TODO: how do we prevent errors in the filesystem from compromising the machine
**Validation:** Optional.| | +| initiatorName | string| `string` | | | initiatorName is the custom iSCSI Initiator Name.
If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface
: will be created for the connection.
**Validation:** Optional.| | | iqn | string| `string` | | | iqn is the target iSCSI Qualified Name. | | -| iscsiInterface | string| `string` | | | iscsiInterface is the interface Name that uses an iSCSI transport.
Defaults to 'default' (tcp).
+optional
+default="default" | | +| iscsiInterface | string| `string` | | | iscsiInterface is the interface Name that uses an iSCSI transport.
Defaults to 'default' (tcp).
**Validation:** Optional; Default: "default".| | | lun | int32 (formatted integer)| `int32` | | | lun represents iSCSI Target Lun number. | | -| portals | []string| `[]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).
+optional
+listType=atomic | | -| readOnly | boolean| `bool` | | | readOnly here will force the ReadOnly setting in VolumeMounts.
Defaults to false.
+optional | | +| portals | []string| `[]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).
**Validation:** Optional.| | +| readOnly | boolean| `bool` | | | readOnly here will force the ReadOnly setting in VolumeMounts.
Defaults to false.
**Validation:** Optional.| | | secretRef | [LocalObjectReference](#local-object-reference)| `LocalObjectReference` | | | | | | targetPortal | string| `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). | | @@ -1834,7 +1820,7 @@ ISCSI volumes support ownership management and SELinux relabeling. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| | pullPolicy | [PullPolicy](#pull-policy)| `PullPolicy` | | | | | -| reference | string| `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.
+optional | | +| reference | string| `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.
**Validation:** Optional.| | @@ -1853,16 +1839,14 @@ ISCSI volumes support ownership management and SELinux relabeling. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| | artifacts | [Artifacts](#artifacts)| `Artifacts` | | | | | -| parameters | [][Parameter](#parameter)| `[]*Parameter` | | | Parameters are a list of parameters passed as inputs
MaxItems is an artificial limit to limit CEL validation costs - see note at top of file
+patchStrategy=merge
+patchMergeKey=name
+kubebuilder:validation:MaxItems=500 | | +| parameters | [][Parameter](#parameter)| `[]*Parameter` | | | Parameters are a list of parameters passed as inputs
MaxItems is an artificial limit to limit CEL validation costs - see note at top of file
**Validation:** Maximum items: 500.| | ### IntOrString -> +protobuf=true -+protobuf.options.(gogoproto.goproto_stringer)=false -+k8s:openapi-gen=true + @@ -1882,7 +1866,6 @@ ISCSI volumes support ownership management and SELinux relabeling. ### Item -> +protobuf.options.(gogoproto.goproto_stringer)=false @@ -1901,7 +1884,7 @@ ISCSI volumes support ownership management and SELinux relabeling. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| | key | string| `string` | | | key is the key to project. | | -| mode | int32 (formatted integer)| `int32` | | | 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.
+optional | | +| mode | int32 (formatted integer)| `int32` | | | 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.
**Validation:** Optional.| | | path | string| `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 '..'. | | @@ -1912,7 +1895,6 @@ ISCSI volumes support ownership management and SELinux relabeling. > A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. -+structType=atomic @@ -1923,8 +1905,8 @@ label selector matches no objects. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| -| matchExpressions | [][LabelSelectorRequirement](#label-selector-requirement)| `[]*LabelSelectorRequirement` | | | matchExpressions is a list of label selector requirements. The requirements are ANDed.
+optional
+listType=atomic | | -| matchLabels | map of string| `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.
+optional | | +| matchExpressions | [][LabelSelectorRequirement](#label-selector-requirement)| `[]*LabelSelectorRequirement` | | | matchExpressions is a list of label selector requirements. The requirements are ANDed.
**Validation:** Optional.| | +| matchLabels | map of string| `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.
**Validation:** Optional.| | @@ -1956,7 +1938,7 @@ relates the key and values. |------|------|---------|:--------:| ------- |-------------|---------| | key | string| `string` | | | key is the label key that the selector applies to. | | | operator | [LabelSelectorOperator](#label-selector-operator)| `LabelSelectorOperator` | | | | | -| values | []string| `[]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.
+optional
+listType=atomic | | +| values | []string| `[]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.
**Validation:** Optional.| | @@ -2042,7 +2024,6 @@ will affect numerous schemas. Don't make new APIs embed an underspecified API t Instead of using this type, create a locally provided and used type that is well-focused on your reference. For example, ServiceReferences for admission registration: https://github.com/kubernetes/api/blob/release-1.17/admissionregistration/v1/types.go#L533 . -+structType=atomic @@ -2053,7 +2034,7 @@ For example, ServiceReferences for admission registration: https://github.com/ku | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| -| name | string| `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
+optional
+default=""
+kubebuilder:default=""
TODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896. | | +| name | string| `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
TODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.
**Validation:** Optional; Default: "".| | @@ -2078,7 +2059,7 @@ that the fieldset applies to. | manager | string| `string` | | | Manager is an identifier of the workflow managing these fields. | | | operation | [ManagedFieldsOperationType](#managed-fields-operation-type)| `ManagedFieldsOperationType` | | | | | | subresource | string| `string` | | | Subresource is the name of the subresource used to update that object, or
empty string if the object was updated through the main resource. The
value of this field is used to distinguish between managers, even if they
share the same name. For example, a status update will be distinct from a
regular update using the same manager name.
Note that the APIVersion field is not related to the Subresource field and
it always corresponds to the version of the main resource. | | -| time | string| `string` | | | Time is the timestamp of when the ManagedFields entry was added. The
timestamp will also be updated if a field is added, the manager
changes any of the owned fields value or removes a field. The
timestamp does not update when a field is removed from the entry
because another manager took it over.
+optional | | +| time | string| `string` | | | Time is the timestamp of when the ManagedFields entry was added. The
timestamp will also be updated if a field is added, the manager
changes any of the owned fields value or removes a field. The
timestamp does not update when a field is removed from the entry
because another manager took it over.
**Validation:** Optional.| | @@ -2161,7 +2142,7 @@ that the fieldset applies to. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| -| key | string| `string` | | | +kubebuilder:validation:Pattern=`^[a-zA-Z_][a-zA-Z0-9_]*$` | | +| key | string| `string` | | |
**Validation:** Pattern: `^[a-zA-Z_][a-zA-Z0-9_]*$`.| | | value | string| `string` | | | | | @@ -2180,21 +2161,20 @@ that the fieldset applies to. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| -| prometheus | [][Prometheus](#prometheus)| `[]*Prometheus` | | | Prometheus is a list of prometheus metrics to be emitted
MaxItems is an artificial limit to limit CEL validation costs - see note at top of file
+kubebuilder:validation:MaxItems=100 | | +| prometheus | [][Prometheus](#prometheus)| `[]*Prometheus` | | | Prometheus is a list of prometheus metrics to be emitted
MaxItems is an artificial limit to limit CEL validation costs - see note at top of file
**Validation:** Maximum items: 100.| | ### MountPropagationMode -> +enum | Name | Type | Go type | Default | Description | Example | |------|------|---------| ------- |-------------|---------| -| MountPropagationMode | string| string | | +enum | | +| MountPropagationMode | string| string | | | | @@ -2233,7 +2213,7 @@ that the fieldset applies to. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| | path | string| `string` | | | path that is exported by the NFS server.
More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs | | -| readOnly | boolean| `bool` | | | readOnly here will force the NFS export to be mounted with read-only permissions.
Defaults to false.
More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
+optional | | +| readOnly | boolean| `bool` | | | 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
**Validation:** Optional.| | | server | string| `string` | | | server is the hostname or IP address of the NFS server.
More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs | | @@ -2249,7 +2229,7 @@ that the fieldset applies to. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| -| preferredDuringSchedulingIgnoredDuringExecution | [][PreferredSchedulingTerm](#preferred-scheduling-term)| `[]*PreferredSchedulingTerm` | | | The scheduler will prefer to schedule pods to nodes that satisfy
the affinity expressions specified by this field, but it may choose
a node that violates one or more of the expressions. The node that is
most preferred is the one with the greatest sum of weights, i.e.
for each node that meets all of the scheduling requirements (resource
request, requiredDuringScheduling affinity expressions, etc.),
compute a sum by iterating through the elements of this field and adding
"weight" to the sum if the node matches the corresponding matchExpressions; the
node(s) with the highest sum are the most preferred.
+optional
+listType=atomic | | +| preferredDuringSchedulingIgnoredDuringExecution | [][PreferredSchedulingTerm](#preferred-scheduling-term)| `[]*PreferredSchedulingTerm` | | | 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.
**Validation:** Optional.| | | requiredDuringSchedulingIgnoredDuringExecution | [NodeSelector](#node-selector)| `NodeSelector` | | | | | @@ -2289,7 +2269,6 @@ that the fieldset applies to. > A node selector represents the union of the results of one or more label queries over a set of nodes; that is, it represents the OR of the selectors represented by the node selector terms. -+structType=atomic @@ -2300,7 +2279,7 @@ by the node selector terms. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| -| nodeSelectorTerms | [][NodeSelectorTerm](#node-selector-term)| `[]*NodeSelectorTerm` | | | Required. A list of node selector terms. The terms are ORed.
+listType=atomic | | +| nodeSelectorTerms | [][NodeSelectorTerm](#node-selector-term)| `[]*NodeSelectorTerm` | | | Required. A list of node selector terms. The terms are ORed. | | @@ -2309,14 +2288,13 @@ by the node selector terms. > A node selector operator is the set of operators that can be used in a node selector requirement. -+enum | Name | Type | Go type | Default | Description | Example | |------|------|---------| ------- |-------------|---------| -| NodeSelectorOperator | string| string | | A node selector operator is the set of operators that can be used in
a node selector requirement.
+enum | | +| NodeSelectorOperator | string| string | | A node selector operator is the set of operators that can be used in
a node selector requirement.| | @@ -2337,7 +2315,7 @@ that relates the key and values. |------|------|---------|:--------:| ------- |-------------|---------| | key | string| `string` | | | The label key that the selector applies to. | | | operator | [NodeSelectorOperator](#node-selector-operator)| `NodeSelectorOperator` | | | | | -| values | []string| `[]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.
+optional
+listType=atomic | | +| values | []string| `[]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.
**Validation:** Optional.| | @@ -2347,7 +2325,6 @@ that relates the key and values. > A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm. -+structType=atomic @@ -2358,8 +2335,8 @@ The TopologySelectorTerm type implements a subset of the NodeSelectorTerm. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| -| matchExpressions | [][NodeSelectorRequirement](#node-selector-requirement)| `[]*NodeSelectorRequirement` | | | A list of node selector requirements by node's labels.
+optional
+listType=atomic | | -| matchFields | [][NodeSelectorRequirement](#node-selector-requirement)| `[]*NodeSelectorRequirement` | | | A list of node selector requirements by node's fields.
+optional
+listType=atomic | | +| matchExpressions | [][NodeSelectorRequirement](#node-selector-requirement)| `[]*NodeSelectorRequirement` | | | A list of node selector requirements by node's labels.
**Validation:** Optional.| | +| matchFields | [][NodeSelectorRequirement](#node-selector-requirement)| `[]*NodeSelectorRequirement` | | | A list of node selector requirements by node's fields.
**Validation:** Optional.| | @@ -2464,7 +2441,6 @@ save/load the directory appropriately. ### ObjectFieldSelector -> +structType=atomic @@ -2475,7 +2451,7 @@ save/load the directory appropriately. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| -| apiVersion | string| `string` | | | Version of the schema the FieldPath is written in terms of, defaults to "v1".
+optional | | +| apiVersion | string| `string` | | | Version of the schema the FieldPath is written in terms of, defaults to "v1".
**Validation:** Optional.| | | fieldPath | string| `string` | | | Path of the field to select in the specified API version. | | @@ -2513,7 +2489,7 @@ save/load the directory appropriately. |------|------|---------|:--------:| ------- |-------------|---------| | artifacts | [Artifacts](#artifacts)| `Artifacts` | | | | | | exitCode | string| `string` | | | ExitCode holds the exit code of a script template | | -| parameters | [][Parameter](#parameter)| `[]*Parameter` | | | Parameters holds the list of output parameters produced by a step
+patchStrategy=merge
+patchMergeKey=name | | +| parameters | [][Parameter](#parameter)| `[]*Parameter` | | | Parameters holds the list of output parameters produced by a step | | | result | string| `string` | | | Result holds the result (stdout) of a script or container template, or the response body of an HTTP template | | @@ -2524,7 +2500,6 @@ save/load the directory appropriately. > OwnerReference contains enough information to let you identify an owning object. An owning object must be in the same namespace as the dependent, or be cluster-scoped, so there is no namespace field. -+structType=atomic @@ -2536,8 +2511,8 @@ be cluster-scoped, so there is no namespace field. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| | apiVersion | string| `string` | | | API version of the referent. | | -| blockOwnerDeletion | boolean| `bool` | | | If true, AND if the owner has the "foregroundDeletion" finalizer, then
the owner cannot be deleted from the key-value store until this
reference is removed.
See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion
for how the garbage collector interacts with this field and enforces the foreground deletion.
Defaults to false.
To set this field, a user needs "delete" permission of the owner,
otherwise 422 (Unprocessable Entity) will be returned.
+optional | | -| controller | boolean| `bool` | | | If true, this reference points to the managing controller.
+optional | | +| blockOwnerDeletion | boolean| `bool` | | | If true, AND if the owner has the "foregroundDeletion" finalizer, then
the owner cannot be deleted from the key-value store until this
reference is removed.
See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion
for how the garbage collector interacts with this field and enforces the foreground deletion.
Defaults to false.
To set this field, a user needs "delete" permission of the owner,
otherwise 422 (Unprocessable Entity) will be returned.
**Validation:** Optional.| | +| controller | boolean| `bool` | | | If true, this reference points to the managing controller.
**Validation:** Optional.| | | kind | string| `string` | | | Kind of the referent.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | | | name | string| `string` | | | Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names | | | uid | [UID](#uid)| `UID` | | | | | @@ -2567,9 +2542,9 @@ be cluster-scoped, so there is no namespace field. |------|------|---------|:--------:| ------- |-------------|---------| | default | [AnyString](#any-string)| `AnyString` | | | | | | description | [AnyString](#any-string)| `AnyString` | | | | | -| enum | [][AnyString](#any-string)| `[]AnyString` | | | Enum holds a list of string values to choose from, for the actual value of the parameter
+kubebuilder:validation:MinItems=1 | | +| enum | [][AnyString](#any-string)| `[]AnyString` | | | Enum holds a list of string values to choose from, for the actual value of the parameter
**Validation:** Minimum items: 1.| | | globalName | string| `string` | | | GlobalName exports an output parameter to the global scope, making it available as
'{{workflow.outputs.parameters.XXXX}} and in workflow.status.outputs.parameters | | -| name | string| `string` | | | Name is the parameter name
+kubebuilder:validation:Pattern=`^[-a-zA-Z0-9_]+$` | | +| name | string| `string` | | | Name is the parameter name
**Validation:** Pattern: `^[-a-zA-Z0-9_]+$`.| | | value | [AnyString](#any-string)| `AnyString` | | | | | | valueFrom | [ValueFrom](#value-from)| `ValueFrom` | | | | | @@ -2578,14 +2553,13 @@ be cluster-scoped, so there is no namespace field. ### PersistentVolumeAccessMode -> +enum | Name | Type | Go type | Default | Description | Example | |------|------|---------| ------- |-------------|---------| -| PersistentVolumeAccessMode | string| string | | +enum | | +| PersistentVolumeAccessMode | string| string | | | | @@ -2604,15 +2578,15 @@ and allows a Source for provider-specific attributes | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| -| accessModes | [][PersistentVolumeAccessMode](#persistent-volume-access-mode)| `[]PersistentVolumeAccessMode` | | | accessModes contains the desired access modes the volume should have.
More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1
+optional
+listType=atomic | | +| accessModes | [][PersistentVolumeAccessMode](#persistent-volume-access-mode)| `[]PersistentVolumeAccessMode` | | | accessModes contains the desired access modes the volume should have.
More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1
**Validation:** Optional.| | | dataSource | [TypedLocalObjectReference](#typed-local-object-reference)| `TypedLocalObjectReference` | | | | | | dataSourceRef | [TypedObjectReference](#typed-object-reference)| `TypedObjectReference` | | | | | | resources | [VolumeResourceRequirements](#volume-resource-requirements)| `VolumeResourceRequirements` | | | | | | selector | [LabelSelector](#label-selector)| `LabelSelector` | | | | | -| storageClassName | string| `string` | | | storageClassName is the name of the StorageClass required by the claim.
More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1
+optional | | -| volumeAttributesClassName | string| `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 value means that no VolumeAttributesClass
will be applied to the claim but it's not allowed to reset this field to empty string once it is set.
If unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass
will be set by the persistentvolume controller if it exists.
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/
(Beta) Using this field requires the VolumeAttributesClass feature gate to be enabled (off by default).
+featureGate=VolumeAttributesClass
+optional | | +| storageClassName | string| `string` | | | storageClassName is the name of the StorageClass required by the claim.
More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1
**Validation:** Optional.| | +| volumeAttributesClassName | string| `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 value means that no VolumeAttributesClass
will be applied to the claim but it's not allowed to reset this field to empty string once it is set.
If unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass
will be set by the persistentvolume controller if it exists.
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/
(Beta) Using this field requires the VolumeAttributesClass feature gate to be enabled (off by default).
**Validation:** Optional.| | | volumeMode | [PersistentVolumeMode](#persistent-volume-mode)| `PersistentVolumeMode` | | | | | -| volumeName | string| `string` | | | volumeName is the binding reference to the PersistentVolume backing this claim.
+optional | | +| volumeName | string| `string` | | | volumeName is the binding reference to the PersistentVolume backing this claim.
**Validation:** Optional.| | @@ -2631,20 +2605,20 @@ PersistentVolumeClaim objects as part of an EphemeralVolumeSource. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| -| annotations | map of string| `map[string]string` | | | Annotations is an unstructured key value map stored with a resource that may be
set by external tools to store and retrieve arbitrary metadata. They are not
queryable and should be preserved when modifying objects.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations
+optional | | -| creationTimestamp | string| `string` | | | CreationTimestamp is a timestamp representing the server time when this object was
created. It is not guaranteed to be set in happens-before order across separate operations.
Clients may not set this value. It is represented in RFC3339 form and is in UTC.

Populated by the system.
Read-only.
Null for lists.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
+optional | | -| deletionGracePeriodSeconds | int64 (formatted integer)| `int64` | | | Number of seconds allowed for this object to gracefully terminate before
it will be removed from the system. Only set when deletionTimestamp is also set.
May only be shortened.
Read-only.
+optional | | -| deletionTimestamp | string| `string` | | | DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This
field is set by the server when a graceful deletion is requested by the user, and is not
directly settable by a client. The resource is expected to be deleted (no longer visible
from resource lists, and not reachable by name) after the time in this field, once the
finalizers list is empty. As long as the finalizers list contains items, deletion is blocked.
Once the deletionTimestamp is set, this value may not be unset or be set further into the
future, although it may be shortened or the resource may be deleted prior to this time.
For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react
by sending a graceful termination signal to the containers in the pod. After that 30 seconds,
the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup,
remove the pod from the API. In the presence of network partitions, this object may still
exist after this timestamp, until an administrator or automated process can determine the
resource is fully terminated.
If not set, graceful deletion of the object has not been requested.

Populated by the system when a graceful deletion is requested.
Read-only.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
+optional | | -| finalizers | []string| `[]string` | | | Must be empty before the object is deleted from the registry. Each entry
is an identifier for the responsible component that will remove the entry
from the list. If the deletionTimestamp of the object is non-nil, entries
in this list can only be removed.
Finalizers may be processed and removed in any order. Order is NOT enforced
because it introduces significant risk of stuck finalizers.
finalizers is a shared field, any actor with permission can reorder it.
If the finalizer list is processed in order, then this can lead to a situation
in which the component responsible for the first finalizer in the list is
waiting for a signal (field value, external system, or other) produced by a
component responsible for a finalizer later in the list, resulting in a deadlock.
Without enforced ordering finalizers are free to order amongst themselves and
are not vulnerable to ordering changes in the list.
+optional
+patchStrategy=merge
+listType=set | | -| generateName | string| `string` | | | GenerateName is an optional prefix, used by the server, to generate a unique
name ONLY IF the Name field has not been provided.
If this field is used, the name returned to the client will be different
than the name passed. This value will also be combined with a unique suffix.
The provided value has the same validation rules as the Name field,
and may be truncated by the length of the suffix required to make the value
unique on the server.

If this field is specified and the generated name exists, the server will return a 409.

Applied only if Name is not specified.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency
+optional | | -| generation | int64 (formatted integer)| `int64` | | | A sequence number representing a specific generation of the desired state.
Populated by the system. Read-only.
+optional | | -| labels | map of string| `map[string]string` | | | Map of string keys and values that can be used to organize and categorize
(scope and select) objects. May match selectors of replication controllers
and services.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels
+optional | | -| managedFields | [][ManagedFieldsEntry](#managed-fields-entry)| `[]*ManagedFieldsEntry` | | | ManagedFields maps workflow-id and version to the set of fields
that are managed by that workflow. This is mostly for internal
housekeeping, and users typically shouldn't need to set or
understand this field. A workflow can be the user's name, a
controller's name, or the name of a specific apply path like
"ci-cd". The set of fields is always in the version that the
workflow used when modifying the object.

+optional
+listType=atomic | | -| name | string| `string` | | | Name must be unique within a namespace. Is required when creating resources, although
some resources may allow a client to request the generation of an appropriate name
automatically. Name is primarily intended for creation idempotence and configuration
definition.
Cannot be updated.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names
+optional | | -| namespace | string| `string` | | | Namespace defines the space within which each name must be unique. An empty namespace is
equivalent to the "default" namespace, but "default" is the canonical representation.
Not all objects are required to be scoped to a namespace - the value of this field for
those objects will be empty.

Must be a DNS_LABEL.
Cannot be updated.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces
+optional | | -| ownerReferences | [][OwnerReference](#owner-reference)| `[]*OwnerReference` | | | List of objects depended by this object. If ALL objects in the list have
been deleted, this object will be garbage collected. If this object is managed by a controller,
then an entry in this list will point to this controller, with the controller field set to true.
There cannot be more than one managing controller.
+optional
+patchMergeKey=uid
+patchStrategy=merge
+listType=map
+listMapKey=uid | | -| resourceVersion | string| `string` | | | An opaque value that represents the internal version of this object that can
be used by clients to determine when objects have changed. May be used for optimistic
concurrency, change detection, and the watch operation on a resource or set of resources.
Clients must treat these values as opaque and passed unmodified back to the server.
They may only be valid for a particular resource or set of resources.

Populated by the system.
Read-only.
Value must be treated as opaque by clients and .
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
+optional | | -| selfLink | string| `string` | | | Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.
+optional | | +| annotations | map of string| `map[string]string` | | | Annotations is an unstructured key value map stored with a resource that may be
set by external tools to store and retrieve arbitrary metadata. They are not
queryable and should be preserved when modifying objects.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations
**Validation:** Optional.| | +| creationTimestamp | string| `string` | | | CreationTimestamp is a timestamp representing the server time when this object was
created. It is not guaranteed to be set in happens-before order across separate operations.
Clients may not set this value. It is represented in RFC3339 form and is in UTC.
Populated by the system.
Read-only.
Null for lists.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
**Validation:** Optional.| | +| deletionGracePeriodSeconds | int64 (formatted integer)| `int64` | | | Number of seconds allowed for this object to gracefully terminate before
it will be removed from the system. Only set when deletionTimestamp is also set.
May only be shortened.
Read-only.
**Validation:** Optional.| | +| deletionTimestamp | string| `string` | | | DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This
field is set by the server when a graceful deletion is requested by the user, and is not
directly settable by a client. The resource is expected to be deleted (no longer visible
from resource lists, and not reachable by name) after the time in this field, once the
finalizers list is empty. As long as the finalizers list contains items, deletion is blocked.
Once the deletionTimestamp is set, this value may not be unset or be set further into the
future, although it may be shortened or the resource may be deleted prior to this time.
For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react
by sending a graceful termination signal to the containers in the pod. After that 30 seconds,
the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup,
remove the pod from the API. In the presence of network partitions, this object may still
exist after this timestamp, until an administrator or automated process can determine the
resource is fully terminated.
If not set, graceful deletion of the object has not been requested.
Populated by the system when a graceful deletion is requested.
Read-only.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
**Validation:** Optional.| | +| finalizers | []string| `[]string` | | | Must be empty before the object is deleted from the registry. Each entry
is an identifier for the responsible component that will remove the entry
from the list. If the deletionTimestamp of the object is non-nil, entries
in this list can only be removed.
Finalizers may be processed and removed in any order. Order is NOT enforced
because it introduces significant risk of stuck finalizers.
finalizers is a shared field, any actor with permission can reorder it.
If the finalizer list is processed in order, then this can lead to a situation
in which the component responsible for the first finalizer in the list is
waiting for a signal (field value, external system, or other) produced by a
component responsible for a finalizer later in the list, resulting in a deadlock.
Without enforced ordering finalizers are free to order amongst themselves and
are not vulnerable to ordering changes in the list.
**Validation:** Optional.| | +| generateName | string| `string` | | | GenerateName is an optional prefix, used by the server, to generate a unique
name ONLY IF the Name field has not been provided.
If this field is used, the name returned to the client will be different
than the name passed. This value will also be combined with a unique suffix.
The provided value has the same validation rules as the Name field,
and may be truncated by the length of the suffix required to make the value
unique on the server.
If this field is specified and the generated name exists, the server will return a 409.
Applied only if Name is not specified.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency
**Validation:** Optional.| | +| generation | int64 (formatted integer)| `int64` | | | A sequence number representing a specific generation of the desired state.
Populated by the system. Read-only.
**Validation:** Optional.| | +| labels | map of string| `map[string]string` | | | Map of string keys and values that can be used to organize and categorize
(scope and select) objects. May match selectors of replication controllers
and services.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels
**Validation:** Optional.| | +| managedFields | [][ManagedFieldsEntry](#managed-fields-entry)| `[]*ManagedFieldsEntry` | | | ManagedFields maps workflow-id and version to the set of fields
that are managed by that workflow. This is mostly for internal
housekeeping, and users typically shouldn't need to set or
understand this field. A workflow can be the user's name, a
controller's name, or the name of a specific apply path like
"ci-cd". The set of fields is always in the version that the
workflow used when modifying the object.
**Validation:** Optional.| | +| name | string| `string` | | | Name must be unique within a namespace. Is required when creating resources, although
some resources may allow a client to request the generation of an appropriate name
automatically. Name is primarily intended for creation idempotence and configuration
definition.
Cannot be updated.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names
**Validation:** Optional.| | +| namespace | string| `string` | | | Namespace defines the space within which each name must be unique. An empty namespace is
equivalent to the "default" namespace, but "default" is the canonical representation.
Not all objects are required to be scoped to a namespace - the value of this field for
those objects will be empty.
Must be a DNS_LABEL.
Cannot be updated.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces
**Validation:** Optional.| | +| ownerReferences | [][OwnerReference](#owner-reference)| `[]*OwnerReference` | | | List of objects depended by this object. If ALL objects in the list have
been deleted, this object will be garbage collected. If this object is managed by a controller,
then an entry in this list will point to this controller, with the controller field set to true.
There cannot be more than one managing controller.
**Validation:** Optional.| | +| resourceVersion | string| `string` | | | An opaque value that represents the internal version of this object that can
be used by clients to determine when objects have changed. May be used for optimistic
concurrency, change detection, and the watch operation on a resource or set of resources.
Clients must treat these values as opaque and passed unmodified back to the server.
They may only be valid for a particular resource or set of resources.
Populated by the system.
Read-only.
Value must be treated as opaque by clients and .
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
**Validation:** Optional.| | +| selfLink | string| `string` | | | Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.
**Validation:** Optional.| | | spec | [PersistentVolumeClaimSpec](#persistent-volume-claim-spec)| `PersistentVolumeClaimSpec` | | | | | | uid | [UID](#uid)| `UID` | | | | | @@ -2667,21 +2641,20 @@ type of volume that is owned by someone else (the system). | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| | claimName | string| `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 | | -| readOnly | boolean| `bool` | | | readOnly Will force the ReadOnly setting in VolumeMounts.
Default false.
+optional | | +| readOnly | boolean| `bool` | | | readOnly Will force the ReadOnly setting in VolumeMounts.
Default false.
**Validation:** Optional.| | ### PersistentVolumeMode -> +enum | Name | Type | Go type | Default | Description | Example | |------|------|---------| ------- |-------------|---------| -| PersistentVolumeMode | string| string | | +enum | | +| PersistentVolumeMode | string| string | | | | @@ -2743,8 +2716,8 @@ type of volume that is owned by someone else (the system). | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| -| preferredDuringSchedulingIgnoredDuringExecution | [][WeightedPodAffinityTerm](#weighted-pod-affinity-term)| `[]*WeightedPodAffinityTerm` | | | The scheduler will prefer to schedule pods to nodes that satisfy
the affinity expressions specified by this field, but it may choose
a node that violates one or more of the expressions. The node that is
most preferred is the one with the greatest sum of weights, i.e.
for each node that meets all of the scheduling requirements (resource
request, requiredDuringScheduling affinity expressions, etc.),
compute a sum by iterating through the elements of this field and adding
"weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the
node(s) with the highest sum are the most preferred.
+optional
+listType=atomic | | -| requiredDuringSchedulingIgnoredDuringExecution | [][PodAffinityTerm](#pod-affinity-term)| `[]*PodAffinityTerm` | | | If the affinity requirements specified by this field are not met at
scheduling time, the pod will not be scheduled onto the node.
If the affinity requirements specified by this field cease to be met
at some point during pod execution (e.g. due to a pod label update), the
system may or may not try to eventually evict the pod from its node.
When there are multiple elements, the lists of nodes corresponding to each
podAffinityTerm are intersected, i.e. all terms must be satisfied.
+optional
+listType=atomic | | +| preferredDuringSchedulingIgnoredDuringExecution | [][WeightedPodAffinityTerm](#weighted-pod-affinity-term)| `[]*WeightedPodAffinityTerm` | | | 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.
**Validation:** Optional.| | +| requiredDuringSchedulingIgnoredDuringExecution | [][PodAffinityTerm](#pod-affinity-term)| `[]*PodAffinityTerm` | | | 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.
**Validation:** Optional.| | @@ -2768,10 +2741,10 @@ a pod of the set of pods is running | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| | labelSelector | [LabelSelector](#label-selector)| `LabelSelector` | | | | | -| matchLabelKeys | []string| `[]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.

+listType=atomic
+optional | | -| mismatchLabelKeys | []string| `[]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.

+listType=atomic
+optional | | +| matchLabelKeys | []string| `[]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.
**Validation:** Optional.| | +| mismatchLabelKeys | []string| `[]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.
**Validation:** Optional.| | | namespaceSelector | [LabelSelector](#label-selector)| `LabelSelector` | | | | | -| namespaces | []string| `[]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".
+optional
+listType=atomic | | +| namespaces | []string| `[]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".
**Validation:** Optional.| | | topologyKey | string| `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. | | @@ -2787,8 +2760,8 @@ a pod of the set of pods is running | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| -| preferredDuringSchedulingIgnoredDuringExecution | [][WeightedPodAffinityTerm](#weighted-pod-affinity-term)| `[]*WeightedPodAffinityTerm` | | | The scheduler will prefer to schedule pods to nodes that satisfy
the anti-affinity expressions specified by this field, but it may choose
a node that violates one or more of the expressions. The node that is
most preferred is the one with the greatest sum of weights, i.e.
for each node that meets all of the scheduling requirements (resource
request, requiredDuringScheduling anti-affinity expressions, etc.),
compute a sum by iterating through the elements of this field and adding
"weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the
node(s) with the highest sum are the most preferred.
+optional
+listType=atomic | | -| requiredDuringSchedulingIgnoredDuringExecution | [][PodAffinityTerm](#pod-affinity-term)| `[]*PodAffinityTerm` | | | If the anti-affinity requirements specified by this field are not met at
scheduling time, the pod will not be scheduled onto the node.
If the anti-affinity requirements specified by this field cease to be met
at some point during pod execution (e.g. due to a pod label update), the
system may or may not try to eventually evict the pod from its node.
When there are multiple elements, the lists of nodes corresponding to each
podAffinityTerm are intersected, i.e. all terms must be satisfied.
+optional
+listType=atomic | | +| preferredDuringSchedulingIgnoredDuringExecution | [][WeightedPodAffinityTerm](#weighted-pod-affinity-term)| `[]*WeightedPodAffinityTerm` | | | The scheduler will prefer to schedule pods to nodes that satisfy
the anti-affinity expressions specified by this field, but it may choose
a node that violates one or more of the expressions. The node that is
most preferred is the one with the greatest sum of weights, i.e.
for each node that meets all of the scheduling requirements (resource
request, requiredDuringScheduling anti-affinity expressions, etc.),
compute a sum by iterating through the elements of this field and adding
"weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the
node(s) with the highest sum are the most preferred.
**Validation:** Optional.| | +| requiredDuringSchedulingIgnoredDuringExecution | [][PodAffinityTerm](#pod-affinity-term)| `[]*PodAffinityTerm` | | | 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.
**Validation:** Optional.| | @@ -2797,14 +2770,13 @@ a pod of the set of pods is running > PodFSGroupChangePolicy holds policies that will be used for applying fsGroup to a volume when volume is mounted. -+enum | Name | Type | Go type | Default | Description | Example | |------|------|---------| ------- |-------------|---------| -| PodFSGroupChangePolicy | string| string | | PodFSGroupChangePolicy holds policies that will be used for applying fsGroup to a volume
when volume is mounted.
+enum | | +| PodFSGroupChangePolicy | string| string | | PodFSGroupChangePolicy holds policies that will be used for applying fsGroup to a volume
when volume is mounted.| | @@ -2835,17 +2807,17 @@ container.securityContext take precedence over field values of PodSecurityContex | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| | appArmorProfile | [AppArmorProfile](#app-armor-profile)| `AppArmorProfile` | | | | | -| fsGroup | int64 (formatted integer)| `int64` | | | 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.
+optional | | +| fsGroup | int64 (formatted integer)| `int64` | | | 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.
**Validation:** Optional.| | | fsGroupChangePolicy | [PodFSGroupChangePolicy](#pod-f-s-group-change-policy)| `PodFSGroupChangePolicy` | | | | | -| runAsGroup | int64 (formatted integer)| `int64` | | | 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.
+optional | | -| runAsNonRoot | boolean| `bool` | | | Indicates that the container must run as a non-root user.
If true, the Kubelet will validate the image at runtime to ensure that it
does not run as UID 0 (root) and fail to start the container if it does.
If unset or false, no such validation will be performed.
May also be set in SecurityContext. If set in both SecurityContext and
PodSecurityContext, the value specified in SecurityContext takes precedence.
+optional | | -| runAsUser | int64 (formatted integer)| `int64` | | | 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.
+optional | | +| runAsGroup | int64 (formatted integer)| `int64` | | | 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.
**Validation:** Optional.| | +| runAsNonRoot | boolean| `bool` | | | 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.
**Validation:** Optional.| | +| runAsUser | int64 (formatted integer)| `int64` | | | 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.
**Validation:** Optional.| | | seLinuxChangePolicy | [PodSELinuxChangePolicy](#pod-s-e-linux-change-policy)| `PodSELinuxChangePolicy` | | | | | | seLinuxOptions | [SELinuxOptions](#s-e-linux-options)| `SELinuxOptions` | | | | | | seccompProfile | [SeccompProfile](#seccomp-profile)| `SeccompProfile` | | | | | -| supplementalGroups | []int64 (formatted integer)| `[]int64` | | | 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.
+optional
+listType=atomic | | +| supplementalGroups | []int64 (formatted integer)| `[]int64` | | | 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.
**Validation:** Optional.| | | supplementalGroupsPolicy | [SupplementalGroupsPolicy](#supplemental-groups-policy)| `SupplementalGroupsPolicy` | | | | | -| sysctls | [][Sysctl](#sysctl)| `[]*Sysctl` | | | 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.
+optional
+listType=atomic | | +| sysctls | [][Sysctl](#sysctl)| `[]*Sysctl` | | | 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.
**Validation:** Optional.| | | windowsOptions | [WindowsSecurityContextOptions](#windows-security-context-options)| `WindowsSecurityContextOptions` | | | | | @@ -2862,7 +2834,7 @@ container.securityContext take precedence over field values of PodSecurityContex | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| | fsType | string| `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. | | -| readOnly | boolean| `bool` | | | readOnly defaults to false (read/write). ReadOnly here will force
the ReadOnly setting in VolumeMounts.
+optional | | +| readOnly | boolean| `bool` | | | readOnly defaults to false (read/write). ReadOnly here will force
the ReadOnly setting in VolumeMounts.
**Validation:** Optional.| | | volumeID | string| `string` | | | volumeID uniquely identifies a Portworx volume | | @@ -2903,29 +2875,28 @@ alive or ready to receive traffic. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| | exec | [ExecAction](#exec-action)| `ExecAction` | | | | | -| failureThreshold | int32 (formatted integer)| `int32` | | | Minimum consecutive failures for the probe to be considered failed after having succeeded.
Defaults to 3. Minimum value is 1.
+optional | | +| failureThreshold | int32 (formatted integer)| `int32` | | | Minimum consecutive failures for the probe to be considered failed after having succeeded.
Defaults to 3. Minimum value is 1.
**Validation:** Optional.| | | grpc | [GRPCAction](#g-rpc-action)| `GRPCAction` | | | | | | httpGet | [HTTPGetAction](#http-get-action)| `HTTPGetAction` | | | | | -| initialDelaySeconds | int32 (formatted integer)| `int32` | | | Number of seconds after the container has started before liveness probes are initiated.
More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+optional | | -| periodSeconds | int32 (formatted integer)| `int32` | | | How often (in seconds) to perform the probe.
Default to 10 seconds. Minimum value is 1.
+optional | | -| successThreshold | int32 (formatted integer)| `int32` | | | Minimum consecutive successes for the probe to be considered successful after having failed.
Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.
+optional | | +| initialDelaySeconds | int32 (formatted integer)| `int32` | | | 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
**Validation:** Optional.| | +| periodSeconds | int32 (formatted integer)| `int32` | | | How often (in seconds) to perform the probe.
Default to 10 seconds. Minimum value is 1.
**Validation:** Optional.| | +| successThreshold | int32 (formatted integer)| `int32` | | | 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.
**Validation:** Optional.| | | tcpSocket | [TCPSocketAction](#tcp-socket-action)| `TCPSocketAction` | | | | | -| terminationGracePeriodSeconds | int64 (formatted integer)| `int64` | | | 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.
+optional | | -| timeoutSeconds | int32 (formatted integer)| `int32` | | | Number of seconds after which the probe times out.
Defaults to 1 second. Minimum value is 1.
More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+optional | | +| terminationGracePeriodSeconds | int64 (formatted integer)| `int64` | | | 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.
**Validation:** Optional.| | +| timeoutSeconds | int32 (formatted integer)| `int32` | | | 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
**Validation:** Optional.| | ### ProcMountType -> +enum | Name | Type | Go type | Default | Description | Example | |------|------|---------| ------- |-------------|---------| -| ProcMountType | string| string | | +enum | | +| ProcMountType | string| string | | | | @@ -2954,8 +2925,8 @@ alive or ready to receive traffic. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| -| defaultMode | int32 (formatted integer)| `int32` | | | 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.
+optional | | -| sources | [][VolumeProjection](#volume-projection)| `[]*VolumeProjection` | | | sources is the list of volume projections. Each entry in this list
handles one source.
+optional
+listType=atomic | | +| defaultMode | int32 (formatted integer)| `int32` | | | 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.
**Validation:** Optional.| | +| sources | [][VolumeProjection](#volume-projection)| `[]*VolumeProjection` | | | sources is the list of volume projections. Each entry in this list
handles one source.
**Validation:** Optional.| | @@ -2975,10 +2946,10 @@ alive or ready to receive traffic. |------|------|---------|:--------:| ------- |-------------|---------| | counter | [Counter](#counter)| `Counter` | | | | | | gauge | [Gauge](#gauge)| `Gauge` | | | | | -| help | string| `string` | | | Help is a string that describes the metric
+kubebuilder:validation:MinLength=1 | | +| help | string| `string` | | | Help is a string that describes the metric
**Validation:** Minimum length: 1.| | | histogram | [Histogram](#histogram)| `Histogram` | | | | | | labels | [][MetricLabel](#metric-label)| `[]*MetricLabel` | | | Labels is a list of metric labels | | -| name | string| `string` | | | Name is the name of the metric
+kubebuilder:validation:Pattern=`^[a-zA-Z_][a-zA-Z0-9_]*$` | | +| name | string| `string` | | | Name is the name of the metric
**Validation:** Pattern: `^[a-zA-Z_][a-zA-Z0-9_]*$`.| | | when | string| `string` | | | When is a conditional statement that decides when to emit the metric | | @@ -2986,14 +2957,13 @@ alive or ready to receive traffic. ### Protocol -> +enum | Name | Type | Go type | Default | Description | Example | |------|------|---------| ------- |-------------|---------| -| Protocol | string| string | | +enum | | +| Protocol | string| string | | | | @@ -3001,14 +2971,13 @@ alive or ready to receive traffic. > PullPolicy describes a policy for if/when to pull a container image -+enum | Name | Type | Go type | Default | Description | Example | |------|------|---------| ------- |-------------|---------| -| PullPolicy | string| string | | PullPolicy describes a policy for if/when to pull a container image
+enum | | +| PullPolicy | string| string | | PullPolicy describes a policy for if/when to pull a container image| | @@ -3074,12 +3043,8 @@ This format is intended to make it difficult to use these numbers without writing some sort of special handling code in the hopes that that will cause implementors to also use a fixed point implementation. -+protobuf=true -+protobuf.embed=string -+protobuf.options.marshal=false -+protobuf.options.(gogoproto.goproto_stringer)=false -+k8s:deepcopy-gen=true -+k8s:openapi-gen=true + + @@ -3100,11 +3065,11 @@ cause implementors to also use a fixed point implementation. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| -| group | string| `string` | | | group to map volume access to
Default is no group
+optional | | -| readOnly | boolean| `bool` | | | readOnly here will force the Quobyte volume to be mounted with read-only permissions.
Defaults to false.
+optional | | +| group | string| `string` | | | group to map volume access to
Default is no group
**Validation:** Optional.| | +| readOnly | boolean| `bool` | | | readOnly here will force the Quobyte volume to be mounted with read-only permissions.
Defaults to false.
**Validation:** Optional.| | | registry | string| `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 | | -| tenant | string| `string` | | | tenant owning the given Quobyte volume in the Backend
Used with dynamically provisioned Quobyte volumes, value is set by the plugin
+optional | | -| user | string| `string` | | | user to map volume access to
Defaults to serivceaccount user
+optional | | +| tenant | string| `string` | | | tenant owning the given Quobyte volume in the Backend
Used with dynamically provisioned Quobyte volumes, value is set by the plugin
**Validation:** Optional.| | +| user | string| `string` | | | user to map volume access to
Defaults to serivceaccount user
**Validation:** Optional.| | | volume | string| `string` | | | volume is a string that references an already created Quobyte volume by name. | | @@ -3123,14 +3088,14 @@ cause implementors to also use a fixed point implementation. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| -| fsType | string| `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
TODO: how do we prevent errors in the filesystem from compromising the machine
+optional | | +| fsType | string| `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
TODO: how do we prevent errors in the filesystem from compromising the machine
**Validation:** Optional.| | | image | string| `string` | | | image is the rados image name.
More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it | | -| keyring | string| `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
+optional
+default="/etc/ceph/keyring" | | -| monitors | []string| `[]string` | | | monitors is a collection of Ceph monitors.
More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
+listType=atomic | | -| pool | string| `string` | | | pool is the rados pool name.
Default is rbd.
More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
+optional
+default="rbd" | | -| readOnly | boolean| `bool` | | | readOnly here will force the ReadOnly setting in VolumeMounts.
Defaults to false.
More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
+optional | | +| keyring | string| `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
**Validation:** Optional; Default: "/etc/ceph/keyring".| | +| monitors | []string| `[]string` | | | monitors is a collection of Ceph monitors.
More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it | | +| pool | string| `string` | | | pool is the rados pool name.
Default is rbd.
More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
**Validation:** Optional; Default: "rbd".| | +| readOnly | boolean| `bool` | | | 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
**Validation:** Optional.| | | secretRef | [LocalObjectReference](#local-object-reference)| `LocalObjectReference` | | | | | -| user | string| `string` | | | user is the rados user name.
Default is admin.
More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
+optional
+default="admin" | | +| user | string| `string` | | | user is the rados user name.
Default is admin.
More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
**Validation:** Optional; Default: "admin".| | @@ -3175,7 +3140,7 @@ cause implementors to also use a fixed point implementation. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| | name | string| `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. | | -| request | string| `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.

+optional | | +| request | string| `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.
**Validation:** Optional.| | @@ -3183,7 +3148,6 @@ cause implementors to also use a fixed point implementation. > ResourceFieldSelector represents container resources (cpu, memory) and their output format -+structType=atomic @@ -3194,7 +3158,7 @@ cause implementors to also use a fixed point implementation. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| -| containerName | string| `string` | | | Container name: required for volumes, optional for env vars
+optional | | +| containerName | string| `string` | | | Container name: required for volumes, optional for env vars
**Validation:** Optional.| | | divisor | [Quantity](#quantity)| `Quantity` | | | | | | resource | string| `string` | | | Required: resource to select | | @@ -3229,7 +3193,7 @@ cause implementors to also use a fixed point implementation. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| -| claims | [][ResourceClaim](#resource-claim)| `[]*ResourceClaim` | | | Claims lists the names of resources, defined in spec.resourceClaims,
that are used by this container.

This is an alpha field and requires enabling the
DynamicResourceAllocation feature gate.

This field is immutable. It can only be set for containers.

+listType=map
+listMapKey=name
+featureGate=DynamicResourceAllocation
+optional | | +| claims | [][ResourceClaim](#resource-claim)| `[]*ResourceClaim` | | | Claims lists the names of resources, defined in spec.resourceClaims,
that are used by this container.
This is an alpha field and requires enabling the
DynamicResourceAllocation feature gate.
This field is immutable. It can only be set for containers.
**Validation:** Optional.| | | limits | [ResourceList](#resource-list)| `ResourceList` | | | | | | requests | [ResourceList](#resource-list)| `ResourceList` | | | | | @@ -3250,7 +3214,6 @@ cause implementors to also use a fixed point implementation. > ResourceTemplate is a template subtype to manipulate kubernetes resources -+kubebuilder:validation:XValidation:rule="(has(self.manifest) && !has(self.manifestFrom)) || (!has(self.manifest) && has(self.manifestFrom)) || (!has(self.manifest) && !has(self.manifestFrom))",message="only one of manifest or manifestFrom can be specified" @@ -3261,12 +3224,12 @@ cause implementors to also use a fixed point implementation. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| -| action | string| `string` | | | Action is the action to perform to the resource.
Must be one of: get, create, apply, delete, replace, patch
+kubebuilder:validation:Enum=get;create;apply;delete;replace;patch | | +| action | string| `string` | | | Action is the action to perform to the resource.
Must be one of: get, create, apply, delete, replace, patch
**Validation:** Valid values: get, create, apply, delete, replace, patch.| | | failureCondition | string| `string` | | | FailureCondition is a label selector expression which describes the conditions
of the k8s resource in which the step was considered failed | | | flags | []string| `[]string` | | | Flags is a set of additional options passed to kubectl before submitting a resource
I.e. to disable resource validation:
flags: [
"--validate=false" # disable resource validation
] | | | manifest | string| `string` | | | Manifest contains the kubernetes manifest | | | manifestFrom | [ManifestFrom](#manifest-from)| `ManifestFrom` | | | | | -| mergeStrategy | string| `string` | | | MergeStrategy is the strategy used to merge a patch. It defaults to "strategic"
Must be one of: strategic, merge, json
+kubebuilder:validation:Enum=strategic;merge;json | | +| mergeStrategy | string| `string` | | | MergeStrategy is the strategy used to merge a patch. It defaults to "strategic"
Must be one of: strategic, merge, json
**Validation:** Valid values: strategic, merge, json.| | | setOwnerReference | boolean| `bool` | | | SetOwnerReference sets the reference to the workflow on the OwnerReference of generated resource. | | | successCondition | string| `string` | | | SuccessCondition is a label selector expression which describes the conditions
of the k8s resource in which it is acceptable to proceed to the following step | | @@ -3300,14 +3263,13 @@ cause implementors to also use a fixed point implementation. ### RetryPolicy -> +kubebuilder:validation:Enum=Always;OnFailure;OnError;OnTransientError | Name | Type | Go type | Default | Description | Example | |------|------|---------| ------- |-------------|---------| -| RetryPolicy | string| string | | +kubebuilder:validation:Enum=Always;OnFailure;OnError;OnTransientError | | +| RetryPolicy | string| string | |
**Validation:** Valid values: Always, OnFailure, OnError, OnTransientError.| | @@ -3398,10 +3360,10 @@ cause implementors to also use a fixed point implementation. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| -| level | string| `string` | | | Level is SELinux level label that applies to the container.
+optional | | -| role | string| `string` | | | Role is a SELinux role label that applies to the container.
+optional | | -| type | string| `string` | | | Type is a SELinux type label that applies to the container.
+optional | | -| user | string| `string` | | | User is a SELinux user label that applies to the container.
+optional | | +| level | string| `string` | | | Level is SELinux level label that applies to the container.
**Validation:** Optional.| | +| role | string| `string` | | | Role is a SELinux role label that applies to the container.
**Validation:** Optional.| | +| type | string| `string` | | | Type is a SELinux type label that applies to the container.
**Validation:** Optional.| | +| user | string| `string` | | | User is a SELinux user label that applies to the container.
**Validation:** Optional.| | @@ -3419,14 +3381,14 @@ cause implementors to also use a fixed point implementation. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| -| fsType | string| `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".
+optional
+default="xfs" | | +| fsType | string| `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".
**Validation:** Optional; Default: "xfs".| | | gateway | string| `string` | | | gateway is the host address of the ScaleIO API Gateway. | | -| protectionDomain | string| `string` | | | protectionDomain is the name of the ScaleIO Protection Domain for the configured storage.
+optional | | -| readOnly | boolean| `bool` | | | readOnly Defaults to false (read/write). ReadOnly here will force
the ReadOnly setting in VolumeMounts.
+optional | | +| protectionDomain | string| `string` | | | protectionDomain is the name of the ScaleIO Protection Domain for the configured storage.
**Validation:** Optional.| | +| readOnly | boolean| `bool` | | | readOnly Defaults to false (read/write). ReadOnly here will force
the ReadOnly setting in VolumeMounts.
**Validation:** Optional.| | | secretRef | [LocalObjectReference](#local-object-reference)| `LocalObjectReference` | | | | | -| sslEnabled | boolean| `bool` | | | sslEnabled Flag enable/disable SSL communication with Gateway, default false
+optional | | -| storageMode | string| `string` | | | storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned.
Default is ThinProvisioned.
+optional
+default="ThinProvisioned" | | -| storagePool | string| `string` | | | storagePool is the ScaleIO Storage Pool associated with the protection domain.
+optional | | +| sslEnabled | boolean| `bool` | | | sslEnabled Flag enable/disable SSL communication with Gateway, default false
**Validation:** Optional.| | +| storageMode | string| `string` | | | storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned.
Default is ThinProvisioned.
**Validation:** Optional; Default: "ThinProvisioned".| | +| storagePool | string| `string` | | | storagePool is the ScaleIO Storage Pool associated with the protection domain.
**Validation:** Optional.| | | system | string| `string` | | | system is the name of the storage system as configured in ScaleIO. | | | volumeName | string| `string` | | | volumeName is the name of a volume already created in the ScaleIO system
that is associated with this volume source. | | @@ -3446,31 +3408,31 @@ cause implementors to also use a fixed point implementation. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| -| args | []string| `[]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
+optional
+listType=atomic | | -| command | []string| `[]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
+optional
+listType=atomic | | -| env | [][EnvVar](#env-var)| `[]*EnvVar` | | | List of environment variables to set in the container.
Cannot be updated.
+optional
+patchMergeKey=name
+patchStrategy=merge
+listType=map
+listMapKey=name | | -| envFrom | [][EnvFromSource](#env-from-source)| `[]*EnvFromSource` | | | List of sources to populate environment variables in the container.
The keys defined within a source must be a C_IDENTIFIER. All invalid keys
will be reported as an event when the container is starting. When a key exists in multiple
sources, the value associated with the last source will take precedence.
Values defined by an Env with a duplicate key will take precedence.
Cannot be updated.
+optional
+listType=atomic | | -| image | string| `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.
+optional | | +| args | []string| `[]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
**Validation:** Optional.| | +| command | []string| `[]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
**Validation:** Optional.| | +| env | [][EnvVar](#env-var)| `[]*EnvVar` | | | List of environment variables to set in the container.
Cannot be updated.
**Validation:** Optional.| | +| envFrom | [][EnvFromSource](#env-from-source)| `[]*EnvFromSource` | | | List of sources to populate environment variables in the container.
The keys defined within a source must be a C_IDENTIFIER. All invalid keys
will be reported as an event when the container is starting. When a key exists in multiple
sources, the value associated with the last source will take precedence.
Values defined by an Env with a duplicate key will take precedence.
Cannot be updated.
**Validation:** Optional.| | +| image | string| `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.
**Validation:** Optional.| | | imagePullPolicy | [PullPolicy](#pull-policy)| `PullPolicy` | | | | | | lifecycle | [Lifecycle](#lifecycle)| `Lifecycle` | | | | | | livenessProbe | [Probe](#probe)| `Probe` | | | | | | name | string| `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. | | -| ports | [][ContainerPort](#container-port)| `[]*ContainerPort` | | | 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.
+optional
+patchMergeKey=containerPort
+patchStrategy=merge
+listType=map
+listMapKey=containerPort
+listMapKey=protocol | | +| ports | [][ContainerPort](#container-port)| `[]*ContainerPort` | | | 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.
**Validation:** Optional.| | | readinessProbe | [Probe](#probe)| `Probe` | | | | | -| resizePolicy | [][ContainerResizePolicy](#container-resize-policy)| `[]*ContainerResizePolicy` | | | Resources resize policy for the container.
+featureGate=InPlacePodVerticalScaling
+optional
+listType=atomic | | +| resizePolicy | [][ContainerResizePolicy](#container-resize-policy)| `[]*ContainerResizePolicy` | | | Resources resize policy for the container.
**Validation:** Optional.| | | resources | [ResourceRequirements](#resource-requirements)| `ResourceRequirements` | | | | | | restartPolicy | [ContainerRestartPolicy](#container-restart-policy)| `ContainerRestartPolicy` | | | | | | securityContext | [SecurityContext](#security-context)| `SecurityContext` | | | | | -| source | string| `string` | | | Source contains the source code of the script to execute
+optional | | +| source | string| `string` | | | Source contains the source code of the script to execute
**Validation:** Optional.| | | startupProbe | [Probe](#probe)| `Probe` | | | | | -| stdin | boolean| `bool` | | | Whether this container should allocate a buffer for stdin in the container runtime. If this
is not set, reads from stdin in the container will always result in EOF.
Default is false.
+optional | | -| stdinOnce | boolean| `bool` | | | Whether the container runtime should close the stdin channel after it has been opened by
a single attach. When stdin is true the stdin stream will remain open across multiple attach
sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the
first client attaches to stdin, and then remains open and accepts data until the client disconnects,
at which time stdin is closed and remains closed until the container is restarted. If this
flag is false, a container processes that reads from stdin will never receive an EOF.
Default is false
+optional | | -| terminationMessagePath | string| `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.
+optional | | +| stdin | boolean| `bool` | | | 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.
**Validation:** Optional.| | +| stdinOnce | boolean| `bool` | | | 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
**Validation:** Optional.| | +| terminationMessagePath | string| `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.
**Validation:** Optional.| | | terminationMessagePolicy | [TerminationMessagePolicy](#termination-message-policy)| `TerminationMessagePolicy` | | | | | -| tty | boolean| `bool` | | | Whether this container should allocate a TTY for itself, also requires 'stdin' to be true.
Default is false.
+optional | | -| volumeDevices | [][VolumeDevice](#volume-device)| `[]*VolumeDevice` | | | volumeDevices is the list of block devices to be used by the container.
+patchMergeKey=devicePath
+patchStrategy=merge
+listType=map
+listMapKey=devicePath
+optional | | -| volumeMounts | [][VolumeMount](#volume-mount)| `[]*VolumeMount` | | | Pod volumes to mount into the container's filesystem.
Cannot be updated.
+optional
+patchMergeKey=mountPath
+patchStrategy=merge
+listType=map
+listMapKey=mountPath | | -| workingDir | string| `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.
+optional | | +| tty | boolean| `bool` | | | Whether this container should allocate a TTY for itself, also requires 'stdin' to be true.
Default is false.
**Validation:** Optional.| | +| volumeDevices | [][VolumeDevice](#volume-device)| `[]*VolumeDevice` | | | volumeDevices is the list of block devices to be used by the container.
**Validation:** Optional.| | +| volumeMounts | [][VolumeMount](#volume-mount)| `[]*VolumeMount` | | | Pod volumes to mount into the container's filesystem.
Cannot be updated.
**Validation:** Optional.| | +| workingDir | string| `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.
**Validation:** Optional.| | @@ -3478,7 +3440,6 @@ cause implementors to also use a fixed point implementation. > Only one profile source may be set. -+union @@ -3489,7 +3450,7 @@ cause implementors to also use a fixed point implementation. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| -| localhostProfile | string| `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.
+optional | | +| localhostProfile | string| `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.
**Validation:** Optional.| | | type | [SeccompProfileType](#seccomp-profile-type)| `SeccompProfileType` | | | | | @@ -3497,14 +3458,13 @@ cause implementors to also use a fixed point implementation. ### SeccompProfileType -> +enum | Name | Type | Go type | Default | Description | Example | |------|------|---------| ------- |-------------|---------| -| SeccompProfileType | string| string | | +enum | | +| SeccompProfileType | string| string | | | | @@ -3523,15 +3483,14 @@ key-value pairs as environment variables. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| -| name | string| `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
+optional
+default=""
+kubebuilder:default=""
TODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896. | | -| optional | boolean| `bool` | | | Specify whether the Secret must be defined
+optional | | +| name | string| `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
TODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.
**Validation:** Optional; Default: "".| | +| optional | boolean| `bool` | | | Specify whether the Secret must be defined
**Validation:** Optional.| | ### SecretKeySelector -> +structType=atomic @@ -3543,8 +3502,8 @@ key-value pairs as environment variables. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| | key | string| `string` | | | The key of the secret to select from. Must be a valid secret key. | | -| name | string| `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
+optional
+default=""
+kubebuilder:default=""
TODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896. | | -| optional | boolean| `bool` | | | Specify whether the Secret or its key must be defined
+optional | | +| name | string| `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
TODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.
**Validation:** Optional; Default: "".| | +| optional | boolean| `bool` | | | Specify whether the Secret or its key must be defined
**Validation:** Optional.| | @@ -3565,9 +3524,9 @@ mode. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| -| items | [][KeyToPath](#key-to-path)| `[]*KeyToPath` | | | 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 '..'.
+optional
+listType=atomic | | -| name | string| `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
+optional
+default=""
+kubebuilder:default=""
TODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896. | | -| optional | boolean| `bool` | | | optional field specify whether the Secret or its key must be defined
+optional | | +| items | [][KeyToPath](#key-to-path)| `[]*KeyToPath` | | | 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 '..'.
**Validation:** Optional.| | +| name | string| `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
TODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.
**Validation:** Optional; Default: "".| | +| optional | boolean| `bool` | | | optional field specify whether the Secret or its key must be defined
**Validation:** Optional.| | @@ -3587,10 +3546,10 @@ Secret volumes support ownership management and SELinux relabeling. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| -| defaultMode | int32 (formatted integer)| `int32` | | | 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.
+optional | | -| items | [][KeyToPath](#key-to-path)| `[]*KeyToPath` | | | 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 '..'.
+optional
+listType=atomic | | -| optional | boolean| `bool` | | | optional field specify whether the Secret or its keys must be defined
+optional | | -| secretName | string| `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
+optional | | +| defaultMode | int32 (formatted integer)| `int32` | | | 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.
**Validation:** Optional.| | +| items | [][KeyToPath](#key-to-path)| `[]*KeyToPath` | | | 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 '..'.
**Validation:** Optional.| | +| optional | boolean| `bool` | | | optional field specify whether the Secret or its keys must be defined
**Validation:** Optional.| | +| secretName | string| `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
**Validation:** Optional.| | @@ -3609,15 +3568,15 @@ are set, the values in SecurityContext take precedence. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| -| allowPrivilegeEscalation | boolean| `bool` | | | 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.
+optional | | +| allowPrivilegeEscalation | boolean| `bool` | | | 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.
**Validation:** Optional.| | | appArmorProfile | [AppArmorProfile](#app-armor-profile)| `AppArmorProfile` | | | | | | capabilities | [Capabilities](#capabilities)| `Capabilities` | | | | | -| privileged | boolean| `bool` | | | 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.
+optional | | +| privileged | boolean| `bool` | | | 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.
**Validation:** Optional.| | | procMount | [ProcMountType](#proc-mount-type)| `ProcMountType` | | | | | -| readOnlyRootFilesystem | boolean| `bool` | | | 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.
+optional | | -| runAsGroup | int64 (formatted integer)| `int64` | | | 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.
+optional | | -| runAsNonRoot | boolean| `bool` | | | Indicates that the container must run as a non-root user.
If true, the Kubelet will validate the image at runtime to ensure that it
does not run as UID 0 (root) and fail to start the container if it does.
If unset or false, no such validation will be performed.
May also be set in PodSecurityContext. If set in both SecurityContext and
PodSecurityContext, the value specified in SecurityContext takes precedence.
+optional | | -| runAsUser | int64 (formatted integer)| `int64` | | | 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.
+optional | | +| readOnlyRootFilesystem | boolean| `bool` | | | 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.
**Validation:** Optional.| | +| runAsGroup | int64 (formatted integer)| `int64` | | | 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.
**Validation:** Optional.| | +| runAsNonRoot | boolean| `bool` | | | 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.
**Validation:** Optional.| | +| runAsUser | int64 (formatted integer)| `int64` | | | 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.
**Validation:** Optional.| | | seLinuxOptions | [SELinuxOptions](#s-e-linux-options)| `SELinuxOptions` | | | | | | seccompProfile | [SeccompProfile](#seccomp-profile)| `SeccompProfile` | | | | | | windowsOptions | [WindowsSecurityContextOptions](#windows-security-context-options)| `WindowsSecurityContextOptions` | | | | | @@ -3648,7 +3607,6 @@ are set, the values in SecurityContext take precedence. > Sequence expands a workflow step into numeric range -+kubebuilder:validation:XValidation:rule="!(has(self.count) && has(self.end))",message="only one of count or end can be defined" @@ -3683,8 +3641,8 @@ otherwise). | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| -| audience | string| `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.
+optional | | -| expirationSeconds | int64 (formatted integer)| `int64` | | | expirationSeconds is the requested duration of validity of the service
account token. As the token approaches expiration, the kubelet volume
plugin will proactively rotate the service account token. The kubelet will
start trying to rotate the token if the token is older than 80 percent of
its time to live or if the token is older than 24 hours.Defaults to 1 hour
and must be at least 10 minutes.
+optional | | +| audience | string| `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.
**Validation:** Optional.| | +| expirationSeconds | int64 (formatted integer)| `int64` | | | 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.
**Validation:** Optional.| | | path | string| `string` | | | path is the path relative to the mount point of the file to project the
token into. | | @@ -3693,14 +3651,13 @@ otherwise). > Signal defines the stop signal of containers -+enum | Name | Type | Go type | Default | Description | Example | |------|------|---------| ------- |-------------|---------| -| Signal | string| string | | Signal defines the stop signal of containers
+enum | | +| Signal | string| string | | Signal defines the stop signal of containers| | @@ -3741,11 +3698,11 @@ otherwise). | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| -| fsType | string| `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.
+optional | | -| readOnly | boolean| `bool` | | | readOnly defaults to false (read/write). ReadOnly here will force
the ReadOnly setting in VolumeMounts.
+optional | | +| fsType | string| `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.
**Validation:** Optional.| | +| readOnly | boolean| `bool` | | | readOnly defaults to false (read/write). ReadOnly here will force
the ReadOnly setting in VolumeMounts.
**Validation:** Optional.| | | secretRef | [LocalObjectReference](#local-object-reference)| `LocalObjectReference` | | | | | | volumeName | string| `string` | | | volumeName is the human-readable name of the StorageOS volume. Volume
names are only unique within a namespace. | | -| volumeNamespace | string| `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.
+optional | | +| volumeNamespace | string| `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.
**Validation:** Optional.| | @@ -3754,14 +3711,13 @@ otherwise). > SupplementalGroupsPolicy defines how supplemental groups of the first container processes are calculated. -+enum | Name | Type | Go type | Default | Description | Example | |------|------|---------| ------- |-------------|---------| -| SupplementalGroupsPolicy | string| string | | SupplementalGroupsPolicy defines how supplemental groups
of the first container processes are calculated.
+enum | | +| SupplementalGroupsPolicy | string| string | | SupplementalGroupsPolicy defines how supplemental groups
of the first container processes are calculated.| | @@ -3857,7 +3813,7 @@ of the first container processes are calculated. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| -| host | string| `string` | | | Optional: Host name to connect to, defaults to the pod IP.
+optional | | +| host | string| `string` | | | Optional: Host name to connect to, defaults to the pod IP.
**Validation:** Optional.| | | port | [IntOrString](#int-or-string)| `IntOrString` | | | | | @@ -3865,14 +3821,13 @@ of the first container processes are calculated. ### TaintEffect -> +enum | Name | Type | Go type | Default | Description | Example | |------|------|---------| ------- |-------------|---------| -| TaintEffect | string| string | | +enum | | +| TaintEffect | string| string | | | | @@ -3920,33 +3875,33 @@ of the first container processes are calculated. | data | [Data](#data)| `Data` | | | | | | executor | [ExecutorConfig](#executor-config)| `ExecutorConfig` | | | | | | failFast | boolean| `bool` | | | FailFast, if specified, will fail this template if any of its child pods has failed. This is useful for when this
template is expanded with `withItems`, etc. | | -| hostAliases | [][HostAlias](#host-alias)| `[]*HostAlias` | | | HostAliases is an optional list of hosts and IPs that will be injected into the pod spec
+patchStrategy=merge
+patchMergeKey=ip | | +| hostAliases | [][HostAlias](#host-alias)| `[]*HostAlias` | | | HostAliases is an optional list of hosts and IPs that will be injected into the pod spec | | | http | [HTTP](#http)| `HTTP` | | | | | -| initContainers | [][UserContainer](#user-container)| `[]*UserContainer` | | | InitContainers is a list of containers which run before the main container.
+patchStrategy=merge
+patchMergeKey=name | | +| initContainers | [][UserContainer](#user-container)| `[]*UserContainer` | | | InitContainers is a list of containers which run before the main container. | | | inputs | [Inputs](#inputs)| `Inputs` | | | | | | memoize | [Memoize](#memoize)| `Memoize` | | | | | | metadata | [Metadata](#metadata)| `Metadata` | | | | | | metrics | [Metrics](#metrics)| `Metrics` | | | | | -| name | string| `string` | | | Name is the name of the template
+kubebuilder:validation:MaxLength=128
+kubebuilder:validation:Pattern=`^[a-zA-Z0-9][-a-zA-Z0-9]*$` | | +| name | string| `string` | | | Name is the name of the template
**Validation:** Maximum length: 128; Pattern: `^[a-zA-Z0-9][-a-zA-Z0-9]*$`.| | | nodeSelector | map of string| `map[string]string` | | | NodeSelector is a selector to schedule this step of the workflow to be
run on the selected node(s). Overrides the selector set at the workflow level. | | | outputs | [Outputs](#outputs)| `Outputs` | | | | | -| parallelism | int64 (formatted integer)| `int64` | | | Parallelism limits the max total parallel pods that can execute at the same time within the
boundaries of this template invocation. If additional steps/dag templates are invoked, the
pods created by those templates will not be counted towards this total.
+kubebuilder:validation:Minimum=1 | | +| parallelism | int64 (formatted integer)| `int64` | | | Parallelism limits the max total parallel pods that can execute at the same time within the
boundaries of this template invocation. If additional steps/dag templates are invoked, the
pods created by those templates will not be counted towards this total.
**Validation:** Minimum: 1.| | | plugin | [Plugin](#plugin)| `Plugin` | | | | | | podSpecPatch | string| `string` | | | PodSpecPatch holds strategic merge patch to apply against the pod spec. Allows parameterization of
container fields which are not strings (e.g. resource limits). | | | priorityClassName | string| `string` | | | PriorityClassName to apply to workflow pods. | | | resource | [ResourceTemplate](#resource-template)| `ResourceTemplate` | | | | | | retryStrategy | [RetryStrategy](#retry-strategy)| `RetryStrategy` | | | | | -| schedulerName | string| `string` | | | If specified, the pod will be dispatched by specified scheduler.
Or it will be dispatched by workflow scope scheduler if specified.
If neither specified, the pod will be dispatched by default scheduler.
+optional | | +| schedulerName | string| `string` | | | If specified, the pod will be dispatched by specified scheduler.
Or it will be dispatched by workflow scope scheduler if specified.
If neither specified, the pod will be dispatched by default scheduler.
**Validation:** Optional.| | | script | [ScriptTemplate](#script-template)| `ScriptTemplate` | | | | | | securityContext | [PodSecurityContext](#pod-security-context)| `PodSecurityContext` | | | | | | serviceAccountName | string| `string` | | | ServiceAccountName to apply to workflow pods | | -| sidecars | [][UserContainer](#user-container)| `[]*UserContainer` | | | Sidecars is a list of containers which run alongside the main container
Sidecars are automatically killed when the main container completes
+patchStrategy=merge
+patchMergeKey=name | | -| steps | [][ParallelSteps](#parallel-steps)| `[]ParallelSteps` | | | Steps define a series of sequential/parallel workflow steps
+kubebuilder:validation:MinItems=1 | | +| sidecars | [][UserContainer](#user-container)| `[]*UserContainer` | | | Sidecars is a list of containers which run alongside the main container
Sidecars are automatically killed when the main container completes | | +| steps | [][ParallelSteps](#parallel-steps)| `[]ParallelSteps` | | | Steps define a series of sequential/parallel workflow steps
**Validation:** Minimum items: 1.| | | suspend | [SuspendTemplate](#suspend-template)| `SuspendTemplate` | | | | | | synchronization | [Synchronization](#synchronization)| `Synchronization` | | | | | | timeout | string| `string` | | | Timeout allows to set the total node execution timeout duration counting from the node's start time.
This duration also includes time in which the node spends in Pending state. This duration may not be applied to Step or DAG templates. | | -| tolerations | [][Toleration](#toleration)| `[]*Toleration` | | | Tolerations to apply to workflow pods.
+patchStrategy=merge
+patchMergeKey=key | | -| volumes | [][Volume](#volume)| `[]*Volume` | | | Volumes is a list of volumes that can be mounted by containers in a template.
+patchStrategy=merge
+patchMergeKey=name | | +| tolerations | [][Toleration](#toleration)| `[]*Toleration` | | | Tolerations to apply to workflow pods. | | +| volumes | [][Volume](#volume)| `[]*Volume` | | | Volumes is a list of volumes that can be mounted by containers in a template. | | @@ -3970,14 +3925,13 @@ of the first container processes are calculated. ### TerminationMessagePolicy -> +enum | Name | Type | Go type | Default | Description | Example | |------|------|---------| ------- |-------------|---------| -| TerminationMessagePolicy | string| string | | +enum | | +| TerminationMessagePolicy | string| string | | | | @@ -3997,24 +3951,23 @@ the triple using the matching operator . | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| | effect | [TaintEffect](#taint-effect)| `TaintEffect` | | | | | -| key | string| `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.
+optional | | +| key | string| `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.
**Validation:** Optional.| | | operator | [TolerationOperator](#toleration-operator)| `TolerationOperator` | | | | | -| tolerationSeconds | int64 (formatted integer)| `int64` | | | TolerationSeconds represents the period of time the toleration (which must be
of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default,
it is not set, which means tolerate the taint forever (do not evict). Zero and
negative values will be treated as 0 (evict immediately) by the system.
+optional | | -| value | string| `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.
+optional | | +| tolerationSeconds | int64 (formatted integer)| `int64` | | | 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.
**Validation:** Optional.| | +| value | string| `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.
**Validation:** Optional.| | ### TolerationOperator -> +enum | Name | Type | Go type | Default | Description | Example | |------|------|---------| ------- |-------------|---------| -| TolerationOperator | string| string | | +enum | | +| TolerationOperator | string| string | | | | @@ -4067,7 +4020,6 @@ will affect numerous schemas. Don't make new APIs embed an underspecified API t Instead of using this type, create a locally provided and used type that is well-focused on your reference. For example, ServiceReferences for admission registration: https://github.com/kubernetes/api/blob/release-1.17/admissionregistration/v1/types.go#L533 . -+structType=atomic @@ -4078,7 +4030,7 @@ For example, ServiceReferences for admission registration: https://github.com/ku | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| -| apiGroup | string| `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.
+optional | | +| apiGroup | string| `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.
**Validation:** Optional.| | | kind | string| `string` | | | Kind is the type of resource being referenced | | | name | string| `string` | | | Name is the name of resource being referenced | | @@ -4098,10 +4050,10 @@ For example, ServiceReferences for admission registration: https://github.com/ku | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| -| apiGroup | string| `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.
+optional | | +| apiGroup | string| `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.
**Validation:** Optional.| | | kind | string| `string` | | | Kind is the type of resource being referenced | | | name | string| `string` | | | Name is the name of resource being referenced | | -| namespace | string| `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.
+featureGate=CrossNamespaceVolumeDataSource
+optional | | +| namespace | string| `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.
**Validation:** Optional.| | @@ -4125,14 +4077,13 @@ intent and helps make sure that UIDs and names do not get conflated. > URIScheme identifies the scheme used for connection to a host for Get actions -+enum | Name | Type | Go type | Default | Description | Example | |------|------|---------| ------- |-------------|---------| -| URIScheme | string| string | | URIScheme identifies the scheme used for connection to a host for Get actions
+enum | | +| URIScheme | string| string | | URIScheme identifies the scheme used for connection to a host for Get actions| | @@ -4147,31 +4098,31 @@ intent and helps make sure that UIDs and names do not get conflated. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| -| args | []string| `[]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
+optional
+listType=atomic | | -| command | []string| `[]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
+optional
+listType=atomic | | -| env | [][EnvVar](#env-var)| `[]*EnvVar` | | | List of environment variables to set in the container.
Cannot be updated.
+optional
+patchMergeKey=name
+patchStrategy=merge
+listType=map
+listMapKey=name | | -| envFrom | [][EnvFromSource](#env-from-source)| `[]*EnvFromSource` | | | List of sources to populate environment variables in the container.
The keys defined within a source must be a C_IDENTIFIER. All invalid keys
will be reported as an event when the container is starting. When a key exists in multiple
sources, the value associated with the last source will take precedence.
Values defined by an Env with a duplicate key will take precedence.
Cannot be updated.
+optional
+listType=atomic | | -| image | string| `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.
+optional | | +| args | []string| `[]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
**Validation:** Optional.| | +| command | []string| `[]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
**Validation:** Optional.| | +| env | [][EnvVar](#env-var)| `[]*EnvVar` | | | List of environment variables to set in the container.
Cannot be updated.
**Validation:** Optional.| | +| envFrom | [][EnvFromSource](#env-from-source)| `[]*EnvFromSource` | | | List of sources to populate environment variables in the container.
The keys defined within a source must be a C_IDENTIFIER. All invalid keys
will be reported as an event when the container is starting. When a key exists in multiple
sources, the value associated with the last source will take precedence.
Values defined by an Env with a duplicate key will take precedence.
Cannot be updated.
**Validation:** Optional.| | +| image | string| `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.
**Validation:** Optional.| | | imagePullPolicy | [PullPolicy](#pull-policy)| `PullPolicy` | | | | | | lifecycle | [Lifecycle](#lifecycle)| `Lifecycle` | | | | | | livenessProbe | [Probe](#probe)| `Probe` | | | | | | mirrorVolumeMounts | boolean| `bool` | | | MirrorVolumeMounts will mount the same volumes specified in the main container
to the container (including artifacts), at the same mountPaths. This enables
dind daemon to partially see the same filesystem as the main container in
order to use features such as docker volume binding | | | name | string| `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. | | -| ports | [][ContainerPort](#container-port)| `[]*ContainerPort` | | | 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.
+optional
+patchMergeKey=containerPort
+patchStrategy=merge
+listType=map
+listMapKey=containerPort
+listMapKey=protocol | | +| ports | [][ContainerPort](#container-port)| `[]*ContainerPort` | | | 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.
**Validation:** Optional.| | | readinessProbe | [Probe](#probe)| `Probe` | | | | | -| resizePolicy | [][ContainerResizePolicy](#container-resize-policy)| `[]*ContainerResizePolicy` | | | Resources resize policy for the container.
+featureGate=InPlacePodVerticalScaling
+optional
+listType=atomic | | +| resizePolicy | [][ContainerResizePolicy](#container-resize-policy)| `[]*ContainerResizePolicy` | | | Resources resize policy for the container.
**Validation:** Optional.| | | resources | [ResourceRequirements](#resource-requirements)| `ResourceRequirements` | | | | | | restartPolicy | [ContainerRestartPolicy](#container-restart-policy)| `ContainerRestartPolicy` | | | | | | securityContext | [SecurityContext](#security-context)| `SecurityContext` | | | | | | startupProbe | [Probe](#probe)| `Probe` | | | | | -| stdin | boolean| `bool` | | | Whether this container should allocate a buffer for stdin in the container runtime. If this
is not set, reads from stdin in the container will always result in EOF.
Default is false.
+optional | | -| stdinOnce | boolean| `bool` | | | Whether the container runtime should close the stdin channel after it has been opened by
a single attach. When stdin is true the stdin stream will remain open across multiple attach
sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the
first client attaches to stdin, and then remains open and accepts data until the client disconnects,
at which time stdin is closed and remains closed until the container is restarted. If this
flag is false, a container processes that reads from stdin will never receive an EOF.
Default is false
+optional | | -| terminationMessagePath | string| `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.
+optional | | +| stdin | boolean| `bool` | | | 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.
**Validation:** Optional.| | +| stdinOnce | boolean| `bool` | | | 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
**Validation:** Optional.| | +| terminationMessagePath | string| `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.
**Validation:** Optional.| | | terminationMessagePolicy | [TerminationMessagePolicy](#termination-message-policy)| `TerminationMessagePolicy` | | | | | -| tty | boolean| `bool` | | | Whether this container should allocate a TTY for itself, also requires 'stdin' to be true.
Default is false.
+optional | | -| volumeDevices | [][VolumeDevice](#volume-device)| `[]*VolumeDevice` | | | volumeDevices is the list of block devices to be used by the container.
+patchMergeKey=devicePath
+patchStrategy=merge
+listType=map
+listMapKey=devicePath
+optional | | -| volumeMounts | [][VolumeMount](#volume-mount)| `[]*VolumeMount` | | | Pod volumes to mount into the container's filesystem.
Cannot be updated.
+optional
+patchMergeKey=mountPath
+patchStrategy=merge
+listType=map
+listMapKey=mountPath | | -| workingDir | string| `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.
+optional | | +| tty | boolean| `bool` | | | Whether this container should allocate a TTY for itself, also requires 'stdin' to be true.
Default is false.
**Validation:** Optional.| | +| volumeDevices | [][VolumeDevice](#volume-device)| `[]*VolumeDevice` | | | volumeDevices is the list of block devices to be used by the container.
**Validation:** Optional.| | +| volumeMounts | [][VolumeMount](#volume-mount)| `[]*VolumeMount` | | | Pod volumes to mount into the container's filesystem.
Cannot be updated.
**Validation:** Optional.| | +| workingDir | string| `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.
**Validation:** Optional.| | @@ -4276,10 +4227,10 @@ intent and helps make sure that UIDs and names do not get conflated. | mountPath | string| `string` | | | Path within the container at which the volume should be mounted. Must
not contain ':'. | | | mountPropagation | [MountPropagationMode](#mount-propagation-mode)| `MountPropagationMode` | | | | | | name | string| `string` | | | This must match the Name of a Volume. | | -| readOnly | boolean| `bool` | | | Mounted read-only if true, read-write otherwise (false or unspecified).
Defaults to false.
+optional | | +| readOnly | boolean| `bool` | | | Mounted read-only if true, read-write otherwise (false or unspecified).
Defaults to false.
**Validation:** Optional.| | | recursiveReadOnly | [RecursiveReadOnlyMode](#recursive-read-only-mode)| `RecursiveReadOnlyMode` | | | | | -| subPath | string| `string` | | | Path within the volume from which the container's volume should be mounted.
Defaults to "" (volume's root).
+optional | | -| subPathExpr | string| `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.
+optional | | +| subPath | string| `string` | | | Path within the volume from which the container's volume should be mounted.
Defaults to "" (volume's root).
**Validation:** Optional.| | +| subPathExpr | string| `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.
**Validation:** Optional.| | @@ -4332,9 +4283,9 @@ intent and helps make sure that UIDs and names do not get conflated. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| -| fsType | string| `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.
+optional | | -| storagePolicyID | string| `string` | | | storagePolicyID is the storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.
+optional | | -| storagePolicyName | string| `string` | | | storagePolicyName is the storage Policy Based Management (SPBM) profile name.
+optional | | +| fsType | string| `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.
**Validation:** Optional.| | +| storagePolicyID | string| `string` | | | storagePolicyID is the storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.
**Validation:** Optional.| | +| storagePolicyName | string| `string` | | | storagePolicyName is the storage Policy Based Management (SPBM) profile name.
**Validation:** Optional.| | | volumePath | string| `string` | | | volumePath is the path that identifies vSphere volume vmdk | | @@ -4369,10 +4320,10 @@ intent and helps make sure that UIDs and names do not get conflated. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| -| gmsaCredentialSpec | string| `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.
+optional | | -| gmsaCredentialSpecName | string| `string` | | | GMSACredentialSpecName is the name of the GMSA credential spec to use.
+optional | | -| hostProcess | boolean| `bool` | | | 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.
+optional | | -| runAsUserName | string| `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.
+optional | | +| gmsaCredentialSpec | string| `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.
**Validation:** Optional.| | +| gmsaCredentialSpecName | string| `string` | | | GMSACredentialSpecName is the name of the GMSA credential spec to use.
**Validation:** Optional.| | +| hostProcess | boolean| `bool` | | | 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.
**Validation:** Optional.| | +| runAsUserName | string| `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.
**Validation:** Optional.| | diff --git a/hack/docgen/clean_swagger_md.py b/hack/docgen/clean_swagger_md.py new file mode 100755 index 000000000000..58cc1e4d18f8 --- /dev/null +++ b/hack/docgen/clean_swagger_md.py @@ -0,0 +1,284 @@ +#!/usr/bin/env python3 +""" +Clean up kubebuilder and other annotations in generated swagger markdown. + +Converts annotations to human-readable text in a "Validation" section. +""" + +import re +import sys + + +def parse_annotations(text): + """Extract annotations from text and return (clean_text, annotations_dict).""" + annotations = { + 'optional': False, + 'required': False, + 'default': None, + 'enum_values': None, + 'minimum': None, + 'maximum': None, + 'min_length': None, + 'max_length': None, + 'min_items': None, + 'max_items': None, + 'pattern': None, + } + + # Patterns to extract and their handlers + # Order matters - more specific patterns first + + # +optional + if re.search(r'\+optional\b', text): + annotations['optional'] = True + text = re.sub(r'
\+optional\b', '', text) + text = re.sub(r'\+optional\b', '', text) + + # +required + if re.search(r'\+required\b', text): + annotations['required'] = True + text = re.sub(r'
\+required\b', '', text) + text = re.sub(r'\+required\b', '', text) + + # +default="value" or +default=value or +kubebuilder:default="value" + match = re.search(r'\+(?:kubebuilder:)?default="([^"]*)"', text) + if match: + annotations['default'] = f'"{match.group(1)}"' + else: + match = re.search(r'\+(?:kubebuilder:)?default=(\S+?)(?:
|\s|\||$)', text) + if match: + annotations['default'] = match.group(1) + text = re.sub(r'
\+kubebuilder:default="[^"]*"', '', text) + text = re.sub(r'
\+kubebuilder:default=\S+?(?=
|\s|\||$)', '', text) + text = re.sub(r'\+kubebuilder:default="[^"]*"', '', text) + text = re.sub(r'\+kubebuilder:default=\S+?(?=
|\s|\||$)', '', text) + text = re.sub(r'
\+default="[^"]*"', '', text) + text = re.sub(r'
\+default=\S+?(?=
|\s|\||$)', '', text) + text = re.sub(r'\+default="[^"]*"', '', text) + text = re.sub(r'\+default=\S+?(?=
|\s|\||$)', '', text) + + # +kubebuilder:validation:Enum=A;B;C + match = re.search(r'\+kubebuilder:validation:Enum=([^|<\s]+)', text) + if match: + annotations['enum_values'] = match.group(1).replace(';', ', ') + text = re.sub(r'
\+kubebuilder:validation:Enum=[^|<\s]+', '', text) + text = re.sub(r'\+kubebuilder:validation:Enum=[^|<\s]+', '', text) + + # +kubebuilder:validation:Minimum=X + match = re.search(r'\+kubebuilder:validation:Minimum=(\d+)', text) + if match: + annotations['minimum'] = match.group(1) + text = re.sub(r'
\+kubebuilder:validation:Minimum=\d+', '', text) + text = re.sub(r'\+kubebuilder:validation:Minimum=\d+', '', text) + + # +kubebuilder:validation:Maximum=X + match = re.search(r'\+kubebuilder:validation:Maximum=(\d+)', text) + if match: + annotations['maximum'] = match.group(1) + text = re.sub(r'
\+kubebuilder:validation:Maximum=\d+', '', text) + text = re.sub(r'\+kubebuilder:validation:Maximum=\d+', '', text) + + # +kubebuilder:validation:MinLength=X + match = re.search(r'\+kubebuilder:validation:MinLength=(\d+)', text) + if match: + annotations['min_length'] = match.group(1) + text = re.sub(r'
\+kubebuilder:validation:MinLength=\d+', '', text) + text = re.sub(r'\+kubebuilder:validation:MinLength=\d+', '', text) + + # +kubebuilder:validation:MaxLength=X + match = re.search(r'\+kubebuilder:validation:MaxLength=(\d+)', text) + if match: + annotations['max_length'] = match.group(1) + text = re.sub(r'
\+kubebuilder:validation:MaxLength=\d+', '', text) + text = re.sub(r'\+kubebuilder:validation:MaxLength=\d+', '', text) + + # +kubebuilder:validation:MinItems=X + match = re.search(r'\+kubebuilder:validation:MinItems=(\d+)', text) + if match: + annotations['min_items'] = match.group(1) + text = re.sub(r'
\+kubebuilder:validation:MinItems=\d+', '', text) + text = re.sub(r'\+kubebuilder:validation:MinItems=\d+', '', text) + + # +kubebuilder:validation:MaxItems=X + match = re.search(r'\+kubebuilder:validation:MaxItems=(\d+)', text) + if match: + annotations['max_items'] = match.group(1) + text = re.sub(r'
\+kubebuilder:validation:MaxItems=\d+', '', text) + text = re.sub(r'\+kubebuilder:validation:MaxItems=\d+', '', text) + + # +kubebuilder:validation:Pattern=`X` + match = re.search(r'\+kubebuilder:validation:Pattern=`([^`]+)`', text) + if match: + annotations['pattern'] = match.group(1) + text = re.sub(r'
\+kubebuilder:validation:Pattern=`[^`]+`', '', text) + text = re.sub(r'\+kubebuilder:validation:Pattern=`[^`]+`', '', text) + + # Handle +enum - just remove it (it's a type marker, not useful in docs) + text = re.sub(r'\+enum\b', '', text) + + # Remove annotations we don't convert (internal implementation details) + patterns_to_remove = [ + r'
\+kubebuilder:validation:XValidation:[^|<]*', + r'\+kubebuilder:validation:XValidation:[^|]*', + r'
\+kubebuilder:validation:Type=[^|<\s]+', + r'\+kubebuilder:validation:Type=[^|\s]+', + r'
\+kubebuilder:validation:Schemaless', + r'\+kubebuilder:validation:Schemaless', + r'
\+kubebuilder:pruning:PreserveUnknownFields', + r'\+kubebuilder:pruning:PreserveUnknownFields', + r'
\+kubebuilder:[^|<]*', + r'\+kubebuilder:[^|]*', + r'
\+patchStrategy=[^|<\s]+', + r'\+patchStrategy=[^|\s]+', + r'
\+patchMergeKey=[^|<\s]+', + r'\+patchMergeKey=[^|\s]+', + r'
\+listType=[^|<\s]+', + r'\+listType=[^|\s]+', + r'
\+listMapKey=[^|<\s]+', + r'\+listMapKey=[^|\s]+', + r'
\+featureGate=[^|<\s]+', + r'\+featureGate=[^|\s]+', + r'
\+structType=[^|<\s]+', + r'\+structType=[^|\s]+', + r'
\+protobuf[^|<]*', + r'\+protobuf[^|]*', + r'
\+union\b', + r'\+union\b', + r'
\+k8s:[^|<\s]+', + r'\+k8s:[^|\s]+', + ] + + for pattern in patterns_to_remove: + text = re.sub(pattern, '', text) + + return text, annotations + + +def build_validation_section(annotations): + """Build a human-readable validation section from annotations.""" + parts = [] + + if annotations['optional']: + parts.append('Optional') + if annotations['required']: + parts.append('Required') + if annotations['default'] is not None: + parts.append(f"Default: {annotations['default']}") + if annotations['enum_values']: + parts.append(f"Valid values: {annotations['enum_values']}") + if annotations['minimum'] is not None: + parts.append(f"Minimum: {annotations['minimum']}") + if annotations['maximum'] is not None: + parts.append(f"Maximum: {annotations['maximum']}") + if annotations['min_length'] is not None: + parts.append(f"Minimum length: {annotations['min_length']}") + if annotations['max_length'] is not None: + parts.append(f"Maximum length: {annotations['max_length']}") + if annotations['min_items'] is not None: + parts.append(f"Minimum items: {annotations['min_items']}") + if annotations['max_items'] is not None: + parts.append(f"Maximum items: {annotations['max_items']}") + if annotations['pattern']: + parts.append(f"Pattern: `{annotations['pattern']}`") + + if not parts: + return '' + + return '
**Validation:** ' + '; '.join(parts) + '.' + + +def process_table_cell(cell): + """Process a table cell that might contain annotations.""" + clean_text, annotations = parse_annotations(cell) + validation_section = build_validation_section(annotations) + + # Clean up any trailing
before adding validation (but preserve cell spacing) + clean_text = re.sub(r'(
)+\s*$', '', clean_text) + + if validation_section: + clean_text = clean_text + validation_section + + return clean_text + + +def process_line(line): + """Process a single line, handling table rows specially.""" + # Check if this is a table row + if line.startswith('|') and '|' in line[1:]: + # Split into cells + cells = line.split('|') + # Process each cell (skip first and last which are empty due to leading/trailing |) + processed_cells = [] + for i, cell in enumerate(cells): + if i == 0 or i == len(cells) - 1: + processed_cells.append(cell) + else: + processed_cells.append(process_table_cell(cell)) + return '|'.join(processed_cells) + + # Check for standalone annotation lines like "> +kubebuilder:..." or "+kubebuilder:..." + if re.match(r'^>?\s*\+kubebuilder:', line): + return None # Remove this line + if re.match(r'^>?\s*\+enum\s*$', line): + return None # Remove standalone +enum lines + if re.match(r'^>?\s*\+union\s*$', line): + return None # Remove standalone +union lines + if re.match(r'^>?\s*\+structType=', line): + return None + if re.match(r'^>?\s*\+protobuf', line): + return None + + # For description lines, also clean up annotations + if '|' not in line: + clean_text, annotations = parse_annotations(line) + validation_section = build_validation_section(annotations) + if validation_section: + clean_text = clean_text.rstrip() + ' ' + validation_section.replace('
', ' ') + # Clean up +enum from inline text + clean_text = re.sub(r'\s*\+enum\s*', '', clean_text) + return clean_text + + return line + + +def process_markdown(content): + """Process the entire markdown content.""" + lines = content.split('\n') + processed_lines = [] + + for line in lines: + processed = process_line(line) + if processed is not None: + processed_lines.append(processed) + + result = '\n'.join(processed_lines) + + # Also fix the interface{} links issue + result = re.sub(r'\[interface{}\]\(#interface\)', '`interface{}`', result) + + # Clean up any multiple
(but don't touch other whitespace) + result = re.sub(r'(
){2,}', '
', result) + + return result + + +def main(): + if len(sys.argv) != 2: + print(f"Usage: {sys.argv[0]} ", file=sys.stderr) + sys.exit(1) + + filepath = sys.argv[1] + + with open(filepath, 'r') as f: + content = f.read() + + processed = process_markdown(content) + + with open(filepath, 'w') as f: + f.write(processed) + + print(f"Processed {filepath}") + + +if __name__ == '__main__': + main() From 4e2810aa991e7c06455aeef325cbb89aec0aca0f Mon Sep 17 00:00:00 2001 From: Alan Clucas Date: Wed, 3 Dec 2025 14:46:51 +0000 Subject: [PATCH 2/6] Update hack/docgen/clean_swagger_md.py Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: Alan Clucas --- hack/docgen/clean_swagger_md.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/hack/docgen/clean_swagger_md.py b/hack/docgen/clean_swagger_md.py index 58cc1e4d18f8..88f892f47200 100755 --- a/hack/docgen/clean_swagger_md.py +++ b/hack/docgen/clean_swagger_md.py @@ -269,12 +269,12 @@ def main(): filepath = sys.argv[1] - with open(filepath, 'r') as f: + with open(filepath, 'r', encoding='utf-8') as f: content = f.read() processed = process_markdown(content) - with open(filepath, 'w') as f: + with open(filepath, 'w', encoding='utf-8') as f: f.write(processed) print(f"Processed {filepath}") From ce85610c383057ca10fe374ad5835ed6efa9a45b Mon Sep 17 00:00:00 2001 From: Alan Clucas Date: Thu, 4 Dec 2025 09:04:25 +0000 Subject: [PATCH 3/6] fix: tidy Signed-off-by: Alan Clucas --- Makefile | 2 +- hack/docgen/clean_swagger_md.py | 215 +++++++++++------------------- hack/docs/clean_swagger_md.py | 227 ++++++++++++++++++++++++++++++++ 3 files changed, 307 insertions(+), 137 deletions(-) create mode 100755 hack/docs/clean_swagger_md.py diff --git a/Makefile b/Makefile index d949eb64b132..6eae68d386cc 100644 --- a/Makefile +++ b/Makefile @@ -354,7 +354,7 @@ codegen: types swagger manifests $(TOOL_MOCKERY) $(GENERATED_DOCS) ## Generate c go generate ./... $(TOOL_MOCKERY) --config .mockery.yaml # Clean up kubebuilder annotations and convert to human-readable validation section - python3 hack/docgen/clean_swagger_md.py docs/executor_swagger.md + python3 hack/docs/clean_swagger_md.py docs/executor_swagger.md make --directory sdks/java USE_NIX=$(USE_NIX) generate make --directory sdks/python USE_NIX=$(USE_NIX) generate diff --git a/hack/docgen/clean_swagger_md.py b/hack/docgen/clean_swagger_md.py index 88f892f47200..4f71e9b853ff 100755 --- a/hack/docgen/clean_swagger_md.py +++ b/hack/docgen/clean_swagger_md.py @@ -9,36 +9,24 @@ import sys +def extract_and_remove(text, search_pattern, remove_pattern): + """Extract a value using search_pattern, then remove all matches of remove_pattern.""" + match = re.search(search_pattern, text) + value = match.group(1) if match else None + text = re.sub(r'
' + remove_pattern, '', text) + text = re.sub(remove_pattern, '', text) + return text, value + + def parse_annotations(text): """Extract annotations from text and return (clean_text, annotations_dict).""" - annotations = { - 'optional': False, - 'required': False, - 'default': None, - 'enum_values': None, - 'minimum': None, - 'maximum': None, - 'min_length': None, - 'max_length': None, - 'min_items': None, - 'max_items': None, - 'pattern': None, - } - - # Patterns to extract and their handlers - # Order matters - more specific patterns first - - # +optional - if re.search(r'\+optional\b', text): - annotations['optional'] = True - text = re.sub(r'
\+optional\b', '', text) - text = re.sub(r'\+optional\b', '', text) - - # +required - if re.search(r'\+required\b', text): - annotations['required'] = True - text = re.sub(r'
\+required\b', '', text) - text = re.sub(r'\+required\b', '', text) + annotations = {} + + # Boolean flags + for name in ('optional', 'required'): + annotations[name] = bool(re.search(rf'\+{name}\b', text)) + text = re.sub(rf'
\+{name}\b', '', text) + text = re.sub(rf'\+{name}\b', '', text) # +default="value" or +default=value or +kubebuilder:default="value" match = re.search(r'\+(?:kubebuilder:)?default="([^"]*)"', text) @@ -46,109 +34,64 @@ def parse_annotations(text): annotations['default'] = f'"{match.group(1)}"' else: match = re.search(r'\+(?:kubebuilder:)?default=(\S+?)(?:
|\s|\||$)', text) - if match: - annotations['default'] = match.group(1) - text = re.sub(r'
\+kubebuilder:default="[^"]*"', '', text) - text = re.sub(r'
\+kubebuilder:default=\S+?(?=
|\s|\||$)', '', text) - text = re.sub(r'\+kubebuilder:default="[^"]*"', '', text) - text = re.sub(r'\+kubebuilder:default=\S+?(?=
|\s|\||$)', '', text) - text = re.sub(r'
\+default="[^"]*"', '', text) - text = re.sub(r'
\+default=\S+?(?=
|\s|\||$)', '', text) - text = re.sub(r'\+default="[^"]*"', '', text) - text = re.sub(r'\+default=\S+?(?=
|\s|\||$)', '', text) - - # +kubebuilder:validation:Enum=A;B;C - match = re.search(r'\+kubebuilder:validation:Enum=([^|<\s]+)', text) - if match: - annotations['enum_values'] = match.group(1).replace(';', ', ') - text = re.sub(r'
\+kubebuilder:validation:Enum=[^|<\s]+', '', text) - text = re.sub(r'\+kubebuilder:validation:Enum=[^|<\s]+', '', text) - - # +kubebuilder:validation:Minimum=X - match = re.search(r'\+kubebuilder:validation:Minimum=(\d+)', text) - if match: - annotations['minimum'] = match.group(1) - text = re.sub(r'
\+kubebuilder:validation:Minimum=\d+', '', text) - text = re.sub(r'\+kubebuilder:validation:Minimum=\d+', '', text) - - # +kubebuilder:validation:Maximum=X - match = re.search(r'\+kubebuilder:validation:Maximum=(\d+)', text) - if match: - annotations['maximum'] = match.group(1) - text = re.sub(r'
\+kubebuilder:validation:Maximum=\d+', '', text) - text = re.sub(r'\+kubebuilder:validation:Maximum=\d+', '', text) - - # +kubebuilder:validation:MinLength=X - match = re.search(r'\+kubebuilder:validation:MinLength=(\d+)', text) - if match: - annotations['min_length'] = match.group(1) - text = re.sub(r'
\+kubebuilder:validation:MinLength=\d+', '', text) - text = re.sub(r'\+kubebuilder:validation:MinLength=\d+', '', text) - - # +kubebuilder:validation:MaxLength=X - match = re.search(r'\+kubebuilder:validation:MaxLength=(\d+)', text) - if match: - annotations['max_length'] = match.group(1) - text = re.sub(r'
\+kubebuilder:validation:MaxLength=\d+', '', text) - text = re.sub(r'\+kubebuilder:validation:MaxLength=\d+', '', text) - - # +kubebuilder:validation:MinItems=X - match = re.search(r'\+kubebuilder:validation:MinItems=(\d+)', text) - if match: - annotations['min_items'] = match.group(1) - text = re.sub(r'
\+kubebuilder:validation:MinItems=\d+', '', text) - text = re.sub(r'\+kubebuilder:validation:MinItems=\d+', '', text) - - # +kubebuilder:validation:MaxItems=X - match = re.search(r'\+kubebuilder:validation:MaxItems=(\d+)', text) - if match: - annotations['max_items'] = match.group(1) - text = re.sub(r'
\+kubebuilder:validation:MaxItems=\d+', '', text) - text = re.sub(r'\+kubebuilder:validation:MaxItems=\d+', '', text) + annotations['default'] = match.group(1) if match else None + for prefix in (r'\+kubebuilder:default', r'\+default'): + text = re.sub(rf'
{prefix}="[^"]*"', '', text) + text = re.sub(rf'
{prefix}=\S+?(?=
|\s|\||$)', '', text) + text = re.sub(rf'{prefix}="[^"]*"', '', text) + text = re.sub(rf'{prefix}=\S+?(?=
|\s|\||$)', '', text) + + # +kubebuilder:validation:Enum=A;B;C (special: semicolons become commas) + text, enum_val = extract_and_remove( + text, + r'\+kubebuilder:validation:Enum=([^|<\s]+)', + r'\+kubebuilder:validation:Enum=[^|<\s]+') + annotations['enum_values'] = enum_val.replace(';', ', ') if enum_val else None + + # Numeric kubebuilder validations + validation_fields = [ + ('minimum', 'Minimum'), + ('maximum', 'Maximum'), + ('min_length', 'MinLength'), + ('max_length', 'MaxLength'), + ('min_items', 'MinItems'), + ('max_items', 'MaxItems'), + ] + for key, validator in validation_fields: + text, annotations[key] = extract_and_remove( + text, + rf'\+kubebuilder:validation:{validator}=(\d+)', + rf'\+kubebuilder:validation:{validator}=\d+') # +kubebuilder:validation:Pattern=`X` - match = re.search(r'\+kubebuilder:validation:Pattern=`([^`]+)`', text) - if match: - annotations['pattern'] = match.group(1) - text = re.sub(r'
\+kubebuilder:validation:Pattern=`[^`]+`', '', text) - text = re.sub(r'\+kubebuilder:validation:Pattern=`[^`]+`', '', text) + text, annotations['pattern'] = extract_and_remove( + text, + r'\+kubebuilder:validation:Pattern=`([^`]+)`', + r'\+kubebuilder:validation:Pattern=`[^`]+`') # Handle +enum - just remove it (it's a type marker, not useful in docs) text = re.sub(r'\+enum\b', '', text) # Remove annotations we don't convert (internal implementation details) patterns_to_remove = [ - r'
\+kubebuilder:validation:XValidation:[^|<]*', - r'\+kubebuilder:validation:XValidation:[^|]*', - r'
\+kubebuilder:validation:Type=[^|<\s]+', - r'\+kubebuilder:validation:Type=[^|\s]+', - r'
\+kubebuilder:validation:Schemaless', + r'\+kubebuilder:validation:XValidation:[^|<]*', + r'\+kubebuilder:validation:Type=[^|<\s]+', r'\+kubebuilder:validation:Schemaless', - r'
\+kubebuilder:pruning:PreserveUnknownFields', r'\+kubebuilder:pruning:PreserveUnknownFields', - r'
\+kubebuilder:[^|<]*', - r'\+kubebuilder:[^|]*', - r'
\+patchStrategy=[^|<\s]+', - r'\+patchStrategy=[^|\s]+', - r'
\+patchMergeKey=[^|<\s]+', - r'\+patchMergeKey=[^|\s]+', - r'
\+listType=[^|<\s]+', - r'\+listType=[^|\s]+', - r'
\+listMapKey=[^|<\s]+', - r'\+listMapKey=[^|\s]+', - r'
\+featureGate=[^|<\s]+', - r'\+featureGate=[^|\s]+', - r'
\+structType=[^|<\s]+', - r'\+structType=[^|\s]+', - r'
\+protobuf[^|<]*', - r'\+protobuf[^|]*', - r'
\+union\b', + r'\+kubebuilder:[^|<]*', + r'\+patchStrategy=[^|<\s]+', + r'\+patchMergeKey=[^|<\s]+', + r'\+listType=[^|<\s]+', + r'\+listMapKey=[^|<\s]+', + r'\+featureGate=[^|<\s]+', + r'\+structType=[^|<\s]+', + r'\+protobuf[^|<]*', r'\+union\b', - r'
\+k8s:[^|<\s]+', - r'\+k8s:[^|\s]+', + r'\+k8s:[^|<\s]+', ] for pattern in patterns_to_remove: + text = re.sub(r'
' + pattern, '', text) text = re.sub(pattern, '', text) return text, annotations @@ -158,27 +101,27 @@ def build_validation_section(annotations): """Build a human-readable validation section from annotations.""" parts = [] - if annotations['optional']: + if annotations.get('optional'): parts.append('Optional') - if annotations['required']: + if annotations.get('required'): parts.append('Required') - if annotations['default'] is not None: - parts.append(f"Default: {annotations['default']}") - if annotations['enum_values']: - parts.append(f"Valid values: {annotations['enum_values']}") - if annotations['minimum'] is not None: - parts.append(f"Minimum: {annotations['minimum']}") - if annotations['maximum'] is not None: - parts.append(f"Maximum: {annotations['maximum']}") - if annotations['min_length'] is not None: - parts.append(f"Minimum length: {annotations['min_length']}") - if annotations['max_length'] is not None: - parts.append(f"Maximum length: {annotations['max_length']}") - if annotations['min_items'] is not None: - parts.append(f"Minimum items: {annotations['min_items']}") - if annotations['max_items'] is not None: - parts.append(f"Maximum items: {annotations['max_items']}") - if annotations['pattern']: + + # Fields with labels + labeled_fields = [ + ('default', 'Default'), + ('enum_values', 'Valid values'), + ('minimum', 'Minimum'), + ('maximum', 'Maximum'), + ('min_length', 'Minimum length'), + ('max_length', 'Maximum length'), + ('min_items', 'Minimum items'), + ('max_items', 'Maximum items'), + ] + for key, label in labeled_fields: + if annotations.get(key) is not None: + parts.append(f"{label}: {annotations[key]}") + + if annotations.get('pattern'): parts.append(f"Pattern: `{annotations['pattern']}`") if not parts: diff --git a/hack/docs/clean_swagger_md.py b/hack/docs/clean_swagger_md.py new file mode 100755 index 000000000000..a3a4dfb3a376 --- /dev/null +++ b/hack/docs/clean_swagger_md.py @@ -0,0 +1,227 @@ +#!/usr/bin/env python3 +""" +Clean up kubebuilder and other annotations in generated swagger markdown. + +Converts annotations to human-readable text in a "Validation" section. +""" + +import re +import sys + + +def extract_and_remove(text, search_pattern, remove_pattern): + """Extract a value using search_pattern, then remove all matches of remove_pattern.""" + match = re.search(search_pattern, text) + value = match.group(1) if match else None + text = re.sub(r'
' + remove_pattern, '', text) + text = re.sub(remove_pattern, '', text) + return text, value + + +def parse_annotations(text): + """Extract annotations from text and return (clean_text, annotations_dict).""" + annotations = {} + + # Boolean flags + for name in ('optional', 'required'): + annotations[name] = bool(re.search(rf'\+{name}\b', text)) + text = re.sub(rf'
\+{name}\b', '', text) + text = re.sub(rf'\+{name}\b', '', text) + + # +default="value" or +default=value or +kubebuilder:default="value" + match = re.search(r'\+(?:kubebuilder:)?default="([^"]*)"', text) + if match: + annotations['default'] = f'"{match.group(1)}"' + else: + match = re.search(r'\+(?:kubebuilder:)?default=(\S+?)(?:
|\s|\||$)', text) + annotations['default'] = match.group(1) if match else None + for prefix in (r'\+kubebuilder:default', r'\+default'): + text = re.sub(rf'
{prefix}="[^"]*"', '', text) + text = re.sub(rf'
{prefix}=\S+?(?=
|\s|\||$)', '', text) + text = re.sub(rf'{prefix}="[^"]*"', '', text) + text = re.sub(rf'{prefix}=\S+?(?=
|\s|\||$)', '', text) + + # +kubebuilder:validation:Enum=A;B;C (special: semicolons become commas) + text, enum_val = extract_and_remove( + text, + r'\+kubebuilder:validation:Enum=([^|<\s]+)', + r'\+kubebuilder:validation:Enum=[^|<\s]+') + annotations['enum_values'] = enum_val.replace(';', ', ') if enum_val else None + + # Numeric kubebuilder validations + validation_fields = [ + ('minimum', 'Minimum'), + ('maximum', 'Maximum'), + ('min_length', 'MinLength'), + ('max_length', 'MaxLength'), + ('min_items', 'MinItems'), + ('max_items', 'MaxItems'), + ] + for key, validator in validation_fields: + text, annotations[key] = extract_and_remove( + text, + rf'\+kubebuilder:validation:{validator}=([+-]?\d+)', + rf'\+kubebuilder:validation:{validator}=[+-]?\d+') + + # +kubebuilder:validation:Pattern=`X` + text, annotations['pattern'] = extract_and_remove( + text, + r'\+kubebuilder:validation:Pattern=`([^`]+)`', + r'\+kubebuilder:validation:Pattern=`[^`]+`') + + # Handle +enum - just remove it (it's a type marker, not useful in docs) + text = re.sub(r'\+enum\b', '', text) + + # Remove annotations we don't convert (internal implementation details) + patterns_to_remove = [ + r'\+kubebuilder:validation:XValidation:[^|<]*', + r'\+kubebuilder:validation:Type=[^|<\s]+', + r'\+kubebuilder:validation:Schemaless', + r'\+kubebuilder:pruning:PreserveUnknownFields', + r'\+kubebuilder:[^|<]*', + r'\+patchStrategy=[^|<\s]+', + r'\+patchMergeKey=[^|<\s]+', + r'\+listType=[^|<\s]+', + r'\+listMapKey=[^|<\s]+', + r'\+featureGate=[^|<\s]+', + r'\+structType=[^|<\s]+', + r'\+protobuf[^|<]*', + r'\+union\b', + r'\+k8s:[^|<\s]+', + ] + + for pattern in patterns_to_remove: + text = re.sub(r'
' + pattern, '', text) + text = re.sub(pattern, '', text) + + return text, annotations + + +def build_validation_section(annotations): + """Build a human-readable validation section from annotations.""" + parts = [] + + if annotations.get('optional'): + parts.append('Optional') + if annotations.get('required'): + parts.append('Required') + + # Fields with labels + labeled_fields = [ + ('default', 'Default'), + ('enum_values', 'Valid values'), + ('minimum', 'Minimum'), + ('maximum', 'Maximum'), + ('min_length', 'Minimum length'), + ('max_length', 'Maximum length'), + ('min_items', 'Minimum items'), + ('max_items', 'Maximum items'), + ] + for key, label in labeled_fields: + if annotations.get(key) is not None: + parts.append(f"{label}: {annotations[key]}") + + if annotations.get('pattern'): + parts.append(f"Pattern: `{annotations['pattern']}`") + + if not parts: + return '' + + return '
**Validation:** ' + '; '.join(parts) + '.' + + +def process_table_cell(cell): + """Process a table cell that might contain annotations.""" + clean_text, annotations = parse_annotations(cell) + validation_section = build_validation_section(annotations) + + # Clean up any trailing
before adding validation (but preserve cell spacing) + clean_text = re.sub(r'(
)+\s*$', '', clean_text) + + if validation_section: + clean_text = clean_text + validation_section + + return clean_text + + +def process_line(line): + """Process a single line, handling table rows specially.""" + # Check if this is a table row + if line.startswith('|') and '|' in line[1:]: + # Split into cells + cells = line.split('|') + # Process each cell (skip first and last which are empty due to leading/trailing |) + processed_cells = [] + for i, cell in enumerate(cells): + if i == 0 or i == len(cells) - 1: + processed_cells.append(cell) + else: + processed_cells.append(process_table_cell(cell)) + return '|'.join(processed_cells) + + # Check for standalone annotation lines like "> +kubebuilder:..." or "+kubebuilder:..." + if re.match(r'^>?\s*\+kubebuilder:', line): + return None # Remove this line + if re.match(r'^>?\s*\+enum\s*$', line): + return None # Remove standalone +enum lines + if re.match(r'^>?\s*\+union\s*$', line): + return None # Remove standalone +union lines + if re.match(r'^>?\s*\+structType=', line): + return None + if re.match(r'^>?\s*\+protobuf', line): + return None + + # For description lines, also clean up annotations + if '|' not in line: + clean_text, annotations = parse_annotations(line) + validation_section = build_validation_section(annotations) + if validation_section: + clean_text = clean_text.rstrip() + ' ' + validation_section.replace('
', ' ') + # Clean up +enum from inline text + clean_text = re.sub(r'\s*\+enum\s*', '', clean_text) + return clean_text + + return line + + +def process_markdown(content): + """Process the entire markdown content.""" + lines = content.split('\n') + processed_lines = [] + + for line in lines: + processed = process_line(line) + if processed is not None: + processed_lines.append(processed) + + result = '\n'.join(processed_lines) + + # Also fix the interface{} links issue + result = re.sub(r'\[interface{}\]\(#interface\)', '`interface{}`', result) + + # Clean up any multiple
(but don't touch other whitespace) + result = re.sub(r'(
){2,}', '
', result) + + return result + + +def main(): + if len(sys.argv) != 2: + print(f"Usage: {sys.argv[0]} ", file=sys.stderr) + sys.exit(1) + + filepath = sys.argv[1] + + with open(filepath, 'r', encoding='utf-8') as f: + content = f.read() + + processed = process_markdown(content) + + with open(filepath, 'w', encoding='utf-8') as f: + f.write(processed) + + print(f"Processed {filepath}") + + +if __name__ == '__main__': + main() From 8ca226bbd8286cd8410fab051fca1d9214a59dc6 Mon Sep 17 00:00:00 2001 From: Alan Clucas Date: Fri, 5 Dec 2025 09:22:32 +0000 Subject: [PATCH 4/6] chore: remove moved file Signed-off-by: Alan Clucas --- hack/docgen/clean_swagger_md.py | 227 -------------------------------- 1 file changed, 227 deletions(-) delete mode 100755 hack/docgen/clean_swagger_md.py diff --git a/hack/docgen/clean_swagger_md.py b/hack/docgen/clean_swagger_md.py deleted file mode 100755 index 4f71e9b853ff..000000000000 --- a/hack/docgen/clean_swagger_md.py +++ /dev/null @@ -1,227 +0,0 @@ -#!/usr/bin/env python3 -""" -Clean up kubebuilder and other annotations in generated swagger markdown. - -Converts annotations to human-readable text in a "Validation" section. -""" - -import re -import sys - - -def extract_and_remove(text, search_pattern, remove_pattern): - """Extract a value using search_pattern, then remove all matches of remove_pattern.""" - match = re.search(search_pattern, text) - value = match.group(1) if match else None - text = re.sub(r'
' + remove_pattern, '', text) - text = re.sub(remove_pattern, '', text) - return text, value - - -def parse_annotations(text): - """Extract annotations from text and return (clean_text, annotations_dict).""" - annotations = {} - - # Boolean flags - for name in ('optional', 'required'): - annotations[name] = bool(re.search(rf'\+{name}\b', text)) - text = re.sub(rf'
\+{name}\b', '', text) - text = re.sub(rf'\+{name}\b', '', text) - - # +default="value" or +default=value or +kubebuilder:default="value" - match = re.search(r'\+(?:kubebuilder:)?default="([^"]*)"', text) - if match: - annotations['default'] = f'"{match.group(1)}"' - else: - match = re.search(r'\+(?:kubebuilder:)?default=(\S+?)(?:
|\s|\||$)', text) - annotations['default'] = match.group(1) if match else None - for prefix in (r'\+kubebuilder:default', r'\+default'): - text = re.sub(rf'
{prefix}="[^"]*"', '', text) - text = re.sub(rf'
{prefix}=\S+?(?=
|\s|\||$)', '', text) - text = re.sub(rf'{prefix}="[^"]*"', '', text) - text = re.sub(rf'{prefix}=\S+?(?=
|\s|\||$)', '', text) - - # +kubebuilder:validation:Enum=A;B;C (special: semicolons become commas) - text, enum_val = extract_and_remove( - text, - r'\+kubebuilder:validation:Enum=([^|<\s]+)', - r'\+kubebuilder:validation:Enum=[^|<\s]+') - annotations['enum_values'] = enum_val.replace(';', ', ') if enum_val else None - - # Numeric kubebuilder validations - validation_fields = [ - ('minimum', 'Minimum'), - ('maximum', 'Maximum'), - ('min_length', 'MinLength'), - ('max_length', 'MaxLength'), - ('min_items', 'MinItems'), - ('max_items', 'MaxItems'), - ] - for key, validator in validation_fields: - text, annotations[key] = extract_and_remove( - text, - rf'\+kubebuilder:validation:{validator}=(\d+)', - rf'\+kubebuilder:validation:{validator}=\d+') - - # +kubebuilder:validation:Pattern=`X` - text, annotations['pattern'] = extract_and_remove( - text, - r'\+kubebuilder:validation:Pattern=`([^`]+)`', - r'\+kubebuilder:validation:Pattern=`[^`]+`') - - # Handle +enum - just remove it (it's a type marker, not useful in docs) - text = re.sub(r'\+enum\b', '', text) - - # Remove annotations we don't convert (internal implementation details) - patterns_to_remove = [ - r'\+kubebuilder:validation:XValidation:[^|<]*', - r'\+kubebuilder:validation:Type=[^|<\s]+', - r'\+kubebuilder:validation:Schemaless', - r'\+kubebuilder:pruning:PreserveUnknownFields', - r'\+kubebuilder:[^|<]*', - r'\+patchStrategy=[^|<\s]+', - r'\+patchMergeKey=[^|<\s]+', - r'\+listType=[^|<\s]+', - r'\+listMapKey=[^|<\s]+', - r'\+featureGate=[^|<\s]+', - r'\+structType=[^|<\s]+', - r'\+protobuf[^|<]*', - r'\+union\b', - r'\+k8s:[^|<\s]+', - ] - - for pattern in patterns_to_remove: - text = re.sub(r'
' + pattern, '', text) - text = re.sub(pattern, '', text) - - return text, annotations - - -def build_validation_section(annotations): - """Build a human-readable validation section from annotations.""" - parts = [] - - if annotations.get('optional'): - parts.append('Optional') - if annotations.get('required'): - parts.append('Required') - - # Fields with labels - labeled_fields = [ - ('default', 'Default'), - ('enum_values', 'Valid values'), - ('minimum', 'Minimum'), - ('maximum', 'Maximum'), - ('min_length', 'Minimum length'), - ('max_length', 'Maximum length'), - ('min_items', 'Minimum items'), - ('max_items', 'Maximum items'), - ] - for key, label in labeled_fields: - if annotations.get(key) is not None: - parts.append(f"{label}: {annotations[key]}") - - if annotations.get('pattern'): - parts.append(f"Pattern: `{annotations['pattern']}`") - - if not parts: - return '' - - return '
**Validation:** ' + '; '.join(parts) + '.' - - -def process_table_cell(cell): - """Process a table cell that might contain annotations.""" - clean_text, annotations = parse_annotations(cell) - validation_section = build_validation_section(annotations) - - # Clean up any trailing
before adding validation (but preserve cell spacing) - clean_text = re.sub(r'(
)+\s*$', '', clean_text) - - if validation_section: - clean_text = clean_text + validation_section - - return clean_text - - -def process_line(line): - """Process a single line, handling table rows specially.""" - # Check if this is a table row - if line.startswith('|') and '|' in line[1:]: - # Split into cells - cells = line.split('|') - # Process each cell (skip first and last which are empty due to leading/trailing |) - processed_cells = [] - for i, cell in enumerate(cells): - if i == 0 or i == len(cells) - 1: - processed_cells.append(cell) - else: - processed_cells.append(process_table_cell(cell)) - return '|'.join(processed_cells) - - # Check for standalone annotation lines like "> +kubebuilder:..." or "+kubebuilder:..." - if re.match(r'^>?\s*\+kubebuilder:', line): - return None # Remove this line - if re.match(r'^>?\s*\+enum\s*$', line): - return None # Remove standalone +enum lines - if re.match(r'^>?\s*\+union\s*$', line): - return None # Remove standalone +union lines - if re.match(r'^>?\s*\+structType=', line): - return None - if re.match(r'^>?\s*\+protobuf', line): - return None - - # For description lines, also clean up annotations - if '|' not in line: - clean_text, annotations = parse_annotations(line) - validation_section = build_validation_section(annotations) - if validation_section: - clean_text = clean_text.rstrip() + ' ' + validation_section.replace('
', ' ') - # Clean up +enum from inline text - clean_text = re.sub(r'\s*\+enum\s*', '', clean_text) - return clean_text - - return line - - -def process_markdown(content): - """Process the entire markdown content.""" - lines = content.split('\n') - processed_lines = [] - - for line in lines: - processed = process_line(line) - if processed is not None: - processed_lines.append(processed) - - result = '\n'.join(processed_lines) - - # Also fix the interface{} links issue - result = re.sub(r'\[interface{}\]\(#interface\)', '`interface{}`', result) - - # Clean up any multiple
(but don't touch other whitespace) - result = re.sub(r'(
){2,}', '
', result) - - return result - - -def main(): - if len(sys.argv) != 2: - print(f"Usage: {sys.argv[0]} ", file=sys.stderr) - sys.exit(1) - - filepath = sys.argv[1] - - with open(filepath, 'r', encoding='utf-8') as f: - content = f.read() - - processed = process_markdown(content) - - with open(filepath, 'w', encoding='utf-8') as f: - f.write(processed) - - print(f"Processed {filepath}") - - -if __name__ == '__main__': - main() From a879ff31f1672d609236baf5ef83f03c34540671 Mon Sep 17 00:00:00 2001 From: Alan Clucas Date: Fri, 5 Dec 2025 11:05:44 +0000 Subject: [PATCH 5/6] docs: Tidy up the validation words Signed-off-by: Alan Clucas --- docs/executor_swagger.md | 542 +++++++++++++++++----------------- hack/docs/clean_swagger_md.py | 14 +- 2 files changed, 277 insertions(+), 279 deletions(-) diff --git a/docs/executor_swagger.md b/docs/executor_swagger.md index 4efb17e82ddd..d97470f9940f 100644 --- a/docs/executor_swagger.md +++ b/docs/executor_swagger.md @@ -81,9 +81,9 @@ ownership management and SELinux relabeling. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| -| fsType | string| `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
TODO: how do we prevent errors in the filesystem from compromising the machine
**Validation:** Optional.| | -| partition | int32 (formatted integer)| `int32` | | | 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).
**Validation:** Optional.| | -| readOnly | boolean| `bool` | | | readOnly value true will force the readOnly setting in VolumeMounts.
More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
**Validation:** Optional.| | +| fsType | string| `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
TODO: how do we prevent errors in the filesystem from compromising the machine
*Optional.*| | +| partition | int32 (formatted integer)| `int32` | | | 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).
*Optional.*| | +| readOnly | boolean| `bool` | | | readOnly value true will force the readOnly setting in VolumeMounts.
More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
*Optional.*| | | volumeID | string| `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 | | @@ -142,7 +142,7 @@ It will marshall back to string - marshalling is not symmetric. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| -| localhostProfile | string| `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".
**Validation:** Optional.| | +| localhostProfile | string| `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".
*Optional.*| | | type | [AppArmorProfileType](#app-armor-profile-type)| `AppArmorProfileType` | | | | | @@ -226,8 +226,8 @@ It will marshall back to string - marshalling is not symmetric. | globalName | string| `string` | | | GlobalName exports an output artifact to the global scope, making it available as
'{{workflow.outputs.artifacts.XXXX}} and in workflow.status.outputs.artifacts | | | hdfs | [HDFSArtifact](#h-d-f-s-artifact)| `HDFSArtifact` | | | | | | http | [HTTPArtifact](#http-artifact)| `HTTPArtifact` | | | | | -| mode | int32 (formatted integer)| `int32` | | | mode bits to use on this file, must be a value between 0 and 0777.
Set when loading input artifacts. It is recommended to set the mode value
to ensure the artifact has the expected permissions in your container.
**Validation:** Minimum: 0; Maximum: 511.| | -| name | string| `string` | | | name of the artifact. must be unique within a template's inputs/outputs.
**Validation:** Pattern: `^[-a-zA-Z0-9_{}.]+$`.| | +| mode | int32 (formatted integer)| `int32` | | | mode bits to use on this file, must be a value between 0 and 0777.
Set when loading input artifacts. It is recommended to set the mode value
to ensure the artifact has the expected permissions in your container.
*Minimum value: 0; Maximum value: 511.*| | +| name | string| `string` | | | name of the artifact. must be unique within a template's inputs/outputs.
*Validation regex: `^[-a-zA-Z0-9_{}.]+$`.*| | | optional | boolean| `bool` | | | Make Artifacts optional, if Artifacts doesn't generate or exist | | | oss | [OSSArtifact](#o-s-s-artifact)| `OSSArtifact` | | | | | | path | string| `string` | | | Path is the container path to the artifact | | @@ -327,8 +327,8 @@ of a single workflow step, which the executor will use as a default location to | globalName | string| `string` | | | GlobalName exports an output artifact to the global scope, making it available as
'{{workflow.outputs.artifacts.XXXX}} and in workflow.status.outputs.artifacts | | | hdfs | [HDFSArtifact](#h-d-f-s-artifact)| `HDFSArtifact` | | | | | | http | [HTTPArtifact](#http-artifact)| `HTTPArtifact` | | | | | -| mode | int32 (formatted integer)| `int32` | | | mode bits to use on this file, must be a value between 0 and 0777.
Set when loading input artifacts. It is recommended to set the mode value
to ensure the artifact has the expected permissions in your container.
**Validation:** Minimum: 0; Maximum: 511.| | -| name | string| `string` | | | name of the artifact. must be unique within a template's inputs/outputs.
**Validation:** Pattern: `^[-a-zA-Z0-9_{}.]+$`.| | +| mode | int32 (formatted integer)| `int32` | | | mode bits to use on this file, must be a value between 0 and 0777.
Set when loading input artifacts. It is recommended to set the mode value
to ensure the artifact has the expected permissions in your container.
*Minimum value: 0; Maximum value: 511.*| | +| name | string| `string` | | | name of the artifact. must be unique within a template's inputs/outputs.
*Validation regex: `^[-a-zA-Z0-9_{}.]+$`.*| | | optional | boolean| `bool` | | | Make Artifacts optional, if Artifacts doesn't generate or exist | | | oss | [OSSArtifact](#o-s-s-artifact)| `OSSArtifact` | | | | | | path | string| `string` | | | Path is the container path to the artifact | | @@ -443,9 +443,9 @@ of a single workflow step, which the executor will use as a default location to | cachingMode | [AzureDataDiskCachingMode](#azure-data-disk-caching-mode)| `AzureDataDiskCachingMode` | | | | | | diskName | string| `string` | | | diskName is the Name of the data disk in the blob storage | | | diskURI | string| `string` | | | diskURI is the URI of data disk in the blob storage | | -| fsType | string| `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.
**Validation:** Optional; Default: "ext4".| | +| fsType | string| `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.
*Optional; Default value: "ext4".*| | | kind | [AzureDataDiskKind](#azure-data-disk-kind)| `AzureDataDiskKind` | | | | | -| readOnly | boolean| `bool` | | | readOnly Defaults to false (read/write). ReadOnly here will force
the ReadOnly setting in VolumeMounts.
**Validation:** Optional; Default: false.| | +| readOnly | boolean| `bool` | | | readOnly Defaults to false (read/write). ReadOnly here will force
the ReadOnly setting in VolumeMounts.
*Optional; Default value: false.*| | @@ -460,7 +460,7 @@ of a single workflow step, which the executor will use as a default location to | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| -| readOnly | boolean| `bool` | | | readOnly defaults to false (read/write). ReadOnly here will force
the ReadOnly setting in VolumeMounts.
**Validation:** Optional.| | +| readOnly | boolean| `bool` | | | readOnly defaults to false (read/write). ReadOnly here will force
the ReadOnly setting in VolumeMounts.
*Optional.*| | | secretName | string| `string` | | | secretName is the name of secret that contains Azure Storage Account Name and Key | | | shareName | string| `string` | | | shareName is the azure share Name | | @@ -521,10 +521,10 @@ of a single workflow step, which the executor will use as a default location to | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| | driver | string| `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. | | -| fsType | string| `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.
**Validation:** Optional.| | +| fsType | string| `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.
*Optional.*| | | nodePublishSecretRef | [LocalObjectReference](#local-object-reference)| `LocalObjectReference` | | | | | -| readOnly | boolean| `bool` | | | readOnly specifies a read-only configuration for the volume.
Defaults to false (read/write).
**Validation:** Optional.| | -| volumeAttributes | map of string| `map[string]string` | | | volumeAttributes stores driver-specific properties that are passed to the CSI
driver. Consult your driver's documentation for supported values.
**Validation:** Optional.| | +| readOnly | boolean| `bool` | | | readOnly specifies a read-only configuration for the volume.
Defaults to false (read/write).
*Optional.*| | +| volumeAttributes | map of string| `map[string]string` | | | volumeAttributes stores driver-specific properties that are passed to the CSI
driver. Consult your driver's documentation for supported values.
*Optional.*| | @@ -557,8 +557,8 @@ of a single workflow step, which the executor will use as a default location to | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| -| add | [][Capability](#capability)| `[]Capability` | | | Added capabilities
**Validation:** Optional.| | -| drop | [][Capability](#capability)| `[]Capability` | | | Removed capabilities
**Validation:** Optional.| | +| add | [][Capability](#capability)| `[]Capability` | | | Added capabilities
*Optional.*| | +| drop | [][Capability](#capability)| `[]Capability` | | | Removed capabilities
*Optional.*| | @@ -592,11 +592,11 @@ Cephfs volumes do not support ownership management or SELinux relabeling. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| | monitors | []string| `[]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 | | -| path | string| `string` | | | path is Optional: Used as the mounted root, rather than the full Ceph tree, default is /
**Validation:** Optional.| | -| readOnly | boolean| `bool` | | | 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
**Validation:** Optional.| | -| secretFile | string| `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
**Validation:** Optional.| | +| path | string| `string` | | | path is Optional: Used as the mounted root, rather than the full Ceph tree, default is /
*Optional.*| | +| readOnly | boolean| `bool` | | | 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
*Optional.*| | +| secretFile | string| `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
*Optional.*| | | secretRef | [LocalObjectReference](#local-object-reference)| `LocalObjectReference` | | | | | -| user | string| `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
**Validation:** Optional.| | +| user | string| `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
*Optional.*| | @@ -616,8 +616,8 @@ Cinder volumes support ownership management and SELinux relabeling. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| -| fsType | string| `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
**Validation:** Optional.| | -| readOnly | boolean| `bool` | | | 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
**Validation:** Optional.| | +| fsType | string| `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
*Optional.*| | +| readOnly | boolean| `bool` | | | 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
*Optional.*| | | secretRef | [LocalObjectReference](#local-object-reference)| `LocalObjectReference` | | | | | | volumeID | string| `string` | | | volumeID used to identify the volume in cinder.
More info: https://examples.k8s.io/mysql-cinder-pd/README.md | | @@ -659,10 +659,10 @@ filesystem. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| | labelSelector | [LabelSelector](#label-selector)| `LabelSelector` | | | | | -| name | string| `string` | | | Select a single ClusterTrustBundle by object name. Mutually-exclusive
with signerName and labelSelector.
**Validation:** Optional.| | -| optional | boolean| `bool` | | | 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.
**Validation:** Optional.| | +| name | string| `string` | | | Select a single ClusterTrustBundle by object name. Mutually-exclusive
with signerName and labelSelector.
*Optional.*| | +| optional | boolean| `bool` | | | 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.
*Optional.*| | | path | string| `string` | | | Relative path from the volume root to write the bundle. | | -| signerName | string| `string` | | | Select all ClusterTrustBundles that match this signer name.
Mutually-exclusive with name. The contents of all selected
ClusterTrustBundles will be unified and deduplicated.
**Validation:** Optional.| | +| signerName | string| `string` | | | Select all ClusterTrustBundles that match this signer name.
Mutually-exclusive with name. The contents of all selected
ClusterTrustBundles will be unified and deduplicated.
*Optional.*| | @@ -681,8 +681,8 @@ key-value pairs as environment variables. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| -| name | string| `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
TODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.
**Validation:** Optional; Default: "".| | -| optional | boolean| `bool` | | | Specify whether the ConfigMap must be defined
**Validation:** Optional.| | +| name | string| `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
TODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.
*Optional; Default value: "".*| | +| optional | boolean| `bool` | | | Specify whether the ConfigMap must be defined
*Optional.*| | @@ -700,8 +700,8 @@ key-value pairs as environment variables. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| | key | string| `string` | | | The key to select. | | -| name | string| `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
TODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.
**Validation:** Optional; Default: "".| | -| optional | boolean| `bool` | | | Specify whether the ConfigMap or its key must be defined
**Validation:** Optional.| | +| name | string| `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
TODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.
*Optional; Default value: "".*| | +| optional | boolean| `bool` | | | Specify whether the ConfigMap or its key must be defined
*Optional.*| | @@ -723,9 +723,9 @@ mode. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| -| items | [][KeyToPath](#key-to-path)| `[]*KeyToPath` | | | 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 '..'.
**Validation:** Optional.| | -| name | string| `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
TODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.
**Validation:** Optional; Default: "".| | -| optional | boolean| `bool` | | | optional specify whether the ConfigMap or its keys must be defined
**Validation:** Optional.| | +| items | [][KeyToPath](#key-to-path)| `[]*KeyToPath` | | | 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 '..'.
*Optional.*| | +| name | string| `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
TODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.
*Optional; Default value: "".*| | +| optional | boolean| `bool` | | | optional specify whether the ConfigMap or its keys must be defined
*Optional.*| | @@ -746,10 +746,10 @@ ConfigMap volumes support ownership management and SELinux relabeling. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| -| defaultMode | int32 (formatted integer)| `int32` | | | 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.
**Validation:** Optional.| | -| items | [][KeyToPath](#key-to-path)| `[]*KeyToPath` | | | 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 '..'.
**Validation:** Optional.| | -| name | string| `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
TODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.
**Validation:** Optional; Default: "".| | -| optional | boolean| `bool` | | | optional specify whether the ConfigMap or its keys must be defined
**Validation:** Optional.| | +| defaultMode | int32 (formatted integer)| `int32` | | | 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.
*Optional.*| | +| items | [][KeyToPath](#key-to-path)| `[]*KeyToPath` | | | 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 '..'.
*Optional.*| | +| name | string| `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
TODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.
*Optional; Default value: "".*| | +| optional | boolean| `bool` | | | optional specify whether the ConfigMap or its keys must be defined
*Optional.*| | @@ -764,30 +764,30 @@ ConfigMap volumes support ownership management and SELinux relabeling. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| -| args | []string| `[]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
**Validation:** Optional.| | -| command | []string| `[]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
**Validation:** Optional.| | -| env | [][EnvVar](#env-var)| `[]*EnvVar` | | | List of environment variables to set in the container.
Cannot be updated.
**Validation:** Optional.| | -| envFrom | [][EnvFromSource](#env-from-source)| `[]*EnvFromSource` | | | List of sources to populate environment variables in the container.
The keys defined within a source must be a C_IDENTIFIER. All invalid keys
will be reported as an event when the container is starting. When a key exists in multiple
sources, the value associated with the last source will take precedence.
Values defined by an Env with a duplicate key will take precedence.
Cannot be updated.
**Validation:** Optional.| | -| image | string| `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.
**Validation:** Optional.| | +| args | []string| `[]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
*Optional.*| | +| command | []string| `[]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
*Optional.*| | +| env | [][EnvVar](#env-var)| `[]*EnvVar` | | | List of environment variables to set in the container.
Cannot be updated.
*Optional.*| | +| envFrom | [][EnvFromSource](#env-from-source)| `[]*EnvFromSource` | | | List of sources to populate environment variables in the container.
The keys defined within a source must be a C_IDENTIFIER. All invalid keys
will be reported as an event when the container is starting. When a key exists in multiple
sources, the value associated with the last source will take precedence.
Values defined by an Env with a duplicate key will take precedence.
Cannot be updated.
*Optional.*| | +| image | string| `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.
*Optional.*| | | imagePullPolicy | [PullPolicy](#pull-policy)| `PullPolicy` | | | | | | lifecycle | [Lifecycle](#lifecycle)| `Lifecycle` | | | | | | livenessProbe | [Probe](#probe)| `Probe` | | | | | | name | string| `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. | | -| ports | [][ContainerPort](#container-port)| `[]*ContainerPort` | | | 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.
**Validation:** Optional.| | +| ports | [][ContainerPort](#container-port)| `[]*ContainerPort` | | | 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.
*Optional.*| | | readinessProbe | [Probe](#probe)| `Probe` | | | | | -| resizePolicy | [][ContainerResizePolicy](#container-resize-policy)| `[]*ContainerResizePolicy` | | | Resources resize policy for the container.
**Validation:** Optional.| | +| resizePolicy | [][ContainerResizePolicy](#container-resize-policy)| `[]*ContainerResizePolicy` | | | Resources resize policy for the container.
*Optional.*| | | resources | [ResourceRequirements](#resource-requirements)| `ResourceRequirements` | | | | | | restartPolicy | [ContainerRestartPolicy](#container-restart-policy)| `ContainerRestartPolicy` | | | | | | securityContext | [SecurityContext](#security-context)| `SecurityContext` | | | | | | startupProbe | [Probe](#probe)| `Probe` | | | | | -| stdin | boolean| `bool` | | | 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.
**Validation:** Optional.| | -| stdinOnce | boolean| `bool` | | | 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
**Validation:** Optional.| | -| terminationMessagePath | string| `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.
**Validation:** Optional.| | +| stdin | boolean| `bool` | | | Whether this container should allocate a buffer for stdin in the container runtime. If this
is not set, reads from stdin in the container will always result in EOF.
Default is false.
*Optional.*| | +| stdinOnce | boolean| `bool` | | | Whether the container runtime should close the stdin channel after it has been opened by
a single attach. When stdin is true the stdin stream will remain open across multiple attach
sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the
first client attaches to stdin, and then remains open and accepts data until the client disconnects,
at which time stdin is closed and remains closed until the container is restarted. If this
flag is false, a container processes that reads from stdin will never receive an EOF.
Default is false
*Optional.*| | +| terminationMessagePath | string| `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.
*Optional.*| | | terminationMessagePolicy | [TerminationMessagePolicy](#termination-message-policy)| `TerminationMessagePolicy` | | | | | -| tty | boolean| `bool` | | | Whether this container should allocate a TTY for itself, also requires 'stdin' to be true.
Default is false.
**Validation:** Optional.| | -| volumeDevices | [][VolumeDevice](#volume-device)| `[]*VolumeDevice` | | | volumeDevices is the list of block devices to be used by the container.
**Validation:** Optional.| | -| volumeMounts | [][VolumeMount](#volume-mount)| `[]*VolumeMount` | | | Pod volumes to mount into the container's filesystem.
Cannot be updated.
**Validation:** Optional.| | -| workingDir | string| `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.
**Validation:** Optional.| | +| tty | boolean| `bool` | | | Whether this container should allocate a TTY for itself, also requires 'stdin' to be true.
Default is false.
*Optional.*| | +| volumeDevices | [][VolumeDevice](#volume-device)| `[]*VolumeDevice` | | | volumeDevices is the list of block devices to be used by the container.
*Optional.*| | +| volumeMounts | [][VolumeMount](#volume-mount)| `[]*VolumeMount` | | | Pod volumes to mount into the container's filesystem.
Cannot be updated.
*Optional.*| | +| workingDir | string| `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.
*Optional.*| | @@ -802,31 +802,31 @@ ConfigMap volumes support ownership management and SELinux relabeling. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| -| args | []string| `[]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
**Validation:** Optional.| | -| command | []string| `[]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
**Validation:** Optional.| | +| args | []string| `[]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
*Optional.*| | +| command | []string| `[]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
*Optional.*| | | dependencies | []string| `[]string` | | | | | -| env | [][EnvVar](#env-var)| `[]*EnvVar` | | | List of environment variables to set in the container.
Cannot be updated.
**Validation:** Optional.| | -| envFrom | [][EnvFromSource](#env-from-source)| `[]*EnvFromSource` | | | List of sources to populate environment variables in the container.
The keys defined within a source must be a C_IDENTIFIER. All invalid keys
will be reported as an event when the container is starting. When a key exists in multiple
sources, the value associated with the last source will take precedence.
Values defined by an Env with a duplicate key will take precedence.
Cannot be updated.
**Validation:** Optional.| | -| image | string| `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.
**Validation:** Optional.| | +| env | [][EnvVar](#env-var)| `[]*EnvVar` | | | List of environment variables to set in the container.
Cannot be updated.
*Optional.*| | +| envFrom | [][EnvFromSource](#env-from-source)| `[]*EnvFromSource` | | | List of sources to populate environment variables in the container.
The keys defined within a source must be a C_IDENTIFIER. All invalid keys
will be reported as an event when the container is starting. When a key exists in multiple
sources, the value associated with the last source will take precedence.
Values defined by an Env with a duplicate key will take precedence.
Cannot be updated.
*Optional.*| | +| image | string| `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.
*Optional.*| | | imagePullPolicy | [PullPolicy](#pull-policy)| `PullPolicy` | | | | | | lifecycle | [Lifecycle](#lifecycle)| `Lifecycle` | | | | | | livenessProbe | [Probe](#probe)| `Probe` | | | | | | name | string| `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. | | -| ports | [][ContainerPort](#container-port)| `[]*ContainerPort` | | | 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.
**Validation:** Optional.| | +| ports | [][ContainerPort](#container-port)| `[]*ContainerPort` | | | 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.
*Optional.*| | | readinessProbe | [Probe](#probe)| `Probe` | | | | | -| resizePolicy | [][ContainerResizePolicy](#container-resize-policy)| `[]*ContainerResizePolicy` | | | Resources resize policy for the container.
**Validation:** Optional.| | +| resizePolicy | [][ContainerResizePolicy](#container-resize-policy)| `[]*ContainerResizePolicy` | | | Resources resize policy for the container.
*Optional.*| | | resources | [ResourceRequirements](#resource-requirements)| `ResourceRequirements` | | | | | | restartPolicy | [ContainerRestartPolicy](#container-restart-policy)| `ContainerRestartPolicy` | | | | | | securityContext | [SecurityContext](#security-context)| `SecurityContext` | | | | | | startupProbe | [Probe](#probe)| `Probe` | | | | | -| stdin | boolean| `bool` | | | 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.
**Validation:** Optional.| | -| stdinOnce | boolean| `bool` | | | 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
**Validation:** Optional.| | -| terminationMessagePath | string| `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.
**Validation:** Optional.| | +| stdin | boolean| `bool` | | | Whether this container should allocate a buffer for stdin in the container runtime. If this
is not set, reads from stdin in the container will always result in EOF.
Default is false.
*Optional.*| | +| stdinOnce | boolean| `bool` | | | Whether the container runtime should close the stdin channel after it has been opened by
a single attach. When stdin is true the stdin stream will remain open across multiple attach
sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the
first client attaches to stdin, and then remains open and accepts data until the client disconnects,
at which time stdin is closed and remains closed until the container is restarted. If this
flag is false, a container processes that reads from stdin will never receive an EOF.
Default is false
*Optional.*| | +| terminationMessagePath | string| `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.
*Optional.*| | | terminationMessagePolicy | [TerminationMessagePolicy](#termination-message-policy)| `TerminationMessagePolicy` | | | | | -| tty | boolean| `bool` | | | Whether this container should allocate a TTY for itself, also requires 'stdin' to be true.
Default is false.
**Validation:** Optional.| | -| volumeDevices | [][VolumeDevice](#volume-device)| `[]*VolumeDevice` | | | volumeDevices is the list of block devices to be used by the container.
**Validation:** Optional.| | -| volumeMounts | [][VolumeMount](#volume-mount)| `[]*VolumeMount` | | | Pod volumes to mount into the container's filesystem.
Cannot be updated.
**Validation:** Optional.| | -| workingDir | string| `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.
**Validation:** Optional.| | +| tty | boolean| `bool` | | | Whether this container should allocate a TTY for itself, also requires 'stdin' to be true.
Default is false.
*Optional.*| | +| volumeDevices | [][VolumeDevice](#volume-device)| `[]*VolumeDevice` | | | volumeDevices is the list of block devices to be used by the container.
*Optional.*| | +| volumeMounts | [][VolumeMount](#volume-mount)| `[]*VolumeMount` | | | Pod volumes to mount into the container's filesystem.
Cannot be updated.
*Optional.*| | +| workingDir | string| `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.
*Optional.*| | @@ -842,9 +842,9 @@ ConfigMap volumes support ownership management and SELinux relabeling. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| | containerPort | int32 (formatted integer)| `int32` | | | Number of port to expose on the pod's IP address.
This must be a valid port number, 0 < x < 65536. | | -| hostIP | string| `string` | | | What host IP to bind the external port to.
**Validation:** Optional.| | -| hostPort | int32 (formatted integer)| `int32` | | | 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.
**Validation:** Optional.| | -| name | string| `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.
**Validation:** Optional.| | +| hostIP | string| `string` | | | What host IP to bind the external port to.
*Optional.*| | +| hostPort | int32 (formatted integer)| `int32` | | | Number of port to expose on the host.
If specified, this must be a valid port number, 0 < x < 65536.
If HostNetwork is specified, this must match ContainerPort.
Most containers do not need this.
*Optional.*| | +| name | string| `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.
*Optional.*| | | protocol | [Protocol](#protocol)| `Protocol` | | | | | @@ -929,8 +929,8 @@ ConfigMap volumes support ownership management and SELinux relabeling. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| -| error | boolean| `bool` | | |
**Validation:** Optional.| | -| failed | boolean| `bool` | | |
**Validation:** Optional.| | +| error | boolean| `bool` | | |
*Optional.*| | +| failed | boolean| `bool` | | |
*Optional.*| | @@ -948,7 +948,7 @@ ConfigMap volumes support ownership management and SELinux relabeling. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| -| value | string| `string` | | | Value is the value of the metric
**Validation:** Minimum length: 1.| | +| value | string| `string` | | | Value is the value of the metric
*Minimum length: 1.*| | @@ -991,7 +991,7 @@ Note: CEL validation cannot check withItems (Schemaless) or inline (PreserveUnkn | depends | string| `string` | | | Depends are name of other targets which this depends on | | | hooks | [LifecycleHooks](#lifecycle-hooks)| `LifecycleHooks` | | | | | | inline | [Template](#template)| `Template` | | | | | -| name | string| `string` | | | Name is the name of the target
**Validation:** Maximum length: 128; Pattern: `^[a-zA-Z0-9][-a-zA-Z0-9]*$`.| | +| name | string| `string` | | | Name is the name of the target
*Maximum length: 128; Validation regex: `^[a-zA-Z0-9][-a-zA-Z0-9]*$`.*| | | onExit | string| `string` | | | OnExit is a template reference which is invoked at the end of the
template, irrespective of the success, failure, or error of the
primary template.
DEPRECATED: Use Hooks[exit].Template instead. | | | template | string| `string` | | | Name of template to execute | | | templateRef | [TemplateRef](#template-ref)| `TemplateRef` | | | | | @@ -1018,7 +1018,7 @@ Note: CEL validation cannot check withItems (Schemaless) or inline (PreserveUnkn |------|------|---------|:--------:| ------- |-------------|---------| | failFast | boolean| `bool` | | | This flag is for DAG logic. The DAG logic has a built-in "fail fast" feature to stop scheduling new steps,
as soon as it detects that one of the DAG nodes is failed. Then it waits until all DAG nodes are completed
before failing the DAG itself.
The FailFast flag default is true, if set to false, it will allow a DAG to run all branches of the DAG to
completion (either success or failure), regardless of the failed outcomes of branches in the DAG.
More info and example about this feature at https://github.com/argoproj/argo-workflows/issues/1442 | | | target | string| `string` | | | Target are one or more names of targets to execute in a DAG | | -| tasks | [][DAGTask](#d-a-g-task)| `[]*DAGTask` | | | Tasks are a list of DAG tasks
MaxItems is an artificial limit to limit CEL validation costs - see note at top of file
**Validation:** Minimum items: 1; Maximum items: 200.| | +| tasks | [][DAGTask](#d-a-g-task)| `[]*DAGTask` | | | Tasks are a list of DAG tasks
MaxItems is an artificial limit to limit CEL validation costs - see note at top of file
*Minimum items: 1; Maximum items: 200.*| | @@ -1074,7 +1074,7 @@ mode. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| -| items | [][DownwardAPIVolumeFile](#downward-api-volume-file)| `[]*DownwardAPIVolumeFile` | | | Items is a list of DownwardAPIVolume file
**Validation:** Optional.| | +| items | [][DownwardAPIVolumeFile](#downward-api-volume-file)| `[]*DownwardAPIVolumeFile` | | | Items is a list of DownwardAPIVolume file
*Optional.*| | @@ -1093,7 +1093,7 @@ mode. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| | fieldRef | [ObjectFieldSelector](#object-field-selector)| `ObjectFieldSelector` | | | | | -| mode | int32 (formatted integer)| `int32` | | | 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.
**Validation:** Optional.| | +| mode | int32 (formatted integer)| `int32` | | | 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.
*Optional.*| | | path | string| `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 '..' | | | resourceFieldRef | [ResourceFieldSelector](#resource-field-selector)| `ResourceFieldSelector` | | | | | @@ -1113,8 +1113,8 @@ mode. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| -| defaultMode | int32 (formatted integer)| `int32` | | | 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.
**Validation:** Optional.| | -| items | [][DownwardAPIVolumeFile](#downward-api-volume-file)| `[]*DownwardAPIVolumeFile` | | | Items is a list of downward API volume file
**Validation:** Optional.| | +| defaultMode | int32 (formatted integer)| `int32` | | | 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.
*Optional.*| | +| items | [][DownwardAPIVolumeFile](#downward-api-volume-file)| `[]*DownwardAPIVolumeFile` | | | Items is a list of downward API volume file
*Optional.*| | @@ -1164,7 +1164,7 @@ can be used as map keys in json. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| | configMapRef | [ConfigMapEnvSource](#config-map-env-source)| `ConfigMapEnvSource` | | | | | -| prefix | string| `string` | | | Optional text to prepend to the name of each environment variable. Must be a C_IDENTIFIER.
**Validation:** Optional.| | +| prefix | string| `string` | | | Optional text to prepend to the name of each environment variable. Must be a C_IDENTIFIER.
*Optional.*| | | secretRef | [SecretEnvSource](#secret-env-source)| `SecretEnvSource` | | | | | @@ -1181,7 +1181,7 @@ can be used as map keys in json. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| | name | string| `string` | | | Name of the environment variable. Must be a C_IDENTIFIER. | | -| value | string| `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 "".
**Validation:** Optional.| | +| value | string| `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 "".
*Optional.*| | | valueFrom | [EnvVarSource](#env-var-source)| `EnvVarSource` | | | | | @@ -1230,7 +1230,7 @@ can be used as map keys in json. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| -| command | []string| `[]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.
**Validation:** Optional.| | +| command | []string| `[]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.
*Optional.*| | @@ -1296,11 +1296,11 @@ Fibre Channel volumes support ownership management and SELinux relabeling. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| -| fsType | string| `string` | | | fsType is the filesystem type to mount.
Must be a filesystem type supported by the host operating system.
Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
TODO: how do we prevent errors in the filesystem from compromising the machine
**Validation:** Optional.| | -| lun | int32 (formatted integer)| `int32` | | | lun is Optional: FC target lun number
**Validation:** Optional.| | -| readOnly | boolean| `bool` | | | readOnly is Optional: Defaults to false (read/write). ReadOnly here will force
the ReadOnly setting in VolumeMounts.
**Validation:** Optional.| | -| targetWWNs | []string| `[]string` | | | targetWWNs is Optional: FC target worldwide names (WWNs)
**Validation:** Optional.| | -| wwids | []string| `[]string` | | | wwids Optional: FC volume world wide identifiers (wwids)
Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously.
**Validation:** Optional.| | +| fsType | string| `string` | | | fsType is the filesystem type to mount.
Must be a filesystem type supported by the host operating system.
Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
TODO: how do we prevent errors in the filesystem from compromising the machine
*Optional.*| | +| lun | int32 (formatted integer)| `int32` | | | lun is Optional: FC target lun number
*Optional.*| | +| readOnly | boolean| `bool` | | | readOnly is Optional: Defaults to false (read/write). ReadOnly here will force
the ReadOnly setting in VolumeMounts.
*Optional.*| | +| targetWWNs | []string| `[]string` | | | targetWWNs is Optional: FC target worldwide names (WWNs)
*Optional.*| | +| wwids | []string| `[]string` | | | wwids Optional: FC volume world wide identifiers (wwids)
Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously.
*Optional.*| | @@ -1338,9 +1338,9 @@ provisioned/attached using an exec based plugin. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| | driver | string| `string` | | | driver is the name of the driver to use for this volume. | | -| fsType | string| `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.
**Validation:** Optional.| | -| options | map of string| `map[string]string` | | | options is Optional: this field holds extra command options if any.
**Validation:** Optional.| | -| readOnly | boolean| `bool` | | | readOnly is Optional: defaults to false (read/write). ReadOnly here will force
the ReadOnly setting in VolumeMounts.
**Validation:** Optional.| | +| fsType | string| `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.
*Optional.*| | +| options | map of string| `map[string]string` | | | options is Optional: this field holds extra command options if any.
*Optional.*| | +| readOnly | boolean| `bool` | | | readOnly is Optional: defaults to false (read/write). ReadOnly here will force
the ReadOnly setting in VolumeMounts.
*Optional.*| | | secretRef | [LocalObjectReference](#local-object-reference)| `LocalObjectReference` | | | | | @@ -1360,8 +1360,8 @@ Flocker volumes do not support ownership management or SELinux relabeling. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| -| datasetName | string| `string` | | | datasetName is Name of the dataset stored as metadata -> name on the dataset for Flocker
should be considered as deprecated
**Validation:** Optional.| | -| datasetUUID | string| `string` | | | datasetUUID is the UUID of the dataset. This is unique identifier of a Flocker dataset
**Validation:** Optional.| | +| datasetName | string| `string` | | | datasetName is Name of the dataset stored as metadata -> name on the dataset for Flocker
should be considered as deprecated
*Optional.*| | +| datasetUUID | string| `string` | | | datasetUUID is the UUID of the dataset. This is unique identifier of a Flocker dataset
*Optional.*| | @@ -1382,10 +1382,10 @@ PDs support ownership management and SELinux relabeling. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| -| fsType | string| `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
TODO: how do we prevent errors in the filesystem from compromising the machine
**Validation:** Optional.| | -| partition | int32 (formatted integer)| `int32` | | | 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
**Validation:** Optional.| | +| fsType | string| `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
TODO: how do we prevent errors in the filesystem from compromising the machine
*Optional.*| | +| partition | int32 (formatted integer)| `int32` | | | 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
*Optional.*| | | pdName | string| `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 | | -| readOnly | boolean| `bool` | | | readOnly here will force the ReadOnly setting in VolumeMounts.
Defaults to false.
More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
**Validation:** Optional.| | +| readOnly | boolean| `bool` | | | readOnly here will force the ReadOnly setting in VolumeMounts.
Defaults to false.
More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
*Optional.*| | @@ -1421,7 +1421,7 @@ PDs support ownership management and SELinux relabeling. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| | port | int32 (formatted integer)| `int32` | | | Port number of the gRPC service. Number must be in the range 1 to 65535. | | -| service | string| `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.
**Validation:** Optional; Default: "".| | +| service | string| `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.
*Optional; Default value: "".*| | @@ -1441,7 +1441,7 @@ PDs support ownership management and SELinux relabeling. |------|------|---------|:--------:| ------- |-------------|---------| | operation | [GaugeOperation](#gauge-operation)| `GaugeOperation` | | | | | | realtime | boolean| `bool` | | | Realtime emits this metric in real time if applicable | | -| value | string| `string` | | | Value is the value to be used in the operation with the metric's current value. If no operation is set,
value is the value of the metric
MaxLength is an artificial limit to limit CEL validation costs - see note at top of file
**Validation:** Minimum length: 1; Maximum length: 256.| | +| value | string| `string` | | | Value is the value to be used in the operation with the metric's current value. If no operation is set,
value is the value of the metric
MaxLength is an artificial limit to limit CEL validation costs - see note at top of file
*Minimum length: 1; Maximum length: 256.*| | @@ -1454,7 +1454,7 @@ PDs support ownership management and SELinux relabeling. | Name | Type | Go type | Default | Description | Example | |------|------|---------| ------- |-------------|---------| -| GaugeOperation | string| string | |
**Validation:** Valid values: Set, Add, Sub.| | +| GaugeOperation | string| string | |
*Allowed values: Set, Add, Sub.*| | @@ -1503,9 +1503,9 @@ into the Pod's container. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| -| directory | string| `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.
**Validation:** Optional.| | +| directory | string| `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.
*Optional.*| | | repository | string| `string` | | | repository is the URL | | -| revision | string| `string` | | | revision is the commit hash for the specified revision.
**Validation:** Optional.| | +| revision | string| `string` | | | revision is the commit hash for the specified revision.
*Optional.*| | @@ -1525,7 +1525,7 @@ into the Pod's container. |------|------|---------|:--------:| ------- |-------------|---------| | endpoints | string| `string` | | | endpoints is the endpoint name that details Glusterfs topology.
More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod | | | path | string| `string` | | | path is the Glusterfs volume path.
More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod | | -| readOnly | boolean| `bool` | | | 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
**Validation:** Optional.| | +| readOnly | boolean| `bool` | | | readOnly here will force the Glusterfs volume to be mounted with read-only permissions.
Defaults to false.
More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
*Optional.*| | @@ -1642,9 +1642,9 @@ into the Pod's container. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| -| host | string| `string` | | | Host name to connect to, defaults to the pod IP. You probably want to set
"Host" in httpHeaders instead.
**Validation:** Optional.| | -| httpHeaders | [][HTTPHeader](#http-header)| `[]*HTTPHeader` | | | Custom headers to set in the request. HTTP allows repeated headers.
**Validation:** Optional.| | -| path | string| `string` | | | Path to access on the HTTP server.
**Validation:** Optional.| | +| host | string| `string` | | | Host name to connect to, defaults to the pod IP. You probably want to set
"Host" in httpHeaders instead.
*Optional.*| | +| httpHeaders | [][HTTPHeader](#http-header)| `[]*HTTPHeader` | | | Custom headers to set in the request. HTTP allows repeated headers.
*Optional.*| | +| path | string| `string` | | | Path to access on the HTTP server.
*Optional.*| | | port | [IntOrString](#int-or-string)| `IntOrString` | | | | | | scheme | [URIScheme](#uri-scheme)| `URIScheme` | | | | | @@ -1723,7 +1723,7 @@ into the Pod's container. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| | buckets | [][Amount](#amount)| `[]Amount` | | | Buckets is a list of bucket divisors for the histogram | | -| value | string| `string` | | | Value is the value of the metric
**Validation:** Minimum length: 1.| | +| value | string| `string` | | | Value is the value of the metric
*Minimum length: 1.*| | @@ -1743,7 +1743,7 @@ pod's hosts file. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| | hostnames | []string| `[]string` | | | Hostnames for the above IP address. | | -| ip | string| `string` | | | IP address of the host file entry.
**Validation:** Required.| | +| ip | string| `string` | | | IP address of the host file entry. | | @@ -1794,15 +1794,15 @@ ISCSI volumes support ownership management and SELinux relabeling. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| -| chapAuthDiscovery | boolean| `bool` | | | chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication
**Validation:** Optional.| | -| chapAuthSession | boolean| `bool` | | | chapAuthSession defines whether support iSCSI Session CHAP authentication
**Validation:** Optional.| | -| fsType | string| `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
TODO: how do we prevent errors in the filesystem from compromising the machine
**Validation:** Optional.| | -| initiatorName | string| `string` | | | initiatorName is the custom iSCSI Initiator Name.
If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface
: will be created for the connection.
**Validation:** Optional.| | +| chapAuthDiscovery | boolean| `bool` | | | chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication
*Optional.*| | +| chapAuthSession | boolean| `bool` | | | chapAuthSession defines whether support iSCSI Session CHAP authentication
*Optional.*| | +| fsType | string| `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
TODO: how do we prevent errors in the filesystem from compromising the machine
*Optional.*| | +| initiatorName | string| `string` | | | initiatorName is the custom iSCSI Initiator Name.
If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface
: will be created for the connection.
*Optional.*| | | iqn | string| `string` | | | iqn is the target iSCSI Qualified Name. | | -| iscsiInterface | string| `string` | | | iscsiInterface is the interface Name that uses an iSCSI transport.
Defaults to 'default' (tcp).
**Validation:** Optional; Default: "default".| | +| iscsiInterface | string| `string` | | | iscsiInterface is the interface Name that uses an iSCSI transport.
Defaults to 'default' (tcp).
*Optional; Default value: "default".*| | | lun | int32 (formatted integer)| `int32` | | | lun represents iSCSI Target Lun number. | | -| portals | []string| `[]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).
**Validation:** Optional.| | -| readOnly | boolean| `bool` | | | readOnly here will force the ReadOnly setting in VolumeMounts.
Defaults to false.
**Validation:** Optional.| | +| portals | []string| `[]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).
*Optional.*| | +| readOnly | boolean| `bool` | | | readOnly here will force the ReadOnly setting in VolumeMounts.
Defaults to false.
*Optional.*| | | secretRef | [LocalObjectReference](#local-object-reference)| `LocalObjectReference` | | | | | | targetPortal | string| `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). | | @@ -1820,7 +1820,7 @@ ISCSI volumes support ownership management and SELinux relabeling. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| | pullPolicy | [PullPolicy](#pull-policy)| `PullPolicy` | | | | | -| reference | string| `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.
**Validation:** Optional.| | +| reference | string| `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.
*Optional.*| | @@ -1839,7 +1839,7 @@ ISCSI volumes support ownership management and SELinux relabeling. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| | artifacts | [Artifacts](#artifacts)| `Artifacts` | | | | | -| parameters | [][Parameter](#parameter)| `[]*Parameter` | | | Parameters are a list of parameters passed as inputs
MaxItems is an artificial limit to limit CEL validation costs - see note at top of file
**Validation:** Maximum items: 500.| | +| parameters | [][Parameter](#parameter)| `[]*Parameter` | | | Parameters are a list of parameters passed as inputs
MaxItems is an artificial limit to limit CEL validation costs - see note at top of file
*Maximum items: 500.*| | @@ -1884,7 +1884,7 @@ ISCSI volumes support ownership management and SELinux relabeling. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| | key | string| `string` | | | key is the key to project. | | -| mode | int32 (formatted integer)| `int32` | | | 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.
**Validation:** Optional.| | +| mode | int32 (formatted integer)| `int32` | | | 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.
*Optional.*| | | path | string| `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 '..'. | | @@ -1905,8 +1905,8 @@ label selector matches no objects. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| -| matchExpressions | [][LabelSelectorRequirement](#label-selector-requirement)| `[]*LabelSelectorRequirement` | | | matchExpressions is a list of label selector requirements. The requirements are ANDed.
**Validation:** Optional.| | -| matchLabels | map of string| `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.
**Validation:** Optional.| | +| matchExpressions | [][LabelSelectorRequirement](#label-selector-requirement)| `[]*LabelSelectorRequirement` | | | matchExpressions is a list of label selector requirements. The requirements are ANDed.
*Optional.*| | +| matchLabels | map of string| `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.
*Optional.*| | @@ -1938,7 +1938,7 @@ relates the key and values. |------|------|---------|:--------:| ------- |-------------|---------| | key | string| `string` | | | key is the label key that the selector applies to. | | | operator | [LabelSelectorOperator](#label-selector-operator)| `LabelSelectorOperator` | | | | | -| values | []string| `[]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.
**Validation:** Optional.| | +| values | []string| `[]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.
*Optional.*| | @@ -2034,7 +2034,7 @@ For example, ServiceReferences for admission registration: https://github.com/ku | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| -| name | string| `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
TODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.
**Validation:** Optional; Default: "".| | +| name | string| `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
TODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.
*Optional; Default value: "".*| | @@ -2059,7 +2059,7 @@ that the fieldset applies to. | manager | string| `string` | | | Manager is an identifier of the workflow managing these fields. | | | operation | [ManagedFieldsOperationType](#managed-fields-operation-type)| `ManagedFieldsOperationType` | | | | | | subresource | string| `string` | | | Subresource is the name of the subresource used to update that object, or
empty string if the object was updated through the main resource. The
value of this field is used to distinguish between managers, even if they
share the same name. For example, a status update will be distinct from a
regular update using the same manager name.
Note that the APIVersion field is not related to the Subresource field and
it always corresponds to the version of the main resource. | | -| time | string| `string` | | | Time is the timestamp of when the ManagedFields entry was added. The
timestamp will also be updated if a field is added, the manager
changes any of the owned fields value or removes a field. The
timestamp does not update when a field is removed from the entry
because another manager took it over.
**Validation:** Optional.| | +| time | string| `string` | | | Time is the timestamp of when the ManagedFields entry was added. The
timestamp will also be updated if a field is added, the manager
changes any of the owned fields value or removes a field. The
timestamp does not update when a field is removed from the entry
because another manager took it over.
*Optional.*| | @@ -2142,7 +2142,7 @@ that the fieldset applies to. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| -| key | string| `string` | | |
**Validation:** Pattern: `^[a-zA-Z_][a-zA-Z0-9_]*$`.| | +| key | string| `string` | | |
*Validation regex: `^[a-zA-Z_][a-zA-Z0-9_]*$`.*| | | value | string| `string` | | | | | @@ -2161,7 +2161,7 @@ that the fieldset applies to. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| -| prometheus | [][Prometheus](#prometheus)| `[]*Prometheus` | | | Prometheus is a list of prometheus metrics to be emitted
MaxItems is an artificial limit to limit CEL validation costs - see note at top of file
**Validation:** Maximum items: 100.| | +| prometheus | [][Prometheus](#prometheus)| `[]*Prometheus` | | | Prometheus is a list of prometheus metrics to be emitted
MaxItems is an artificial limit to limit CEL validation costs - see note at top of file
*Maximum items: 100.*| | @@ -2213,7 +2213,7 @@ that the fieldset applies to. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| | path | string| `string` | | | path that is exported by the NFS server.
More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs | | -| readOnly | boolean| `bool` | | | 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
**Validation:** Optional.| | +| readOnly | boolean| `bool` | | | readOnly here will force the NFS export to be mounted with read-only permissions.
Defaults to false.
More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
*Optional.*| | | server | string| `string` | | | server is the hostname or IP address of the NFS server.
More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs | | @@ -2229,7 +2229,7 @@ that the fieldset applies to. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| -| preferredDuringSchedulingIgnoredDuringExecution | [][PreferredSchedulingTerm](#preferred-scheduling-term)| `[]*PreferredSchedulingTerm` | | | 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.
**Validation:** Optional.| | +| preferredDuringSchedulingIgnoredDuringExecution | [][PreferredSchedulingTerm](#preferred-scheduling-term)| `[]*PreferredSchedulingTerm` | | | The scheduler will prefer to schedule pods to nodes that satisfy
the affinity expressions specified by this field, but it may choose
a node that violates one or more of the expressions. The node that is
most preferred is the one with the greatest sum of weights, i.e.
for each node that meets all of the scheduling requirements (resource
request, requiredDuringScheduling affinity expressions, etc.),
compute a sum by iterating through the elements of this field and adding
"weight" to the sum if the node matches the corresponding matchExpressions; the
node(s) with the highest sum are the most preferred.
*Optional.*| | | requiredDuringSchedulingIgnoredDuringExecution | [NodeSelector](#node-selector)| `NodeSelector` | | | | | @@ -2315,7 +2315,7 @@ that relates the key and values. |------|------|---------|:--------:| ------- |-------------|---------| | key | string| `string` | | | The label key that the selector applies to. | | | operator | [NodeSelectorOperator](#node-selector-operator)| `NodeSelectorOperator` | | | | | -| values | []string| `[]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.
**Validation:** Optional.| | +| values | []string| `[]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.
*Optional.*| | @@ -2335,8 +2335,8 @@ The TopologySelectorTerm type implements a subset of the NodeSelectorTerm. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| -| matchExpressions | [][NodeSelectorRequirement](#node-selector-requirement)| `[]*NodeSelectorRequirement` | | | A list of node selector requirements by node's labels.
**Validation:** Optional.| | -| matchFields | [][NodeSelectorRequirement](#node-selector-requirement)| `[]*NodeSelectorRequirement` | | | A list of node selector requirements by node's fields.
**Validation:** Optional.| | +| matchExpressions | [][NodeSelectorRequirement](#node-selector-requirement)| `[]*NodeSelectorRequirement` | | | A list of node selector requirements by node's labels.
*Optional.*| | +| matchFields | [][NodeSelectorRequirement](#node-selector-requirement)| `[]*NodeSelectorRequirement` | | | A list of node selector requirements by node's fields.
*Optional.*| | @@ -2451,7 +2451,7 @@ save/load the directory appropriately. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| -| apiVersion | string| `string` | | | Version of the schema the FieldPath is written in terms of, defaults to "v1".
**Validation:** Optional.| | +| apiVersion | string| `string` | | | Version of the schema the FieldPath is written in terms of, defaults to "v1".
*Optional.*| | | fieldPath | string| `string` | | | Path of the field to select in the specified API version. | | @@ -2511,8 +2511,8 @@ be cluster-scoped, so there is no namespace field. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| | apiVersion | string| `string` | | | API version of the referent. | | -| blockOwnerDeletion | boolean| `bool` | | | If true, AND if the owner has the "foregroundDeletion" finalizer, then
the owner cannot be deleted from the key-value store until this
reference is removed.
See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion
for how the garbage collector interacts with this field and enforces the foreground deletion.
Defaults to false.
To set this field, a user needs "delete" permission of the owner,
otherwise 422 (Unprocessable Entity) will be returned.
**Validation:** Optional.| | -| controller | boolean| `bool` | | | If true, this reference points to the managing controller.
**Validation:** Optional.| | +| blockOwnerDeletion | boolean| `bool` | | | If true, AND if the owner has the "foregroundDeletion" finalizer, then
the owner cannot be deleted from the key-value store until this
reference is removed.
See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion
for how the garbage collector interacts with this field and enforces the foreground deletion.
Defaults to false.
To set this field, a user needs "delete" permission of the owner,
otherwise 422 (Unprocessable Entity) will be returned.
*Optional.*| | +| controller | boolean| `bool` | | | If true, this reference points to the managing controller.
*Optional.*| | | kind | string| `string` | | | Kind of the referent.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | | | name | string| `string` | | | Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names | | | uid | [UID](#uid)| `UID` | | | | | @@ -2542,9 +2542,9 @@ be cluster-scoped, so there is no namespace field. |------|------|---------|:--------:| ------- |-------------|---------| | default | [AnyString](#any-string)| `AnyString` | | | | | | description | [AnyString](#any-string)| `AnyString` | | | | | -| enum | [][AnyString](#any-string)| `[]AnyString` | | | Enum holds a list of string values to choose from, for the actual value of the parameter
**Validation:** Minimum items: 1.| | +| enum | [][AnyString](#any-string)| `[]AnyString` | | | Enum holds a list of string values to choose from, for the actual value of the parameter
*Minimum items: 1.*| | | globalName | string| `string` | | | GlobalName exports an output parameter to the global scope, making it available as
'{{workflow.outputs.parameters.XXXX}} and in workflow.status.outputs.parameters | | -| name | string| `string` | | | Name is the parameter name
**Validation:** Pattern: `^[-a-zA-Z0-9_]+$`.| | +| name | string| `string` | | | Name is the parameter name
*Validation regex: `^[-a-zA-Z0-9_]+$`.*| | | value | [AnyString](#any-string)| `AnyString` | | | | | | valueFrom | [ValueFrom](#value-from)| `ValueFrom` | | | | | @@ -2578,15 +2578,15 @@ and allows a Source for provider-specific attributes | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| -| accessModes | [][PersistentVolumeAccessMode](#persistent-volume-access-mode)| `[]PersistentVolumeAccessMode` | | | accessModes contains the desired access modes the volume should have.
More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1
**Validation:** Optional.| | +| accessModes | [][PersistentVolumeAccessMode](#persistent-volume-access-mode)| `[]PersistentVolumeAccessMode` | | | accessModes contains the desired access modes the volume should have.
More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1
*Optional.*| | | dataSource | [TypedLocalObjectReference](#typed-local-object-reference)| `TypedLocalObjectReference` | | | | | | dataSourceRef | [TypedObjectReference](#typed-object-reference)| `TypedObjectReference` | | | | | | resources | [VolumeResourceRequirements](#volume-resource-requirements)| `VolumeResourceRequirements` | | | | | | selector | [LabelSelector](#label-selector)| `LabelSelector` | | | | | -| storageClassName | string| `string` | | | storageClassName is the name of the StorageClass required by the claim.
More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1
**Validation:** Optional.| | -| volumeAttributesClassName | string| `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 value means that no VolumeAttributesClass
will be applied to the claim but it's not allowed to reset this field to empty string once it is set.
If unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass
will be set by the persistentvolume controller if it exists.
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/
(Beta) Using this field requires the VolumeAttributesClass feature gate to be enabled (off by default).
**Validation:** Optional.| | +| storageClassName | string| `string` | | | storageClassName is the name of the StorageClass required by the claim.
More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1
*Optional.*| | +| volumeAttributesClassName | string| `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 value means that no VolumeAttributesClass
will be applied to the claim but it's not allowed to reset this field to empty string once it is set.
If unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass
will be set by the persistentvolume controller if it exists.
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/
(Beta) Using this field requires the VolumeAttributesClass feature gate to be enabled (off by default).
*Optional.*| | | volumeMode | [PersistentVolumeMode](#persistent-volume-mode)| `PersistentVolumeMode` | | | | | -| volumeName | string| `string` | | | volumeName is the binding reference to the PersistentVolume backing this claim.
**Validation:** Optional.| | +| volumeName | string| `string` | | | volumeName is the binding reference to the PersistentVolume backing this claim.
*Optional.*| | @@ -2605,20 +2605,20 @@ PersistentVolumeClaim objects as part of an EphemeralVolumeSource. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| -| annotations | map of string| `map[string]string` | | | Annotations is an unstructured key value map stored with a resource that may be
set by external tools to store and retrieve arbitrary metadata. They are not
queryable and should be preserved when modifying objects.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations
**Validation:** Optional.| | -| creationTimestamp | string| `string` | | | CreationTimestamp is a timestamp representing the server time when this object was
created. It is not guaranteed to be set in happens-before order across separate operations.
Clients may not set this value. It is represented in RFC3339 form and is in UTC.
Populated by the system.
Read-only.
Null for lists.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
**Validation:** Optional.| | -| deletionGracePeriodSeconds | int64 (formatted integer)| `int64` | | | Number of seconds allowed for this object to gracefully terminate before
it will be removed from the system. Only set when deletionTimestamp is also set.
May only be shortened.
Read-only.
**Validation:** Optional.| | -| deletionTimestamp | string| `string` | | | DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This
field is set by the server when a graceful deletion is requested by the user, and is not
directly settable by a client. The resource is expected to be deleted (no longer visible
from resource lists, and not reachable by name) after the time in this field, once the
finalizers list is empty. As long as the finalizers list contains items, deletion is blocked.
Once the deletionTimestamp is set, this value may not be unset or be set further into the
future, although it may be shortened or the resource may be deleted prior to this time.
For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react
by sending a graceful termination signal to the containers in the pod. After that 30 seconds,
the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup,
remove the pod from the API. In the presence of network partitions, this object may still
exist after this timestamp, until an administrator or automated process can determine the
resource is fully terminated.
If not set, graceful deletion of the object has not been requested.
Populated by the system when a graceful deletion is requested.
Read-only.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
**Validation:** Optional.| | -| finalizers | []string| `[]string` | | | Must be empty before the object is deleted from the registry. Each entry
is an identifier for the responsible component that will remove the entry
from the list. If the deletionTimestamp of the object is non-nil, entries
in this list can only be removed.
Finalizers may be processed and removed in any order. Order is NOT enforced
because it introduces significant risk of stuck finalizers.
finalizers is a shared field, any actor with permission can reorder it.
If the finalizer list is processed in order, then this can lead to a situation
in which the component responsible for the first finalizer in the list is
waiting for a signal (field value, external system, or other) produced by a
component responsible for a finalizer later in the list, resulting in a deadlock.
Without enforced ordering finalizers are free to order amongst themselves and
are not vulnerable to ordering changes in the list.
**Validation:** Optional.| | -| generateName | string| `string` | | | GenerateName is an optional prefix, used by the server, to generate a unique
name ONLY IF the Name field has not been provided.
If this field is used, the name returned to the client will be different
than the name passed. This value will also be combined with a unique suffix.
The provided value has the same validation rules as the Name field,
and may be truncated by the length of the suffix required to make the value
unique on the server.
If this field is specified and the generated name exists, the server will return a 409.
Applied only if Name is not specified.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency
**Validation:** Optional.| | -| generation | int64 (formatted integer)| `int64` | | | A sequence number representing a specific generation of the desired state.
Populated by the system. Read-only.
**Validation:** Optional.| | -| labels | map of string| `map[string]string` | | | Map of string keys and values that can be used to organize and categorize
(scope and select) objects. May match selectors of replication controllers
and services.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels
**Validation:** Optional.| | -| managedFields | [][ManagedFieldsEntry](#managed-fields-entry)| `[]*ManagedFieldsEntry` | | | ManagedFields maps workflow-id and version to the set of fields
that are managed by that workflow. This is mostly for internal
housekeeping, and users typically shouldn't need to set or
understand this field. A workflow can be the user's name, a
controller's name, or the name of a specific apply path like
"ci-cd". The set of fields is always in the version that the
workflow used when modifying the object.
**Validation:** Optional.| | -| name | string| `string` | | | Name must be unique within a namespace. Is required when creating resources, although
some resources may allow a client to request the generation of an appropriate name
automatically. Name is primarily intended for creation idempotence and configuration
definition.
Cannot be updated.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names
**Validation:** Optional.| | -| namespace | string| `string` | | | Namespace defines the space within which each name must be unique. An empty namespace is
equivalent to the "default" namespace, but "default" is the canonical representation.
Not all objects are required to be scoped to a namespace - the value of this field for
those objects will be empty.
Must be a DNS_LABEL.
Cannot be updated.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces
**Validation:** Optional.| | -| ownerReferences | [][OwnerReference](#owner-reference)| `[]*OwnerReference` | | | List of objects depended by this object. If ALL objects in the list have
been deleted, this object will be garbage collected. If this object is managed by a controller,
then an entry in this list will point to this controller, with the controller field set to true.
There cannot be more than one managing controller.
**Validation:** Optional.| | -| resourceVersion | string| `string` | | | An opaque value that represents the internal version of this object that can
be used by clients to determine when objects have changed. May be used for optimistic
concurrency, change detection, and the watch operation on a resource or set of resources.
Clients must treat these values as opaque and passed unmodified back to the server.
They may only be valid for a particular resource or set of resources.
Populated by the system.
Read-only.
Value must be treated as opaque by clients and .
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
**Validation:** Optional.| | -| selfLink | string| `string` | | | Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.
**Validation:** Optional.| | +| annotations | map of string| `map[string]string` | | | Annotations is an unstructured key value map stored with a resource that may be
set by external tools to store and retrieve arbitrary metadata. They are not
queryable and should be preserved when modifying objects.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations
*Optional.*| | +| creationTimestamp | string| `string` | | | CreationTimestamp is a timestamp representing the server time when this object was
created. It is not guaranteed to be set in happens-before order across separate operations.
Clients may not set this value. It is represented in RFC3339 form and is in UTC.
Populated by the system.
Read-only.
Null for lists.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
*Optional.*| | +| deletionGracePeriodSeconds | int64 (formatted integer)| `int64` | | | Number of seconds allowed for this object to gracefully terminate before
it will be removed from the system. Only set when deletionTimestamp is also set.
May only be shortened.
Read-only.
*Optional.*| | +| deletionTimestamp | string| `string` | | | DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This
field is set by the server when a graceful deletion is requested by the user, and is not
directly settable by a client. The resource is expected to be deleted (no longer visible
from resource lists, and not reachable by name) after the time in this field, once the
finalizers list is empty. As long as the finalizers list contains items, deletion is blocked.
Once the deletionTimestamp is set, this value may not be unset or be set further into the
future, although it may be shortened or the resource may be deleted prior to this time.
For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react
by sending a graceful termination signal to the containers in the pod. After that 30 seconds,
the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup,
remove the pod from the API. In the presence of network partitions, this object may still
exist after this timestamp, until an administrator or automated process can determine the
resource is fully terminated.
If not set, graceful deletion of the object has not been requested.
Populated by the system when a graceful deletion is requested.
Read-only.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
*Optional.*| | +| finalizers | []string| `[]string` | | | Must be empty before the object is deleted from the registry. Each entry
is an identifier for the responsible component that will remove the entry
from the list. If the deletionTimestamp of the object is non-nil, entries
in this list can only be removed.
Finalizers may be processed and removed in any order. Order is NOT enforced
because it introduces significant risk of stuck finalizers.
finalizers is a shared field, any actor with permission can reorder it.
If the finalizer list is processed in order, then this can lead to a situation
in which the component responsible for the first finalizer in the list is
waiting for a signal (field value, external system, or other) produced by a
component responsible for a finalizer later in the list, resulting in a deadlock.
Without enforced ordering finalizers are free to order amongst themselves and
are not vulnerable to ordering changes in the list.
*Optional.*| | +| generateName | string| `string` | | | GenerateName is an optional prefix, used by the server, to generate a unique
name ONLY IF the Name field has not been provided.
If this field is used, the name returned to the client will be different
than the name passed. This value will also be combined with a unique suffix.
The provided value has the same validation rules as the Name field,
and may be truncated by the length of the suffix required to make the value
unique on the server.
If this field is specified and the generated name exists, the server will return a 409.
Applied only if Name is not specified.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency
*Optional.*| | +| generation | int64 (formatted integer)| `int64` | | | A sequence number representing a specific generation of the desired state.
Populated by the system. Read-only.
*Optional.*| | +| labels | map of string| `map[string]string` | | | Map of string keys and values that can be used to organize and categorize
(scope and select) objects. May match selectors of replication controllers
and services.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels
*Optional.*| | +| managedFields | [][ManagedFieldsEntry](#managed-fields-entry)| `[]*ManagedFieldsEntry` | | | ManagedFields maps workflow-id and version to the set of fields
that are managed by that workflow. This is mostly for internal
housekeeping, and users typically shouldn't need to set or
understand this field. A workflow can be the user's name, a
controller's name, or the name of a specific apply path like
"ci-cd". The set of fields is always in the version that the
workflow used when modifying the object.
*Optional.*| | +| name | string| `string` | | | Name must be unique within a namespace. Is required when creating resources, although
some resources may allow a client to request the generation of an appropriate name
automatically. Name is primarily intended for creation idempotence and configuration
definition.
Cannot be updated.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names
*Optional.*| | +| namespace | string| `string` | | | Namespace defines the space within which each name must be unique. An empty namespace is
equivalent to the "default" namespace, but "default" is the canonical representation.
Not all objects are required to be scoped to a namespace - the value of this field for
those objects will be empty.
Must be a DNS_LABEL.
Cannot be updated.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces
*Optional.*| | +| ownerReferences | [][OwnerReference](#owner-reference)| `[]*OwnerReference` | | | List of objects depended by this object. If ALL objects in the list have
been deleted, this object will be garbage collected. If this object is managed by a controller,
then an entry in this list will point to this controller, with the controller field set to true.
There cannot be more than one managing controller.
*Optional.*| | +| resourceVersion | string| `string` | | | An opaque value that represents the internal version of this object that can
be used by clients to determine when objects have changed. May be used for optimistic
concurrency, change detection, and the watch operation on a resource or set of resources.
Clients must treat these values as opaque and passed unmodified back to the server.
They may only be valid for a particular resource or set of resources.
Populated by the system.
Read-only.
Value must be treated as opaque by clients and .
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
*Optional.*| | +| selfLink | string| `string` | | | Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.
*Optional.*| | | spec | [PersistentVolumeClaimSpec](#persistent-volume-claim-spec)| `PersistentVolumeClaimSpec` | | | | | | uid | [UID](#uid)| `UID` | | | | | @@ -2641,7 +2641,7 @@ type of volume that is owned by someone else (the system). | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| | claimName | string| `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 | | -| readOnly | boolean| `bool` | | | readOnly Will force the ReadOnly setting in VolumeMounts.
Default false.
**Validation:** Optional.| | +| readOnly | boolean| `bool` | | | readOnly Will force the ReadOnly setting in VolumeMounts.
Default false.
*Optional.*| | @@ -2716,8 +2716,8 @@ type of volume that is owned by someone else (the system). | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| -| preferredDuringSchedulingIgnoredDuringExecution | [][WeightedPodAffinityTerm](#weighted-pod-affinity-term)| `[]*WeightedPodAffinityTerm` | | | 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.
**Validation:** Optional.| | -| requiredDuringSchedulingIgnoredDuringExecution | [][PodAffinityTerm](#pod-affinity-term)| `[]*PodAffinityTerm` | | | 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.
**Validation:** Optional.| | +| preferredDuringSchedulingIgnoredDuringExecution | [][WeightedPodAffinityTerm](#weighted-pod-affinity-term)| `[]*WeightedPodAffinityTerm` | | | The scheduler will prefer to schedule pods to nodes that satisfy
the affinity expressions specified by this field, but it may choose
a node that violates one or more of the expressions. The node that is
most preferred is the one with the greatest sum of weights, i.e.
for each node that meets all of the scheduling requirements (resource
request, requiredDuringScheduling affinity expressions, etc.),
compute a sum by iterating through the elements of this field and adding
"weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the
node(s) with the highest sum are the most preferred.
*Optional.*| | +| requiredDuringSchedulingIgnoredDuringExecution | [][PodAffinityTerm](#pod-affinity-term)| `[]*PodAffinityTerm` | | | If the affinity requirements specified by this field are not met at
scheduling time, the pod will not be scheduled onto the node.
If the affinity requirements specified by this field cease to be met
at some point during pod execution (e.g. due to a pod label update), the
system may or may not try to eventually evict the pod from its node.
When there are multiple elements, the lists of nodes corresponding to each
podAffinityTerm are intersected, i.e. all terms must be satisfied.
*Optional.*| | @@ -2741,10 +2741,10 @@ a pod of the set of pods is running | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| | labelSelector | [LabelSelector](#label-selector)| `LabelSelector` | | | | | -| matchLabelKeys | []string| `[]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.
**Validation:** Optional.| | -| mismatchLabelKeys | []string| `[]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.
**Validation:** Optional.| | +| matchLabelKeys | []string| `[]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.
*Optional.*| | +| mismatchLabelKeys | []string| `[]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.
*Optional.*| | | namespaceSelector | [LabelSelector](#label-selector)| `LabelSelector` | | | | | -| namespaces | []string| `[]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".
**Validation:** Optional.| | +| namespaces | []string| `[]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".
*Optional.*| | | topologyKey | string| `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. | | @@ -2760,8 +2760,8 @@ a pod of the set of pods is running | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| -| preferredDuringSchedulingIgnoredDuringExecution | [][WeightedPodAffinityTerm](#weighted-pod-affinity-term)| `[]*WeightedPodAffinityTerm` | | | The scheduler will prefer to schedule pods to nodes that satisfy
the anti-affinity expressions specified by this field, but it may choose
a node that violates one or more of the expressions. The node that is
most preferred is the one with the greatest sum of weights, i.e.
for each node that meets all of the scheduling requirements (resource
request, requiredDuringScheduling anti-affinity expressions, etc.),
compute a sum by iterating through the elements of this field and adding
"weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the
node(s) with the highest sum are the most preferred.
**Validation:** Optional.| | -| requiredDuringSchedulingIgnoredDuringExecution | [][PodAffinityTerm](#pod-affinity-term)| `[]*PodAffinityTerm` | | | 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.
**Validation:** Optional.| | +| preferredDuringSchedulingIgnoredDuringExecution | [][WeightedPodAffinityTerm](#weighted-pod-affinity-term)| `[]*WeightedPodAffinityTerm` | | | The scheduler will prefer to schedule pods to nodes that satisfy
the anti-affinity expressions specified by this field, but it may choose
a node that violates one or more of the expressions. The node that is
most preferred is the one with the greatest sum of weights, i.e.
for each node that meets all of the scheduling requirements (resource
request, requiredDuringScheduling anti-affinity expressions, etc.),
compute a sum by iterating through the elements of this field and adding
"weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the
node(s) with the highest sum are the most preferred.
*Optional.*| | +| requiredDuringSchedulingIgnoredDuringExecution | [][PodAffinityTerm](#pod-affinity-term)| `[]*PodAffinityTerm` | | | If the anti-affinity requirements specified by this field are not met at
scheduling time, the pod will not be scheduled onto the node.
If the anti-affinity requirements specified by this field cease to be met
at some point during pod execution (e.g. due to a pod label update), the
system may or may not try to eventually evict the pod from its node.
When there are multiple elements, the lists of nodes corresponding to each
podAffinityTerm are intersected, i.e. all terms must be satisfied.
*Optional.*| | @@ -2807,17 +2807,17 @@ container.securityContext take precedence over field values of PodSecurityContex | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| | appArmorProfile | [AppArmorProfile](#app-armor-profile)| `AppArmorProfile` | | | | | -| fsGroup | int64 (formatted integer)| `int64` | | | 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.
**Validation:** Optional.| | +| fsGroup | int64 (formatted integer)| `int64` | | | 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.
*Optional.*| | | fsGroupChangePolicy | [PodFSGroupChangePolicy](#pod-f-s-group-change-policy)| `PodFSGroupChangePolicy` | | | | | -| runAsGroup | int64 (formatted integer)| `int64` | | | 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.
**Validation:** Optional.| | -| runAsNonRoot | boolean| `bool` | | | 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.
**Validation:** Optional.| | -| runAsUser | int64 (formatted integer)| `int64` | | | 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.
**Validation:** Optional.| | +| runAsGroup | int64 (formatted integer)| `int64` | | | 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.
*Optional.*| | +| runAsNonRoot | boolean| `bool` | | | Indicates that the container must run as a non-root user.
If true, the Kubelet will validate the image at runtime to ensure that it
does not run as UID 0 (root) and fail to start the container if it does.
If unset or false, no such validation will be performed.
May also be set in SecurityContext. If set in both SecurityContext and
PodSecurityContext, the value specified in SecurityContext takes precedence.
*Optional.*| | +| runAsUser | int64 (formatted integer)| `int64` | | | 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.
*Optional.*| | | seLinuxChangePolicy | [PodSELinuxChangePolicy](#pod-s-e-linux-change-policy)| `PodSELinuxChangePolicy` | | | | | | seLinuxOptions | [SELinuxOptions](#s-e-linux-options)| `SELinuxOptions` | | | | | | seccompProfile | [SeccompProfile](#seccomp-profile)| `SeccompProfile` | | | | | -| supplementalGroups | []int64 (formatted integer)| `[]int64` | | | 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.
**Validation:** Optional.| | +| supplementalGroups | []int64 (formatted integer)| `[]int64` | | | 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.
*Optional.*| | | supplementalGroupsPolicy | [SupplementalGroupsPolicy](#supplemental-groups-policy)| `SupplementalGroupsPolicy` | | | | | -| sysctls | [][Sysctl](#sysctl)| `[]*Sysctl` | | | 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.
**Validation:** Optional.| | +| sysctls | [][Sysctl](#sysctl)| `[]*Sysctl` | | | 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.
*Optional.*| | | windowsOptions | [WindowsSecurityContextOptions](#windows-security-context-options)| `WindowsSecurityContextOptions` | | | | | @@ -2834,7 +2834,7 @@ container.securityContext take precedence over field values of PodSecurityContex | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| | fsType | string| `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. | | -| readOnly | boolean| `bool` | | | readOnly defaults to false (read/write). ReadOnly here will force
the ReadOnly setting in VolumeMounts.
**Validation:** Optional.| | +| readOnly | boolean| `bool` | | | readOnly defaults to false (read/write). ReadOnly here will force
the ReadOnly setting in VolumeMounts.
*Optional.*| | | volumeID | string| `string` | | | volumeID uniquely identifies a Portworx volume | | @@ -2875,15 +2875,15 @@ alive or ready to receive traffic. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| | exec | [ExecAction](#exec-action)| `ExecAction` | | | | | -| failureThreshold | int32 (formatted integer)| `int32` | | | Minimum consecutive failures for the probe to be considered failed after having succeeded.
Defaults to 3. Minimum value is 1.
**Validation:** Optional.| | +| failureThreshold | int32 (formatted integer)| `int32` | | | Minimum consecutive failures for the probe to be considered failed after having succeeded.
Defaults to 3. Minimum value is 1.
*Optional.*| | | grpc | [GRPCAction](#g-rpc-action)| `GRPCAction` | | | | | | httpGet | [HTTPGetAction](#http-get-action)| `HTTPGetAction` | | | | | -| initialDelaySeconds | int32 (formatted integer)| `int32` | | | 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
**Validation:** Optional.| | -| periodSeconds | int32 (formatted integer)| `int32` | | | How often (in seconds) to perform the probe.
Default to 10 seconds. Minimum value is 1.
**Validation:** Optional.| | -| successThreshold | int32 (formatted integer)| `int32` | | | 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.
**Validation:** Optional.| | +| initialDelaySeconds | int32 (formatted integer)| `int32` | | | Number of seconds after the container has started before liveness probes are initiated.
More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
*Optional.*| | +| periodSeconds | int32 (formatted integer)| `int32` | | | How often (in seconds) to perform the probe.
Default to 10 seconds. Minimum value is 1.
*Optional.*| | +| successThreshold | int32 (formatted integer)| `int32` | | | Minimum consecutive successes for the probe to be considered successful after having failed.
Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.
*Optional.*| | | tcpSocket | [TCPSocketAction](#tcp-socket-action)| `TCPSocketAction` | | | | | -| terminationGracePeriodSeconds | int64 (formatted integer)| `int64` | | | 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.
**Validation:** Optional.| | -| timeoutSeconds | int32 (formatted integer)| `int32` | | | 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
**Validation:** Optional.| | +| terminationGracePeriodSeconds | int64 (formatted integer)| `int64` | | | 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.
*Optional.*| | +| timeoutSeconds | int32 (formatted integer)| `int32` | | | Number of seconds after which the probe times out.
Defaults to 1 second. Minimum value is 1.
More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
*Optional.*| | @@ -2925,8 +2925,8 @@ alive or ready to receive traffic. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| -| defaultMode | int32 (formatted integer)| `int32` | | | 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.
**Validation:** Optional.| | -| sources | [][VolumeProjection](#volume-projection)| `[]*VolumeProjection` | | | sources is the list of volume projections. Each entry in this list
handles one source.
**Validation:** Optional.| | +| defaultMode | int32 (formatted integer)| `int32` | | | 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.
*Optional.*| | +| sources | [][VolumeProjection](#volume-projection)| `[]*VolumeProjection` | | | sources is the list of volume projections. Each entry in this list
handles one source.
*Optional.*| | @@ -2946,10 +2946,10 @@ alive or ready to receive traffic. |------|------|---------|:--------:| ------- |-------------|---------| | counter | [Counter](#counter)| `Counter` | | | | | | gauge | [Gauge](#gauge)| `Gauge` | | | | | -| help | string| `string` | | | Help is a string that describes the metric
**Validation:** Minimum length: 1.| | +| help | string| `string` | | | Help is a string that describes the metric
*Minimum length: 1.*| | | histogram | [Histogram](#histogram)| `Histogram` | | | | | | labels | [][MetricLabel](#metric-label)| `[]*MetricLabel` | | | Labels is a list of metric labels | | -| name | string| `string` | | | Name is the name of the metric
**Validation:** Pattern: `^[a-zA-Z_][a-zA-Z0-9_]*$`.| | +| name | string| `string` | | | Name is the name of the metric
*Validation regex: `^[a-zA-Z_][a-zA-Z0-9_]*$`.*| | | when | string| `string` | | | When is a conditional statement that decides when to emit the metric | | @@ -3065,11 +3065,11 @@ cause implementors to also use a fixed point implementation. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| -| group | string| `string` | | | group to map volume access to
Default is no group
**Validation:** Optional.| | -| readOnly | boolean| `bool` | | | readOnly here will force the Quobyte volume to be mounted with read-only permissions.
Defaults to false.
**Validation:** Optional.| | +| group | string| `string` | | | group to map volume access to
Default is no group
*Optional.*| | +| readOnly | boolean| `bool` | | | readOnly here will force the Quobyte volume to be mounted with read-only permissions.
Defaults to false.
*Optional.*| | | registry | string| `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 | | -| tenant | string| `string` | | | tenant owning the given Quobyte volume in the Backend
Used with dynamically provisioned Quobyte volumes, value is set by the plugin
**Validation:** Optional.| | -| user | string| `string` | | | user to map volume access to
Defaults to serivceaccount user
**Validation:** Optional.| | +| tenant | string| `string` | | | tenant owning the given Quobyte volume in the Backend
Used with dynamically provisioned Quobyte volumes, value is set by the plugin
*Optional.*| | +| user | string| `string` | | | user to map volume access to
Defaults to serivceaccount user
*Optional.*| | | volume | string| `string` | | | volume is a string that references an already created Quobyte volume by name. | | @@ -3088,14 +3088,14 @@ cause implementors to also use a fixed point implementation. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| -| fsType | string| `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
TODO: how do we prevent errors in the filesystem from compromising the machine
**Validation:** Optional.| | +| fsType | string| `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
TODO: how do we prevent errors in the filesystem from compromising the machine
*Optional.*| | | image | string| `string` | | | image is the rados image name.
More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it | | -| keyring | string| `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
**Validation:** Optional; Default: "/etc/ceph/keyring".| | +| keyring | string| `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
*Optional; Default value: "/etc/ceph/keyring".*| | | monitors | []string| `[]string` | | | monitors is a collection of Ceph monitors.
More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it | | -| pool | string| `string` | | | pool is the rados pool name.
Default is rbd.
More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
**Validation:** Optional; Default: "rbd".| | -| readOnly | boolean| `bool` | | | 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
**Validation:** Optional.| | +| pool | string| `string` | | | pool is the rados pool name.
Default is rbd.
More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
*Optional; Default value: "rbd".*| | +| readOnly | boolean| `bool` | | | readOnly here will force the ReadOnly setting in VolumeMounts.
Defaults to false.
More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
*Optional.*| | | secretRef | [LocalObjectReference](#local-object-reference)| `LocalObjectReference` | | | | | -| user | string| `string` | | | user is the rados user name.
Default is admin.
More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
**Validation:** Optional; Default: "admin".| | +| user | string| `string` | | | user is the rados user name.
Default is admin.
More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
*Optional; Default value: "admin".*| | @@ -3140,7 +3140,7 @@ cause implementors to also use a fixed point implementation. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| | name | string| `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. | | -| request | string| `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.
**Validation:** Optional.| | +| request | string| `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.
*Optional.*| | @@ -3158,7 +3158,7 @@ cause implementors to also use a fixed point implementation. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| -| containerName | string| `string` | | | Container name: required for volumes, optional for env vars
**Validation:** Optional.| | +| containerName | string| `string` | | | Container name: required for volumes, optional for env vars
*Optional.*| | | divisor | [Quantity](#quantity)| `Quantity` | | | | | | resource | string| `string` | | | Required: resource to select | | @@ -3193,7 +3193,7 @@ cause implementors to also use a fixed point implementation. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| -| claims | [][ResourceClaim](#resource-claim)| `[]*ResourceClaim` | | | Claims lists the names of resources, defined in spec.resourceClaims,
that are used by this container.
This is an alpha field and requires enabling the
DynamicResourceAllocation feature gate.
This field is immutable. It can only be set for containers.
**Validation:** Optional.| | +| claims | [][ResourceClaim](#resource-claim)| `[]*ResourceClaim` | | | Claims lists the names of resources, defined in spec.resourceClaims,
that are used by this container.
This is an alpha field and requires enabling the
DynamicResourceAllocation feature gate.
This field is immutable. It can only be set for containers.
*Optional.*| | | limits | [ResourceList](#resource-list)| `ResourceList` | | | | | | requests | [ResourceList](#resource-list)| `ResourceList` | | | | | @@ -3224,12 +3224,12 @@ cause implementors to also use a fixed point implementation. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| -| action | string| `string` | | | Action is the action to perform to the resource.
Must be one of: get, create, apply, delete, replace, patch
**Validation:** Valid values: get, create, apply, delete, replace, patch.| | +| action | string| `string` | | | Action is the action to perform to the resource.
Must be one of: get, create, apply, delete, replace, patch
*Allowed values: get, create, apply, delete, replace, patch.*| | | failureCondition | string| `string` | | | FailureCondition is a label selector expression which describes the conditions
of the k8s resource in which the step was considered failed | | | flags | []string| `[]string` | | | Flags is a set of additional options passed to kubectl before submitting a resource
I.e. to disable resource validation:
flags: [
"--validate=false" # disable resource validation
] | | | manifest | string| `string` | | | Manifest contains the kubernetes manifest | | | manifestFrom | [ManifestFrom](#manifest-from)| `ManifestFrom` | | | | | -| mergeStrategy | string| `string` | | | MergeStrategy is the strategy used to merge a patch. It defaults to "strategic"
Must be one of: strategic, merge, json
**Validation:** Valid values: strategic, merge, json.| | +| mergeStrategy | string| `string` | | | MergeStrategy is the strategy used to merge a patch. It defaults to "strategic"
Must be one of: strategic, merge, json
*Allowed values: strategic, merge, json.*| | | setOwnerReference | boolean| `bool` | | | SetOwnerReference sets the reference to the workflow on the OwnerReference of generated resource. | | | successCondition | string| `string` | | | SuccessCondition is a label selector expression which describes the conditions
of the k8s resource in which it is acceptable to proceed to the following step | | @@ -3269,7 +3269,7 @@ cause implementors to also use a fixed point implementation. | Name | Type | Go type | Default | Description | Example | |------|------|---------| ------- |-------------|---------| -| RetryPolicy | string| string | |
**Validation:** Valid values: Always, OnFailure, OnError, OnTransientError.| | +| RetryPolicy | string| string | |
*Allowed values: Always, OnFailure, OnError, OnTransientError.*| | @@ -3360,10 +3360,10 @@ cause implementors to also use a fixed point implementation. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| -| level | string| `string` | | | Level is SELinux level label that applies to the container.
**Validation:** Optional.| | -| role | string| `string` | | | Role is a SELinux role label that applies to the container.
**Validation:** Optional.| | -| type | string| `string` | | | Type is a SELinux type label that applies to the container.
**Validation:** Optional.| | -| user | string| `string` | | | User is a SELinux user label that applies to the container.
**Validation:** Optional.| | +| level | string| `string` | | | Level is SELinux level label that applies to the container.
*Optional.*| | +| role | string| `string` | | | Role is a SELinux role label that applies to the container.
*Optional.*| | +| type | string| `string` | | | Type is a SELinux type label that applies to the container.
*Optional.*| | +| user | string| `string` | | | User is a SELinux user label that applies to the container.
*Optional.*| | @@ -3381,14 +3381,14 @@ cause implementors to also use a fixed point implementation. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| -| fsType | string| `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".
**Validation:** Optional; Default: "xfs".| | +| fsType | string| `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".
*Optional; Default value: "xfs".*| | | gateway | string| `string` | | | gateway is the host address of the ScaleIO API Gateway. | | -| protectionDomain | string| `string` | | | protectionDomain is the name of the ScaleIO Protection Domain for the configured storage.
**Validation:** Optional.| | -| readOnly | boolean| `bool` | | | readOnly Defaults to false (read/write). ReadOnly here will force
the ReadOnly setting in VolumeMounts.
**Validation:** Optional.| | +| protectionDomain | string| `string` | | | protectionDomain is the name of the ScaleIO Protection Domain for the configured storage.
*Optional.*| | +| readOnly | boolean| `bool` | | | readOnly Defaults to false (read/write). ReadOnly here will force
the ReadOnly setting in VolumeMounts.
*Optional.*| | | secretRef | [LocalObjectReference](#local-object-reference)| `LocalObjectReference` | | | | | -| sslEnabled | boolean| `bool` | | | sslEnabled Flag enable/disable SSL communication with Gateway, default false
**Validation:** Optional.| | -| storageMode | string| `string` | | | storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned.
Default is ThinProvisioned.
**Validation:** Optional; Default: "ThinProvisioned".| | -| storagePool | string| `string` | | | storagePool is the ScaleIO Storage Pool associated with the protection domain.
**Validation:** Optional.| | +| sslEnabled | boolean| `bool` | | | sslEnabled Flag enable/disable SSL communication with Gateway, default false
*Optional.*| | +| storageMode | string| `string` | | | storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned.
Default is ThinProvisioned.
*Optional; Default value: "ThinProvisioned".*| | +| storagePool | string| `string` | | | storagePool is the ScaleIO Storage Pool associated with the protection domain.
*Optional.*| | | system | string| `string` | | | system is the name of the storage system as configured in ScaleIO. | | | volumeName | string| `string` | | | volumeName is the name of a volume already created in the ScaleIO system
that is associated with this volume source. | | @@ -3408,31 +3408,31 @@ cause implementors to also use a fixed point implementation. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| -| args | []string| `[]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
**Validation:** Optional.| | -| command | []string| `[]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
**Validation:** Optional.| | -| env | [][EnvVar](#env-var)| `[]*EnvVar` | | | List of environment variables to set in the container.
Cannot be updated.
**Validation:** Optional.| | -| envFrom | [][EnvFromSource](#env-from-source)| `[]*EnvFromSource` | | | List of sources to populate environment variables in the container.
The keys defined within a source must be a C_IDENTIFIER. All invalid keys
will be reported as an event when the container is starting. When a key exists in multiple
sources, the value associated with the last source will take precedence.
Values defined by an Env with a duplicate key will take precedence.
Cannot be updated.
**Validation:** Optional.| | -| image | string| `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.
**Validation:** Optional.| | +| args | []string| `[]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
*Optional.*| | +| command | []string| `[]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
*Optional.*| | +| env | [][EnvVar](#env-var)| `[]*EnvVar` | | | List of environment variables to set in the container.
Cannot be updated.
*Optional.*| | +| envFrom | [][EnvFromSource](#env-from-source)| `[]*EnvFromSource` | | | List of sources to populate environment variables in the container.
The keys defined within a source must be a C_IDENTIFIER. All invalid keys
will be reported as an event when the container is starting. When a key exists in multiple
sources, the value associated with the last source will take precedence.
Values defined by an Env with a duplicate key will take precedence.
Cannot be updated.
*Optional.*| | +| image | string| `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.
*Optional.*| | | imagePullPolicy | [PullPolicy](#pull-policy)| `PullPolicy` | | | | | | lifecycle | [Lifecycle](#lifecycle)| `Lifecycle` | | | | | | livenessProbe | [Probe](#probe)| `Probe` | | | | | | name | string| `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. | | -| ports | [][ContainerPort](#container-port)| `[]*ContainerPort` | | | 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.
**Validation:** Optional.| | +| ports | [][ContainerPort](#container-port)| `[]*ContainerPort` | | | 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.
*Optional.*| | | readinessProbe | [Probe](#probe)| `Probe` | | | | | -| resizePolicy | [][ContainerResizePolicy](#container-resize-policy)| `[]*ContainerResizePolicy` | | | Resources resize policy for the container.
**Validation:** Optional.| | +| resizePolicy | [][ContainerResizePolicy](#container-resize-policy)| `[]*ContainerResizePolicy` | | | Resources resize policy for the container.
*Optional.*| | | resources | [ResourceRequirements](#resource-requirements)| `ResourceRequirements` | | | | | | restartPolicy | [ContainerRestartPolicy](#container-restart-policy)| `ContainerRestartPolicy` | | | | | | securityContext | [SecurityContext](#security-context)| `SecurityContext` | | | | | -| source | string| `string` | | | Source contains the source code of the script to execute
**Validation:** Optional.| | +| source | string| `string` | | | Source contains the source code of the script to execute
*Optional.*| | | startupProbe | [Probe](#probe)| `Probe` | | | | | -| stdin | boolean| `bool` | | | 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.
**Validation:** Optional.| | -| stdinOnce | boolean| `bool` | | | 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
**Validation:** Optional.| | -| terminationMessagePath | string| `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.
**Validation:** Optional.| | +| stdin | boolean| `bool` | | | Whether this container should allocate a buffer for stdin in the container runtime. If this
is not set, reads from stdin in the container will always result in EOF.
Default is false.
*Optional.*| | +| stdinOnce | boolean| `bool` | | | Whether the container runtime should close the stdin channel after it has been opened by
a single attach. When stdin is true the stdin stream will remain open across multiple attach
sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the
first client attaches to stdin, and then remains open and accepts data until the client disconnects,
at which time stdin is closed and remains closed until the container is restarted. If this
flag is false, a container processes that reads from stdin will never receive an EOF.
Default is false
*Optional.*| | +| terminationMessagePath | string| `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.
*Optional.*| | | terminationMessagePolicy | [TerminationMessagePolicy](#termination-message-policy)| `TerminationMessagePolicy` | | | | | -| tty | boolean| `bool` | | | Whether this container should allocate a TTY for itself, also requires 'stdin' to be true.
Default is false.
**Validation:** Optional.| | -| volumeDevices | [][VolumeDevice](#volume-device)| `[]*VolumeDevice` | | | volumeDevices is the list of block devices to be used by the container.
**Validation:** Optional.| | -| volumeMounts | [][VolumeMount](#volume-mount)| `[]*VolumeMount` | | | Pod volumes to mount into the container's filesystem.
Cannot be updated.
**Validation:** Optional.| | -| workingDir | string| `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.
**Validation:** Optional.| | +| tty | boolean| `bool` | | | Whether this container should allocate a TTY for itself, also requires 'stdin' to be true.
Default is false.
*Optional.*| | +| volumeDevices | [][VolumeDevice](#volume-device)| `[]*VolumeDevice` | | | volumeDevices is the list of block devices to be used by the container.
*Optional.*| | +| volumeMounts | [][VolumeMount](#volume-mount)| `[]*VolumeMount` | | | Pod volumes to mount into the container's filesystem.
Cannot be updated.
*Optional.*| | +| workingDir | string| `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.
*Optional.*| | @@ -3450,7 +3450,7 @@ cause implementors to also use a fixed point implementation. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| -| localhostProfile | string| `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.
**Validation:** Optional.| | +| localhostProfile | string| `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.
*Optional.*| | | type | [SeccompProfileType](#seccomp-profile-type)| `SeccompProfileType` | | | | | @@ -3483,8 +3483,8 @@ key-value pairs as environment variables. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| -| name | string| `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
TODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.
**Validation:** Optional; Default: "".| | -| optional | boolean| `bool` | | | Specify whether the Secret must be defined
**Validation:** Optional.| | +| name | string| `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
TODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.
*Optional; Default value: "".*| | +| optional | boolean| `bool` | | | Specify whether the Secret must be defined
*Optional.*| | @@ -3502,8 +3502,8 @@ key-value pairs as environment variables. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| | key | string| `string` | | | The key of the secret to select from. Must be a valid secret key. | | -| name | string| `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
TODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.
**Validation:** Optional; Default: "".| | -| optional | boolean| `bool` | | | Specify whether the Secret or its key must be defined
**Validation:** Optional.| | +| name | string| `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
TODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.
*Optional; Default value: "".*| | +| optional | boolean| `bool` | | | Specify whether the Secret or its key must be defined
*Optional.*| | @@ -3524,9 +3524,9 @@ mode. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| -| items | [][KeyToPath](#key-to-path)| `[]*KeyToPath` | | | 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 '..'.
**Validation:** Optional.| | -| name | string| `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
TODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.
**Validation:** Optional; Default: "".| | -| optional | boolean| `bool` | | | optional field specify whether the Secret or its key must be defined
**Validation:** Optional.| | +| items | [][KeyToPath](#key-to-path)| `[]*KeyToPath` | | | 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 '..'.
*Optional.*| | +| name | string| `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
TODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.
*Optional; Default value: "".*| | +| optional | boolean| `bool` | | | optional field specify whether the Secret or its key must be defined
*Optional.*| | @@ -3546,10 +3546,10 @@ Secret volumes support ownership management and SELinux relabeling. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| -| defaultMode | int32 (formatted integer)| `int32` | | | 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.
**Validation:** Optional.| | -| items | [][KeyToPath](#key-to-path)| `[]*KeyToPath` | | | 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 '..'.
**Validation:** Optional.| | -| optional | boolean| `bool` | | | optional field specify whether the Secret or its keys must be defined
**Validation:** Optional.| | -| secretName | string| `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
**Validation:** Optional.| | +| defaultMode | int32 (formatted integer)| `int32` | | | 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.
*Optional.*| | +| items | [][KeyToPath](#key-to-path)| `[]*KeyToPath` | | | 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 '..'.
*Optional.*| | +| optional | boolean| `bool` | | | optional field specify whether the Secret or its keys must be defined
*Optional.*| | +| secretName | string| `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
*Optional.*| | @@ -3568,15 +3568,15 @@ are set, the values in SecurityContext take precedence. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| -| allowPrivilegeEscalation | boolean| `bool` | | | 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.
**Validation:** Optional.| | +| allowPrivilegeEscalation | boolean| `bool` | | | 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.
*Optional.*| | | appArmorProfile | [AppArmorProfile](#app-armor-profile)| `AppArmorProfile` | | | | | | capabilities | [Capabilities](#capabilities)| `Capabilities` | | | | | -| privileged | boolean| `bool` | | | 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.
**Validation:** Optional.| | +| privileged | boolean| `bool` | | | 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.
*Optional.*| | | procMount | [ProcMountType](#proc-mount-type)| `ProcMountType` | | | | | -| readOnlyRootFilesystem | boolean| `bool` | | | 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.
**Validation:** Optional.| | -| runAsGroup | int64 (formatted integer)| `int64` | | | 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.
**Validation:** Optional.| | -| runAsNonRoot | boolean| `bool` | | | 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.
**Validation:** Optional.| | -| runAsUser | int64 (formatted integer)| `int64` | | | 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.
**Validation:** Optional.| | +| readOnlyRootFilesystem | boolean| `bool` | | | 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.
*Optional.*| | +| runAsGroup | int64 (formatted integer)| `int64` | | | 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.
*Optional.*| | +| runAsNonRoot | boolean| `bool` | | | Indicates that the container must run as a non-root user.
If true, the Kubelet will validate the image at runtime to ensure that it
does not run as UID 0 (root) and fail to start the container if it does.
If unset or false, no such validation will be performed.
May also be set in PodSecurityContext. If set in both SecurityContext and
PodSecurityContext, the value specified in SecurityContext takes precedence.
*Optional.*| | +| runAsUser | int64 (formatted integer)| `int64` | | | 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.
*Optional.*| | | seLinuxOptions | [SELinuxOptions](#s-e-linux-options)| `SELinuxOptions` | | | | | | seccompProfile | [SeccompProfile](#seccomp-profile)| `SeccompProfile` | | | | | | windowsOptions | [WindowsSecurityContextOptions](#windows-security-context-options)| `WindowsSecurityContextOptions` | | | | | @@ -3641,8 +3641,8 @@ otherwise). | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| -| audience | string| `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.
**Validation:** Optional.| | -| expirationSeconds | int64 (formatted integer)| `int64` | | | 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.
**Validation:** Optional.| | +| audience | string| `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.
*Optional.*| | +| expirationSeconds | int64 (formatted integer)| `int64` | | | expirationSeconds is the requested duration of validity of the service
account token. As the token approaches expiration, the kubelet volume
plugin will proactively rotate the service account token. The kubelet will
start trying to rotate the token if the token is older than 80 percent of
its time to live or if the token is older than 24 hours.Defaults to 1 hour
and must be at least 10 minutes.
*Optional.*| | | path | string| `string` | | | path is the path relative to the mount point of the file to project the
token into. | | @@ -3698,11 +3698,11 @@ otherwise). | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| -| fsType | string| `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.
**Validation:** Optional.| | -| readOnly | boolean| `bool` | | | readOnly defaults to false (read/write). ReadOnly here will force
the ReadOnly setting in VolumeMounts.
**Validation:** Optional.| | +| fsType | string| `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.
*Optional.*| | +| readOnly | boolean| `bool` | | | readOnly defaults to false (read/write). ReadOnly here will force
the ReadOnly setting in VolumeMounts.
*Optional.*| | | secretRef | [LocalObjectReference](#local-object-reference)| `LocalObjectReference` | | | | | | volumeName | string| `string` | | | volumeName is the human-readable name of the StorageOS volume. Volume
names are only unique within a namespace. | | -| volumeNamespace | string| `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.
**Validation:** Optional.| | +| volumeNamespace | string| `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.
*Optional.*| | @@ -3813,7 +3813,7 @@ of the first container processes are calculated. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| -| host | string| `string` | | | Optional: Host name to connect to, defaults to the pod IP.
**Validation:** Optional.| | +| host | string| `string` | | | Optional: Host name to connect to, defaults to the pod IP.
*Optional.*| | | port | [IntOrString](#int-or-string)| `IntOrString` | | | | | @@ -3882,21 +3882,21 @@ of the first container processes are calculated. | memoize | [Memoize](#memoize)| `Memoize` | | | | | | metadata | [Metadata](#metadata)| `Metadata` | | | | | | metrics | [Metrics](#metrics)| `Metrics` | | | | | -| name | string| `string` | | | Name is the name of the template
**Validation:** Maximum length: 128; Pattern: `^[a-zA-Z0-9][-a-zA-Z0-9]*$`.| | +| name | string| `string` | | | Name is the name of the template
*Maximum length: 128; Validation regex: `^[a-zA-Z0-9][-a-zA-Z0-9]*$`.*| | | nodeSelector | map of string| `map[string]string` | | | NodeSelector is a selector to schedule this step of the workflow to be
run on the selected node(s). Overrides the selector set at the workflow level. | | | outputs | [Outputs](#outputs)| `Outputs` | | | | | -| parallelism | int64 (formatted integer)| `int64` | | | Parallelism limits the max total parallel pods that can execute at the same time within the
boundaries of this template invocation. If additional steps/dag templates are invoked, the
pods created by those templates will not be counted towards this total.
**Validation:** Minimum: 1.| | +| parallelism | int64 (formatted integer)| `int64` | | | Parallelism limits the max total parallel pods that can execute at the same time within the
boundaries of this template invocation. If additional steps/dag templates are invoked, the
pods created by those templates will not be counted towards this total.
*Minimum value: 1.*| | | plugin | [Plugin](#plugin)| `Plugin` | | | | | | podSpecPatch | string| `string` | | | PodSpecPatch holds strategic merge patch to apply against the pod spec. Allows parameterization of
container fields which are not strings (e.g. resource limits). | | | priorityClassName | string| `string` | | | PriorityClassName to apply to workflow pods. | | | resource | [ResourceTemplate](#resource-template)| `ResourceTemplate` | | | | | | retryStrategy | [RetryStrategy](#retry-strategy)| `RetryStrategy` | | | | | -| schedulerName | string| `string` | | | If specified, the pod will be dispatched by specified scheduler.
Or it will be dispatched by workflow scope scheduler if specified.
If neither specified, the pod will be dispatched by default scheduler.
**Validation:** Optional.| | +| schedulerName | string| `string` | | | If specified, the pod will be dispatched by specified scheduler.
Or it will be dispatched by workflow scope scheduler if specified.
If neither specified, the pod will be dispatched by default scheduler.
*Optional.*| | | script | [ScriptTemplate](#script-template)| `ScriptTemplate` | | | | | | securityContext | [PodSecurityContext](#pod-security-context)| `PodSecurityContext` | | | | | | serviceAccountName | string| `string` | | | ServiceAccountName to apply to workflow pods | | | sidecars | [][UserContainer](#user-container)| `[]*UserContainer` | | | Sidecars is a list of containers which run alongside the main container
Sidecars are automatically killed when the main container completes | | -| steps | [][ParallelSteps](#parallel-steps)| `[]ParallelSteps` | | | Steps define a series of sequential/parallel workflow steps
**Validation:** Minimum items: 1.| | +| steps | [][ParallelSteps](#parallel-steps)| `[]ParallelSteps` | | | Steps define a series of sequential/parallel workflow steps
*Minimum items: 1.*| | | suspend | [SuspendTemplate](#suspend-template)| `SuspendTemplate` | | | | | | synchronization | [Synchronization](#synchronization)| `Synchronization` | | | | | | timeout | string| `string` | | | Timeout allows to set the total node execution timeout duration counting from the node's start time.
This duration also includes time in which the node spends in Pending state. This duration may not be applied to Step or DAG templates. | | @@ -3951,10 +3951,10 @@ the triple using the matching operator . | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| | effect | [TaintEffect](#taint-effect)| `TaintEffect` | | | | | -| key | string| `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.
**Validation:** Optional.| | +| key | string| `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.
*Optional.*| | | operator | [TolerationOperator](#toleration-operator)| `TolerationOperator` | | | | | -| tolerationSeconds | int64 (formatted integer)| `int64` | | | 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.
**Validation:** Optional.| | -| value | string| `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.
**Validation:** Optional.| | +| tolerationSeconds | int64 (formatted integer)| `int64` | | | TolerationSeconds represents the period of time the toleration (which must be
of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default,
it is not set, which means tolerate the taint forever (do not evict). Zero and
negative values will be treated as 0 (evict immediately) by the system.
*Optional.*| | +| value | string| `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.
*Optional.*| | @@ -4030,7 +4030,7 @@ For example, ServiceReferences for admission registration: https://github.com/ku | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| -| apiGroup | string| `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.
**Validation:** Optional.| | +| apiGroup | string| `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.
*Optional.*| | | kind | string| `string` | | | Kind is the type of resource being referenced | | | name | string| `string` | | | Name is the name of resource being referenced | | @@ -4050,10 +4050,10 @@ For example, ServiceReferences for admission registration: https://github.com/ku | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| -| apiGroup | string| `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.
**Validation:** Optional.| | +| apiGroup | string| `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.
*Optional.*| | | kind | string| `string` | | | Kind is the type of resource being referenced | | | name | string| `string` | | | Name is the name of resource being referenced | | -| namespace | string| `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.
**Validation:** Optional.| | +| namespace | string| `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.
*Optional.*| | @@ -4098,31 +4098,31 @@ intent and helps make sure that UIDs and names do not get conflated. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| -| args | []string| `[]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
**Validation:** Optional.| | -| command | []string| `[]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
**Validation:** Optional.| | -| env | [][EnvVar](#env-var)| `[]*EnvVar` | | | List of environment variables to set in the container.
Cannot be updated.
**Validation:** Optional.| | -| envFrom | [][EnvFromSource](#env-from-source)| `[]*EnvFromSource` | | | List of sources to populate environment variables in the container.
The keys defined within a source must be a C_IDENTIFIER. All invalid keys
will be reported as an event when the container is starting. When a key exists in multiple
sources, the value associated with the last source will take precedence.
Values defined by an Env with a duplicate key will take precedence.
Cannot be updated.
**Validation:** Optional.| | -| image | string| `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.
**Validation:** Optional.| | +| args | []string| `[]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
*Optional.*| | +| command | []string| `[]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
*Optional.*| | +| env | [][EnvVar](#env-var)| `[]*EnvVar` | | | List of environment variables to set in the container.
Cannot be updated.
*Optional.*| | +| envFrom | [][EnvFromSource](#env-from-source)| `[]*EnvFromSource` | | | List of sources to populate environment variables in the container.
The keys defined within a source must be a C_IDENTIFIER. All invalid keys
will be reported as an event when the container is starting. When a key exists in multiple
sources, the value associated with the last source will take precedence.
Values defined by an Env with a duplicate key will take precedence.
Cannot be updated.
*Optional.*| | +| image | string| `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.
*Optional.*| | | imagePullPolicy | [PullPolicy](#pull-policy)| `PullPolicy` | | | | | | lifecycle | [Lifecycle](#lifecycle)| `Lifecycle` | | | | | | livenessProbe | [Probe](#probe)| `Probe` | | | | | | mirrorVolumeMounts | boolean| `bool` | | | MirrorVolumeMounts will mount the same volumes specified in the main container
to the container (including artifacts), at the same mountPaths. This enables
dind daemon to partially see the same filesystem as the main container in
order to use features such as docker volume binding | | | name | string| `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. | | -| ports | [][ContainerPort](#container-port)| `[]*ContainerPort` | | | 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.
**Validation:** Optional.| | +| ports | [][ContainerPort](#container-port)| `[]*ContainerPort` | | | 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.
*Optional.*| | | readinessProbe | [Probe](#probe)| `Probe` | | | | | -| resizePolicy | [][ContainerResizePolicy](#container-resize-policy)| `[]*ContainerResizePolicy` | | | Resources resize policy for the container.
**Validation:** Optional.| | +| resizePolicy | [][ContainerResizePolicy](#container-resize-policy)| `[]*ContainerResizePolicy` | | | Resources resize policy for the container.
*Optional.*| | | resources | [ResourceRequirements](#resource-requirements)| `ResourceRequirements` | | | | | | restartPolicy | [ContainerRestartPolicy](#container-restart-policy)| `ContainerRestartPolicy` | | | | | | securityContext | [SecurityContext](#security-context)| `SecurityContext` | | | | | | startupProbe | [Probe](#probe)| `Probe` | | | | | -| stdin | boolean| `bool` | | | 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.
**Validation:** Optional.| | -| stdinOnce | boolean| `bool` | | | 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
**Validation:** Optional.| | -| terminationMessagePath | string| `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.
**Validation:** Optional.| | +| stdin | boolean| `bool` | | | Whether this container should allocate a buffer for stdin in the container runtime. If this
is not set, reads from stdin in the container will always result in EOF.
Default is false.
*Optional.*| | +| stdinOnce | boolean| `bool` | | | Whether the container runtime should close the stdin channel after it has been opened by
a single attach. When stdin is true the stdin stream will remain open across multiple attach
sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the
first client attaches to stdin, and then remains open and accepts data until the client disconnects,
at which time stdin is closed and remains closed until the container is restarted. If this
flag is false, a container processes that reads from stdin will never receive an EOF.
Default is false
*Optional.*| | +| terminationMessagePath | string| `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.
*Optional.*| | | terminationMessagePolicy | [TerminationMessagePolicy](#termination-message-policy)| `TerminationMessagePolicy` | | | | | -| tty | boolean| `bool` | | | Whether this container should allocate a TTY for itself, also requires 'stdin' to be true.
Default is false.
**Validation:** Optional.| | -| volumeDevices | [][VolumeDevice](#volume-device)| `[]*VolumeDevice` | | | volumeDevices is the list of block devices to be used by the container.
**Validation:** Optional.| | -| volumeMounts | [][VolumeMount](#volume-mount)| `[]*VolumeMount` | | | Pod volumes to mount into the container's filesystem.
Cannot be updated.
**Validation:** Optional.| | -| workingDir | string| `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.
**Validation:** Optional.| | +| tty | boolean| `bool` | | | Whether this container should allocate a TTY for itself, also requires 'stdin' to be true.
Default is false.
*Optional.*| | +| volumeDevices | [][VolumeDevice](#volume-device)| `[]*VolumeDevice` | | | volumeDevices is the list of block devices to be used by the container.
*Optional.*| | +| volumeMounts | [][VolumeMount](#volume-mount)| `[]*VolumeMount` | | | Pod volumes to mount into the container's filesystem.
Cannot be updated.
*Optional.*| | +| workingDir | string| `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.
*Optional.*| | @@ -4227,10 +4227,10 @@ intent and helps make sure that UIDs and names do not get conflated. | mountPath | string| `string` | | | Path within the container at which the volume should be mounted. Must
not contain ':'. | | | mountPropagation | [MountPropagationMode](#mount-propagation-mode)| `MountPropagationMode` | | | | | | name | string| `string` | | | This must match the Name of a Volume. | | -| readOnly | boolean| `bool` | | | Mounted read-only if true, read-write otherwise (false or unspecified).
Defaults to false.
**Validation:** Optional.| | +| readOnly | boolean| `bool` | | | Mounted read-only if true, read-write otherwise (false or unspecified).
Defaults to false.
*Optional.*| | | recursiveReadOnly | [RecursiveReadOnlyMode](#recursive-read-only-mode)| `RecursiveReadOnlyMode` | | | | | -| subPath | string| `string` | | | Path within the volume from which the container's volume should be mounted.
Defaults to "" (volume's root).
**Validation:** Optional.| | -| subPathExpr | string| `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.
**Validation:** Optional.| | +| subPath | string| `string` | | | Path within the volume from which the container's volume should be mounted.
Defaults to "" (volume's root).
*Optional.*| | +| subPathExpr | string| `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.
*Optional.*| | @@ -4283,9 +4283,9 @@ intent and helps make sure that UIDs and names do not get conflated. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| -| fsType | string| `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.
**Validation:** Optional.| | -| storagePolicyID | string| `string` | | | storagePolicyID is the storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.
**Validation:** Optional.| | -| storagePolicyName | string| `string` | | | storagePolicyName is the storage Policy Based Management (SPBM) profile name.
**Validation:** Optional.| | +| fsType | string| `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.
*Optional.*| | +| storagePolicyID | string| `string` | | | storagePolicyID is the storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.
*Optional.*| | +| storagePolicyName | string| `string` | | | storagePolicyName is the storage Policy Based Management (SPBM) profile name.
*Optional.*| | | volumePath | string| `string` | | | volumePath is the path that identifies vSphere volume vmdk | | @@ -4320,10 +4320,10 @@ intent and helps make sure that UIDs and names do not get conflated. | Name | Type | Go type | Required | Default | Description | Example | |------|------|---------|:--------:| ------- |-------------|---------| -| gmsaCredentialSpec | string| `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.
**Validation:** Optional.| | -| gmsaCredentialSpecName | string| `string` | | | GMSACredentialSpecName is the name of the GMSA credential spec to use.
**Validation:** Optional.| | -| hostProcess | boolean| `bool` | | | 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.
**Validation:** Optional.| | -| runAsUserName | string| `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.
**Validation:** Optional.| | +| gmsaCredentialSpec | string| `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.
*Optional.*| | +| gmsaCredentialSpecName | string| `string` | | | GMSACredentialSpecName is the name of the GMSA credential spec to use.
*Optional.*| | +| hostProcess | boolean| `bool` | | | 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.
*Optional.*| | +| runAsUserName | string| `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.
*Optional.*| | diff --git a/hack/docs/clean_swagger_md.py b/hack/docs/clean_swagger_md.py index a3a4dfb3a376..33d1e3a7d296 100755 --- a/hack/docs/clean_swagger_md.py +++ b/hack/docs/clean_swagger_md.py @@ -103,15 +103,13 @@ def build_validation_section(annotations): if annotations.get('optional'): parts.append('Optional') - if annotations.get('required'): - parts.append('Required') # Fields with labels labeled_fields = [ - ('default', 'Default'), - ('enum_values', 'Valid values'), - ('minimum', 'Minimum'), - ('maximum', 'Maximum'), + ('default', 'Default value'), + ('enum_values', 'Allowed values'), + ('minimum', 'Minimum value'), + ('maximum', 'Maximum value'), ('min_length', 'Minimum length'), ('max_length', 'Maximum length'), ('min_items', 'Minimum items'), @@ -122,12 +120,12 @@ def build_validation_section(annotations): parts.append(f"{label}: {annotations[key]}") if annotations.get('pattern'): - parts.append(f"Pattern: `{annotations['pattern']}`") + parts.append(f"Validation regex: `{annotations['pattern']}`") if not parts: return '' - return '
**Validation:** ' + '; '.join(parts) + '.' + return '
*' + '; '.join(parts) + '.*' def process_table_cell(cell): From 5703679f7b686fd8fd0e6a4a548b19f7e5445437 Mon Sep 17 00:00:00 2001 From: Alan Clucas Date: Fri, 5 Dec 2025 11:08:30 +0000 Subject: [PATCH 6/6] chore: do go generate instead Signed-off-by: Alan Clucas --- Makefile | 2 -- pkg/plugins/executor/swagger.go | 1 + 2 files changed, 1 insertion(+), 2 deletions(-) diff --git a/Makefile b/Makefile index 6eae68d386cc..17ab0f0cae95 100644 --- a/Makefile +++ b/Makefile @@ -353,8 +353,6 @@ argoexec-nonroot-image: codegen: types swagger manifests $(TOOL_MOCKERY) $(GENERATED_DOCS) ## Generate code via `go generate`, as well as SDKs go generate ./... $(TOOL_MOCKERY) --config .mockery.yaml - # Clean up kubebuilder annotations and convert to human-readable validation section - python3 hack/docs/clean_swagger_md.py docs/executor_swagger.md make --directory sdks/java USE_NIX=$(USE_NIX) generate make --directory sdks/python USE_NIX=$(USE_NIX) generate diff --git a/pkg/plugins/executor/swagger.go b/pkg/plugins/executor/swagger.go index 4470021797e8..e58e19227023 100644 --- a/pkg/plugins/executor/swagger.go +++ b/pkg/plugins/executor/swagger.go @@ -16,3 +16,4 @@ package executor //go:generate env SWAGGER_GENERATE_EXTENSION=false swagger generate spec -o swagger.yml //go:generate env SWAGGER_GENERATE_EXTENSION=false swagger generate markdown -f swagger.yml --output ../../../docs/executor_swagger.md +//go:generate python3 ../../../hack/docs/clean_swagger_md.py ../../../docs/executor_swagger.md