API Reference#

Packages:

bootstrap.cluster.x-k8s.io/v1beta1
controlplane.cluster.x-k8s.io/v1beta1
infrastructure.cluster.x-k8s.io/v1beta1
k0smotron.io/v1beta1

bootstrap.cluster.x-k8s.io/v1beta1#

Resource Types:

K0sControllerConfig

K0sWorkerConfig

K0sWorkerConfigTemplate

K0sControllerConfig#

^{^{↩ Parent}}

Name	Type	Description	Required
apiVersion	string	bootstrap.cluster.x-k8s.io/v1beta1	true
kind	string	K0sControllerConfig	true
metadata	object	Refer to the Kubernetes API documentation for the fields of the `metadata` field.	true
spec	object		false
status	object		false

K0sControllerConfig.spec#

^{^{↩ Parent}}

Name	Type	Description	Required
args	[]string	Args specifies extra arguments to be passed to k0s controller. See: https://docs.k0sproject.io/stable/cli/k0s_controller/	false
downloadURL	string	DownloadURL specifies the URL from which to download the k0s binary. If the version field is specified, it is ignored, and whatever version is downloaded from the URL is used.	false
files	[]object	Files specifies extra files to be passed to user_data upon creation.	false
k0s	object	K0s defines the k0s configuration. Note, that some fields will be overwritten by k0smotron. If empty, will be used default configuration. @see https://docs.k0sproject.io/stable/configuration/	false
postStartCommands	[]string	PostStartCommands specifies commands to be run after starting k0s worker.	false
preInstalledK0s	boolean	PreInstallK0s specifies whether k0s binary is pre-installed on the node.	false
preStartCommands	[]string	PreStartCommands specifies commands to be run before starting k0s worker.	false
tunneling	object	Tunneling defines the tunneling configuration for the cluster.	false
useSystemHostname	boolean	UseSystemHostname specifies whether to use the system hostname for the kubernetes node name. By default, k0smotron will use Machine name as a node name. If true, it will pick it from `hostname` command output. Default: false	false
version	string	Version is the version of k0s to use. In case this is not set, k0smotron will use a version field of the Machine object. If it's empty, the latest version is used. Make sure the version is compatible with the k0s version running on the control plane. For reference see the Kubernetes version skew policy: https://kubernetes.io/docs/setup/release/version-skew-policy/	false

K0sControllerConfig.spec.files[index]#

^{^{↩ Parent}}

File defines a file to be passed to user_data upon creation.

Name	Type	Description	Required
content	string		false
contentFrom	object	ContentFrom specifies the source of the content.	false
path	string		false
permissions	string		false

K0sControllerConfig.spec.files[index].contentFrom#

^{^{↩ Parent}}

ContentFrom specifies the source of the content.

Name	Type	Description	Required
configMapRef	object	ConfigMapRef is a reference to a configmap that contains the content.	false
secretRef	object	SecretRef is a reference to a secret that contains the content.	false

K0sControllerConfig.spec.files[index].contentFrom.configMapRef#

^{^{↩ Parent}}

ConfigMapRef is a reference to a configmap that contains the content.

Name	Type	Description	Required
key	string	Key is the key in the source that contains the content	true
name	string	Name is the name of the source	true

K0sControllerConfig.spec.files[index].contentFrom.secretRef#

^{^{↩ Parent}}

SecretRef is a reference to a secret that contains the content.

Name	Type	Description	Required
key	string	Key is the key in the source that contains the content	true
name	string	Name is the name of the source	true

K0sControllerConfig.spec.tunneling#

^{^{↩ Parent}}

Tunneling defines the tunneling configuration for the cluster.

Name	Type	Description	Required
enabled	boolean	Enabled specifies whether tunneling is enabled. Default: false	false
mode	enum	Mode describes tunneling mode. If empty, k0smotron will use the default one. Enum: tunnel, proxy Default: tunnel	false
serverAddress	string	Server address of the tunneling server. If empty, k0smotron will try to detect worker node address for.	false
serverNodePort	integer	NodePort to publish for server port of the tunneling server. If empty, k0smotron will use the default one. Format: int32 Default: 31700	false
tunnelingNodePort	integer	NodePort to publish for tunneling port. If empty, k0smotron will use the default one. Format: int32 Default: 31443	false

K0sControllerConfig.status#

^{^{↩ Parent}}

Name	Type	Description	Required
dataSecretName	string	DataSecretName is the name of the secret that stores the bootstrap data script.	false
ready	boolean	Ready indicates the Bootstrapdata field is ready to be consumed	false

K0sWorkerConfig#

^{^{↩ Parent}}

Name	Type	Description	Required
apiVersion	string	bootstrap.cluster.x-k8s.io/v1beta1	true
kind	string	K0sWorkerConfig	true
metadata	object	Refer to the Kubernetes API documentation for the fields of the `metadata` field.	true
spec	object		false
status	object		false

K0sWorkerConfig.spec#

^{^{↩ Parent}}

Name	Type	Description	Required
args	[]string	Args specifies extra arguments to be passed to k0s worker. See: https://docs.k0sproject.io/stable/worker-node-config/ See: https://docs.k0sproject.io/stable/cli/k0s_worker/	false
downloadURL	string	DownloadURL specifies the URL to download k0s binary from. If specified the version field is ignored and what ever version is downloaded from the URL is used.	false
files	[]object	Files specifies extra files to be passed to user_data upon creation.	false
joinTokenSecretRef	object	JoinTokenSecretRef is a reference to a secret that contains the join token. This should be only set in the case you want to use a pre-generated join token.	false
postStartCommands	[]string	PostStartCommands specifies commands to be run after starting k0s worker.	false
preInstalledK0s	boolean	PreInstallK0s specifies whether k0s binary is pre-installed on the node.	false
preStartCommands	[]string	PreStartCommands specifies commands to be run before starting k0s worker.	false
useSystemHostname	boolean	UseSystemHostname specifies whether to use the system hostname for the kubernetes node name. By default, k0smotron will use Machine name as a node name. If true, it will pick it from `hostname` command output. Default: false	false
version	string	Version is the version of k0s to use. In case this is not set, k0smotron will use a version field of the Machine object. If it's empty, the latest version is used. Make sure the version is compatible with the k0s version running on the control plane. For reference see the Kubernetes version skew policy: https://kubernetes.io/docs/setup/release/version-skew-policy/	false

K0sWorkerConfig.spec.files[index]#

^{^{↩ Parent}}

File defines a file to be passed to user_data upon creation.

Name	Type	Description	Required
content	string		false
contentFrom	object	ContentFrom specifies the source of the content.	false
path	string		false
permissions	string		false

K0sWorkerConfig.spec.files[index].contentFrom#

^{^{↩ Parent}}

ContentFrom specifies the source of the content.

Name	Type	Description	Required
configMapRef	object	ConfigMapRef is a reference to a configmap that contains the content.	false
secretRef	object	SecretRef is a reference to a secret that contains the content.	false

K0sWorkerConfig.spec.files[index].contentFrom.configMapRef#

^{^{↩ Parent}}

ConfigMapRef is a reference to a configmap that contains the content.

Name	Type	Description	Required
key	string	Key is the key in the source that contains the content	true
name	string	Name is the name of the source	true

K0sWorkerConfig.spec.files[index].contentFrom.secretRef#

^{^{↩ Parent}}

SecretRef is a reference to a secret that contains the content.

Name	Type	Description	Required
key	string	Key is the key in the source that contains the content	true
name	string	Name is the name of the source	true

K0sWorkerConfig.spec.joinTokenSecretRef#

^{^{↩ Parent}}

JoinTokenSecretRef is a reference to a secret that contains the join token. This should be only set in the case you want to use a pre-generated join token.

Name	Type	Description	Required
key	string	Key is the key in the secret that contains the join token	true
name	string	Name is the name of the secret	true

K0sWorkerConfig.status#

^{^{↩ Parent}}

Name	Type	Description	Required
dataSecretName	string	DataSecretName is the name of the secret that stores the bootstrap data script.	false
ready	boolean	Ready indicates the Bootstrapdata field is ready to be consumed	false

K0sWorkerConfigTemplate#

^{^{↩ Parent}}

Name	Type	Description	Required
apiVersion	string	bootstrap.cluster.x-k8s.io/v1beta1	true
kind	string	K0sWorkerConfigTemplate	true
metadata	object	Refer to the Kubernetes API documentation for the fields of the `metadata` field.	true
spec	object		false

K0sWorkerConfigTemplate.spec#

^{^{↩ Parent}}

Name	Type	Description	Required
template	object		false

K0sWorkerConfigTemplate.spec.template#

^{^{↩ Parent}}

Name	Type	Description	Required
metadata	object		false
spec	object		false

K0sWorkerConfigTemplate.spec.template.metadata#

^{^{↩ Parent}}

Name	Type	Required
annotations	map[string]string	false
finalizers	[]string	false
labels	map[string]string	false
name	string	false
namespace	string	false

K0sWorkerConfigTemplate.spec.template.spec#

^{^{↩ Parent}}

Name	Type	Description	Required
args	[]string	Args specifies extra arguments to be passed to k0s worker. See: https://docs.k0sproject.io/stable/worker-node-config/ See: https://docs.k0sproject.io/stable/cli/k0s_worker/	false
downloadURL	string	DownloadURL specifies the URL to download k0s binary from. If specified the version field is ignored and what ever version is downloaded from the URL is used.	false
files	[]object	Files specifies extra files to be passed to user_data upon creation.	false
joinTokenSecretRef	object	JoinTokenSecretRef is a reference to a secret that contains the join token. This should be only set in the case you want to use a pre-generated join token.	false
postStartCommands	[]string	PostStartCommands specifies commands to be run after starting k0s worker.	false
preInstalledK0s	boolean	PreInstallK0s specifies whether k0s binary is pre-installed on the node.	false
preStartCommands	[]string	PreStartCommands specifies commands to be run before starting k0s worker.	false
useSystemHostname	boolean	UseSystemHostname specifies whether to use the system hostname for the kubernetes node name. By default, k0smotron will use Machine name as a node name. If true, it will pick it from `hostname` command output. Default: false	false
version	string	Version is the version of k0s to use. In case this is not set, k0smotron will use a version field of the Machine object. If it's empty, the latest version is used. Make sure the version is compatible with the k0s version running on the control plane. For reference see the Kubernetes version skew policy: https://kubernetes.io/docs/setup/release/version-skew-policy/	false

K0sWorkerConfigTemplate.spec.template.spec.files[index]#

^{^{↩ Parent}}

File defines a file to be passed to user_data upon creation.

Name	Type	Description	Required
content	string		false
contentFrom	object	ContentFrom specifies the source of the content.	false
path	string		false
permissions	string		false

K0sWorkerConfigTemplate.spec.template.spec.files[index].contentFrom#

^{^{↩ Parent}}

ContentFrom specifies the source of the content.

Name	Type	Description	Required
configMapRef	object	ConfigMapRef is a reference to a configmap that contains the content.	false
secretRef	object	SecretRef is a reference to a secret that contains the content.	false

K0sWorkerConfigTemplate.spec.template.spec.files[index].contentFrom.configMapRef#

^{^{↩ Parent}}

ConfigMapRef is a reference to a configmap that contains the content.

Name	Type	Description	Required
key	string	Key is the key in the source that contains the content	true
name	string	Name is the name of the source	true

K0sWorkerConfigTemplate.spec.template.spec.files[index].contentFrom.secretRef#

^{^{↩ Parent}}

SecretRef is a reference to a secret that contains the content.

Name	Type	Description	Required
key	string	Key is the key in the source that contains the content	true
name	string	Name is the name of the source	true

K0sWorkerConfigTemplate.spec.template.spec.joinTokenSecretRef#

^{^{↩ Parent}}

JoinTokenSecretRef is a reference to a secret that contains the join token. This should be only set in the case you want to use a pre-generated join token.

Name	Type	Description	Required
key	string	Key is the key in the secret that contains the join token	true
name	string	Name is the name of the secret	true

controlplane.cluster.x-k8s.io/v1beta1#

Resource Types:

K0sControlPlane

K0sControlPlaneTemplate

K0smotronControlPlane

K0smotronControlPlaneTemplate

K0sControlPlane#

^{^{↩ Parent}}

Name	Type	Description	Required
apiVersion	string	controlplane.cluster.x-k8s.io/v1beta1	true
kind	string	K0sControlPlane	true
metadata	object	Refer to the Kubernetes API documentation for the fields of the `metadata` field.	true
spec	object		false
status	object		false

K0sControlPlane.spec#

^{^{↩ Parent}}

Name	Type	Description	Required
k0sConfigSpec	object		true
machineTemplate	object		true
replicas	integer	Format: int32 Default: 1	false
updateStrategy	enum	UpdateStrategy defines the strategy to use when updating the control plane. Enum: InPlace, Recreate Default: InPlace	false
version	string	Version defines the k0s version to be deployed. You can use a specific k0s version (e.g. v1.27.1+k0s.0) or just the Kubernetes version (e.g. v1.27.1). If left empty, k0smotron will select one automatically.	false

K0sControlPlane.spec.k0sConfigSpec#

^{^{↩ Parent}}

Name	Type	Description	Required
args	[]string	Args specifies extra arguments to be passed to k0s controller. See: https://docs.k0sproject.io/stable/cli/k0s_controller/	false
downloadURL	string	DownloadURL specifies the URL from which to download the k0s binary. If the version field is specified, it is ignored, and whatever version is downloaded from the URL is used.	false
files	[]object	Files specifies extra files to be passed to user_data upon creation.	false
k0s	object	K0s defines the k0s configuration. Note, that some fields will be overwritten by k0smotron. If empty, will be used default configuration. @see https://docs.k0sproject.io/stable/configuration/	false
postStartCommands	[]string	PostStartCommands specifies commands to be run after starting k0s worker.	false
preInstalledK0s	boolean	PreInstallK0s specifies whether k0s binary is pre-installed on the node.	false
preStartCommands	[]string	PreStartCommands specifies commands to be run before starting k0s worker.	false
tunneling	object	Tunneling defines the tunneling configuration for the cluster.	false
useSystemHostname	boolean	UseSystemHostname specifies whether to use the system hostname for the kubernetes node name. By default, k0smotron will use Machine name as a node name. If true, it will pick it from `hostname` command output. Default: false	false

K0sControlPlane.spec.k0sConfigSpec.files[index]#

^{^{↩ Parent}}

File defines a file to be passed to user_data upon creation.

Name	Type	Description	Required
content	string		false
contentFrom	object	ContentFrom specifies the source of the content.	false
path	string		false
permissions	string		false

K0sControlPlane.spec.k0sConfigSpec.files[index].contentFrom#

^{^{↩ Parent}}

ContentFrom specifies the source of the content.

Name	Type	Description	Required
configMapRef	object	ConfigMapRef is a reference to a configmap that contains the content.	false
secretRef	object	SecretRef is a reference to a secret that contains the content.	false

K0sControlPlane.spec.k0sConfigSpec.files[index].contentFrom.configMapRef#

^{^{↩ Parent}}

ConfigMapRef is a reference to a configmap that contains the content.

Name	Type	Description	Required
key	string	Key is the key in the source that contains the content	true
name	string	Name is the name of the source	true

K0sControlPlane.spec.k0sConfigSpec.files[index].contentFrom.secretRef#

^{^{↩ Parent}}

SecretRef is a reference to a secret that contains the content.

Name	Type	Description	Required
key	string	Key is the key in the source that contains the content	true
name	string	Name is the name of the source	true

K0sControlPlane.spec.k0sConfigSpec.tunneling#

^{^{↩ Parent}}

Tunneling defines the tunneling configuration for the cluster.

Name	Type	Description	Required
enabled	boolean	Enabled specifies whether tunneling is enabled. Default: false	false
mode	enum	Mode describes tunneling mode. If empty, k0smotron will use the default one. Enum: tunnel, proxy Default: tunnel	false
serverAddress	string	Server address of the tunneling server. If empty, k0smotron will try to detect worker node address for.	false
serverNodePort	integer	NodePort to publish for server port of the tunneling server. If empty, k0smotron will use the default one. Format: int32 Default: 31700	false
tunnelingNodePort	integer	NodePort to publish for tunneling port. If empty, k0smotron will use the default one. Format: int32 Default: 31443	false

K0sControlPlane.spec.machineTemplate#

^{^{↩ Parent}}

Name	Type	Description	Required
infrastructureRef	object	InfrastructureRef is a required reference to a custom resource offered by an infrastructure provider.	true
metadata	object	Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata	false
nodeDeletionTimeout	string	NodeDeletionTimeout defines how long the machine controller will attempt to delete the Node that the Machine hosts after the Machine is marked for deletion. A duration of 0 will retry deletion indefinitely. If no value is provided, the default value for this property of the Machine resource will be used.	false
nodeDrainTimeout	string	NodeDrainTimeout is the total amount of time that the controller will spend on draining a controlplane node The default value is 0, meaning that the node can be drained without any time limitations. NOTE: NodeDrainTimeout is different from `kubectl drain --timeout`	false
nodeVolumeDetachTimeout	string	NodeVolumeDetachTimeout is the total amount of time that the controller will spend on waiting for all volumes to be detached. The default value is 0, meaning that the volumes can be detached without any time limitations.	false

K0sControlPlane.spec.machineTemplate.infrastructureRef#

^{^{↩ Parent}}

InfrastructureRef is a required reference to a custom resource offered by an infrastructure provider.

Name	Type	Description	Required
apiVersion	string	API version of the referent.	false
fieldPath	string	If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object. TODO: this design is not final and this field is subject to change in the future.	false
kind	string	Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds	false
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names	false
namespace	string	Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/	false
resourceVersion	string	Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency	false
uid	string	UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids	false

K0sControlPlane.spec.machineTemplate.metadata#

^{^{↩ Parent}}

Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

Name	Type	Description	Required
annotations	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: http://kubernetes.io/docs/user-guide/annotations	false
labels	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: http://kubernetes.io/docs/user-guide/labels	false

K0sControlPlane.status#

^{^{↩ Parent}}

Name	Type	Description	Required
controlPlaneReady	boolean		true
externalManagedControlPlane	boolean		true
initialized	boolean		true
ready	boolean	Ready denotes that the control plane is ready	true
readyReplicas	integer	Format: int32	true
replicas	integer	Format: int32	true
selector	string		true
unavailableReplicas	integer	Format: int32	true
updatedReplicas	integer	Format: int32	true
version	string		true
conditions	[]object	Conditions defines current service state of the K0sControlPlane.	false

K0sControlPlane.status.conditions[index]#

^{^{↩ Parent}}

Condition defines an observation of a Cluster API resource operational state.

Name	Type	Description	Required
lastTransitionTime	string	Last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable. Format: date-time	true
status	string	Status of the condition, one of True, False, Unknown.	true
type	string	Type of condition in CamelCase or in foo.example.com/CamelCase. Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be useful (see .node.status.conditions), the ability to deconflict is important.	true
message	string	A human readable message indicating details about the transition. This field may be empty.	false
reason	string	The reason for the condition's last transition in CamelCase. The specific API may choose whether or not this field is considered a guaranteed API. This field may not be empty.	false
severity	string	Severity provides an explicit classification of Reason code, so the users or machines can immediately understand the current situation and act accordingly. The Severity field MUST be set only when Status=False.	false

K0sControlPlaneTemplate#

^{^{↩ Parent}}

Name	Type	Description	Required
apiVersion	string	controlplane.cluster.x-k8s.io/v1beta1	true
kind	string	K0sControlPlaneTemplate	true
metadata	object	Refer to the Kubernetes API documentation for the fields of the `metadata` field.	true
spec	object		false

K0sControlPlaneTemplate.spec#

^{^{↩ Parent}}

Name	Type	Description	Required
template	object		false

K0sControlPlaneTemplate.spec.template#

^{^{↩ Parent}}

Name	Type	Description	Required
metadata	object		false
spec	object		false

K0sControlPlaneTemplate.spec.template.metadata#

^{^{↩ Parent}}

Name	Type	Required
annotations	map[string]string	false
finalizers	[]string	false
labels	map[string]string	false
name	string	false
namespace	string	false

K0sControlPlaneTemplate.spec.template.spec#

^{^{↩ Parent}}

Name	Type	Description	Required
k0sConfigSpec	object		true
machineTemplate	object		false
updateStrategy	enum	UpdateStrategy defines the strategy to use when updating the control plane. Enum: InPlace, Recreate Default: InPlace	false
version	string		false

K0sControlPlaneTemplate.spec.template.spec.k0sConfigSpec#

^{^{↩ Parent}}

Name	Type	Description	Required
args	[]string	Args specifies extra arguments to be passed to k0s controller. See: https://docs.k0sproject.io/stable/cli/k0s_controller/	false
downloadURL	string	DownloadURL specifies the URL from which to download the k0s binary. If the version field is specified, it is ignored, and whatever version is downloaded from the URL is used.	false
files	[]object	Files specifies extra files to be passed to user_data upon creation.	false
k0s	object	K0s defines the k0s configuration. Note, that some fields will be overwritten by k0smotron. If empty, will be used default configuration. @see https://docs.k0sproject.io/stable/configuration/	false
postStartCommands	[]string	PostStartCommands specifies commands to be run after starting k0s worker.	false
preInstalledK0s	boolean	PreInstallK0s specifies whether k0s binary is pre-installed on the node.	false
preStartCommands	[]string	PreStartCommands specifies commands to be run before starting k0s worker.	false
tunneling	object	Tunneling defines the tunneling configuration for the cluster.	false
useSystemHostname	boolean	UseSystemHostname specifies whether to use the system hostname for the kubernetes node name. By default, k0smotron will use Machine name as a node name. If true, it will pick it from `hostname` command output. Default: false	false

K0sControlPlaneTemplate.spec.template.spec.k0sConfigSpec.files[index]#

^{^{↩ Parent}}

File defines a file to be passed to user_data upon creation.

Name	Type	Description	Required
content	string		false
contentFrom	object	ContentFrom specifies the source of the content.	false
path	string		false
permissions	string		false

K0sControlPlaneTemplate.spec.template.spec.k0sConfigSpec.files[index].contentFrom#

^{^{↩ Parent}}

ContentFrom specifies the source of the content.

Name	Type	Description	Required
configMapRef	object	ConfigMapRef is a reference to a configmap that contains the content.	false
secretRef	object	SecretRef is a reference to a secret that contains the content.	false

K0sControlPlaneTemplate.spec.template.spec.k0sConfigSpec.files[index].contentFrom.configMapRef#

^{^{↩ Parent}}

ConfigMapRef is a reference to a configmap that contains the content.

Name	Type	Description	Required
key	string	Key is the key in the source that contains the content	true
name	string	Name is the name of the source	true

K0sControlPlaneTemplate.spec.template.spec.k0sConfigSpec.files[index].contentFrom.secretRef#

^{^{↩ Parent}}

SecretRef is a reference to a secret that contains the content.

Name	Type	Description	Required
key	string	Key is the key in the source that contains the content	true
name	string	Name is the name of the source	true

K0sControlPlaneTemplate.spec.template.spec.k0sConfigSpec.tunneling#

^{^{↩ Parent}}

Tunneling defines the tunneling configuration for the cluster.

Name	Type	Description	Required
enabled	boolean	Enabled specifies whether tunneling is enabled. Default: false	false
mode	enum	Mode describes tunneling mode. If empty, k0smotron will use the default one. Enum: tunnel, proxy Default: tunnel	false
serverAddress	string	Server address of the tunneling server. If empty, k0smotron will try to detect worker node address for.	false
serverNodePort	integer	NodePort to publish for server port of the tunneling server. If empty, k0smotron will use the default one. Format: int32 Default: 31700	false
tunnelingNodePort	integer	NodePort to publish for tunneling port. If empty, k0smotron will use the default one. Format: int32 Default: 31443	false

K0sControlPlaneTemplate.spec.template.spec.machineTemplate#

^{^{↩ Parent}}

Name	Type	Description	Required
infrastructureRef	object	InfrastructureRef is a required reference to a custom resource offered by an infrastructure provider.	true
metadata	object	Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata	false
nodeDeletionTimeout	string	NodeDeletionTimeout defines how long the machine controller will attempt to delete the Node that the Machine hosts after the Machine is marked for deletion. A duration of 0 will retry deletion indefinitely. If no value is provided, the default value for this property of the Machine resource will be used.	false
nodeDrainTimeout	string	NodeDrainTimeout is the total amount of time that the controller will spend on draining a controlplane node The default value is 0, meaning that the node can be drained without any time limitations. NOTE: NodeDrainTimeout is different from `kubectl drain --timeout`	false
nodeVolumeDetachTimeout	string	NodeVolumeDetachTimeout is the total amount of time that the controller will spend on waiting for all volumes to be detached. The default value is 0, meaning that the volumes can be detached without any time limitations.	false

K0sControlPlaneTemplate.spec.template.spec.machineTemplate.infrastructureRef#

^{^{↩ Parent}}

InfrastructureRef is a required reference to a custom resource offered by an infrastructure provider.

Name	Type	Description	Required
apiVersion	string	API version of the referent.	false
fieldPath	string	If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object. TODO: this design is not final and this field is subject to change in the future.	false
kind	string	Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds	false
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names	false
namespace	string	Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/	false
resourceVersion	string	Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency	false
uid	string	UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids	false

K0sControlPlaneTemplate.spec.template.spec.machineTemplate.metadata#

^{^{↩ Parent}}

Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

Name	Type	Description	Required
annotations	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: http://kubernetes.io/docs/user-guide/annotations	false
labels	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: http://kubernetes.io/docs/user-guide/labels	false

K0smotronControlPlane#

^{^{↩ Parent}}

Name	Type	Description	Required
apiVersion	string	controlplane.cluster.x-k8s.io/v1beta1	true
kind	string	K0smotronControlPlane	true
metadata	object	Refer to the Kubernetes API documentation for the fields of the `metadata` field.	true
spec	object	ClusterSpec defines the desired state of K0smotronCluster	false
status	object		false

K0smotronControlPlane.spec#

^{^{↩ Parent}}

ClusterSpec defines the desired state of K0smotronCluster

Name	Type	Description	Required
certificateRefs	[]object	CertificateRefs defines the certificate references.	false
controllerPlaneFlags	[]string	ControlPlaneFlags allows to configure additional flags for k0s control plane and to override existing ones. The default flags are kept unless they are overriden explicitly. Flags with arguments must be specified as a single string, e.g. --some-flag=argument	false
etcd	object	Etcd defines the etcd configuration. Default: map[image:quay.io/k0sproject/etcd:v3.5.13 persistence:map[]]	false
externalAddress	string	ExternalAddress defines k0s external address. See https://docs.k0sproject.io/stable/configuration/#specapi Will be detected automatically for service type LoadBalancer.	false
image	string	Image defines the k0s image to be deployed. If empty k0smotron will pick it automatically. Must not include the image tag. Default: k0sproject/k0s	false
k0sConfig	object	k0sConfig defines the k0s configuration. Note, that some fields will be overwritten by k0smotron. If empty, will be used default configuration. @see https://docs.k0sproject.io/stable/configuration/	false
kineDataSourceSecretName	string	KineDataSourceSecretName defines the name of kine datasource URL secret.	false
kineDataSourceURL	string	KineDataSourceURL defines the kine datasource URL.	false
manifests	[]object	Manifests allows to specify list of volumes with manifests to be deployed in the cluster. The volumes will be mounted in /var/lib/k0s/manifests/, for this reason each manifest is a stack. K0smotron allows any kind of volume, but the recommendation is to use secrets and configmaps. For more information check: https://docs.k0sproject.io/stable/manifests/ and https://kubernetes.io/docs/concepts/storage/volumes	false
monitoring	object	Monitoring defines the monitoring configuration.	false
mounts	[]object	Mounts allows to specify list of volumes with any files to be mounted in the controlplane pod. K0smotron allows any kind of volume, but the recommendation is to use secrets and configmaps. For more information check: https://kubernetes.io/docs/concepts/storage/volumes	false
persistence	object	Persistence defines the persistence configuration. If empty k0smotron will use emptyDir as a volume. See https://docs.k0smotron.io/stable/configuration/#persistence	false
replicas	integer	Replicas is the desired number of replicas of the k0s control planes. If unspecified, defaults to 1. If the value is above 1, k0smotron requires kine datasource URL to be set. Recommended value is 3. Format: int32 Default: 1	false
resources	object	Resources describes the compute resource requirements for the control plane pods.	false
service	object	Service defines the service configuration. Default: map[apiPort:30443 konnectivityPort:30132 type:ClusterIP]	false
version	string	Version defines the k0s version to be deployed. If empty k0smotron will pick it automatically.	false

K0smotronControlPlane.spec.certificateRefs[index]#

^{^{↩ Parent}}

Name	Type	Description	Required
type	enum	Enum: ca, sa, proxy, etcd, apiserver-etcd-client, etcd-peer, etcd-server	true
name	string		false

K0smotronControlPlane.spec.etcd#

^{^{↩ Parent}}

Etcd defines the etcd configuration.

Name	Type	Description	Required
image	string	Image defines the etcd image to be deployed. Default: quay.io/k0sproject/etcd:v3.5.13	true
args	[]string	Args defines the etcd arguments.	false
autoDeletePVCs	boolean	AutoDeletePVCs defines whether the PVC should be deleted when the etcd cluster is deleted. Default: false	false
defragJob	object	DefragJob defines the etcd defragmentation job configuration.	false
persistence	object	Persistence defines the persistence configuration.	false

K0smotronControlPlane.spec.etcd.defragJob#

^{^{↩ Parent}}

DefragJob defines the etcd defragmentation job configuration.

Name	Type	Description	Required
enabled	boolean	Enabled enables the etcd defragmentation job. Default: false	true
image	string	Image defines the etcd defragmentation job image. Default: ghcr.io/ahrtr/etcd-defrag:v0.16.0	true
rule	string	Rule defines the etcd defragmentation job defrag-rule. For more information check: https://github.com/ahrtr/etcd-defrag/tree/main?tab=readme-ov-file#defragmentation-rule Default: dbQuotaUsage > 0.8 \|\| dbSize - dbSizeInUse > 20010241024	true
schedule	string	Schedule defines the etcd defragmentation job schedule. Default: 0 12 * * *	true

K0smotronControlPlane.spec.etcd.persistence#

^{^{↩ Parent}}

Persistence defines the persistence configuration.

Name	Type	Description	Required
size	int or string	Size defines the size of the etcd volume. Default: 1Gi Default: 1Gi	false
storageClass	string	StorageClass defines the storage class to be used for etcd persistence. If empty, will be used the default storage class.	false

K0smotronControlPlane.spec.manifests[index]#

^{^{↩ Parent}}

Volume represents a named volume in a pod that may be accessed by any container in the pod.

Name	Type	Description	Required
name	string	name of the volume. Must be a DNS_LABEL and unique within the pod. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names	true
awsElasticBlockStore	object	awsElasticBlockStore represents an AWS Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore	false
azureDisk	object	azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.	false
azureFile	object	azureFile represents an Azure File Service mount on the host and bind mount to the pod.	false
cephfs	object	cephFS represents a Ceph FS mount on the host that shares a pod's lifetime	false
cinder	object	cinder represents a cinder volume attached and mounted on kubelets host machine. More info: https://examples.k8s.io/mysql-cinder-pd/README.md	false
configMap	object	configMap represents a configMap that should populate this volume	false
csi	object	csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature).	false
downwardAPI	object	downwardAPI represents downward API about the pod that should populate this volume	false
emptyDir	object	emptyDir represents a temporary directory that shares a pod's lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir	false
ephemeral	object	ephemeral represents a volume that is handled by a cluster storage driver. The volume's lifecycle is tied to the pod that defines it - it will be created before the pod starts, and deleted when the pod is removed. Use this if: a) the volume is only needed while the pod runs, b) features of normal volumes like restoring from snapshot or capacity tracking are needed, c) the storage driver is specified through a storage class, and d) the storage driver supports dynamic volume provisioning through a PersistentVolumeClaim (see EphemeralVolumeSource for more information on the connection between this volume type and PersistentVolumeClaim). Use PersistentVolumeClaim or one of the vendor-specific APIs for volumes that persist for longer than the lifecycle of an individual pod. Use CSI for light-weight local ephemeral volumes if the CSI driver is meant to be used that way - see the documentation of the driver for more information. A pod can use both types of ephemeral volumes and persistent volumes at the same time.	false
fc	object	fc represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod.	false
flexVolume	object	flexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.	false
flocker	object	flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running	false
gcePersistentDisk	object	gcePersistentDisk represents a GCE Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk	false
gitRepo	object	gitRepo represents a git repository at a particular revision. DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod's container.	false
glusterfs	object	glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/glusterfs/README.md	false
hostPath	object	hostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath --- TODO(jonesdl) We need to restrict who can use host directory mounts and who can/can not mount host directories as read/write.	false
iscsi	object	iscsi represents an ISCSI Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://examples.k8s.io/volumes/iscsi/README.md	false
nfs	object	nfs represents an NFS mount on the host that shares a pod's lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs	false
persistentVolumeClaim	object	persistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims	false
photonPersistentDisk	object	photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine	false
portworxVolume	object	portworxVolume represents a portworx volume attached and mounted on kubelets host machine	false
projected	object	projected items for all in one resources secrets, configmaps, and downward API	false
quobyte	object	quobyte represents a Quobyte mount on the host that shares a pod's lifetime	false
rbd	object	rbd represents a Rados Block Device mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/rbd/README.md	false
scaleIO	object	scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.	false
secret	object	secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret	false
storageos	object	storageOS represents a StorageOS volume attached and mounted on Kubernetes nodes.	false
vsphereVolume	object	vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine	false

K0smotronControlPlane.spec.manifests[index].awsElasticBlockStore#

^{^{↩ Parent}}

awsElasticBlockStore represents an AWS Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore

Name	Type	Description	Required
volumeID	string	volumeID is unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore	true
fsType	string	fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore TODO: how do we prevent errors in the filesystem from compromising the machine	false
partition	integer	partition is the partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). Format: int32	false
readOnly	boolean	readOnly value true will force the readOnly setting in VolumeMounts. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore	false

K0smotronControlPlane.spec.manifests[index].azureDisk#

^{^{↩ Parent}}

azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.

Name	Type	Description	Required
diskName	string	diskName is the Name of the data disk in the blob storage	true
diskURI	string	diskURI is the URI of data disk in the blob storage	true
cachingMode	string	cachingMode is the Host Caching mode: None, Read Only, Read Write.	false
fsType	string	fsType is Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.	false
kind	string	kind expected values are Shared: multiple blob disks per storage account Dedicated: single blob disk per storage account Managed: azure managed data disk (only in managed availability set). defaults to shared	false
readOnly	boolean	readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.	false

K0smotronControlPlane.spec.manifests[index].azureFile#

^{^{↩ Parent}}

azureFile represents an Azure File Service mount on the host and bind mount to the pod.

Name	Type	Description	Required
secretName	string	secretName is the name of secret that contains Azure Storage Account Name and Key	true
shareName	string	shareName is the azure share Name	true
readOnly	boolean	readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.	false

K0smotronControlPlane.spec.manifests[index].cephfs#

^{^{↩ Parent}}

cephFS represents a Ceph FS mount on the host that shares a pod's lifetime

Name	Type	Description	Required
monitors	[]string	monitors is Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it	true
path	string	path is Optional: Used as the mounted root, rather than the full Ceph tree, default is /	false
readOnly	boolean	readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it	false
secretFile	string	secretFile is Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it	false
secretRef	object	secretRef is Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it	false
user	string	user is optional: User is the rados user name, default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it	false

K0smotronControlPlane.spec.manifests[index].cephfs.secretRef#

^{^{↩ Parent}}

secretRef is Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it

Name	Type	Description	Required
name	string	Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. TODO: Add other useful fields. apiVersion, kind, uid? 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. Default:	false

K0smotronControlPlane.spec.manifests[index].cinder#

^{^{↩ Parent}}

cinder represents a cinder volume attached and mounted on kubelets host machine. More info: https://examples.k8s.io/mysql-cinder-pd/README.md

Name	Type	Description	Required
volumeID	string	volumeID used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md	true
fsType	string	fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://examples.k8s.io/mysql-cinder-pd/README.md	false
readOnly	boolean	readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/mysql-cinder-pd/README.md	false
secretRef	object	secretRef is optional: points to a secret object containing parameters used to connect to OpenStack.	false

K0smotronControlPlane.spec.manifests[index].cinder.secretRef#

^{^{↩ Parent}}

secretRef is optional: points to a secret object containing parameters used to connect to OpenStack.

Name	Type	Description	Required
name	string	Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. TODO: Add other useful fields. apiVersion, kind, uid? 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. Default:	false

K0smotronControlPlane.spec.manifests[index].configMap#

^{^{↩ Parent}}

configMap represents a configMap that should populate this volume

Name	Type	Description	Required
defaultMode	integer	defaultMode is optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false
items	[]object	items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.	false
name	string	Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. TODO: Add other useful fields. apiVersion, kind, uid? 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. Default:	false
optional	boolean	optional specify whether the ConfigMap or its keys must be defined	false

K0smotronControlPlane.spec.manifests[index].configMap.items[index]#

^{^{↩ Parent}}

Maps a string key to a path within a volume.

Name	Type	Description	Required
key	string	key is the key to project.	true
path	string	path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.	true
mode	integer	mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false

K0smotronControlPlane.spec.manifests[index].csi#

^{^{↩ Parent}}

csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature).

Name	Type	Description	Required
driver	string	driver is the name of the CSI driver that handles this volume. Consult with your admin for the correct name as registered in the cluster.	true
fsType	string	fsType to mount. Ex. "ext4", "xfs", "ntfs". If not provided, the empty value is passed to the associated CSI driver which will determine the default filesystem to apply.	false
nodePublishSecretRef	object	nodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secret references are passed.	false
readOnly	boolean	readOnly specifies a read-only configuration for the volume. Defaults to false (read/write).	false
volumeAttributes	map[string]string	volumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver's documentation for supported values.	false

K0smotronControlPlane.spec.manifests[index].csi.nodePublishSecretRef#

^{^{↩ Parent}}

nodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secret references are passed.

Name	Type	Description	Required
name	string	Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. TODO: Add other useful fields. apiVersion, kind, uid? 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. Default:	false

K0smotronControlPlane.spec.manifests[index].downwardAPI#

^{^{↩ Parent}}

downwardAPI represents downward API about the pod that should populate this volume

Name	Type	Description	Required
defaultMode	integer	Optional: mode bits to use on created files by default. Must be a Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false
items	[]object	Items is a list of downward API volume file	false

K0smotronControlPlane.spec.manifests[index].downwardAPI.items[index]#

^{^{↩ Parent}}

DownwardAPIVolumeFile represents information to create the file containing the pod field

Name	Type	Description	Required
path	string	Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'	true
fieldRef	object	Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported.	false
mode	integer	Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false
resourceFieldRef	object	Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.	false

K0smotronControlPlane.spec.manifests[index].downwardAPI.items[index].fieldRef#

^{^{↩ Parent}}

Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported.

Name	Type	Description	Required
fieldPath	string	Path of the field to select in the specified API version.	true
apiVersion	string	Version of the schema the FieldPath is written in terms of, defaults to "v1".	false

K0smotronControlPlane.spec.manifests[index].downwardAPI.items[index].resourceFieldRef#

^{^{↩ Parent}}

Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.

Name	Type	Description	Required
resource	string	Required: resource to select	true
containerName	string	Container name: required for volumes, optional for env vars	false
divisor	int or string	Specifies the output format of the exposed resources, defaults to "1"	false

K0smotronControlPlane.spec.manifests[index].emptyDir#

^{^{↩ Parent}}

emptyDir represents a temporary directory that shares a pod's lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir

Name	Type	Description	Required
medium	string	medium represents what type of storage medium should back this directory. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir	false
sizeLimit	int or string	sizeLimit is the total amount of local storage required for this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers in a pod. The default is nil which means that the limit is undefined. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir	false

K0smotronControlPlane.spec.manifests[index].ephemeral#

^{^{↩ Parent}}

ephemeral represents a volume that is handled by a cluster storage driver. The volume's lifecycle is tied to the pod that defines it - it will be created before the pod starts, and deleted when the pod is removed.

Use this if: a) the volume is only needed while the pod runs, b) features of normal volumes like restoring from snapshot or capacity tracking are needed, c) the storage driver is specified through a storage class, and d) the storage driver supports dynamic volume provisioning through a PersistentVolumeClaim (see EphemeralVolumeSource for more information on the connection between this volume type and PersistentVolumeClaim).

Use PersistentVolumeClaim or one of the vendor-specific APIs for volumes that persist for longer than the lifecycle of an individual pod.

Use CSI for light-weight local ephemeral volumes if the CSI driver is meant to be used that way - see the documentation of the driver for more information.

A pod can use both types of ephemeral volumes and persistent volumes at the same time.

Name	Type	Description	Required
volumeClaimTemplate	object	Will be used to create a stand-alone PVC to provision the volume. The pod in which this EphemeralVolumeSource is embedded will be the owner of the PVC, i.e. the PVC will be deleted together with the pod. The name of the PVC will be `-` where `` is the name from the `PodSpec.Volumes` array entry. Pod validation will reject the pod if the concatenated name is not valid for a PVC (for example, too long). An existing PVC with that name that is not owned by the pod will not be used for the pod to avoid using an unrelated volume by mistake. Starting the pod is then blocked until the unrelated PVC is removed. If such a pre-created PVC is meant to be used by the pod, the PVC has to updated with an owner reference to the pod once the pod exists. Normally this should not be necessary, but it may be useful when manually reconstructing a broken cluster. This field is read-only and no changes will be made by Kubernetes to the PVC after it has been created. Required, must not be nil.	false

K0smotronControlPlane.spec.manifests[index].ephemeral.volumeClaimTemplate#

^{^{↩ Parent}}

Will be used to create a stand-alone PVC to provision the volume. The pod in which this EphemeralVolumeSource is embedded will be the owner of the PVC, i.e. the PVC will be deleted together with the pod. The name of the PVC will be <pod name>-<volume name> where <volume name> is the name from the PodSpec.Volumes array entry. Pod validation will reject the pod if the concatenated name is not valid for a PVC (for example, too long).

An existing PVC with that name that is not owned by the pod will not be used for the pod to avoid using an unrelated volume by mistake. Starting the pod is then blocked until the unrelated PVC is removed. If such a pre-created PVC is meant to be used by the pod, the PVC has to updated with an owner reference to the pod once the pod exists. Normally this should not be necessary, but it may be useful when manually reconstructing a broken cluster.

This field is read-only and no changes will be made by Kubernetes to the PVC after it has been created.

Required, must not be nil.

Name	Type	Description	Required
spec	object	The specification for the PersistentVolumeClaim. The entire content is copied unchanged into the PVC that gets created from this template. The same fields as in a PersistentVolumeClaim are also valid here.	true
metadata	object	May contain labels and annotations that will be copied into the PVC when creating it. No other fields are allowed and will be rejected during validation.	false

K0smotronControlPlane.spec.manifests[index].ephemeral.volumeClaimTemplate.spec#

^{^{↩ Parent}}

The specification for the PersistentVolumeClaim. The entire content is copied unchanged into the PVC that gets created from this template. The same fields as in a PersistentVolumeClaim are also valid here.

Name	Type	Description	Required
accessModes	[]string	accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1	false
dataSource	object	dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. If the namespace is specified, then dataSourceRef will not be copied to dataSource.	false
dataSourceRef	object	dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the dataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, when namespace isn't specified in dataSourceRef, both fields (dataSource and dataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. When namespace is specified in dataSourceRef, dataSource isn't set to the same value and must be empty. There are three important differences between dataSource and dataSourceRef: * While dataSource only allows two specific types of objects, dataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While dataSource ignores disallowed values (dropping them), dataSourceRef preserves all values, and generates an error if a disallowed value is specified. * While dataSource only allows local objects, dataSourceRef allows objects in any namespaces. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.	false
resources	object	resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources	false
selector	object	selector is a label query over volumes to consider for binding.	false
storageClassName	string	storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1	false
volumeAttributesClassName	string	volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim. If specified, the CSI driver will create or update the volume with the attributes defined in the corresponding VolumeAttributesClass. This has a different purpose than storageClassName, it can be changed after the claim is created. An empty string 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/ (Alpha) Using this field requires the VolumeAttributesClass feature gate to be enabled.	false
volumeMode	string	volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.	false
volumeName	string	volumeName is the binding reference to the PersistentVolume backing this claim.	false

K0smotronControlPlane.spec.manifests[index].ephemeral.volumeClaimTemplate.spec.dataSource#

^{^{↩ Parent}}

dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. If the namespace is specified, then dataSourceRef will not be copied to dataSource.

Name	Type	Description	Required
kind	string	Kind is the type of resource being referenced	true
name	string	Name is the name of resource being referenced	true
apiGroup	string	APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.	false

K0smotronControlPlane.spec.manifests[index].ephemeral.volumeClaimTemplate.spec.dataSourceRef#

^{^{↩ Parent}}

dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the dataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, when namespace isn't specified in dataSourceRef, both fields (dataSource and dataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. When namespace is specified in dataSourceRef, dataSource isn't set to the same value and must be empty. There are three important differences between dataSource and dataSourceRef: * While dataSource only allows two specific types of objects, dataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While dataSource ignores disallowed values (dropping them), dataSourceRef preserves all values, and generates an error if a disallowed value is specified. * While dataSource only allows local objects, dataSourceRef allows objects in any namespaces. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.

Name	Type	Description	Required
kind	string	Kind is the type of resource being referenced	true
name	string	Name is the name of resource being referenced	true
apiGroup	string	APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.	false
namespace	string	Namespace is the namespace of resource being referenced Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. (Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.	false

K0smotronControlPlane.spec.manifests[index].ephemeral.volumeClaimTemplate.spec.resources#

^{^{↩ Parent}}

resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources

Name	Type	Description	Required
limits	map[string]int or string	Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/	false
requests	map[string]int or string	Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/	false

K0smotronControlPlane.spec.manifests[index].ephemeral.volumeClaimTemplate.spec.selector#

^{^{↩ Parent}}

selector is a label query over volumes to consider for binding.

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

K0smotronControlPlane.spec.manifests[index].ephemeral.volumeClaimTemplate.spec.selector.matchExpressions[index]#

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

K0smotronControlPlane.spec.manifests[index].ephemeral.volumeClaimTemplate.metadata#

^{^{↩ Parent}}

May contain labels and annotations that will be copied into the PVC when creating it. No other fields are allowed and will be rejected during validation.

Name	Type	Required
annotations	map[string]string	false
finalizers	[]string	false
labels	map[string]string	false
name	string	false
namespace	string	false

K0smotronControlPlane.spec.manifests[index].fc#

^{^{↩ Parent}}

fc represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod.

Name	Type	Description	Required
fsType	string	fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. TODO: how do we prevent errors in the filesystem from compromising the machine	false
lun	integer	lun is Optional: FC target lun number Format: int32	false
readOnly	boolean	readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.	false
targetWWNs	[]string	targetWWNs is Optional: FC target worldwide names (WWNs)	false
wwids	[]string	wwids Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously.	false

K0smotronControlPlane.spec.manifests[index].flexVolume#

^{^{↩ Parent}}

flexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.

Name	Type	Description	Required
driver	string	driver is the name of the driver to use for this volume.	true
fsType	string	fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script.	false
options	map[string]string	options is Optional: this field holds extra command options if any.	false
readOnly	boolean	readOnly is Optional: defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.	false
secretRef	object	secretRef is Optional: secretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts.	false

K0smotronControlPlane.spec.manifests[index].flexVolume.secretRef#

^{^{↩ Parent}}

secretRef is Optional: secretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts.

Name	Type	Description	Required
name	string	Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. TODO: Add other useful fields. apiVersion, kind, uid? 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. Default:	false

K0smotronControlPlane.spec.manifests[index].flocker#

^{^{↩ Parent}}

flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running

Name	Type	Description	Required
datasetName	string	datasetName is Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecated	false
datasetUUID	string	datasetUUID is the UUID of the dataset. This is unique identifier of a Flocker dataset	false

K0smotronControlPlane.spec.manifests[index].gcePersistentDisk#

^{^{↩ Parent}}

gcePersistentDisk represents a GCE Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk

Name	Type	Description	Required
pdName	string	pdName is unique name of the PD resource in GCE. Used to identify the disk in GCE. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk	true
fsType	string	fsType is filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk TODO: how do we prevent errors in the filesystem from compromising the machine	false
partition	integer	partition is the partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk Format: int32	false
readOnly	boolean	readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk	false

K0smotronControlPlane.spec.manifests[index].gitRepo#

^{^{↩ Parent}}

gitRepo represents a git repository at a particular revision. DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod's container.

Name	Type	Description	Required
repository	string	repository is the URL	true
directory	string	directory is the target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name.	false
revision	string	revision is the commit hash for the specified revision.	false

K0smotronControlPlane.spec.manifests[index].glusterfs#

^{^{↩ Parent}}

glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/glusterfs/README.md

Name	Type	Description	Required
endpoints	string	endpoints is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod	true
path	string	path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod	true
readOnly	boolean	readOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod	false

K0smotronControlPlane.spec.manifests[index].hostPath#

^{^{↩ Parent}}

hostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath

TODO(jonesdl) We need to restrict who can use host directory mounts and who can/can not mount host directories as read/write.

Name	Type	Description	Required
path	string	path of the directory on the host. If the path is a symlink, it will follow the link to the real path. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath	true
type	string	type for HostPath Volume Defaults to "" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath	false

K0smotronControlPlane.spec.manifests[index].iscsi#

^{^{↩ Parent}}

iscsi represents an ISCSI Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://examples.k8s.io/volumes/iscsi/README.md

Name	Type	Description	Required
iqn	string	iqn is the target iSCSI Qualified Name.	true
lun	integer	lun represents iSCSI Target Lun number. Format: int32	true
targetPortal	string	targetPortal is iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).	true
chapAuthDiscovery	boolean	chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication	false
chapAuthSession	boolean	chapAuthSession defines whether support iSCSI Session CHAP authentication	false
fsType	string	fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi TODO: how do we prevent errors in the filesystem from compromising the machine	false
initiatorName	string	initiatorName is the custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface : will be created for the connection.	false
iscsiInterface	string	iscsiInterface is the interface Name that uses an iSCSI transport. Defaults to 'default' (tcp).	false
portals	[]string	portals is the iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).	false
readOnly	boolean	readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.	false
secretRef	object	secretRef is the CHAP Secret for iSCSI target and initiator authentication	false

K0smotronControlPlane.spec.manifests[index].iscsi.secretRef#

^{^{↩ Parent}}

secretRef is the CHAP Secret for iSCSI target and initiator authentication

Name	Type	Description	Required
name	string	Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. TODO: Add other useful fields. apiVersion, kind, uid? 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. Default:	false

K0smotronControlPlane.spec.manifests[index].nfs#

^{^{↩ Parent}}

nfs represents an NFS mount on the host that shares a pod's lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

Name	Type	Description	Required
path	string	path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs	true
server	string	server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs	true
readOnly	boolean	readOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs	false

K0smotronControlPlane.spec.manifests[index].persistentVolumeClaim#

^{^{↩ Parent}}

persistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

Name	Type	Description	Required
claimName	string	claimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims	true
readOnly	boolean	readOnly Will force the ReadOnly setting in VolumeMounts. Default false.	false

K0smotronControlPlane.spec.manifests[index].photonPersistentDisk#

^{^{↩ Parent}}

photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine

Name	Type	Description	Required
pdID	string	pdID is the ID that identifies Photon Controller persistent disk	true
fsType	string	fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.	false

K0smotronControlPlane.spec.manifests[index].portworxVolume#

^{^{↩ Parent}}

portworxVolume represents a portworx volume attached and mounted on kubelets host machine

Name	Type	Description	Required
volumeID	string	volumeID uniquely identifies a Portworx volume	true
fsType	string	fSType represents the filesystem type to mount Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs". Implicitly inferred to be "ext4" if unspecified.	false
readOnly	boolean	readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.	false

K0smotronControlPlane.spec.manifests[index].projected#

^{^{↩ Parent}}

projected items for all in one resources secrets, configmaps, and downward API

Name	Type	Description	Required
defaultMode	integer	defaultMode are the mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false
sources	[]object	sources is the list of volume projections	false

K0smotronControlPlane.spec.manifests[index].projected.sources[index]#

^{^{↩ Parent}}

Projection that may be projected along with other supported volume types

Name	Type	Description	Required
clusterTrustBundle	object	ClusterTrustBundle allows a pod to access the `.spec.trustBundle` field of ClusterTrustBundle objects in an auto-updating file. Alpha, gated by the ClusterTrustBundleProjection feature gate. ClusterTrustBundle objects can either be selected by name, or by the combination of signer name and a label selector. Kubelet performs aggressive normalization of the PEM contents written into the pod filesystem. Esoteric PEM features such as inter-block comments and block headers are stripped. Certificates are deduplicated. The ordering of certificates within the file is arbitrary, and Kubelet may change the order over time.	false
configMap	object	configMap information about the configMap data to project	false
downwardAPI	object	downwardAPI information about the downwardAPI data to project	false
secret	object	secret information about the secret data to project	false
serviceAccountToken	object	serviceAccountToken is information about the serviceAccountToken data to project	false

K0smotronControlPlane.spec.manifests[index].projected.sources[index].clusterTrustBundle#

^{^{↩ Parent}}

ClusterTrustBundle allows a pod to access the .spec.trustBundle field of ClusterTrustBundle objects in an auto-updating file.

Alpha, gated by the ClusterTrustBundleProjection feature gate.

ClusterTrustBundle objects can either be selected by name, or by the combination of signer name and a label selector.

Kubelet performs aggressive normalization of the PEM contents written into the pod filesystem. Esoteric PEM features such as inter-block comments and block headers are stripped. Certificates are deduplicated. The ordering of certificates within the file is arbitrary, and Kubelet may change the order over time.

Name	Type	Description	Required
path	string	Relative path from the volume root to write the bundle.	true
labelSelector	object	Select all ClusterTrustBundles that match this label selector. Only has effect if signerName is set. Mutually-exclusive with name. If unset, interpreted as "match nothing". If set but empty, interpreted as "match everything".	false
name	string	Select a single ClusterTrustBundle by object name. Mutually-exclusive with signerName and labelSelector.	false
optional	boolean	If true, don't block pod startup if the referenced ClusterTrustBundle(s) aren't available. If using name, then the named ClusterTrustBundle is allowed not to exist. If using signerName, then the combination of signerName and labelSelector is allowed to match zero ClusterTrustBundles.	false
signerName	string	Select all ClusterTrustBundles that match this signer name. Mutually-exclusive with name. The contents of all selected ClusterTrustBundles will be unified and deduplicated.	false

K0smotronControlPlane.spec.manifests[index].projected.sources[index].clusterTrustBundle.labelSelector#

^{^{↩ Parent}}

Select all ClusterTrustBundles that match this label selector. Only has effect if signerName is set. Mutually-exclusive with name. If unset, interpreted as "match nothing". If set but empty, interpreted as "match everything".

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

K0smotronControlPlane.spec.manifests[index].projected.sources[index].clusterTrustBundle.labelSelector.matchExpressions[index]#

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

K0smotronControlPlane.spec.manifests[index].projected.sources[index].configMap#

^{^{↩ Parent}}

configMap information about the configMap data to project

Name	Type	Description	Required
items	[]object	items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.	false
name	string	Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. TODO: Add other useful fields. apiVersion, kind, uid? 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. Default:	false
optional	boolean	optional specify whether the ConfigMap or its keys must be defined	false

K0smotronControlPlane.spec.manifests[index].projected.sources[index].configMap.items[index]#

^{^{↩ Parent}}

Maps a string key to a path within a volume.

Name	Type	Description	Required
key	string	key is the key to project.	true
path	string	path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.	true
mode	integer	mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false

K0smotronControlPlane.spec.manifests[index].projected.sources[index].downwardAPI#

^{^{↩ Parent}}

downwardAPI information about the downwardAPI data to project

Name	Type	Description	Required
items	[]object	Items is a list of DownwardAPIVolume file	false

K0smotronControlPlane.spec.manifests[index].projected.sources[index].downwardAPI.items[index]#

^{^{↩ Parent}}

DownwardAPIVolumeFile represents information to create the file containing the pod field

Name	Type	Description	Required
path	string	Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'	true
fieldRef	object	Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported.	false
mode	integer	Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false
resourceFieldRef	object	Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.	false

K0smotronControlPlane.spec.manifests[index].projected.sources[index].downwardAPI.items[index].fieldRef#

^{^{↩ Parent}}

Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported.

Name	Type	Description	Required
fieldPath	string	Path of the field to select in the specified API version.	true
apiVersion	string	Version of the schema the FieldPath is written in terms of, defaults to "v1".	false

K0smotronControlPlane.spec.manifests[index].projected.sources[index].downwardAPI.items[index].resourceFieldRef#

^{^{↩ Parent}}

Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.

Name	Type	Description	Required
resource	string	Required: resource to select	true
containerName	string	Container name: required for volumes, optional for env vars	false
divisor	int or string	Specifies the output format of the exposed resources, defaults to "1"	false

K0smotronControlPlane.spec.manifests[index].projected.sources[index].secret#

^{^{↩ Parent}}

secret information about the secret data to project

Name	Type	Description	Required
items	[]object	items if unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.	false
name	string	Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. TODO: Add other useful fields. apiVersion, kind, uid? 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. Default:	false
optional	boolean	optional field specify whether the Secret or its key must be defined	false

K0smotronControlPlane.spec.manifests[index].projected.sources[index].secret.items[index]#

^{^{↩ Parent}}

Maps a string key to a path within a volume.

Name	Type	Description	Required
key	string	key is the key to project.	true
path	string	path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.	true
mode	integer	mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false

K0smotronControlPlane.spec.manifests[index].projected.sources[index].serviceAccountToken#

^{^{↩ Parent}}

serviceAccountToken is information about the serviceAccountToken data to project

Name	Type	Description	Required
path	string	path is the path relative to the mount point of the file to project the token into.	true
audience	string	audience is the intended audience of the token. A recipient of a token must identify itself with an identifier specified in the audience of the token, and otherwise should reject the token. The audience defaults to the identifier of the apiserver.	false
expirationSeconds	integer	expirationSeconds is the requested duration of validity of the service account token. As the token approaches expiration, the kubelet volume plugin will proactively rotate the service account token. The kubelet will start trying to rotate the token if the token is older than 80 percent of its time to live or if the token is older than 24 hours.Defaults to 1 hour and must be at least 10 minutes. Format: int64	false

K0smotronControlPlane.spec.manifests[index].quobyte#

^{^{↩ Parent}}

quobyte represents a Quobyte mount on the host that shares a pod's lifetime

Name	Type	Description	Required
registry	string	registry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumes	true
volume	string	volume is a string that references an already created Quobyte volume by name.	true
group	string	group to map volume access to Default is no group	false
readOnly	boolean	readOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false.	false
tenant	string	tenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes, value is set by the plugin	false
user	string	user to map volume access to Defaults to serivceaccount user	false

K0smotronControlPlane.spec.manifests[index].rbd#

^{^{↩ Parent}}

rbd represents a Rados Block Device mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/rbd/README.md

Name	Type	Description	Required
image	string	image is the rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it	true
monitors	[]string	monitors is a collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it	true
fsType	string	fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#rbd TODO: how do we prevent errors in the filesystem from compromising the machine	false
keyring	string	keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it	false
pool	string	pool is the rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it	false
readOnly	boolean	readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it	false
secretRef	object	secretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it	false
user	string	user is the rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it	false

K0smotronControlPlane.spec.manifests[index].rbd.secretRef#

^{^{↩ Parent}}

secretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

Name	Type	Description	Required
name	string	Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. TODO: Add other useful fields. apiVersion, kind, uid? 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. Default:	false

K0smotronControlPlane.spec.manifests[index].scaleIO#

^{^{↩ Parent}}

scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.

Name	Type	Description	Required
gateway	string	gateway is the host address of the ScaleIO API Gateway.	true
secretRef	object	secretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail.	true
system	string	system is the name of the storage system as configured in ScaleIO.	true
fsType	string	fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Default is "xfs".	false
protectionDomain	string	protectionDomain is the name of the ScaleIO Protection Domain for the configured storage.	false
readOnly	boolean	readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.	false
sslEnabled	boolean	sslEnabled Flag enable/disable SSL communication with Gateway, default false	false
storageMode	string	storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned.	false
storagePool	string	storagePool is the ScaleIO Storage Pool associated with the protection domain.	false
volumeName	string	volumeName is the name of a volume already created in the ScaleIO system that is associated with this volume source.	false

K0smotronControlPlane.spec.manifests[index].scaleIO.secretRef#

^{^{↩ Parent}}

secretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail.

Name	Type	Description	Required
name	string	Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. TODO: Add other useful fields. apiVersion, kind, uid? 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. Default:	false

K0smotronControlPlane.spec.manifests[index].secret#

^{^{↩ Parent}}

secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret

Name	Type	Description	Required
defaultMode	integer	defaultMode is Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false
items	[]object	items If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.	false
optional	boolean	optional field specify whether the Secret or its keys must be defined	false
secretName	string	secretName is the name of the secret in the pod's namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret	false

K0smotronControlPlane.spec.manifests[index].secret.items[index]#

^{^{↩ Parent}}

Maps a string key to a path within a volume.

Name	Type	Description	Required
key	string	key is the key to project.	true
path	string	path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.	true
mode	integer	mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false

K0smotronControlPlane.spec.manifests[index].storageos#

^{^{↩ Parent}}

storageOS represents a StorageOS volume attached and mounted on Kubernetes nodes.

Name	Type	Description	Required
fsType	string	fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.	false
readOnly	boolean	readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.	false
secretRef	object	secretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted.	false
volumeName	string	volumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace.	false
volumeNamespace	string	volumeNamespace specifies the scope of the volume within StorageOS. If no namespace is specified then the Pod's namespace will be used. This allows the Kubernetes name scoping to be mirrored within StorageOS for tighter integration. Set VolumeName to any name to override the default behaviour. Set to "default" if you are not using namespaces within StorageOS. Namespaces that do not pre-exist within StorageOS will be created.	false

K0smotronControlPlane.spec.manifests[index].storageos.secretRef#

^{^{↩ Parent}}

secretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted.

Name	Type	Description	Required
name	string	Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. TODO: Add other useful fields. apiVersion, kind, uid? 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. Default:	false

K0smotronControlPlane.spec.manifests[index].vsphereVolume#

^{^{↩ Parent}}

vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine

Name	Type	Description	Required
volumePath	string	volumePath is the path that identifies vSphere volume vmdk	true
fsType	string	fsType is filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.	false
storagePolicyID	string	storagePolicyID is the storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.	false
storagePolicyName	string	storagePolicyName is the storage Policy Based Management (SPBM) profile name.	false

K0smotronControlPlane.spec.monitoring#

^{^{↩ Parent}}

Monitoring defines the monitoring configuration.

Name	Type	Description	Required
enabled	boolean	Enabled enables prometheus sidecar that scrapes metrics from the child cluster system components and expose them as usual kubernetes pod metrics.	true
prometheusImage	string	PrometheusImage defines the image used for the prometheus sidecar. Default: quay.io/k0sproject/prometheus:v2.44.0	true
proxyImage	string	ProxyImage defines the image used for the nginx proxy sidecar. Default: nginx:1.19.10	true

K0smotronControlPlane.spec.mounts[index]#

^{^{↩ Parent}}

Name	Type	Description	Required
path	string		true
awsElasticBlockStore	object	awsElasticBlockStore represents an AWS Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore	false
azureDisk	object	azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.	false
azureFile	object	azureFile represents an Azure File Service mount on the host and bind mount to the pod.	false
cephfs	object	cephFS represents a Ceph FS mount on the host that shares a pod's lifetime	false
cinder	object	cinder represents a cinder volume attached and mounted on kubelets host machine. More info: https://examples.k8s.io/mysql-cinder-pd/README.md	false
configMap	object	configMap represents a configMap that should populate this volume	false
csi	object	csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature).	false
downwardAPI	object	downwardAPI represents downward API about the pod that should populate this volume	false
emptyDir	object	emptyDir represents a temporary directory that shares a pod's lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir	false
ephemeral	object	ephemeral represents a volume that is handled by a cluster storage driver. The volume's lifecycle is tied to the pod that defines it - it will be created before the pod starts, and deleted when the pod is removed. Use this if: a) the volume is only needed while the pod runs, b) features of normal volumes like restoring from snapshot or capacity tracking are needed, c) the storage driver is specified through a storage class, and d) the storage driver supports dynamic volume provisioning through a PersistentVolumeClaim (see EphemeralVolumeSource for more information on the connection between this volume type and PersistentVolumeClaim). Use PersistentVolumeClaim or one of the vendor-specific APIs for volumes that persist for longer than the lifecycle of an individual pod. Use CSI for light-weight local ephemeral volumes if the CSI driver is meant to be used that way - see the documentation of the driver for more information. A pod can use both types of ephemeral volumes and persistent volumes at the same time.	false
fc	object	fc represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod.	false
flexVolume	object	flexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.	false
flocker	object	flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running	false
gcePersistentDisk	object	gcePersistentDisk represents a GCE Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk	false
gitRepo	object	gitRepo represents a git repository at a particular revision. DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod's container.	false
glusterfs	object	glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/glusterfs/README.md	false
hostPath	object	hostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath --- TODO(jonesdl) We need to restrict who can use host directory mounts and who can/can not mount host directories as read/write.	false
iscsi	object	iscsi represents an ISCSI Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://examples.k8s.io/volumes/iscsi/README.md	false
nfs	object	nfs represents an NFS mount on the host that shares a pod's lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs	false
persistentVolumeClaim	object	persistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims	false
photonPersistentDisk	object	photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine	false
portworxVolume	object	portworxVolume represents a portworx volume attached and mounted on kubelets host machine	false
projected	object	projected items for all in one resources secrets, configmaps, and downward API	false
quobyte	object	quobyte represents a Quobyte mount on the host that shares a pod's lifetime	false
rbd	object	rbd represents a Rados Block Device mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/rbd/README.md	false
readOnly	boolean	ReadOnly specifies whether the volume should be mounted as read-only. (default: false, except for ConfigMaps and Secrets)	false
scaleIO	object	scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.	false
secret	object	secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret	false
storageos	object	storageOS represents a StorageOS volume attached and mounted on Kubernetes nodes.	false
vsphereVolume	object	vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine	false

K0smotronControlPlane.spec.mounts[index].awsElasticBlockStore#

^{^{↩ Parent}}

awsElasticBlockStore represents an AWS Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore

Name	Type	Description	Required
volumeID	string	volumeID is unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore	true
fsType	string	fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore TODO: how do we prevent errors in the filesystem from compromising the machine	false
partition	integer	partition is the partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). Format: int32	false
readOnly	boolean	readOnly value true will force the readOnly setting in VolumeMounts. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore	false

K0smotronControlPlane.spec.mounts[index].azureDisk#

^{^{↩ Parent}}

azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.

Name	Type	Description	Required
diskName	string	diskName is the Name of the data disk in the blob storage	true
diskURI	string	diskURI is the URI of data disk in the blob storage	true
cachingMode	string	cachingMode is the Host Caching mode: None, Read Only, Read Write.	false
fsType	string	fsType is Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.	false
kind	string	kind expected values are Shared: multiple blob disks per storage account Dedicated: single blob disk per storage account Managed: azure managed data disk (only in managed availability set). defaults to shared	false
readOnly	boolean	readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.	false

K0smotronControlPlane.spec.mounts[index].azureFile#

^{^{↩ Parent}}

azureFile represents an Azure File Service mount on the host and bind mount to the pod.

Name	Type	Description	Required
secretName	string	secretName is the name of secret that contains Azure Storage Account Name and Key	true
shareName	string	shareName is the azure share Name	true
readOnly	boolean	readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.	false

K0smotronControlPlane.spec.mounts[index].cephfs#

^{^{↩ Parent}}

cephFS represents a Ceph FS mount on the host that shares a pod's lifetime

Name	Type	Description	Required
monitors	[]string	monitors is Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it	true
path	string	path is Optional: Used as the mounted root, rather than the full Ceph tree, default is /	false
readOnly	boolean	readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it	false
secretFile	string	secretFile is Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it	false
secretRef	object	secretRef is Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it	false
user	string	user is optional: User is the rados user name, default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it	false

K0smotronControlPlane.spec.mounts[index].cephfs.secretRef#

^{^{↩ Parent}}

secretRef is Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it

Name	Type	Description	Required
name	string	Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. TODO: Add other useful fields. apiVersion, kind, uid? 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. Default:	false

K0smotronControlPlane.spec.mounts[index].cinder#

^{^{↩ Parent}}

cinder represents a cinder volume attached and mounted on kubelets host machine. More info: https://examples.k8s.io/mysql-cinder-pd/README.md

Name	Type	Description	Required
volumeID	string	volumeID used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md	true
fsType	string	fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://examples.k8s.io/mysql-cinder-pd/README.md	false
readOnly	boolean	readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/mysql-cinder-pd/README.md	false
secretRef	object	secretRef is optional: points to a secret object containing parameters used to connect to OpenStack.	false

K0smotronControlPlane.spec.mounts[index].cinder.secretRef#

^{^{↩ Parent}}

secretRef is optional: points to a secret object containing parameters used to connect to OpenStack.

Name	Type	Description	Required
name	string	Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. TODO: Add other useful fields. apiVersion, kind, uid? 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. Default:	false

K0smotronControlPlane.spec.mounts[index].configMap#

^{^{↩ Parent}}

configMap represents a configMap that should populate this volume

Name	Type	Description	Required
defaultMode	integer	defaultMode is optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false
items	[]object	items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.	false
name	string	Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. TODO: Add other useful fields. apiVersion, kind, uid? 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. Default:	false
optional	boolean	optional specify whether the ConfigMap or its keys must be defined	false

K0smotronControlPlane.spec.mounts[index].configMap.items[index]#

^{^{↩ Parent}}

Maps a string key to a path within a volume.

Name	Type	Description	Required
key	string	key is the key to project.	true
path	string	path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.	true
mode	integer	mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false

K0smotronControlPlane.spec.mounts[index].csi#

^{^{↩ Parent}}

csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature).

Name	Type	Description	Required
driver	string	driver is the name of the CSI driver that handles this volume. Consult with your admin for the correct name as registered in the cluster.	true
fsType	string	fsType to mount. Ex. "ext4", "xfs", "ntfs". If not provided, the empty value is passed to the associated CSI driver which will determine the default filesystem to apply.	false
nodePublishSecretRef	object	nodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secret references are passed.	false
readOnly	boolean	readOnly specifies a read-only configuration for the volume. Defaults to false (read/write).	false
volumeAttributes	map[string]string	volumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver's documentation for supported values.	false

K0smotronControlPlane.spec.mounts[index].csi.nodePublishSecretRef#

^{^{↩ Parent}}

nodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secret references are passed.

Name	Type	Description	Required
name	string	Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. TODO: Add other useful fields. apiVersion, kind, uid? 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. Default:	false

K0smotronControlPlane.spec.mounts[index].downwardAPI#

^{^{↩ Parent}}

downwardAPI represents downward API about the pod that should populate this volume

Name	Type	Description	Required
defaultMode	integer	Optional: mode bits to use on created files by default. Must be a Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false
items	[]object	Items is a list of downward API volume file	false

K0smotronControlPlane.spec.mounts[index].downwardAPI.items[index]#

^{^{↩ Parent}}

DownwardAPIVolumeFile represents information to create the file containing the pod field

Name	Type	Description	Required
path	string	Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'	true
fieldRef	object	Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported.	false
mode	integer	Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false
resourceFieldRef	object	Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.	false

K0smotronControlPlane.spec.mounts[index].downwardAPI.items[index].fieldRef#

^{^{↩ Parent}}

Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported.

Name	Type	Description	Required
fieldPath	string	Path of the field to select in the specified API version.	true
apiVersion	string	Version of the schema the FieldPath is written in terms of, defaults to "v1".	false

K0smotronControlPlane.spec.mounts[index].downwardAPI.items[index].resourceFieldRef#

^{^{↩ Parent}}

Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.

Name	Type	Description	Required
resource	string	Required: resource to select	true
containerName	string	Container name: required for volumes, optional for env vars	false
divisor	int or string	Specifies the output format of the exposed resources, defaults to "1"	false

K0smotronControlPlane.spec.mounts[index].emptyDir#

^{^{↩ Parent}}

emptyDir represents a temporary directory that shares a pod's lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir

Name	Type	Description	Required
medium	string	medium represents what type of storage medium should back this directory. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir	false
sizeLimit	int or string	sizeLimit is the total amount of local storage required for this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers in a pod. The default is nil which means that the limit is undefined. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir	false

K0smotronControlPlane.spec.mounts[index].ephemeral#

^{^{↩ Parent}}

ephemeral represents a volume that is handled by a cluster storage driver. The volume's lifecycle is tied to the pod that defines it - it will be created before the pod starts, and deleted when the pod is removed.

Use this if: a) the volume is only needed while the pod runs, b) features of normal volumes like restoring from snapshot or capacity tracking are needed, c) the storage driver is specified through a storage class, and d) the storage driver supports dynamic volume provisioning through a PersistentVolumeClaim (see EphemeralVolumeSource for more information on the connection between this volume type and PersistentVolumeClaim).

Use PersistentVolumeClaim or one of the vendor-specific APIs for volumes that persist for longer than the lifecycle of an individual pod.

Use CSI for light-weight local ephemeral volumes if the CSI driver is meant to be used that way - see the documentation of the driver for more information.

A pod can use both types of ephemeral volumes and persistent volumes at the same time.

Name	Type	Description	Required
volumeClaimTemplate	object	Will be used to create a stand-alone PVC to provision the volume. The pod in which this EphemeralVolumeSource is embedded will be the owner of the PVC, i.e. the PVC will be deleted together with the pod. The name of the PVC will be `-` where `` is the name from the `PodSpec.Volumes` array entry. Pod validation will reject the pod if the concatenated name is not valid for a PVC (for example, too long). An existing PVC with that name that is not owned by the pod will not be used for the pod to avoid using an unrelated volume by mistake. Starting the pod is then blocked until the unrelated PVC is removed. If such a pre-created PVC is meant to be used by the pod, the PVC has to updated with an owner reference to the pod once the pod exists. Normally this should not be necessary, but it may be useful when manually reconstructing a broken cluster. This field is read-only and no changes will be made by Kubernetes to the PVC after it has been created. Required, must not be nil.	false

K0smotronControlPlane.spec.mounts[index].ephemeral.volumeClaimTemplate#

^{^{↩ Parent}}

Will be used to create a stand-alone PVC to provision the volume. The pod in which this EphemeralVolumeSource is embedded will be the owner of the PVC, i.e. the PVC will be deleted together with the pod. The name of the PVC will be <pod name>-<volume name> where <volume name> is the name from the PodSpec.Volumes array entry. Pod validation will reject the pod if the concatenated name is not valid for a PVC (for example, too long).

An existing PVC with that name that is not owned by the pod will not be used for the pod to avoid using an unrelated volume by mistake. Starting the pod is then blocked until the unrelated PVC is removed. If such a pre-created PVC is meant to be used by the pod, the PVC has to updated with an owner reference to the pod once the pod exists. Normally this should not be necessary, but it may be useful when manually reconstructing a broken cluster.

This field is read-only and no changes will be made by Kubernetes to the PVC after it has been created.

Required, must not be nil.

Name	Type	Description	Required
spec	object	The specification for the PersistentVolumeClaim. The entire content is copied unchanged into the PVC that gets created from this template. The same fields as in a PersistentVolumeClaim are also valid here.	true
metadata	object	May contain labels and annotations that will be copied into the PVC when creating it. No other fields are allowed and will be rejected during validation.	false

K0smotronControlPlane.spec.mounts[index].ephemeral.volumeClaimTemplate.spec#

^{^{↩ Parent}}

The specification for the PersistentVolumeClaim. The entire content is copied unchanged into the PVC that gets created from this template. The same fields as in a PersistentVolumeClaim are also valid here.

Name	Type	Description	Required
accessModes	[]string	accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1	false
dataSource	object	dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. If the namespace is specified, then dataSourceRef will not be copied to dataSource.	false
dataSourceRef	object	dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the dataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, when namespace isn't specified in dataSourceRef, both fields (dataSource and dataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. When namespace is specified in dataSourceRef, dataSource isn't set to the same value and must be empty. There are three important differences between dataSource and dataSourceRef: * While dataSource only allows two specific types of objects, dataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While dataSource ignores disallowed values (dropping them), dataSourceRef preserves all values, and generates an error if a disallowed value is specified. * While dataSource only allows local objects, dataSourceRef allows objects in any namespaces. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.	false
resources	object	resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources	false
selector	object	selector is a label query over volumes to consider for binding.	false
storageClassName	string	storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1	false
volumeAttributesClassName	string	volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim. If specified, the CSI driver will create or update the volume with the attributes defined in the corresponding VolumeAttributesClass. This has a different purpose than storageClassName, it can be changed after the claim is created. An empty string 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/ (Alpha) Using this field requires the VolumeAttributesClass feature gate to be enabled.	false
volumeMode	string	volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.	false
volumeName	string	volumeName is the binding reference to the PersistentVolume backing this claim.	false

K0smotronControlPlane.spec.mounts[index].ephemeral.volumeClaimTemplate.spec.dataSource#

^{^{↩ Parent}}

dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. If the namespace is specified, then dataSourceRef will not be copied to dataSource.

Name	Type	Description	Required
kind	string	Kind is the type of resource being referenced	true
name	string	Name is the name of resource being referenced	true
apiGroup	string	APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.	false

K0smotronControlPlane.spec.mounts[index].ephemeral.volumeClaimTemplate.spec.dataSourceRef#

^{^{↩ Parent}}

dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the dataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, when namespace isn't specified in dataSourceRef, both fields (dataSource and dataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. When namespace is specified in dataSourceRef, dataSource isn't set to the same value and must be empty. There are three important differences between dataSource and dataSourceRef: * While dataSource only allows two specific types of objects, dataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While dataSource ignores disallowed values (dropping them), dataSourceRef preserves all values, and generates an error if a disallowed value is specified. * While dataSource only allows local objects, dataSourceRef allows objects in any namespaces. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.

Name	Type	Description	Required
kind	string	Kind is the type of resource being referenced	true
name	string	Name is the name of resource being referenced	true
apiGroup	string	APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.	false
namespace	string	Namespace is the namespace of resource being referenced Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. (Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.	false

K0smotronControlPlane.spec.mounts[index].ephemeral.volumeClaimTemplate.spec.resources#

^{^{↩ Parent}}

resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources

Name	Type	Description	Required
limits	map[string]int or string	Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/	false
requests	map[string]int or string	Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/	false

K0smotronControlPlane.spec.mounts[index].ephemeral.volumeClaimTemplate.spec.selector#

^{^{↩ Parent}}

selector is a label query over volumes to consider for binding.

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

K0smotronControlPlane.spec.mounts[index].ephemeral.volumeClaimTemplate.spec.selector.matchExpressions[index]#

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

K0smotronControlPlane.spec.mounts[index].ephemeral.volumeClaimTemplate.metadata#

^{^{↩ Parent}}

May contain labels and annotations that will be copied into the PVC when creating it. No other fields are allowed and will be rejected during validation.

Name	Type	Required
annotations	map[string]string	false
finalizers	[]string	false
labels	map[string]string	false
name	string	false
namespace	string	false

K0smotronControlPlane.spec.mounts[index].fc#

^{^{↩ Parent}}

fc represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod.

Name	Type	Description	Required
fsType	string	fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. TODO: how do we prevent errors in the filesystem from compromising the machine	false
lun	integer	lun is Optional: FC target lun number Format: int32	false
readOnly	boolean	readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.	false
targetWWNs	[]string	targetWWNs is Optional: FC target worldwide names (WWNs)	false
wwids	[]string	wwids Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously.	false

K0smotronControlPlane.spec.mounts[index].flexVolume#

^{^{↩ Parent}}

flexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.

Name	Type	Description	Required
driver	string	driver is the name of the driver to use for this volume.	true
fsType	string	fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script.	false
options	map[string]string	options is Optional: this field holds extra command options if any.	false
readOnly	boolean	readOnly is Optional: defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.	false
secretRef	object	secretRef is Optional: secretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts.	false

K0smotronControlPlane.spec.mounts[index].flexVolume.secretRef#

^{^{↩ Parent}}

secretRef is Optional: secretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts.

Name	Type	Description	Required
name	string	Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. TODO: Add other useful fields. apiVersion, kind, uid? 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. Default:	false

K0smotronControlPlane.spec.mounts[index].flocker#

^{^{↩ Parent}}

flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running

Name	Type	Description	Required
datasetName	string	datasetName is Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecated	false
datasetUUID	string	datasetUUID is the UUID of the dataset. This is unique identifier of a Flocker dataset	false

K0smotronControlPlane.spec.mounts[index].gcePersistentDisk#

^{^{↩ Parent}}

gcePersistentDisk represents a GCE Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk

Name	Type	Description	Required
pdName	string	pdName is unique name of the PD resource in GCE. Used to identify the disk in GCE. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk	true
fsType	string	fsType is filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk TODO: how do we prevent errors in the filesystem from compromising the machine	false
partition	integer	partition is the partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk Format: int32	false
readOnly	boolean	readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk	false

K0smotronControlPlane.spec.mounts[index].gitRepo#

^{^{↩ Parent}}

gitRepo represents a git repository at a particular revision. DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod's container.

Name	Type	Description	Required
repository	string	repository is the URL	true
directory	string	directory is the target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name.	false
revision	string	revision is the commit hash for the specified revision.	false

K0smotronControlPlane.spec.mounts[index].glusterfs#

^{^{↩ Parent}}

glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/glusterfs/README.md

Name	Type	Description	Required
endpoints	string	endpoints is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod	true
path	string	path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod	true
readOnly	boolean	readOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod	false

K0smotronControlPlane.spec.mounts[index].hostPath#

^{^{↩ Parent}}

hostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath

TODO(jonesdl) We need to restrict who can use host directory mounts and who can/can not mount host directories as read/write.

Name	Type	Description	Required
path	string	path of the directory on the host. If the path is a symlink, it will follow the link to the real path. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath	true
type	string	type for HostPath Volume Defaults to "" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath	false

K0smotronControlPlane.spec.mounts[index].iscsi#

^{^{↩ Parent}}

iscsi represents an ISCSI Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://examples.k8s.io/volumes/iscsi/README.md

Name	Type	Description	Required
iqn	string	iqn is the target iSCSI Qualified Name.	true
lun	integer	lun represents iSCSI Target Lun number. Format: int32	true
targetPortal	string	targetPortal is iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).	true
chapAuthDiscovery	boolean	chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication	false
chapAuthSession	boolean	chapAuthSession defines whether support iSCSI Session CHAP authentication	false
fsType	string	fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi TODO: how do we prevent errors in the filesystem from compromising the machine	false
initiatorName	string	initiatorName is the custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface : will be created for the connection.	false
iscsiInterface	string	iscsiInterface is the interface Name that uses an iSCSI transport. Defaults to 'default' (tcp).	false
portals	[]string	portals is the iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).	false
readOnly	boolean	readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.	false
secretRef	object	secretRef is the CHAP Secret for iSCSI target and initiator authentication	false

K0smotronControlPlane.spec.mounts[index].iscsi.secretRef#

^{^{↩ Parent}}

secretRef is the CHAP Secret for iSCSI target and initiator authentication

Name	Type	Description	Required
name	string	Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. TODO: Add other useful fields. apiVersion, kind, uid? 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. Default:	false

K0smotronControlPlane.spec.mounts[index].nfs#

^{^{↩ Parent}}

nfs represents an NFS mount on the host that shares a pod's lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

Name	Type	Description	Required
path	string	path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs	true
server	string	server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs	true
readOnly	boolean	readOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs	false

K0smotronControlPlane.spec.mounts[index].persistentVolumeClaim#

^{^{↩ Parent}}

persistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

Name	Type	Description	Required
claimName	string	claimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims	true
readOnly	boolean	readOnly Will force the ReadOnly setting in VolumeMounts. Default false.	false

K0smotronControlPlane.spec.mounts[index].photonPersistentDisk#

^{^{↩ Parent}}

photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine

Name	Type	Description	Required
pdID	string	pdID is the ID that identifies Photon Controller persistent disk	true
fsType	string	fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.	false

K0smotronControlPlane.spec.mounts[index].portworxVolume#

^{^{↩ Parent}}

portworxVolume represents a portworx volume attached and mounted on kubelets host machine

Name	Type	Description	Required
volumeID	string	volumeID uniquely identifies a Portworx volume	true
fsType	string	fSType represents the filesystem type to mount Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs". Implicitly inferred to be "ext4" if unspecified.	false
readOnly	boolean	readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.	false

K0smotronControlPlane.spec.mounts[index].projected#

^{^{↩ Parent}}

projected items for all in one resources secrets, configmaps, and downward API

Name	Type	Description	Required
defaultMode	integer	defaultMode are the mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false
sources	[]object	sources is the list of volume projections	false

K0smotronControlPlane.spec.mounts[index].projected.sources[index]#

^{^{↩ Parent}}

Projection that may be projected along with other supported volume types

Name	Type	Description	Required
clusterTrustBundle	object	ClusterTrustBundle allows a pod to access the `.spec.trustBundle` field of ClusterTrustBundle objects in an auto-updating file. Alpha, gated by the ClusterTrustBundleProjection feature gate. ClusterTrustBundle objects can either be selected by name, or by the combination of signer name and a label selector. Kubelet performs aggressive normalization of the PEM contents written into the pod filesystem. Esoteric PEM features such as inter-block comments and block headers are stripped. Certificates are deduplicated. The ordering of certificates within the file is arbitrary, and Kubelet may change the order over time.	false
configMap	object	configMap information about the configMap data to project	false
downwardAPI	object	downwardAPI information about the downwardAPI data to project	false
secret	object	secret information about the secret data to project	false
serviceAccountToken	object	serviceAccountToken is information about the serviceAccountToken data to project	false

K0smotronControlPlane.spec.mounts[index].projected.sources[index].clusterTrustBundle#

^{^{↩ Parent}}

ClusterTrustBundle allows a pod to access the .spec.trustBundle field of ClusterTrustBundle objects in an auto-updating file.

Alpha, gated by the ClusterTrustBundleProjection feature gate.

ClusterTrustBundle objects can either be selected by name, or by the combination of signer name and a label selector.

Kubelet performs aggressive normalization of the PEM contents written into the pod filesystem. Esoteric PEM features such as inter-block comments and block headers are stripped. Certificates are deduplicated. The ordering of certificates within the file is arbitrary, and Kubelet may change the order over time.

Name	Type	Description	Required
path	string	Relative path from the volume root to write the bundle.	true
labelSelector	object	Select all ClusterTrustBundles that match this label selector. Only has effect if signerName is set. Mutually-exclusive with name. If unset, interpreted as "match nothing". If set but empty, interpreted as "match everything".	false
name	string	Select a single ClusterTrustBundle by object name. Mutually-exclusive with signerName and labelSelector.	false
optional	boolean	If true, don't block pod startup if the referenced ClusterTrustBundle(s) aren't available. If using name, then the named ClusterTrustBundle is allowed not to exist. If using signerName, then the combination of signerName and labelSelector is allowed to match zero ClusterTrustBundles.	false
signerName	string	Select all ClusterTrustBundles that match this signer name. Mutually-exclusive with name. The contents of all selected ClusterTrustBundles will be unified and deduplicated.	false

K0smotronControlPlane.spec.mounts[index].projected.sources[index].clusterTrustBundle.labelSelector#

^{^{↩ Parent}}

Select all ClusterTrustBundles that match this label selector. Only has effect if signerName is set. Mutually-exclusive with name. If unset, interpreted as "match nothing". If set but empty, interpreted as "match everything".

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

K0smotronControlPlane.spec.mounts[index].projected.sources[index].clusterTrustBundle.labelSelector.matchExpressions[index]#

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

K0smotronControlPlane.spec.mounts[index].projected.sources[index].configMap#

^{^{↩ Parent}}

configMap information about the configMap data to project

Name	Type	Description	Required
items	[]object	items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.	false
name	string	Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. TODO: Add other useful fields. apiVersion, kind, uid? 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. Default:	false
optional	boolean	optional specify whether the ConfigMap or its keys must be defined	false

K0smotronControlPlane.spec.mounts[index].projected.sources[index].configMap.items[index]#

^{^{↩ Parent}}

Maps a string key to a path within a volume.

Name	Type	Description	Required
key	string	key is the key to project.	true
path	string	path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.	true
mode	integer	mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false

K0smotronControlPlane.spec.mounts[index].projected.sources[index].downwardAPI#

^{^{↩ Parent}}

downwardAPI information about the downwardAPI data to project

Name	Type	Description	Required
items	[]object	Items is a list of DownwardAPIVolume file	false

K0smotronControlPlane.spec.mounts[index].projected.sources[index].downwardAPI.items[index]#

^{^{↩ Parent}}

DownwardAPIVolumeFile represents information to create the file containing the pod field

Name	Type	Description	Required
path	string	Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'	true
fieldRef	object	Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported.	false
mode	integer	Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false
resourceFieldRef	object	Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.	false

K0smotronControlPlane.spec.mounts[index].projected.sources[index].downwardAPI.items[index].fieldRef#

^{^{↩ Parent}}

Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported.

Name	Type	Description	Required
fieldPath	string	Path of the field to select in the specified API version.	true
apiVersion	string	Version of the schema the FieldPath is written in terms of, defaults to "v1".	false

K0smotronControlPlane.spec.mounts[index].projected.sources[index].downwardAPI.items[index].resourceFieldRef#

^{^{↩ Parent}}

Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.

Name	Type	Description	Required
resource	string	Required: resource to select	true
containerName	string	Container name: required for volumes, optional for env vars	false
divisor	int or string	Specifies the output format of the exposed resources, defaults to "1"	false

K0smotronControlPlane.spec.mounts[index].projected.sources[index].secret#

^{^{↩ Parent}}

secret information about the secret data to project

Name	Type	Description	Required
items	[]object	items if unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.	false
name	string	Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. TODO: Add other useful fields. apiVersion, kind, uid? 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. Default:	false
optional	boolean	optional field specify whether the Secret or its key must be defined	false

K0smotronControlPlane.spec.mounts[index].projected.sources[index].secret.items[index]#

^{^{↩ Parent}}

Maps a string key to a path within a volume.

Name	Type	Description	Required
key	string	key is the key to project.	true
path	string	path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.	true
mode	integer	mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false

K0smotronControlPlane.spec.mounts[index].projected.sources[index].serviceAccountToken#

^{^{↩ Parent}}

serviceAccountToken is information about the serviceAccountToken data to project

Name	Type	Description	Required
path	string	path is the path relative to the mount point of the file to project the token into.	true
audience	string	audience is the intended audience of the token. A recipient of a token must identify itself with an identifier specified in the audience of the token, and otherwise should reject the token. The audience defaults to the identifier of the apiserver.	false
expirationSeconds	integer	expirationSeconds is the requested duration of validity of the service account token. As the token approaches expiration, the kubelet volume plugin will proactively rotate the service account token. The kubelet will start trying to rotate the token if the token is older than 80 percent of its time to live or if the token is older than 24 hours.Defaults to 1 hour and must be at least 10 minutes. Format: int64	false

K0smotronControlPlane.spec.mounts[index].quobyte#

^{^{↩ Parent}}

quobyte represents a Quobyte mount on the host that shares a pod's lifetime

Name	Type	Description	Required
registry	string	registry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumes	true
volume	string	volume is a string that references an already created Quobyte volume by name.	true
group	string	group to map volume access to Default is no group	false
readOnly	boolean	readOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false.	false
tenant	string	tenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes, value is set by the plugin	false
user	string	user to map volume access to Defaults to serivceaccount user	false

K0smotronControlPlane.spec.mounts[index].rbd#

^{^{↩ Parent}}

rbd represents a Rados Block Device mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/rbd/README.md

Name	Type	Description	Required
image	string	image is the rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it	true
monitors	[]string	monitors is a collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it	true
fsType	string	fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#rbd TODO: how do we prevent errors in the filesystem from compromising the machine	false
keyring	string	keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it	false
pool	string	pool is the rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it	false
readOnly	boolean	readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it	false
secretRef	object	secretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it	false
user	string	user is the rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it	false

K0smotronControlPlane.spec.mounts[index].rbd.secretRef#

^{^{↩ Parent}}

secretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

Name	Type	Description	Required
name	string	Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. TODO: Add other useful fields. apiVersion, kind, uid? 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. Default:	false

K0smotronControlPlane.spec.mounts[index].scaleIO#

^{^{↩ Parent}}

scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.

Name	Type	Description	Required
gateway	string	gateway is the host address of the ScaleIO API Gateway.	true
secretRef	object	secretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail.	true
system	string	system is the name of the storage system as configured in ScaleIO.	true
fsType	string	fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Default is "xfs".	false
protectionDomain	string	protectionDomain is the name of the ScaleIO Protection Domain for the configured storage.	false
readOnly	boolean	readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.	false
sslEnabled	boolean	sslEnabled Flag enable/disable SSL communication with Gateway, default false	false
storageMode	string	storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned.	false
storagePool	string	storagePool is the ScaleIO Storage Pool associated with the protection domain.	false
volumeName	string	volumeName is the name of a volume already created in the ScaleIO system that is associated with this volume source.	false

K0smotronControlPlane.spec.mounts[index].scaleIO.secretRef#

^{^{↩ Parent}}

secretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail.

Name	Type	Description	Required
name	string	Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. TODO: Add other useful fields. apiVersion, kind, uid? 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. Default:	false

K0smotronControlPlane.spec.mounts[index].secret#

^{^{↩ Parent}}

secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret

Name	Type	Description	Required
defaultMode	integer	defaultMode is Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false
items	[]object	items If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.	false
optional	boolean	optional field specify whether the Secret or its keys must be defined	false
secretName	string	secretName is the name of the secret in the pod's namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret	false

K0smotronControlPlane.spec.mounts[index].secret.items[index]#

^{^{↩ Parent}}

Maps a string key to a path within a volume.

Name	Type	Description	Required
key	string	key is the key to project.	true
path	string	path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.	true
mode	integer	mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false

K0smotronControlPlane.spec.mounts[index].storageos#

^{^{↩ Parent}}

storageOS represents a StorageOS volume attached and mounted on Kubernetes nodes.

Name	Type	Description	Required
fsType	string	fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.	false
readOnly	boolean	readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.	false
secretRef	object	secretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted.	false
volumeName	string	volumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace.	false
volumeNamespace	string	volumeNamespace specifies the scope of the volume within StorageOS. If no namespace is specified then the Pod's namespace will be used. This allows the Kubernetes name scoping to be mirrored within StorageOS for tighter integration. Set VolumeName to any name to override the default behaviour. Set to "default" if you are not using namespaces within StorageOS. Namespaces that do not pre-exist within StorageOS will be created.	false

K0smotronControlPlane.spec.mounts[index].storageos.secretRef#

^{^{↩ Parent}}

secretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted.

Name	Type	Description	Required
name	string	Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. TODO: Add other useful fields. apiVersion, kind, uid? 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. Default:	false

K0smotronControlPlane.spec.mounts[index].vsphereVolume#

^{^{↩ Parent}}

vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine

Name	Type	Description	Required
volumePath	string	volumePath is the path that identifies vSphere volume vmdk	true
fsType	string	fsType is filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.	false
storagePolicyID	string	storagePolicyID is the storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.	false
storagePolicyName	string	storagePolicyName is the storage Policy Based Management (SPBM) profile name.	false

K0smotronControlPlane.spec.persistence#

^{^{↩ Parent}}

Persistence defines the persistence configuration. If empty k0smotron will use emptyDir as a volume. See https://docs.k0smotron.io/stable/configuration/#persistence

Name	Type	Description	Required
type	string	Default: emptyDir	true
autoDeletePVCs	boolean	AutoDeletePVCs defines whether the PVC should be deleted when the cluster is deleted. Default: false	false
hostPath	string	HostPath defines the host path configuration. Will be used as is in case of .spec.persistence.type is hostPath.	false
persistentVolumeClaim	object	PersistentVolumeClaim defines the PVC configuration. Will be used as is in case of .spec.persistence.type is pvc.	false

K0smotronControlPlane.spec.persistence.persistentVolumeClaim#

^{^{↩ Parent}}

PersistentVolumeClaim defines the PVC configuration. Will be used as is in case of .spec.persistence.type is pvc.

Name	Type	Description	Required
apiVersion	string	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources	false
kind	string	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds	false
metadata	object	Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata	false
spec	object	spec defines the desired characteristics of a volume requested by a pod author. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims	false
status	object	status represents the current information/status of a persistent volume claim. Read-only. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims	false

K0smotronControlPlane.spec.persistence.persistentVolumeClaim.metadata#

^{^{↩ Parent}}

Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

Name	Type	Required
annotations	map[string]string	false
finalizers	[]string	false
labels	map[string]string	false
name	string	false
namespace	string	false

K0smotronControlPlane.spec.persistence.persistentVolumeClaim.spec#

^{^{↩ Parent}}

spec defines the desired characteristics of a volume requested by a pod author. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

Name	Type	Description	Required
accessModes	[]string	accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1	false
dataSource	object	dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. If the namespace is specified, then dataSourceRef will not be copied to dataSource.	false
dataSourceRef	object	dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the dataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, when namespace isn't specified in dataSourceRef, both fields (dataSource and dataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. When namespace is specified in dataSourceRef, dataSource isn't set to the same value and must be empty. There are three important differences between dataSource and dataSourceRef: * While dataSource only allows two specific types of objects, dataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While dataSource ignores disallowed values (dropping them), dataSourceRef preserves all values, and generates an error if a disallowed value is specified. * While dataSource only allows local objects, dataSourceRef allows objects in any namespaces. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.	false
resources	object	resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources	false
selector	object	selector is a label query over volumes to consider for binding.	false
storageClassName	string	storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1	false
volumeAttributesClassName	string	volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim. If specified, the CSI driver will create or update the volume with the attributes defined in the corresponding VolumeAttributesClass. This has a different purpose than storageClassName, it can be changed after the claim is created. An empty string 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/ (Alpha) Using this field requires the VolumeAttributesClass feature gate to be enabled.	false
volumeMode	string	volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.	false
volumeName	string	volumeName is the binding reference to the PersistentVolume backing this claim.	false

K0smotronControlPlane.spec.persistence.persistentVolumeClaim.spec.dataSource#

^{^{↩ Parent}}

dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. If the namespace is specified, then dataSourceRef will not be copied to dataSource.

Name	Type	Description	Required
kind	string	Kind is the type of resource being referenced	true
name	string	Name is the name of resource being referenced	true
apiGroup	string	APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.	false

K0smotronControlPlane.spec.persistence.persistentVolumeClaim.spec.dataSourceRef#

^{^{↩ Parent}}

dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the dataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, when namespace isn't specified in dataSourceRef, both fields (dataSource and dataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. When namespace is specified in dataSourceRef, dataSource isn't set to the same value and must be empty. There are three important differences between dataSource and dataSourceRef: * While dataSource only allows two specific types of objects, dataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While dataSource ignores disallowed values (dropping them), dataSourceRef preserves all values, and generates an error if a disallowed value is specified. * While dataSource only allows local objects, dataSourceRef allows objects in any namespaces. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.

Name	Type	Description	Required
kind	string	Kind is the type of resource being referenced	true
name	string	Name is the name of resource being referenced	true
apiGroup	string	APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.	false
namespace	string	Namespace is the namespace of resource being referenced Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. (Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.	false

K0smotronControlPlane.spec.persistence.persistentVolumeClaim.spec.resources#

^{^{↩ Parent}}

resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources

Name	Type	Description	Required
limits	map[string]int or string	Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/	false
requests	map[string]int or string	Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/	false

K0smotronControlPlane.spec.persistence.persistentVolumeClaim.spec.selector#

^{^{↩ Parent}}

selector is a label query over volumes to consider for binding.

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

K0smotronControlPlane.spec.persistence.persistentVolumeClaim.spec.selector.matchExpressions[index]#

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

K0smotronControlPlane.spec.persistence.persistentVolumeClaim.status#

^{^{↩ Parent}}

status represents the current information/status of a persistent volume claim. Read-only. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

Name	Type	Description	Required
accessModes	[]string	accessModes contains the actual access modes the volume backing the PVC has. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1	false
allocatedResourceStatuses	map[string]string	allocatedResourceStatuses stores status of resource being resized for the given PVC. Key names follow standard Kubernetes label syntax. Valid values are either: * Un-prefixed keys: - storage - the capacity of the volume. * Custom resources must use implementation-defined prefixed names such as "example.com/my-custom-resource" Apart from above values - keys that are unprefixed or have kubernetes.io prefix are considered reserved and hence may not be used. ClaimResourceStatus can be in any of following states: - ControllerResizeInProgress: State set when resize controller starts resizing the volume in control-plane. - ControllerResizeFailed: State set when resize has failed in resize controller with a terminal error. - NodeResizePending: State set when resize controller has finished resizing the volume but further resizing of volume is needed on the node. - NodeResizeInProgress: State set when kubelet starts resizing the volume. - NodeResizeFailed: State set when resizing has failed in kubelet with a terminal error. Transient errors don't set NodeResizeFailed. For example: if expanding a PVC for more capacity - this field can be one of the following states: - pvc.status.allocatedResourceStatus['storage'] = "ControllerResizeInProgress" - pvc.status.allocatedResourceStatus['storage'] = "ControllerResizeFailed" - pvc.status.allocatedResourceStatus['storage'] = "NodeResizePending" - pvc.status.allocatedResourceStatus['storage'] = "NodeResizeInProgress" - pvc.status.allocatedResourceStatus['storage'] = "NodeResizeFailed" When this field is not set, it means that no resize operation is in progress for the given PVC. A controller that receives PVC update with previously unknown resourceName or ClaimResourceStatus should ignore the update for the purpose it was designed. For example - a controller that only is responsible for resizing capacity of the volume, should ignore PVC updates that change other valid resources associated with PVC. This is an alpha field and requires enabling RecoverVolumeExpansionFailure feature.	false
allocatedResources	map[string]int or string	allocatedResources tracks the resources allocated to a PVC including its capacity. Key names follow standard Kubernetes label syntax. Valid values are either: * Un-prefixed keys: - storage - the capacity of the volume. * Custom resources must use implementation-defined prefixed names such as "example.com/my-custom-resource" Apart from above values - keys that are unprefixed or have kubernetes.io prefix are considered reserved and hence may not be used. Capacity reported here may be larger than the actual capacity when a volume expansion operation is requested. For storage quota, the larger value from allocatedResources and PVC.spec.resources is used. If allocatedResources is not set, PVC.spec.resources alone is used for quota calculation. If a volume expansion capacity request is lowered, allocatedResources is only lowered if there are no expansion operations in progress and if the actual volume capacity is equal or lower than the requested capacity. A controller that receives PVC update with previously unknown resourceName should ignore the update for the purpose it was designed. For example - a controller that only is responsible for resizing capacity of the volume, should ignore PVC updates that change other valid resources associated with PVC. This is an alpha field and requires enabling RecoverVolumeExpansionFailure feature.	false
capacity	map[string]int or string	capacity represents the actual resources of the underlying volume.	false
conditions	[]object	conditions is the current Condition of persistent volume claim. If underlying persistent volume is being resized then the Condition will be set to 'Resizing'.	false
currentVolumeAttributesClassName	string	currentVolumeAttributesClassName is the current name of the VolumeAttributesClass the PVC is using. When unset, there is no VolumeAttributeClass applied to this PersistentVolumeClaim This is an alpha field and requires enabling VolumeAttributesClass feature.	false
modifyVolumeStatus	object	ModifyVolumeStatus represents the status object of ControllerModifyVolume operation. When this is unset, there is no ModifyVolume operation being attempted. This is an alpha field and requires enabling VolumeAttributesClass feature.	false
phase	string	phase represents the current phase of PersistentVolumeClaim.	false

K0smotronControlPlane.spec.persistence.persistentVolumeClaim.status.conditions[index]#

^{^{↩ Parent}}

PersistentVolumeClaimCondition contains details about state of pvc

Name	Type	Description	Required
status	string		true
type	string	PersistentVolumeClaimConditionType is a valid value of PersistentVolumeClaimCondition.Type	true
lastProbeTime	string	lastProbeTime is the time we probed the condition. Format: date-time	false
lastTransitionTime	string	lastTransitionTime is the time the condition transitioned from one status to another. Format: date-time	false
message	string	message is the human-readable message indicating details about last transition.	false
reason	string	reason is a unique, this should be a short, machine understandable string that gives the reason for condition's last transition. If it reports "Resizing" that means the underlying persistent volume is being resized.	false

K0smotronControlPlane.spec.persistence.persistentVolumeClaim.status.modifyVolumeStatus#

^{^{↩ Parent}}

ModifyVolumeStatus represents the status object of ControllerModifyVolume operation. When this is unset, there is no ModifyVolume operation being attempted. This is an alpha field and requires enabling VolumeAttributesClass feature.

Name	Type	Description	Required
status	string	status is the status of the ControllerModifyVolume operation. It can be in any of following states: - Pending Pending indicates that the PersistentVolumeClaim cannot be modified due to unmet requirements, such as the specified VolumeAttributesClass not existing. - InProgress InProgress indicates that the volume is being modified. - Infeasible Infeasible indicates that the request has been rejected as invalid by the CSI driver. To resolve the error, a valid VolumeAttributesClass needs to be specified. Note: New statuses can be added in the future. Consumers should check for unknown statuses and fail appropriately.	true
targetVolumeAttributesClassName	string	targetVolumeAttributesClassName is the name of the VolumeAttributesClass the PVC currently being reconciled	false

K0smotronControlPlane.spec.resources#

^{^{↩ Parent}}

Resources describes the compute resource requirements for the control plane pods.

Name	Type	Description	Required
claims	[]object	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.	false
limits	map[string]int or string	Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/	false
requests	map[string]int or string	Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/	false

K0smotronControlPlane.spec.resources.claims[index]#

^{^{↩ Parent}}

ResourceClaim references one entry in PodSpec.ResourceClaims.

Name	Type	Description	Required
name	string	Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.	true

K0smotronControlPlane.spec.service#

^{^{↩ Parent}}

Service defines the service configuration.

Name	Type	Description	Required
type	enum	Service Type string describes ingress methods for a service Enum: ClusterIP, NodePort, LoadBalancer Default: ClusterIP	true
annotations	map[string]string	Annotations defines extra annotations to be added to the service.	false
apiPort	integer	APIPort defines the kubernetes API port. If empty k0smotron will pick it automatically. Default: 30443	false
konnectivityPort	integer	KonnectivityPort defines the konnectivity port. If empty k0smotron will pick it automatically. Default: 30132	false
labels	map[string]string	Labels defines extra labels to be added to the service.	false
loadBalancerClass	string	LoadBalancerClass defines the load balancer class to be used for the service. Used only when service type is LoadBalancer.	false

K0smotronControlPlane.status#

^{^{↩ Parent}}

Name	Type	Description	Required
controlPlaneReady	boolean		true
externalManagedControlPlane	boolean		true
initialized	boolean		true
ready	boolean	Ready denotes that the control plane is ready	true
version	string		true

K0smotronControlPlaneTemplate#

^{^{↩ Parent}}

Name	Type	Description	Required
apiVersion	string	controlplane.cluster.x-k8s.io/v1beta1	true
kind	string	K0smotronControlPlaneTemplate	true
metadata	object	Refer to the Kubernetes API documentation for the fields of the `metadata` field.	true
spec	object		false

K0smotronControlPlaneTemplate.spec#

^{^{↩ Parent}}

Name	Type	Description	Required
template	object		false

K0smotronControlPlaneTemplate.spec.template#

^{^{↩ Parent}}

Name	Type	Description	Required
metadata	object		false
spec	object	ClusterSpec defines the desired state of K0smotronCluster	false

K0smotronControlPlaneTemplate.spec.template.metadata#

^{^{↩ Parent}}

Name	Type	Required
annotations	map[string]string	false
finalizers	[]string	false
labels	map[string]string	false
name	string	false
namespace	string	false

K0smotronControlPlaneTemplate.spec.template.spec#

^{^{↩ Parent}}

ClusterSpec defines the desired state of K0smotronCluster

Name	Type	Description	Required
certificateRefs	[]object	CertificateRefs defines the certificate references.	false
controllerPlaneFlags	[]string	ControlPlaneFlags allows to configure additional flags for k0s control plane and to override existing ones. The default flags are kept unless they are overriden explicitly. Flags with arguments must be specified as a single string, e.g. --some-flag=argument	false
etcd	object	Etcd defines the etcd configuration. Default: map[image:quay.io/k0sproject/etcd:v3.5.13 persistence:map[]]	false
externalAddress	string	ExternalAddress defines k0s external address. See https://docs.k0sproject.io/stable/configuration/#specapi Will be detected automatically for service type LoadBalancer.	false
image	string	Image defines the k0s image to be deployed. If empty k0smotron will pick it automatically. Must not include the image tag. Default: k0sproject/k0s	false
k0sConfig	object	k0sConfig defines the k0s configuration. Note, that some fields will be overwritten by k0smotron. If empty, will be used default configuration. @see https://docs.k0sproject.io/stable/configuration/	false
kineDataSourceSecretName	string	KineDataSourceSecretName defines the name of kine datasource URL secret.	false
kineDataSourceURL	string	KineDataSourceURL defines the kine datasource URL.	false
manifests	[]object	Manifests allows to specify list of volumes with manifests to be deployed in the cluster. The volumes will be mounted in /var/lib/k0s/manifests/, for this reason each manifest is a stack. K0smotron allows any kind of volume, but the recommendation is to use secrets and configmaps. For more information check: https://docs.k0sproject.io/stable/manifests/ and https://kubernetes.io/docs/concepts/storage/volumes	false
monitoring	object	Monitoring defines the monitoring configuration.	false
mounts	[]object	Mounts allows to specify list of volumes with any files to be mounted in the controlplane pod. K0smotron allows any kind of volume, but the recommendation is to use secrets and configmaps. For more information check: https://kubernetes.io/docs/concepts/storage/volumes	false
persistence	object	Persistence defines the persistence configuration. If empty k0smotron will use emptyDir as a volume. See https://docs.k0smotron.io/stable/configuration/#persistence	false
replicas	integer	Replicas is the desired number of replicas of the k0s control planes. If unspecified, defaults to 1. If the value is above 1, k0smotron requires kine datasource URL to be set. Recommended value is 3. Format: int32 Default: 1	false
resources	object	Resources describes the compute resource requirements for the control plane pods.	false
service	object	Service defines the service configuration. Default: map[apiPort:30443 konnectivityPort:30132 type:ClusterIP]	false
version	string	Version defines the k0s version to be deployed. If empty k0smotron will pick it automatically.	false

K0smotronControlPlaneTemplate.spec.template.spec.certificateRefs[index]#

^{^{↩ Parent}}

Name	Type	Description	Required
type	enum	Enum: ca, sa, proxy, etcd, apiserver-etcd-client, etcd-peer, etcd-server	true
name	string		false

K0smotronControlPlaneTemplate.spec.template.spec.etcd#

^{^{↩ Parent}}

Etcd defines the etcd configuration.

Name	Type	Description	Required
image	string	Image defines the etcd image to be deployed. Default: quay.io/k0sproject/etcd:v3.5.13	true
args	[]string	Args defines the etcd arguments.	false
autoDeletePVCs	boolean	AutoDeletePVCs defines whether the PVC should be deleted when the etcd cluster is deleted. Default: false	false
defragJob	object	DefragJob defines the etcd defragmentation job configuration.	false
persistence	object	Persistence defines the persistence configuration.	false

K0smotronControlPlaneTemplate.spec.template.spec.etcd.defragJob#

^{^{↩ Parent}}

DefragJob defines the etcd defragmentation job configuration.

Name	Type	Description	Required
enabled	boolean	Enabled enables the etcd defragmentation job. Default: false	true
image	string	Image defines the etcd defragmentation job image. Default: ghcr.io/ahrtr/etcd-defrag:v0.16.0	true
rule	string	Rule defines the etcd defragmentation job defrag-rule. For more information check: https://github.com/ahrtr/etcd-defrag/tree/main?tab=readme-ov-file#defragmentation-rule Default: dbQuotaUsage > 0.8 \|\| dbSize - dbSizeInUse > 20010241024	true
schedule	string	Schedule defines the etcd defragmentation job schedule. Default: 0 12 * * *	true

K0smotronControlPlaneTemplate.spec.template.spec.etcd.persistence#

^{^{↩ Parent}}

Persistence defines the persistence configuration.

Name	Type	Description	Required
size	int or string	Size defines the size of the etcd volume. Default: 1Gi Default: 1Gi	false
storageClass	string	StorageClass defines the storage class to be used for etcd persistence. If empty, will be used the default storage class.	false

K0smotronControlPlaneTemplate.spec.template.spec.manifests[index]#

^{^{↩ Parent}}

Volume represents a named volume in a pod that may be accessed by any container in the pod.

Name	Type	Description	Required
name	string	name of the volume. Must be a DNS_LABEL and unique within the pod. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names	true
awsElasticBlockStore	object	awsElasticBlockStore represents an AWS Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore	false
azureDisk	object	azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.	false
azureFile	object	azureFile represents an Azure File Service mount on the host and bind mount to the pod.	false
cephfs	object	cephFS represents a Ceph FS mount on the host that shares a pod's lifetime	false
cinder	object	cinder represents a cinder volume attached and mounted on kubelets host machine. More info: https://examples.k8s.io/mysql-cinder-pd/README.md	false
configMap	object	configMap represents a configMap that should populate this volume	false
csi	object	csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature).	false
downwardAPI	object	downwardAPI represents downward API about the pod that should populate this volume	false
emptyDir	object	emptyDir represents a temporary directory that shares a pod's lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir	false
ephemeral	object	ephemeral represents a volume that is handled by a cluster storage driver. The volume's lifecycle is tied to the pod that defines it - it will be created before the pod starts, and deleted when the pod is removed. Use this if: a) the volume is only needed while the pod runs, b) features of normal volumes like restoring from snapshot or capacity tracking are needed, c) the storage driver is specified through a storage class, and d) the storage driver supports dynamic volume provisioning through a PersistentVolumeClaim (see EphemeralVolumeSource for more information on the connection between this volume type and PersistentVolumeClaim). Use PersistentVolumeClaim or one of the vendor-specific APIs for volumes that persist for longer than the lifecycle of an individual pod. Use CSI for light-weight local ephemeral volumes if the CSI driver is meant to be used that way - see the documentation of the driver for more information. A pod can use both types of ephemeral volumes and persistent volumes at the same time.	false
fc	object	fc represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod.	false
flexVolume	object	flexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.	false
flocker	object	flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running	false
gcePersistentDisk	object	gcePersistentDisk represents a GCE Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk	false
gitRepo	object	gitRepo represents a git repository at a particular revision. DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod's container.	false
glusterfs	object	glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/glusterfs/README.md	false
hostPath	object	hostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath --- TODO(jonesdl) We need to restrict who can use host directory mounts and who can/can not mount host directories as read/write.	false
iscsi	object	iscsi represents an ISCSI Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://examples.k8s.io/volumes/iscsi/README.md	false
nfs	object	nfs represents an NFS mount on the host that shares a pod's lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs	false
persistentVolumeClaim	object	persistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims	false
photonPersistentDisk	object	photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine	false
portworxVolume	object	portworxVolume represents a portworx volume attached and mounted on kubelets host machine	false
projected	object	projected items for all in one resources secrets, configmaps, and downward API	false
quobyte	object	quobyte represents a Quobyte mount on the host that shares a pod's lifetime	false
rbd	object	rbd represents a Rados Block Device mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/rbd/README.md	false
scaleIO	object	scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.	false
secret	object	secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret	false
storageos	object	storageOS represents a StorageOS volume attached and mounted on Kubernetes nodes.	false
vsphereVolume	object	vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine	false

K0smotronControlPlaneTemplate.spec.template.spec.manifests[index].awsElasticBlockStore#

^{^{↩ Parent}}

awsElasticBlockStore represents an AWS Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore

Name	Type	Description	Required
volumeID	string	volumeID is unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore	true
fsType	string	fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore TODO: how do we prevent errors in the filesystem from compromising the machine	false
partition	integer	partition is the partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). Format: int32	false
readOnly	boolean	readOnly value true will force the readOnly setting in VolumeMounts. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore	false

K0smotronControlPlaneTemplate.spec.template.spec.manifests[index].azureDisk#

^{^{↩ Parent}}

azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.

Name	Type	Description	Required
diskName	string	diskName is the Name of the data disk in the blob storage	true
diskURI	string	diskURI is the URI of data disk in the blob storage	true
cachingMode	string	cachingMode is the Host Caching mode: None, Read Only, Read Write.	false
fsType	string	fsType is Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.	false
kind	string	kind expected values are Shared: multiple blob disks per storage account Dedicated: single blob disk per storage account Managed: azure managed data disk (only in managed availability set). defaults to shared	false
readOnly	boolean	readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.	false

K0smotronControlPlaneTemplate.spec.template.spec.manifests[index].azureFile#

^{^{↩ Parent}}

azureFile represents an Azure File Service mount on the host and bind mount to the pod.

Name	Type	Description	Required
secretName	string	secretName is the name of secret that contains Azure Storage Account Name and Key	true
shareName	string	shareName is the azure share Name	true
readOnly	boolean	readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.	false

K0smotronControlPlaneTemplate.spec.template.spec.manifests[index].cephfs#

^{^{↩ Parent}}

cephFS represents a Ceph FS mount on the host that shares a pod's lifetime

Name	Type	Description	Required
monitors	[]string	monitors is Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it	true
path	string	path is Optional: Used as the mounted root, rather than the full Ceph tree, default is /	false
readOnly	boolean	readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it	false
secretFile	string	secretFile is Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it	false
secretRef	object	secretRef is Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it	false
user	string	user is optional: User is the rados user name, default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it	false

K0smotronControlPlaneTemplate.spec.template.spec.manifests[index].cephfs.secretRef#

^{^{↩ Parent}}

secretRef is Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it

Name	Type	Description	Required
name	string	Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. TODO: Add other useful fields. apiVersion, kind, uid? 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. Default:	false

K0smotronControlPlaneTemplate.spec.template.spec.manifests[index].cinder#

^{^{↩ Parent}}

cinder represents a cinder volume attached and mounted on kubelets host machine. More info: https://examples.k8s.io/mysql-cinder-pd/README.md

Name	Type	Description	Required
volumeID	string	volumeID used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md	true
fsType	string	fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://examples.k8s.io/mysql-cinder-pd/README.md	false
readOnly	boolean	readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/mysql-cinder-pd/README.md	false
secretRef	object	secretRef is optional: points to a secret object containing parameters used to connect to OpenStack.	false

K0smotronControlPlaneTemplate.spec.template.spec.manifests[index].cinder.secretRef#

^{^{↩ Parent}}

secretRef is optional: points to a secret object containing parameters used to connect to OpenStack.

Name	Type	Description	Required
name	string	Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. TODO: Add other useful fields. apiVersion, kind, uid? 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. Default:	false

K0smotronControlPlaneTemplate.spec.template.spec.manifests[index].configMap#

^{^{↩ Parent}}

configMap represents a configMap that should populate this volume

Name	Type	Description	Required
defaultMode	integer	defaultMode is optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false
items	[]object	items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.	false
name	string	Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. TODO: Add other useful fields. apiVersion, kind, uid? 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. Default:	false
optional	boolean	optional specify whether the ConfigMap or its keys must be defined	false

K0smotronControlPlaneTemplate.spec.template.spec.manifests[index].configMap.items[index]#

^{^{↩ Parent}}

Maps a string key to a path within a volume.

Name	Type	Description	Required
key	string	key is the key to project.	true
path	string	path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.	true
mode	integer	mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false

K0smotronControlPlaneTemplate.spec.template.spec.manifests[index].csi#

^{^{↩ Parent}}

csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature).

Name	Type	Description	Required
driver	string	driver is the name of the CSI driver that handles this volume. Consult with your admin for the correct name as registered in the cluster.	true
fsType	string	fsType to mount. Ex. "ext4", "xfs", "ntfs". If not provided, the empty value is passed to the associated CSI driver which will determine the default filesystem to apply.	false
nodePublishSecretRef	object	nodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secret references are passed.	false
readOnly	boolean	readOnly specifies a read-only configuration for the volume. Defaults to false (read/write).	false
volumeAttributes	map[string]string	volumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver's documentation for supported values.	false

K0smotronControlPlaneTemplate.spec.template.spec.manifests[index].csi.nodePublishSecretRef#

^{^{↩ Parent}}

nodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secret references are passed.

Name	Type	Description	Required
name	string	Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. TODO: Add other useful fields. apiVersion, kind, uid? 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. Default:	false

K0smotronControlPlaneTemplate.spec.template.spec.manifests[index].downwardAPI#

^{^{↩ Parent}}

downwardAPI represents downward API about the pod that should populate this volume

Name	Type	Description	Required
defaultMode	integer	Optional: mode bits to use on created files by default. Must be a Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false
items	[]object	Items is a list of downward API volume file	false

K0smotronControlPlaneTemplate.spec.template.spec.manifests[index].downwardAPI.items[index]#

^{^{↩ Parent}}

DownwardAPIVolumeFile represents information to create the file containing the pod field

Name	Type	Description	Required
path	string	Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'	true
fieldRef	object	Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported.	false
mode	integer	Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false
resourceFieldRef	object	Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.	false

K0smotronControlPlaneTemplate.spec.template.spec.manifests[index].downwardAPI.items[index].fieldRef#

^{^{↩ Parent}}

Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported.

Name	Type	Description	Required
fieldPath	string	Path of the field to select in the specified API version.	true
apiVersion	string	Version of the schema the FieldPath is written in terms of, defaults to "v1".	false

K0smotronControlPlaneTemplate.spec.template.spec.manifests[index].downwardAPI.items[index].resourceFieldRef#

^{^{↩ Parent}}

Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.

Name	Type	Description	Required
resource	string	Required: resource to select	true
containerName	string	Container name: required for volumes, optional for env vars	false
divisor	int or string	Specifies the output format of the exposed resources, defaults to "1"	false

K0smotronControlPlaneTemplate.spec.template.spec.manifests[index].emptyDir#

^{^{↩ Parent}}

emptyDir represents a temporary directory that shares a pod's lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir

Name	Type	Description	Required
medium	string	medium represents what type of storage medium should back this directory. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir	false
sizeLimit	int or string	sizeLimit is the total amount of local storage required for this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers in a pod. The default is nil which means that the limit is undefined. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir	false

K0smotronControlPlaneTemplate.spec.template.spec.manifests[index].ephemeral#

^{^{↩ Parent}}

ephemeral represents a volume that is handled by a cluster storage driver. The volume's lifecycle is tied to the pod that defines it - it will be created before the pod starts, and deleted when the pod is removed.

Use this if: a) the volume is only needed while the pod runs, b) features of normal volumes like restoring from snapshot or capacity tracking are needed, c) the storage driver is specified through a storage class, and d) the storage driver supports dynamic volume provisioning through a PersistentVolumeClaim (see EphemeralVolumeSource for more information on the connection between this volume type and PersistentVolumeClaim).

Use PersistentVolumeClaim or one of the vendor-specific APIs for volumes that persist for longer than the lifecycle of an individual pod.

Use CSI for light-weight local ephemeral volumes if the CSI driver is meant to be used that way - see the documentation of the driver for more information.

A pod can use both types of ephemeral volumes and persistent volumes at the same time.

Name	Type	Description	Required
volumeClaimTemplate	object	Will be used to create a stand-alone PVC to provision the volume. The pod in which this EphemeralVolumeSource is embedded will be the owner of the PVC, i.e. the PVC will be deleted together with the pod. The name of the PVC will be `-` where `` is the name from the `PodSpec.Volumes` array entry. Pod validation will reject the pod if the concatenated name is not valid for a PVC (for example, too long). An existing PVC with that name that is not owned by the pod will not be used for the pod to avoid using an unrelated volume by mistake. Starting the pod is then blocked until the unrelated PVC is removed. If such a pre-created PVC is meant to be used by the pod, the PVC has to updated with an owner reference to the pod once the pod exists. Normally this should not be necessary, but it may be useful when manually reconstructing a broken cluster. This field is read-only and no changes will be made by Kubernetes to the PVC after it has been created. Required, must not be nil.	false

K0smotronControlPlaneTemplate.spec.template.spec.manifests[index].ephemeral.volumeClaimTemplate#

^{^{↩ Parent}}

Will be used to create a stand-alone PVC to provision the volume. The pod in which this EphemeralVolumeSource is embedded will be the owner of the PVC, i.e. the PVC will be deleted together with the pod. The name of the PVC will be <pod name>-<volume name> where <volume name> is the name from the PodSpec.Volumes array entry. Pod validation will reject the pod if the concatenated name is not valid for a PVC (for example, too long).

An existing PVC with that name that is not owned by the pod will not be used for the pod to avoid using an unrelated volume by mistake. Starting the pod is then blocked until the unrelated PVC is removed. If such a pre-created PVC is meant to be used by the pod, the PVC has to updated with an owner reference to the pod once the pod exists. Normally this should not be necessary, but it may be useful when manually reconstructing a broken cluster.

This field is read-only and no changes will be made by Kubernetes to the PVC after it has been created.

Required, must not be nil.

Name	Type	Description	Required
spec	object	The specification for the PersistentVolumeClaim. The entire content is copied unchanged into the PVC that gets created from this template. The same fields as in a PersistentVolumeClaim are also valid here.	true
metadata	object	May contain labels and annotations that will be copied into the PVC when creating it. No other fields are allowed and will be rejected during validation.	false

K0smotronControlPlaneTemplate.spec.template.spec.manifests[index].ephemeral.volumeClaimTemplate.spec#

^{^{↩ Parent}}

The specification for the PersistentVolumeClaim. The entire content is copied unchanged into the PVC that gets created from this template. The same fields as in a PersistentVolumeClaim are also valid here.

Name	Type	Description	Required
accessModes	[]string	accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1	false
dataSource	object	dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. If the namespace is specified, then dataSourceRef will not be copied to dataSource.	false
dataSourceRef	object	dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the dataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, when namespace isn't specified in dataSourceRef, both fields (dataSource and dataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. When namespace is specified in dataSourceRef, dataSource isn't set to the same value and must be empty. There are three important differences between dataSource and dataSourceRef: * While dataSource only allows two specific types of objects, dataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While dataSource ignores disallowed values (dropping them), dataSourceRef preserves all values, and generates an error if a disallowed value is specified. * While dataSource only allows local objects, dataSourceRef allows objects in any namespaces. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.	false
resources	object	resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources	false
selector	object	selector is a label query over volumes to consider for binding.	false
storageClassName	string	storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1	false
volumeAttributesClassName	string	volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim. If specified, the CSI driver will create or update the volume with the attributes defined in the corresponding VolumeAttributesClass. This has a different purpose than storageClassName, it can be changed after the claim is created. An empty string 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/ (Alpha) Using this field requires the VolumeAttributesClass feature gate to be enabled.	false
volumeMode	string	volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.	false
volumeName	string	volumeName is the binding reference to the PersistentVolume backing this claim.	false

K0smotronControlPlaneTemplate.spec.template.spec.manifests[index].ephemeral.volumeClaimTemplate.spec.dataSource#

^{^{↩ Parent}}

dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. If the namespace is specified, then dataSourceRef will not be copied to dataSource.

Name	Type	Description	Required
kind	string	Kind is the type of resource being referenced	true
name	string	Name is the name of resource being referenced	true
apiGroup	string	APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.	false

K0smotronControlPlaneTemplate.spec.template.spec.manifests[index].ephemeral.volumeClaimTemplate.spec.dataSourceRef#

^{^{↩ Parent}}

dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the dataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, when namespace isn't specified in dataSourceRef, both fields (dataSource and dataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. When namespace is specified in dataSourceRef, dataSource isn't set to the same value and must be empty. There are three important differences between dataSource and dataSourceRef: * While dataSource only allows two specific types of objects, dataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While dataSource ignores disallowed values (dropping them), dataSourceRef preserves all values, and generates an error if a disallowed value is specified. * While dataSource only allows local objects, dataSourceRef allows objects in any namespaces. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.

Name	Type	Description	Required
kind	string	Kind is the type of resource being referenced	true
name	string	Name is the name of resource being referenced	true
apiGroup	string	APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.	false
namespace	string	Namespace is the namespace of resource being referenced Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. (Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.	false

K0smotronControlPlaneTemplate.spec.template.spec.manifests[index].ephemeral.volumeClaimTemplate.spec.resources#

^{^{↩ Parent}}

resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources

Name	Type	Description	Required
limits	map[string]int or string	Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/	false
requests	map[string]int or string	Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/	false

K0smotronControlPlaneTemplate.spec.template.spec.manifests[index].ephemeral.volumeClaimTemplate.spec.selector#

^{^{↩ Parent}}

selector is a label query over volumes to consider for binding.

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

K0smotronControlPlaneTemplate.spec.template.spec.manifests[index].ephemeral.volumeClaimTemplate.spec.selector.matchExpressions[index]#

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

K0smotronControlPlaneTemplate.spec.template.spec.manifests[index].ephemeral.volumeClaimTemplate.metadata#

^{^{↩ Parent}}

May contain labels and annotations that will be copied into the PVC when creating it. No other fields are allowed and will be rejected during validation.

Name	Type	Required
annotations	map[string]string	false
finalizers	[]string	false
labels	map[string]string	false
name	string	false
namespace	string	false

K0smotronControlPlaneTemplate.spec.template.spec.manifests[index].fc#

^{^{↩ Parent}}

fc represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod.

Name	Type	Description	Required
fsType	string	fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. TODO: how do we prevent errors in the filesystem from compromising the machine	false
lun	integer	lun is Optional: FC target lun number Format: int32	false
readOnly	boolean	readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.	false
targetWWNs	[]string	targetWWNs is Optional: FC target worldwide names (WWNs)	false
wwids	[]string	wwids Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously.	false

K0smotronControlPlaneTemplate.spec.template.spec.manifests[index].flexVolume#

^{^{↩ Parent}}

flexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.

Name	Type	Description	Required
driver	string	driver is the name of the driver to use for this volume.	true
fsType	string	fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script.	false
options	map[string]string	options is Optional: this field holds extra command options if any.	false
readOnly	boolean	readOnly is Optional: defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.	false
secretRef	object	secretRef is Optional: secretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts.	false

K0smotronControlPlaneTemplate.spec.template.spec.manifests[index].flexVolume.secretRef#

^{^{↩ Parent}}

secretRef is Optional: secretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts.

Name	Type	Description	Required
name	string	Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. TODO: Add other useful fields. apiVersion, kind, uid? 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. Default:	false

K0smotronControlPlaneTemplate.spec.template.spec.manifests[index].flocker#

^{^{↩ Parent}}

flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running

Name	Type	Description	Required
datasetName	string	datasetName is Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecated	false
datasetUUID	string	datasetUUID is the UUID of the dataset. This is unique identifier of a Flocker dataset	false

K0smotronControlPlaneTemplate.spec.template.spec.manifests[index].gcePersistentDisk#

^{^{↩ Parent}}

gcePersistentDisk represents a GCE Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk

Name	Type	Description	Required
pdName	string	pdName is unique name of the PD resource in GCE. Used to identify the disk in GCE. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk	true
fsType	string	fsType is filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk TODO: how do we prevent errors in the filesystem from compromising the machine	false
partition	integer	partition is the partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk Format: int32	false
readOnly	boolean	readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk	false

K0smotronControlPlaneTemplate.spec.template.spec.manifests[index].gitRepo#

^{^{↩ Parent}}

gitRepo represents a git repository at a particular revision. DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod's container.

Name	Type	Description	Required
repository	string	repository is the URL	true
directory	string	directory is the target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name.	false
revision	string	revision is the commit hash for the specified revision.	false

K0smotronControlPlaneTemplate.spec.template.spec.manifests[index].glusterfs#

^{^{↩ Parent}}

glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/glusterfs/README.md

Name	Type	Description	Required
endpoints	string	endpoints is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod	true
path	string	path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod	true
readOnly	boolean	readOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod	false

K0smotronControlPlaneTemplate.spec.template.spec.manifests[index].hostPath#

^{^{↩ Parent}}

hostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath

TODO(jonesdl) We need to restrict who can use host directory mounts and who can/can not mount host directories as read/write.

Name	Type	Description	Required
path	string	path of the directory on the host. If the path is a symlink, it will follow the link to the real path. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath	true
type	string	type for HostPath Volume Defaults to "" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath	false

K0smotronControlPlaneTemplate.spec.template.spec.manifests[index].iscsi#

^{^{↩ Parent}}

iscsi represents an ISCSI Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://examples.k8s.io/volumes/iscsi/README.md

Name	Type	Description	Required
iqn	string	iqn is the target iSCSI Qualified Name.	true
lun	integer	lun represents iSCSI Target Lun number. Format: int32	true
targetPortal	string	targetPortal is iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).	true
chapAuthDiscovery	boolean	chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication	false
chapAuthSession	boolean	chapAuthSession defines whether support iSCSI Session CHAP authentication	false
fsType	string	fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi TODO: how do we prevent errors in the filesystem from compromising the machine	false
initiatorName	string	initiatorName is the custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface : will be created for the connection.	false
iscsiInterface	string	iscsiInterface is the interface Name that uses an iSCSI transport. Defaults to 'default' (tcp).	false
portals	[]string	portals is the iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).	false
readOnly	boolean	readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.	false
secretRef	object	secretRef is the CHAP Secret for iSCSI target and initiator authentication	false

K0smotronControlPlaneTemplate.spec.template.spec.manifests[index].iscsi.secretRef#

^{^{↩ Parent}}

secretRef is the CHAP Secret for iSCSI target and initiator authentication

Name	Type	Description	Required
name	string	Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. TODO: Add other useful fields. apiVersion, kind, uid? 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. Default:	false

K0smotronControlPlaneTemplate.spec.template.spec.manifests[index].nfs#

^{^{↩ Parent}}

nfs represents an NFS mount on the host that shares a pod's lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

Name	Type	Description	Required
path	string	path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs	true
server	string	server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs	true
readOnly	boolean	readOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs	false

K0smotronControlPlaneTemplate.spec.template.spec.manifests[index].persistentVolumeClaim#

^{^{↩ Parent}}

persistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

Name	Type	Description	Required
claimName	string	claimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims	true
readOnly	boolean	readOnly Will force the ReadOnly setting in VolumeMounts. Default false.	false

K0smotronControlPlaneTemplate.spec.template.spec.manifests[index].photonPersistentDisk#

^{^{↩ Parent}}

photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine

Name	Type	Description	Required
pdID	string	pdID is the ID that identifies Photon Controller persistent disk	true
fsType	string	fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.	false

K0smotronControlPlaneTemplate.spec.template.spec.manifests[index].portworxVolume#

^{^{↩ Parent}}

portworxVolume represents a portworx volume attached and mounted on kubelets host machine

Name	Type	Description	Required
volumeID	string	volumeID uniquely identifies a Portworx volume	true
fsType	string	fSType represents the filesystem type to mount Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs". Implicitly inferred to be "ext4" if unspecified.	false
readOnly	boolean	readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.	false

K0smotronControlPlaneTemplate.spec.template.spec.manifests[index].projected#

^{^{↩ Parent}}

projected items for all in one resources secrets, configmaps, and downward API

Name	Type	Description	Required
defaultMode	integer	defaultMode are the mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false
sources	[]object	sources is the list of volume projections	false

K0smotronControlPlaneTemplate.spec.template.spec.manifests[index].projected.sources[index]#

^{^{↩ Parent}}

Projection that may be projected along with other supported volume types

Name	Type	Description	Required
clusterTrustBundle	object	ClusterTrustBundle allows a pod to access the `.spec.trustBundle` field of ClusterTrustBundle objects in an auto-updating file. Alpha, gated by the ClusterTrustBundleProjection feature gate. ClusterTrustBundle objects can either be selected by name, or by the combination of signer name and a label selector. Kubelet performs aggressive normalization of the PEM contents written into the pod filesystem. Esoteric PEM features such as inter-block comments and block headers are stripped. Certificates are deduplicated. The ordering of certificates within the file is arbitrary, and Kubelet may change the order over time.	false
configMap	object	configMap information about the configMap data to project	false
downwardAPI	object	downwardAPI information about the downwardAPI data to project	false
secret	object	secret information about the secret data to project	false
serviceAccountToken	object	serviceAccountToken is information about the serviceAccountToken data to project	false

K0smotronControlPlaneTemplate.spec.template.spec.manifests[index].projected.sources[index].clusterTrustBundle#

^{^{↩ Parent}}

ClusterTrustBundle allows a pod to access the .spec.trustBundle field of ClusterTrustBundle objects in an auto-updating file.

Alpha, gated by the ClusterTrustBundleProjection feature gate.

ClusterTrustBundle objects can either be selected by name, or by the combination of signer name and a label selector.

Kubelet performs aggressive normalization of the PEM contents written into the pod filesystem. Esoteric PEM features such as inter-block comments and block headers are stripped. Certificates are deduplicated. The ordering of certificates within the file is arbitrary, and Kubelet may change the order over time.

Name	Type	Description	Required
path	string	Relative path from the volume root to write the bundle.	true
labelSelector	object	Select all ClusterTrustBundles that match this label selector. Only has effect if signerName is set. Mutually-exclusive with name. If unset, interpreted as "match nothing". If set but empty, interpreted as "match everything".	false
name	string	Select a single ClusterTrustBundle by object name. Mutually-exclusive with signerName and labelSelector.	false
optional	boolean	If true, don't block pod startup if the referenced ClusterTrustBundle(s) aren't available. If using name, then the named ClusterTrustBundle is allowed not to exist. If using signerName, then the combination of signerName and labelSelector is allowed to match zero ClusterTrustBundles.	false
signerName	string	Select all ClusterTrustBundles that match this signer name. Mutually-exclusive with name. The contents of all selected ClusterTrustBundles will be unified and deduplicated.	false

K0smotronControlPlaneTemplate.spec.template.spec.manifests[index].projected.sources[index].clusterTrustBundle.labelSelector#

^{^{↩ Parent}}

Select all ClusterTrustBundles that match this label selector. Only has effect if signerName is set. Mutually-exclusive with name. If unset, interpreted as "match nothing". If set but empty, interpreted as "match everything".

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

K0smotronControlPlaneTemplate.spec.template.spec.manifests[index].projected.sources[index].clusterTrustBundle.labelSelector.matchExpressions[index]#

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

K0smotronControlPlaneTemplate.spec.template.spec.manifests[index].projected.sources[index].configMap#

^{^{↩ Parent}}

configMap information about the configMap data to project

Name	Type	Description	Required
items	[]object	items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.	false
name	string	Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. TODO: Add other useful fields. apiVersion, kind, uid? 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. Default:	false
optional	boolean	optional specify whether the ConfigMap or its keys must be defined	false

K0smotronControlPlaneTemplate.spec.template.spec.manifests[index].projected.sources[index].configMap.items[index]#

^{^{↩ Parent}}

Maps a string key to a path within a volume.

Name	Type	Description	Required
key	string	key is the key to project.	true
path	string	path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.	true
mode	integer	mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false

K0smotronControlPlaneTemplate.spec.template.spec.manifests[index].projected.sources[index].downwardAPI#

^{^{↩ Parent}}

downwardAPI information about the downwardAPI data to project

Name	Type	Description	Required
items	[]object	Items is a list of DownwardAPIVolume file	false

K0smotronControlPlaneTemplate.spec.template.spec.manifests[index].projected.sources[index].downwardAPI.items[index]#

^{^{↩ Parent}}

DownwardAPIVolumeFile represents information to create the file containing the pod field

Name	Type	Description	Required
path	string	Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'	true
fieldRef	object	Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported.	false
mode	integer	Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false
resourceFieldRef	object	Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.	false

K0smotronControlPlaneTemplate.spec.template.spec.manifests[index].projected.sources[index].downwardAPI.items[index].fieldRef#

^{^{↩ Parent}}

Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported.

Name	Type	Description	Required
fieldPath	string	Path of the field to select in the specified API version.	true
apiVersion	string	Version of the schema the FieldPath is written in terms of, defaults to "v1".	false

K0smotronControlPlaneTemplate.spec.template.spec.manifests[index].projected.sources[index].downwardAPI.items[index].resourceFieldRef#

^{^{↩ Parent}}

Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.

Name	Type	Description	Required
resource	string	Required: resource to select	true
containerName	string	Container name: required for volumes, optional for env vars	false
divisor	int or string	Specifies the output format of the exposed resources, defaults to "1"	false

K0smotronControlPlaneTemplate.spec.template.spec.manifests[index].projected.sources[index].secret#

^{^{↩ Parent}}

secret information about the secret data to project

Name	Type	Description	Required
items	[]object	items if unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.	false
name	string	Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. TODO: Add other useful fields. apiVersion, kind, uid? 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. Default:	false
optional	boolean	optional field specify whether the Secret or its key must be defined	false

K0smotronControlPlaneTemplate.spec.template.spec.manifests[index].projected.sources[index].secret.items[index]#

^{^{↩ Parent}}

Maps a string key to a path within a volume.

Name	Type	Description	Required
key	string	key is the key to project.	true
path	string	path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.	true
mode	integer	mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false

K0smotronControlPlaneTemplate.spec.template.spec.manifests[index].projected.sources[index].serviceAccountToken#

^{^{↩ Parent}}

serviceAccountToken is information about the serviceAccountToken data to project

Name	Type	Description	Required
path	string	path is the path relative to the mount point of the file to project the token into.	true
audience	string	audience is the intended audience of the token. A recipient of a token must identify itself with an identifier specified in the audience of the token, and otherwise should reject the token. The audience defaults to the identifier of the apiserver.	false
expirationSeconds	integer	expirationSeconds is the requested duration of validity of the service account token. As the token approaches expiration, the kubelet volume plugin will proactively rotate the service account token. The kubelet will start trying to rotate the token if the token is older than 80 percent of its time to live or if the token is older than 24 hours.Defaults to 1 hour and must be at least 10 minutes. Format: int64	false

K0smotronControlPlaneTemplate.spec.template.spec.manifests[index].quobyte#

^{^{↩ Parent}}

quobyte represents a Quobyte mount on the host that shares a pod's lifetime

Name	Type	Description	Required
registry	string	registry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumes	true
volume	string	volume is a string that references an already created Quobyte volume by name.	true
group	string	group to map volume access to Default is no group	false
readOnly	boolean	readOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false.	false
tenant	string	tenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes, value is set by the plugin	false
user	string	user to map volume access to Defaults to serivceaccount user	false

K0smotronControlPlaneTemplate.spec.template.spec.manifests[index].rbd#

^{^{↩ Parent}}

rbd represents a Rados Block Device mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/rbd/README.md

Name	Type	Description	Required
image	string	image is the rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it	true
monitors	[]string	monitors is a collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it	true
fsType	string	fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#rbd TODO: how do we prevent errors in the filesystem from compromising the machine	false
keyring	string	keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it	false
pool	string	pool is the rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it	false
readOnly	boolean	readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it	false
secretRef	object	secretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it	false
user	string	user is the rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it	false

K0smotronControlPlaneTemplate.spec.template.spec.manifests[index].rbd.secretRef#

^{^{↩ Parent}}

secretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

Name	Type	Description	Required
name	string	Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. TODO: Add other useful fields. apiVersion, kind, uid? 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. Default:	false

K0smotronControlPlaneTemplate.spec.template.spec.manifests[index].scaleIO#

^{^{↩ Parent}}

scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.

Name	Type	Description	Required
gateway	string	gateway is the host address of the ScaleIO API Gateway.	true
secretRef	object	secretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail.	true
system	string	system is the name of the storage system as configured in ScaleIO.	true
fsType	string	fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Default is "xfs".	false
protectionDomain	string	protectionDomain is the name of the ScaleIO Protection Domain for the configured storage.	false
readOnly	boolean	readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.	false
sslEnabled	boolean	sslEnabled Flag enable/disable SSL communication with Gateway, default false	false
storageMode	string	storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned.	false
storagePool	string	storagePool is the ScaleIO Storage Pool associated with the protection domain.	false
volumeName	string	volumeName is the name of a volume already created in the ScaleIO system that is associated with this volume source.	false

K0smotronControlPlaneTemplate.spec.template.spec.manifests[index].scaleIO.secretRef#

^{^{↩ Parent}}

secretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail.

Name	Type	Description	Required
name	string	Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. TODO: Add other useful fields. apiVersion, kind, uid? 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. Default:	false

K0smotronControlPlaneTemplate.spec.template.spec.manifests[index].secret#

^{^{↩ Parent}}

secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret

Name	Type	Description	Required
defaultMode	integer	defaultMode is Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false
items	[]object	items If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.	false
optional	boolean	optional field specify whether the Secret or its keys must be defined	false
secretName	string	secretName is the name of the secret in the pod's namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret	false

K0smotronControlPlaneTemplate.spec.template.spec.manifests[index].secret.items[index]#

^{^{↩ Parent}}

Maps a string key to a path within a volume.

Name	Type	Description	Required
key	string	key is the key to project.	true
path	string	path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.	true
mode	integer	mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false

K0smotronControlPlaneTemplate.spec.template.spec.manifests[index].storageos#

^{^{↩ Parent}}

storageOS represents a StorageOS volume attached and mounted on Kubernetes nodes.

Name	Type	Description	Required
fsType	string	fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.	false
readOnly	boolean	readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.	false
secretRef	object	secretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted.	false
volumeName	string	volumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace.	false
volumeNamespace	string	volumeNamespace specifies the scope of the volume within StorageOS. If no namespace is specified then the Pod's namespace will be used. This allows the Kubernetes name scoping to be mirrored within StorageOS for tighter integration. Set VolumeName to any name to override the default behaviour. Set to "default" if you are not using namespaces within StorageOS. Namespaces that do not pre-exist within StorageOS will be created.	false

K0smotronControlPlaneTemplate.spec.template.spec.manifests[index].storageos.secretRef#

^{^{↩ Parent}}

secretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted.

Name	Type	Description	Required
name	string	Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. TODO: Add other useful fields. apiVersion, kind, uid? 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. Default:	false

K0smotronControlPlaneTemplate.spec.template.spec.manifests[index].vsphereVolume#

^{^{↩ Parent}}

vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine

Name	Type	Description	Required
volumePath	string	volumePath is the path that identifies vSphere volume vmdk	true
fsType	string	fsType is filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.	false
storagePolicyID	string	storagePolicyID is the storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.	false
storagePolicyName	string	storagePolicyName is the storage Policy Based Management (SPBM) profile name.	false

K0smotronControlPlaneTemplate.spec.template.spec.monitoring#

^{^{↩ Parent}}

Monitoring defines the monitoring configuration.

Name	Type	Description	Required
enabled	boolean	Enabled enables prometheus sidecar that scrapes metrics from the child cluster system components and expose them as usual kubernetes pod metrics.	true
prometheusImage	string	PrometheusImage defines the image used for the prometheus sidecar. Default: quay.io/k0sproject/prometheus:v2.44.0	true
proxyImage	string	ProxyImage defines the image used for the nginx proxy sidecar. Default: nginx:1.19.10	true

K0smotronControlPlaneTemplate.spec.template.spec.mounts[index]#

^{^{↩ Parent}}

Name	Type	Description	Required
path	string		true
awsElasticBlockStore	object	awsElasticBlockStore represents an AWS Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore	false
azureDisk	object	azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.	false
azureFile	object	azureFile represents an Azure File Service mount on the host and bind mount to the pod.	false
cephfs	object	cephFS represents a Ceph FS mount on the host that shares a pod's lifetime	false
cinder	object	cinder represents a cinder volume attached and mounted on kubelets host machine. More info: https://examples.k8s.io/mysql-cinder-pd/README.md	false
configMap	object	configMap represents a configMap that should populate this volume	false
csi	object	csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature).	false
downwardAPI	object	downwardAPI represents downward API about the pod that should populate this volume	false
emptyDir	object	emptyDir represents a temporary directory that shares a pod's lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir	false
ephemeral	object	ephemeral represents a volume that is handled by a cluster storage driver. The volume's lifecycle is tied to the pod that defines it - it will be created before the pod starts, and deleted when the pod is removed. Use this if: a) the volume is only needed while the pod runs, b) features of normal volumes like restoring from snapshot or capacity tracking are needed, c) the storage driver is specified through a storage class, and d) the storage driver supports dynamic volume provisioning through a PersistentVolumeClaim (see EphemeralVolumeSource for more information on the connection between this volume type and PersistentVolumeClaim). Use PersistentVolumeClaim or one of the vendor-specific APIs for volumes that persist for longer than the lifecycle of an individual pod. Use CSI for light-weight local ephemeral volumes if the CSI driver is meant to be used that way - see the documentation of the driver for more information. A pod can use both types of ephemeral volumes and persistent volumes at the same time.	false
fc	object	fc represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod.	false
flexVolume	object	flexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.	false
flocker	object	flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running	false
gcePersistentDisk	object	gcePersistentDisk represents a GCE Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk	false
gitRepo	object	gitRepo represents a git repository at a particular revision. DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod's container.	false
glusterfs	object	glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/glusterfs/README.md	false
hostPath	object	hostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath --- TODO(jonesdl) We need to restrict who can use host directory mounts and who can/can not mount host directories as read/write.	false
iscsi	object	iscsi represents an ISCSI Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://examples.k8s.io/volumes/iscsi/README.md	false
nfs	object	nfs represents an NFS mount on the host that shares a pod's lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs	false
persistentVolumeClaim	object	persistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims	false
photonPersistentDisk	object	photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine	false
portworxVolume	object	portworxVolume represents a portworx volume attached and mounted on kubelets host machine	false
projected	object	projected items for all in one resources secrets, configmaps, and downward API	false
quobyte	object	quobyte represents a Quobyte mount on the host that shares a pod's lifetime	false
rbd	object	rbd represents a Rados Block Device mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/rbd/README.md	false
readOnly	boolean	ReadOnly specifies whether the volume should be mounted as read-only. (default: false, except for ConfigMaps and Secrets)	false
scaleIO	object	scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.	false
secret	object	secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret	false
storageos	object	storageOS represents a StorageOS volume attached and mounted on Kubernetes nodes.	false
vsphereVolume	object	vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine	false

K0smotronControlPlaneTemplate.spec.template.spec.mounts[index].awsElasticBlockStore#

^{^{↩ Parent}}

awsElasticBlockStore represents an AWS Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore

Name	Type	Description	Required
volumeID	string	volumeID is unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore	true
fsType	string	fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore TODO: how do we prevent errors in the filesystem from compromising the machine	false
partition	integer	partition is the partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). Format: int32	false
readOnly	boolean	readOnly value true will force the readOnly setting in VolumeMounts. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore	false

K0smotronControlPlaneTemplate.spec.template.spec.mounts[index].azureDisk#

^{^{↩ Parent}}

azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.

Name	Type	Description	Required
diskName	string	diskName is the Name of the data disk in the blob storage	true
diskURI	string	diskURI is the URI of data disk in the blob storage	true
cachingMode	string	cachingMode is the Host Caching mode: None, Read Only, Read Write.	false
fsType	string	fsType is Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.	false
kind	string	kind expected values are Shared: multiple blob disks per storage account Dedicated: single blob disk per storage account Managed: azure managed data disk (only in managed availability set). defaults to shared	false
readOnly	boolean	readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.	false

K0smotronControlPlaneTemplate.spec.template.spec.mounts[index].azureFile#

^{^{↩ Parent}}

azureFile represents an Azure File Service mount on the host and bind mount to the pod.

Name	Type	Description	Required
secretName	string	secretName is the name of secret that contains Azure Storage Account Name and Key	true
shareName	string	shareName is the azure share Name	true
readOnly	boolean	readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.	false

K0smotronControlPlaneTemplate.spec.template.spec.mounts[index].cephfs#

^{^{↩ Parent}}

cephFS represents a Ceph FS mount on the host that shares a pod's lifetime

Name	Type	Description	Required
monitors	[]string	monitors is Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it	true
path	string	path is Optional: Used as the mounted root, rather than the full Ceph tree, default is /	false
readOnly	boolean	readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it	false
secretFile	string	secretFile is Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it	false
secretRef	object	secretRef is Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it	false
user	string	user is optional: User is the rados user name, default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it	false

K0smotronControlPlaneTemplate.spec.template.spec.mounts[index].cephfs.secretRef#

^{^{↩ Parent}}

secretRef is Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it

Name	Type	Description	Required
name	string	Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. TODO: Add other useful fields. apiVersion, kind, uid? 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. Default:	false

K0smotronControlPlaneTemplate.spec.template.spec.mounts[index].cinder#

^{^{↩ Parent}}

cinder represents a cinder volume attached and mounted on kubelets host machine. More info: https://examples.k8s.io/mysql-cinder-pd/README.md

Name	Type	Description	Required
volumeID	string	volumeID used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md	true
fsType	string	fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://examples.k8s.io/mysql-cinder-pd/README.md	false
readOnly	boolean	readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/mysql-cinder-pd/README.md	false
secretRef	object	secretRef is optional: points to a secret object containing parameters used to connect to OpenStack.	false

K0smotronControlPlaneTemplate.spec.template.spec.mounts[index].cinder.secretRef#

^{^{↩ Parent}}

secretRef is optional: points to a secret object containing parameters used to connect to OpenStack.

Name	Type	Description	Required
name	string	Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. TODO: Add other useful fields. apiVersion, kind, uid? 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. Default:	false

K0smotronControlPlaneTemplate.spec.template.spec.mounts[index].configMap#

^{^{↩ Parent}}

configMap represents a configMap that should populate this volume

Name	Type	Description	Required
defaultMode	integer	defaultMode is optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false
items	[]object	items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.	false
name	string	Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. TODO: Add other useful fields. apiVersion, kind, uid? 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. Default:	false
optional	boolean	optional specify whether the ConfigMap or its keys must be defined	false

K0smotronControlPlaneTemplate.spec.template.spec.mounts[index].configMap.items[index]#

^{^{↩ Parent}}

Maps a string key to a path within a volume.

Name	Type	Description	Required
key	string	key is the key to project.	true
path	string	path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.	true
mode	integer	mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false

K0smotronControlPlaneTemplate.spec.template.spec.mounts[index].csi#

^{^{↩ Parent}}

csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature).

Name	Type	Description	Required
driver	string	driver is the name of the CSI driver that handles this volume. Consult with your admin for the correct name as registered in the cluster.	true
fsType	string	fsType to mount. Ex. "ext4", "xfs", "ntfs". If not provided, the empty value is passed to the associated CSI driver which will determine the default filesystem to apply.	false
nodePublishSecretRef	object	nodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secret references are passed.	false
readOnly	boolean	readOnly specifies a read-only configuration for the volume. Defaults to false (read/write).	false
volumeAttributes	map[string]string	volumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver's documentation for supported values.	false

K0smotronControlPlaneTemplate.spec.template.spec.mounts[index].csi.nodePublishSecretRef#

^{^{↩ Parent}}

nodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secret references are passed.

Name	Type	Description	Required
name	string	Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. TODO: Add other useful fields. apiVersion, kind, uid? 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. Default:	false

K0smotronControlPlaneTemplate.spec.template.spec.mounts[index].downwardAPI#

^{^{↩ Parent}}

downwardAPI represents downward API about the pod that should populate this volume

Name	Type	Description	Required
defaultMode	integer	Optional: mode bits to use on created files by default. Must be a Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false
items	[]object	Items is a list of downward API volume file	false

K0smotronControlPlaneTemplate.spec.template.spec.mounts[index].downwardAPI.items[index]#

^{^{↩ Parent}}

DownwardAPIVolumeFile represents information to create the file containing the pod field

Name	Type	Description	Required
path	string	Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'	true
fieldRef	object	Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported.	false
mode	integer	Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false
resourceFieldRef	object	Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.	false

K0smotronControlPlaneTemplate.spec.template.spec.mounts[index].downwardAPI.items[index].fieldRef#

^{^{↩ Parent}}

Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported.

Name	Type	Description	Required
fieldPath	string	Path of the field to select in the specified API version.	true
apiVersion	string	Version of the schema the FieldPath is written in terms of, defaults to "v1".	false

K0smotronControlPlaneTemplate.spec.template.spec.mounts[index].downwardAPI.items[index].resourceFieldRef#

^{^{↩ Parent}}

Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.

Name	Type	Description	Required
resource	string	Required: resource to select	true
containerName	string	Container name: required for volumes, optional for env vars	false
divisor	int or string	Specifies the output format of the exposed resources, defaults to "1"	false

K0smotronControlPlaneTemplate.spec.template.spec.mounts[index].emptyDir#

^{^{↩ Parent}}

emptyDir represents a temporary directory that shares a pod's lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir

Name	Type	Description	Required
medium	string	medium represents what type of storage medium should back this directory. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir	false
sizeLimit	int or string	sizeLimit is the total amount of local storage required for this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers in a pod. The default is nil which means that the limit is undefined. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir	false

K0smotronControlPlaneTemplate.spec.template.spec.mounts[index].ephemeral#

^{^{↩ Parent}}

ephemeral represents a volume that is handled by a cluster storage driver. The volume's lifecycle is tied to the pod that defines it - it will be created before the pod starts, and deleted when the pod is removed.

Use this if: a) the volume is only needed while the pod runs, b) features of normal volumes like restoring from snapshot or capacity tracking are needed, c) the storage driver is specified through a storage class, and d) the storage driver supports dynamic volume provisioning through a PersistentVolumeClaim (see EphemeralVolumeSource for more information on the connection between this volume type and PersistentVolumeClaim).

Use PersistentVolumeClaim or one of the vendor-specific APIs for volumes that persist for longer than the lifecycle of an individual pod.

Use CSI for light-weight local ephemeral volumes if the CSI driver is meant to be used that way - see the documentation of the driver for more information.

A pod can use both types of ephemeral volumes and persistent volumes at the same time.

Name	Type	Description	Required
volumeClaimTemplate	object	Will be used to create a stand-alone PVC to provision the volume. The pod in which this EphemeralVolumeSource is embedded will be the owner of the PVC, i.e. the PVC will be deleted together with the pod. The name of the PVC will be `-` where `` is the name from the `PodSpec.Volumes` array entry. Pod validation will reject the pod if the concatenated name is not valid for a PVC (for example, too long). An existing PVC with that name that is not owned by the pod will not be used for the pod to avoid using an unrelated volume by mistake. Starting the pod is then blocked until the unrelated PVC is removed. If such a pre-created PVC is meant to be used by the pod, the PVC has to updated with an owner reference to the pod once the pod exists. Normally this should not be necessary, but it may be useful when manually reconstructing a broken cluster. This field is read-only and no changes will be made by Kubernetes to the PVC after it has been created. Required, must not be nil.	false

K0smotronControlPlaneTemplate.spec.template.spec.mounts[index].ephemeral.volumeClaimTemplate#

^{^{↩ Parent}}

Will be used to create a stand-alone PVC to provision the volume. The pod in which this EphemeralVolumeSource is embedded will be the owner of the PVC, i.e. the PVC will be deleted together with the pod. The name of the PVC will be <pod name>-<volume name> where <volume name> is the name from the PodSpec.Volumes array entry. Pod validation will reject the pod if the concatenated name is not valid for a PVC (for example, too long).

An existing PVC with that name that is not owned by the pod will not be used for the pod to avoid using an unrelated volume by mistake. Starting the pod is then blocked until the unrelated PVC is removed. If such a pre-created PVC is meant to be used by the pod, the PVC has to updated with an owner reference to the pod once the pod exists. Normally this should not be necessary, but it may be useful when manually reconstructing a broken cluster.

This field is read-only and no changes will be made by Kubernetes to the PVC after it has been created.

Required, must not be nil.

Name	Type	Description	Required
spec	object	The specification for the PersistentVolumeClaim. The entire content is copied unchanged into the PVC that gets created from this template. The same fields as in a PersistentVolumeClaim are also valid here.	true
metadata	object	May contain labels and annotations that will be copied into the PVC when creating it. No other fields are allowed and will be rejected during validation.	false

K0smotronControlPlaneTemplate.spec.template.spec.mounts[index].ephemeral.volumeClaimTemplate.spec#

^{^{↩ Parent}}

The specification for the PersistentVolumeClaim. The entire content is copied unchanged into the PVC that gets created from this template. The same fields as in a PersistentVolumeClaim are also valid here.

Name	Type	Description	Required
accessModes	[]string	accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1	false
dataSource	object	dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. If the namespace is specified, then dataSourceRef will not be copied to dataSource.	false
dataSourceRef	object	dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the dataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, when namespace isn't specified in dataSourceRef, both fields (dataSource and dataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. When namespace is specified in dataSourceRef, dataSource isn't set to the same value and must be empty. There are three important differences between dataSource and dataSourceRef: * While dataSource only allows two specific types of objects, dataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While dataSource ignores disallowed values (dropping them), dataSourceRef preserves all values, and generates an error if a disallowed value is specified. * While dataSource only allows local objects, dataSourceRef allows objects in any namespaces. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.	false
resources	object	resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources	false
selector	object	selector is a label query over volumes to consider for binding.	false
storageClassName	string	storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1	false
volumeAttributesClassName	string	volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim. If specified, the CSI driver will create or update the volume with the attributes defined in the corresponding VolumeAttributesClass. This has a different purpose than storageClassName, it can be changed after the claim is created. An empty string 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/ (Alpha) Using this field requires the VolumeAttributesClass feature gate to be enabled.	false
volumeMode	string	volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.	false
volumeName	string	volumeName is the binding reference to the PersistentVolume backing this claim.	false

K0smotronControlPlaneTemplate.spec.template.spec.mounts[index].ephemeral.volumeClaimTemplate.spec.dataSource#

^{^{↩ Parent}}

dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. If the namespace is specified, then dataSourceRef will not be copied to dataSource.

Name	Type	Description	Required
kind	string	Kind is the type of resource being referenced	true
name	string	Name is the name of resource being referenced	true
apiGroup	string	APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.	false

K0smotronControlPlaneTemplate.spec.template.spec.mounts[index].ephemeral.volumeClaimTemplate.spec.dataSourceRef#

^{^{↩ Parent}}

dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the dataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, when namespace isn't specified in dataSourceRef, both fields (dataSource and dataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. When namespace is specified in dataSourceRef, dataSource isn't set to the same value and must be empty. There are three important differences between dataSource and dataSourceRef: * While dataSource only allows two specific types of objects, dataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While dataSource ignores disallowed values (dropping them), dataSourceRef preserves all values, and generates an error if a disallowed value is specified. * While dataSource only allows local objects, dataSourceRef allows objects in any namespaces. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.

Name	Type	Description	Required
kind	string	Kind is the type of resource being referenced	true
name	string	Name is the name of resource being referenced	true
apiGroup	string	APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.	false
namespace	string	Namespace is the namespace of resource being referenced Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. (Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.	false

K0smotronControlPlaneTemplate.spec.template.spec.mounts[index].ephemeral.volumeClaimTemplate.spec.resources#

^{^{↩ Parent}}

resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources

Name	Type	Description	Required
limits	map[string]int or string	Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/	false
requests	map[string]int or string	Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/	false

K0smotronControlPlaneTemplate.spec.template.spec.mounts[index].ephemeral.volumeClaimTemplate.spec.selector#

^{^{↩ Parent}}

selector is a label query over volumes to consider for binding.

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

K0smotronControlPlaneTemplate.spec.template.spec.mounts[index].ephemeral.volumeClaimTemplate.spec.selector.matchExpressions[index]#

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

K0smotronControlPlaneTemplate.spec.template.spec.mounts[index].ephemeral.volumeClaimTemplate.metadata#

^{^{↩ Parent}}

May contain labels and annotations that will be copied into the PVC when creating it. No other fields are allowed and will be rejected during validation.

Name	Type	Required
annotations	map[string]string	false
finalizers	[]string	false
labels	map[string]string	false
name	string	false
namespace	string	false

K0smotronControlPlaneTemplate.spec.template.spec.mounts[index].fc#

^{^{↩ Parent}}

fc represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod.

Name	Type	Description	Required
fsType	string	fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. TODO: how do we prevent errors in the filesystem from compromising the machine	false
lun	integer	lun is Optional: FC target lun number Format: int32	false
readOnly	boolean	readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.	false
targetWWNs	[]string	targetWWNs is Optional: FC target worldwide names (WWNs)	false
wwids	[]string	wwids Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously.	false

K0smotronControlPlaneTemplate.spec.template.spec.mounts[index].flexVolume#

^{^{↩ Parent}}

flexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.

Name	Type	Description	Required
driver	string	driver is the name of the driver to use for this volume.	true
fsType	string	fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script.	false
options	map[string]string	options is Optional: this field holds extra command options if any.	false
readOnly	boolean	readOnly is Optional: defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.	false
secretRef	object	secretRef is Optional: secretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts.	false

K0smotronControlPlaneTemplate.spec.template.spec.mounts[index].flexVolume.secretRef#

^{^{↩ Parent}}

secretRef is Optional: secretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts.

Name	Type	Description	Required
name	string	Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. TODO: Add other useful fields. apiVersion, kind, uid? 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. Default:	false

K0smotronControlPlaneTemplate.spec.template.spec.mounts[index].flocker#

^{^{↩ Parent}}

flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running

Name	Type	Description	Required
datasetName	string	datasetName is Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecated	false
datasetUUID	string	datasetUUID is the UUID of the dataset. This is unique identifier of a Flocker dataset	false

K0smotronControlPlaneTemplate.spec.template.spec.mounts[index].gcePersistentDisk#

^{^{↩ Parent}}

gcePersistentDisk represents a GCE Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk

Name	Type	Description	Required
pdName	string	pdName is unique name of the PD resource in GCE. Used to identify the disk in GCE. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk	true
fsType	string	fsType is filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk TODO: how do we prevent errors in the filesystem from compromising the machine	false
partition	integer	partition is the partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk Format: int32	false
readOnly	boolean	readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk	false

K0smotronControlPlaneTemplate.spec.template.spec.mounts[index].gitRepo#

^{^{↩ Parent}}

gitRepo represents a git repository at a particular revision. DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod's container.

Name	Type	Description	Required
repository	string	repository is the URL	true
directory	string	directory is the target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name.	false
revision	string	revision is the commit hash for the specified revision.	false

K0smotronControlPlaneTemplate.spec.template.spec.mounts[index].glusterfs#

^{^{↩ Parent}}

glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/glusterfs/README.md

Name	Type	Description	Required
endpoints	string	endpoints is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod	true
path	string	path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod	true
readOnly	boolean	readOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod	false

K0smotronControlPlaneTemplate.spec.template.spec.mounts[index].hostPath#

^{^{↩ Parent}}

hostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath

TODO(jonesdl) We need to restrict who can use host directory mounts and who can/can not mount host directories as read/write.

Name	Type	Description	Required
path	string	path of the directory on the host. If the path is a symlink, it will follow the link to the real path. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath	true
type	string	type for HostPath Volume Defaults to "" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath	false

K0smotronControlPlaneTemplate.spec.template.spec.mounts[index].iscsi#

^{^{↩ Parent}}

iscsi represents an ISCSI Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://examples.k8s.io/volumes/iscsi/README.md

Name	Type	Description	Required
iqn	string	iqn is the target iSCSI Qualified Name.	true
lun	integer	lun represents iSCSI Target Lun number. Format: int32	true
targetPortal	string	targetPortal is iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).	true
chapAuthDiscovery	boolean	chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication	false
chapAuthSession	boolean	chapAuthSession defines whether support iSCSI Session CHAP authentication	false
fsType	string	fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi TODO: how do we prevent errors in the filesystem from compromising the machine	false
initiatorName	string	initiatorName is the custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface : will be created for the connection.	false
iscsiInterface	string	iscsiInterface is the interface Name that uses an iSCSI transport. Defaults to 'default' (tcp).	false
portals	[]string	portals is the iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).	false
readOnly	boolean	readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.	false
secretRef	object	secretRef is the CHAP Secret for iSCSI target and initiator authentication	false

K0smotronControlPlaneTemplate.spec.template.spec.mounts[index].iscsi.secretRef#

^{^{↩ Parent}}

secretRef is the CHAP Secret for iSCSI target and initiator authentication

Name	Type	Description	Required
name	string	Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. TODO: Add other useful fields. apiVersion, kind, uid? 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. Default:	false

K0smotronControlPlaneTemplate.spec.template.spec.mounts[index].nfs#

^{^{↩ Parent}}

nfs represents an NFS mount on the host that shares a pod's lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

Name	Type	Description	Required
path	string	path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs	true
server	string	server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs	true
readOnly	boolean	readOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs	false

K0smotronControlPlaneTemplate.spec.template.spec.mounts[index].persistentVolumeClaim#

^{^{↩ Parent}}

persistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

Name	Type	Description	Required
claimName	string	claimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims	true
readOnly	boolean	readOnly Will force the ReadOnly setting in VolumeMounts. Default false.	false

K0smotronControlPlaneTemplate.spec.template.spec.mounts[index].photonPersistentDisk#

^{^{↩ Parent}}

photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine

Name	Type	Description	Required
pdID	string	pdID is the ID that identifies Photon Controller persistent disk	true
fsType	string	fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.	false

K0smotronControlPlaneTemplate.spec.template.spec.mounts[index].portworxVolume#

^{^{↩ Parent}}

portworxVolume represents a portworx volume attached and mounted on kubelets host machine

Name	Type	Description	Required
volumeID	string	volumeID uniquely identifies a Portworx volume	true
fsType	string	fSType represents the filesystem type to mount Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs". Implicitly inferred to be "ext4" if unspecified.	false
readOnly	boolean	readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.	false

K0smotronControlPlaneTemplate.spec.template.spec.mounts[index].projected#

^{^{↩ Parent}}

projected items for all in one resources secrets, configmaps, and downward API

Name	Type	Description	Required
defaultMode	integer	defaultMode are the mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false
sources	[]object	sources is the list of volume projections	false

K0smotronControlPlaneTemplate.spec.template.spec.mounts[index].projected.sources[index]#

^{^{↩ Parent}}

Projection that may be projected along with other supported volume types

Name	Type	Description	Required
clusterTrustBundle	object	ClusterTrustBundle allows a pod to access the `.spec.trustBundle` field of ClusterTrustBundle objects in an auto-updating file. Alpha, gated by the ClusterTrustBundleProjection feature gate. ClusterTrustBundle objects can either be selected by name, or by the combination of signer name and a label selector. Kubelet performs aggressive normalization of the PEM contents written into the pod filesystem. Esoteric PEM features such as inter-block comments and block headers are stripped. Certificates are deduplicated. The ordering of certificates within the file is arbitrary, and Kubelet may change the order over time.	false
configMap	object	configMap information about the configMap data to project	false
downwardAPI	object	downwardAPI information about the downwardAPI data to project	false
secret	object	secret information about the secret data to project	false
serviceAccountToken	object	serviceAccountToken is information about the serviceAccountToken data to project	false

K0smotronControlPlaneTemplate.spec.template.spec.mounts[index].projected.sources[index].clusterTrustBundle#

^{^{↩ Parent}}

ClusterTrustBundle allows a pod to access the .spec.trustBundle field of ClusterTrustBundle objects in an auto-updating file.

Alpha, gated by the ClusterTrustBundleProjection feature gate.

ClusterTrustBundle objects can either be selected by name, or by the combination of signer name and a label selector.

Kubelet performs aggressive normalization of the PEM contents written into the pod filesystem. Esoteric PEM features such as inter-block comments and block headers are stripped. Certificates are deduplicated. The ordering of certificates within the file is arbitrary, and Kubelet may change the order over time.

Name	Type	Description	Required
path	string	Relative path from the volume root to write the bundle.	true
labelSelector	object	Select all ClusterTrustBundles that match this label selector. Only has effect if signerName is set. Mutually-exclusive with name. If unset, interpreted as "match nothing". If set but empty, interpreted as "match everything".	false
name	string	Select a single ClusterTrustBundle by object name. Mutually-exclusive with signerName and labelSelector.	false
optional	boolean	If true, don't block pod startup if the referenced ClusterTrustBundle(s) aren't available. If using name, then the named ClusterTrustBundle is allowed not to exist. If using signerName, then the combination of signerName and labelSelector is allowed to match zero ClusterTrustBundles.	false
signerName	string	Select all ClusterTrustBundles that match this signer name. Mutually-exclusive with name. The contents of all selected ClusterTrustBundles will be unified and deduplicated.	false

K0smotronControlPlaneTemplate.spec.template.spec.mounts[index].projected.sources[index].clusterTrustBundle.labelSelector#

^{^{↩ Parent}}

Select all ClusterTrustBundles that match this label selector. Only has effect if signerName is set. Mutually-exclusive with name. If unset, interpreted as "match nothing". If set but empty, interpreted as "match everything".

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

K0smotronControlPlaneTemplate.spec.template.spec.mounts[index].projected.sources[index].clusterTrustBundle.labelSelector.matchExpressions[index]#

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

K0smotronControlPlaneTemplate.spec.template.spec.mounts[index].projected.sources[index].configMap#

^{^{↩ Parent}}

configMap information about the configMap data to project

Name	Type	Description	Required
items	[]object	items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.	false
name	string	Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. TODO: Add other useful fields. apiVersion, kind, uid? 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. Default:	false
optional	boolean	optional specify whether the ConfigMap or its keys must be defined	false

K0smotronControlPlaneTemplate.spec.template.spec.mounts[index].projected.sources[index].configMap.items[index]#

^{^{↩ Parent}}

Maps a string key to a path within a volume.

Name	Type	Description	Required
key	string	key is the key to project.	true
path	string	path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.	true
mode	integer	mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false

K0smotronControlPlaneTemplate.spec.template.spec.mounts[index].projected.sources[index].downwardAPI#

^{^{↩ Parent}}

downwardAPI information about the downwardAPI data to project

Name	Type	Description	Required
items	[]object	Items is a list of DownwardAPIVolume file	false

K0smotronControlPlaneTemplate.spec.template.spec.mounts[index].projected.sources[index].downwardAPI.items[index]#

^{^{↩ Parent}}

DownwardAPIVolumeFile represents information to create the file containing the pod field

Name	Type	Description	Required
path	string	Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'	true
fieldRef	object	Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported.	false
mode	integer	Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false
resourceFieldRef	object	Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.	false

K0smotronControlPlaneTemplate.spec.template.spec.mounts[index].projected.sources[index].downwardAPI.items[index].fieldRef#

^{^{↩ Parent}}

Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported.

Name	Type	Description	Required
fieldPath	string	Path of the field to select in the specified API version.	true
apiVersion	string	Version of the schema the FieldPath is written in terms of, defaults to "v1".	false

K0smotronControlPlaneTemplate.spec.template.spec.mounts[index].projected.sources[index].downwardAPI.items[index].resourceFieldRef#

^{^{↩ Parent}}

Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.

Name	Type	Description	Required
resource	string	Required: resource to select	true
containerName	string	Container name: required for volumes, optional for env vars	false
divisor	int or string	Specifies the output format of the exposed resources, defaults to "1"	false

K0smotronControlPlaneTemplate.spec.template.spec.mounts[index].projected.sources[index].secret#

^{^{↩ Parent}}

secret information about the secret data to project

Name	Type	Description	Required
items	[]object	items if unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.	false
name	string	Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. TODO: Add other useful fields. apiVersion, kind, uid? 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. Default:	false
optional	boolean	optional field specify whether the Secret or its key must be defined	false

K0smotronControlPlaneTemplate.spec.template.spec.mounts[index].projected.sources[index].secret.items[index]#

^{^{↩ Parent}}

Maps a string key to a path within a volume.

Name	Type	Description	Required
key	string	key is the key to project.	true
path	string	path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.	true
mode	integer	mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false

K0smotronControlPlaneTemplate.spec.template.spec.mounts[index].projected.sources[index].serviceAccountToken#

^{^{↩ Parent}}

serviceAccountToken is information about the serviceAccountToken data to project

Name	Type	Description	Required
path	string	path is the path relative to the mount point of the file to project the token into.	true
audience	string	audience is the intended audience of the token. A recipient of a token must identify itself with an identifier specified in the audience of the token, and otherwise should reject the token. The audience defaults to the identifier of the apiserver.	false
expirationSeconds	integer	expirationSeconds is the requested duration of validity of the service account token. As the token approaches expiration, the kubelet volume plugin will proactively rotate the service account token. The kubelet will start trying to rotate the token if the token is older than 80 percent of its time to live or if the token is older than 24 hours.Defaults to 1 hour and must be at least 10 minutes. Format: int64	false

K0smotronControlPlaneTemplate.spec.template.spec.mounts[index].quobyte#

^{^{↩ Parent}}

quobyte represents a Quobyte mount on the host that shares a pod's lifetime

Name	Type	Description	Required
registry	string	registry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumes	true
volume	string	volume is a string that references an already created Quobyte volume by name.	true
group	string	group to map volume access to Default is no group	false
readOnly	boolean	readOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false.	false
tenant	string	tenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes, value is set by the plugin	false
user	string	user to map volume access to Defaults to serivceaccount user	false

K0smotronControlPlaneTemplate.spec.template.spec.mounts[index].rbd#

^{^{↩ Parent}}

rbd represents a Rados Block Device mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/rbd/README.md

Name	Type	Description	Required
image	string	image is the rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it	true
monitors	[]string	monitors is a collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it	true
fsType	string	fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#rbd TODO: how do we prevent errors in the filesystem from compromising the machine	false
keyring	string	keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it	false
pool	string	pool is the rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it	false
readOnly	boolean	readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it	false
secretRef	object	secretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it	false
user	string	user is the rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it	false

K0smotronControlPlaneTemplate.spec.template.spec.mounts[index].rbd.secretRef#

^{^{↩ Parent}}

secretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

Name	Type	Description	Required
name	string	Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. TODO: Add other useful fields. apiVersion, kind, uid? 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. Default:	false

K0smotronControlPlaneTemplate.spec.template.spec.mounts[index].scaleIO#

^{^{↩ Parent}}

scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.

Name	Type	Description	Required
gateway	string	gateway is the host address of the ScaleIO API Gateway.	true
secretRef	object	secretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail.	true
system	string	system is the name of the storage system as configured in ScaleIO.	true
fsType	string	fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Default is "xfs".	false
protectionDomain	string	protectionDomain is the name of the ScaleIO Protection Domain for the configured storage.	false
readOnly	boolean	readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.	false
sslEnabled	boolean	sslEnabled Flag enable/disable SSL communication with Gateway, default false	false
storageMode	string	storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned.	false
storagePool	string	storagePool is the ScaleIO Storage Pool associated with the protection domain.	false
volumeName	string	volumeName is the name of a volume already created in the ScaleIO system that is associated with this volume source.	false

K0smotronControlPlaneTemplate.spec.template.spec.mounts[index].scaleIO.secretRef#

^{^{↩ Parent}}

secretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail.

Name	Type	Description	Required
name	string	Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. TODO: Add other useful fields. apiVersion, kind, uid? 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. Default:	false

K0smotronControlPlaneTemplate.spec.template.spec.mounts[index].secret#

^{^{↩ Parent}}

secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret

Name	Type	Description	Required
defaultMode	integer	defaultMode is Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false
items	[]object	items If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.	false
optional	boolean	optional field specify whether the Secret or its keys must be defined	false
secretName	string	secretName is the name of the secret in the pod's namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret	false

K0smotronControlPlaneTemplate.spec.template.spec.mounts[index].secret.items[index]#

^{^{↩ Parent}}

Maps a string key to a path within a volume.

Name	Type	Description	Required
key	string	key is the key to project.	true
path	string	path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.	true
mode	integer	mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false

K0smotronControlPlaneTemplate.spec.template.spec.mounts[index].storageos#

^{^{↩ Parent}}

storageOS represents a StorageOS volume attached and mounted on Kubernetes nodes.

Name	Type	Description	Required
fsType	string	fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.	false
readOnly	boolean	readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.	false
secretRef	object	secretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted.	false
volumeName	string	volumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace.	false
volumeNamespace	string	volumeNamespace specifies the scope of the volume within StorageOS. If no namespace is specified then the Pod's namespace will be used. This allows the Kubernetes name scoping to be mirrored within StorageOS for tighter integration. Set VolumeName to any name to override the default behaviour. Set to "default" if you are not using namespaces within StorageOS. Namespaces that do not pre-exist within StorageOS will be created.	false

K0smotronControlPlaneTemplate.spec.template.spec.mounts[index].storageos.secretRef#

^{^{↩ Parent}}

secretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted.

Name	Type	Description	Required
name	string	Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. TODO: Add other useful fields. apiVersion, kind, uid? 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. Default:	false

K0smotronControlPlaneTemplate.spec.template.spec.mounts[index].vsphereVolume#

^{^{↩ Parent}}

vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine

Name	Type	Description	Required
volumePath	string	volumePath is the path that identifies vSphere volume vmdk	true
fsType	string	fsType is filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.	false
storagePolicyID	string	storagePolicyID is the storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.	false
storagePolicyName	string	storagePolicyName is the storage Policy Based Management (SPBM) profile name.	false

K0smotronControlPlaneTemplate.spec.template.spec.persistence#

^{^{↩ Parent}}

Persistence defines the persistence configuration. If empty k0smotron will use emptyDir as a volume. See https://docs.k0smotron.io/stable/configuration/#persistence

Name	Type	Description	Required
type	string	Default: emptyDir	true
autoDeletePVCs	boolean	AutoDeletePVCs defines whether the PVC should be deleted when the cluster is deleted. Default: false	false
hostPath	string	HostPath defines the host path configuration. Will be used as is in case of .spec.persistence.type is hostPath.	false
persistentVolumeClaim	object	PersistentVolumeClaim defines the PVC configuration. Will be used as is in case of .spec.persistence.type is pvc.	false

K0smotronControlPlaneTemplate.spec.template.spec.persistence.persistentVolumeClaim#

^{^{↩ Parent}}

PersistentVolumeClaim defines the PVC configuration. Will be used as is in case of .spec.persistence.type is pvc.

Name	Type	Description	Required
apiVersion	string	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources	false
kind	string	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds	false
metadata	object	Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata	false
spec	object	spec defines the desired characteristics of a volume requested by a pod author. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims	false
status	object	status represents the current information/status of a persistent volume claim. Read-only. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims	false

K0smotronControlPlaneTemplate.spec.template.spec.persistence.persistentVolumeClaim.metadata#

^{^{↩ Parent}}

Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

Name	Type	Required
annotations	map[string]string	false
finalizers	[]string	false
labels	map[string]string	false
name	string	false
namespace	string	false

K0smotronControlPlaneTemplate.spec.template.spec.persistence.persistentVolumeClaim.spec#

^{^{↩ Parent}}

spec defines the desired characteristics of a volume requested by a pod author. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

Name	Type	Description	Required
accessModes	[]string	accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1	false
dataSource	object	dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. If the namespace is specified, then dataSourceRef will not be copied to dataSource.	false
dataSourceRef	object	dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the dataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, when namespace isn't specified in dataSourceRef, both fields (dataSource and dataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. When namespace is specified in dataSourceRef, dataSource isn't set to the same value and must be empty. There are three important differences between dataSource and dataSourceRef: * While dataSource only allows two specific types of objects, dataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While dataSource ignores disallowed values (dropping them), dataSourceRef preserves all values, and generates an error if a disallowed value is specified. * While dataSource only allows local objects, dataSourceRef allows objects in any namespaces. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.	false
resources	object	resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources	false
selector	object	selector is a label query over volumes to consider for binding.	false
storageClassName	string	storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1	false
volumeAttributesClassName	string	volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim. If specified, the CSI driver will create or update the volume with the attributes defined in the corresponding VolumeAttributesClass. This has a different purpose than storageClassName, it can be changed after the claim is created. An empty string 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/ (Alpha) Using this field requires the VolumeAttributesClass feature gate to be enabled.	false
volumeMode	string	volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.	false
volumeName	string	volumeName is the binding reference to the PersistentVolume backing this claim.	false

K0smotronControlPlaneTemplate.spec.template.spec.persistence.persistentVolumeClaim.spec.dataSource#

^{^{↩ Parent}}

dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. If the namespace is specified, then dataSourceRef will not be copied to dataSource.

Name	Type	Description	Required
kind	string	Kind is the type of resource being referenced	true
name	string	Name is the name of resource being referenced	true
apiGroup	string	APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.	false

K0smotronControlPlaneTemplate.spec.template.spec.persistence.persistentVolumeClaim.spec.dataSourceRef#

^{^{↩ Parent}}

dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the dataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, when namespace isn't specified in dataSourceRef, both fields (dataSource and dataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. When namespace is specified in dataSourceRef, dataSource isn't set to the same value and must be empty. There are three important differences between dataSource and dataSourceRef: * While dataSource only allows two specific types of objects, dataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While dataSource ignores disallowed values (dropping them), dataSourceRef preserves all values, and generates an error if a disallowed value is specified. * While dataSource only allows local objects, dataSourceRef allows objects in any namespaces. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.

Name	Type	Description	Required
kind	string	Kind is the type of resource being referenced	true
name	string	Name is the name of resource being referenced	true
apiGroup	string	APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.	false
namespace	string	Namespace is the namespace of resource being referenced Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. (Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.	false

K0smotronControlPlaneTemplate.spec.template.spec.persistence.persistentVolumeClaim.spec.resources#

^{^{↩ Parent}}

resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources

Name	Type	Description	Required
limits	map[string]int or string	Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/	false
requests	map[string]int or string	Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/	false

K0smotronControlPlaneTemplate.spec.template.spec.persistence.persistentVolumeClaim.spec.selector#

^{^{↩ Parent}}

selector is a label query over volumes to consider for binding.

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

K0smotronControlPlaneTemplate.spec.template.spec.persistence.persistentVolumeClaim.spec.selector.matchExpressions[index]#

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

K0smotronControlPlaneTemplate.spec.template.spec.persistence.persistentVolumeClaim.status#

^{^{↩ Parent}}

status represents the current information/status of a persistent volume claim. Read-only. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

Name	Type	Description	Required
accessModes	[]string	accessModes contains the actual access modes the volume backing the PVC has. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1	false
allocatedResourceStatuses	map[string]string	allocatedResourceStatuses stores status of resource being resized for the given PVC. Key names follow standard Kubernetes label syntax. Valid values are either: * Un-prefixed keys: - storage - the capacity of the volume. * Custom resources must use implementation-defined prefixed names such as "example.com/my-custom-resource" Apart from above values - keys that are unprefixed or have kubernetes.io prefix are considered reserved and hence may not be used. ClaimResourceStatus can be in any of following states: - ControllerResizeInProgress: State set when resize controller starts resizing the volume in control-plane. - ControllerResizeFailed: State set when resize has failed in resize controller with a terminal error. - NodeResizePending: State set when resize controller has finished resizing the volume but further resizing of volume is needed on the node. - NodeResizeInProgress: State set when kubelet starts resizing the volume. - NodeResizeFailed: State set when resizing has failed in kubelet with a terminal error. Transient errors don't set NodeResizeFailed. For example: if expanding a PVC for more capacity - this field can be one of the following states: - pvc.status.allocatedResourceStatus['storage'] = "ControllerResizeInProgress" - pvc.status.allocatedResourceStatus['storage'] = "ControllerResizeFailed" - pvc.status.allocatedResourceStatus['storage'] = "NodeResizePending" - pvc.status.allocatedResourceStatus['storage'] = "NodeResizeInProgress" - pvc.status.allocatedResourceStatus['storage'] = "NodeResizeFailed" When this field is not set, it means that no resize operation is in progress for the given PVC. A controller that receives PVC update with previously unknown resourceName or ClaimResourceStatus should ignore the update for the purpose it was designed. For example - a controller that only is responsible for resizing capacity of the volume, should ignore PVC updates that change other valid resources associated with PVC. This is an alpha field and requires enabling RecoverVolumeExpansionFailure feature.	false
allocatedResources	map[string]int or string	allocatedResources tracks the resources allocated to a PVC including its capacity. Key names follow standard Kubernetes label syntax. Valid values are either: * Un-prefixed keys: - storage - the capacity of the volume. * Custom resources must use implementation-defined prefixed names such as "example.com/my-custom-resource" Apart from above values - keys that are unprefixed or have kubernetes.io prefix are considered reserved and hence may not be used. Capacity reported here may be larger than the actual capacity when a volume expansion operation is requested. For storage quota, the larger value from allocatedResources and PVC.spec.resources is used. If allocatedResources is not set, PVC.spec.resources alone is used for quota calculation. If a volume expansion capacity request is lowered, allocatedResources is only lowered if there are no expansion operations in progress and if the actual volume capacity is equal or lower than the requested capacity. A controller that receives PVC update with previously unknown resourceName should ignore the update for the purpose it was designed. For example - a controller that only is responsible for resizing capacity of the volume, should ignore PVC updates that change other valid resources associated with PVC. This is an alpha field and requires enabling RecoverVolumeExpansionFailure feature.	false
capacity	map[string]int or string	capacity represents the actual resources of the underlying volume.	false
conditions	[]object	conditions is the current Condition of persistent volume claim. If underlying persistent volume is being resized then the Condition will be set to 'Resizing'.	false
currentVolumeAttributesClassName	string	currentVolumeAttributesClassName is the current name of the VolumeAttributesClass the PVC is using. When unset, there is no VolumeAttributeClass applied to this PersistentVolumeClaim This is an alpha field and requires enabling VolumeAttributesClass feature.	false
modifyVolumeStatus	object	ModifyVolumeStatus represents the status object of ControllerModifyVolume operation. When this is unset, there is no ModifyVolume operation being attempted. This is an alpha field and requires enabling VolumeAttributesClass feature.	false
phase	string	phase represents the current phase of PersistentVolumeClaim.	false

K0smotronControlPlaneTemplate.spec.template.spec.persistence.persistentVolumeClaim.status.conditions[index]#

^{^{↩ Parent}}

PersistentVolumeClaimCondition contains details about state of pvc

Name	Type	Description	Required
status	string		true
type	string	PersistentVolumeClaimConditionType is a valid value of PersistentVolumeClaimCondition.Type	true
lastProbeTime	string	lastProbeTime is the time we probed the condition. Format: date-time	false
lastTransitionTime	string	lastTransitionTime is the time the condition transitioned from one status to another. Format: date-time	false
message	string	message is the human-readable message indicating details about last transition.	false
reason	string	reason is a unique, this should be a short, machine understandable string that gives the reason for condition's last transition. If it reports "Resizing" that means the underlying persistent volume is being resized.	false

K0smotronControlPlaneTemplate.spec.template.spec.persistence.persistentVolumeClaim.status.modifyVolumeStatus#

^{^{↩ Parent}}

ModifyVolumeStatus represents the status object of ControllerModifyVolume operation. When this is unset, there is no ModifyVolume operation being attempted. This is an alpha field and requires enabling VolumeAttributesClass feature.

Name	Type	Description	Required
status	string	status is the status of the ControllerModifyVolume operation. It can be in any of following states: - Pending Pending indicates that the PersistentVolumeClaim cannot be modified due to unmet requirements, such as the specified VolumeAttributesClass not existing. - InProgress InProgress indicates that the volume is being modified. - Infeasible Infeasible indicates that the request has been rejected as invalid by the CSI driver. To resolve the error, a valid VolumeAttributesClass needs to be specified. Note: New statuses can be added in the future. Consumers should check for unknown statuses and fail appropriately.	true
targetVolumeAttributesClassName	string	targetVolumeAttributesClassName is the name of the VolumeAttributesClass the PVC currently being reconciled	false

K0smotronControlPlaneTemplate.spec.template.spec.resources#

^{^{↩ Parent}}

Resources describes the compute resource requirements for the control plane pods.

Name	Type	Description	Required
claims	[]object	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.	false
limits	map[string]int or string	Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/	false
requests	map[string]int or string	Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/	false

K0smotronControlPlaneTemplate.spec.template.spec.resources.claims[index]#

^{^{↩ Parent}}

ResourceClaim references one entry in PodSpec.ResourceClaims.

Name	Type	Description	Required
name	string	Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.	true

K0smotronControlPlaneTemplate.spec.template.spec.service#

^{^{↩ Parent}}

Service defines the service configuration.

Name	Type	Description	Required
type	enum	Service Type string describes ingress methods for a service Enum: ClusterIP, NodePort, LoadBalancer Default: ClusterIP	true
annotations	map[string]string	Annotations defines extra annotations to be added to the service.	false
apiPort	integer	APIPort defines the kubernetes API port. If empty k0smotron will pick it automatically. Default: 30443	false
konnectivityPort	integer	KonnectivityPort defines the konnectivity port. If empty k0smotron will pick it automatically. Default: 30132	false
labels	map[string]string	Labels defines extra labels to be added to the service.	false
loadBalancerClass	string	LoadBalancerClass defines the load balancer class to be used for the service. Used only when service type is LoadBalancer.	false

infrastructure.cluster.x-k8s.io/v1beta1#

Resource Types:

PooledRemoteMachine

RemoteCluster

RemoteMachine

RemoteMachineTemplate

PooledRemoteMachine#

^{^{↩ Parent}}

Name	Type	Description	Required
apiVersion	string	infrastructure.cluster.x-k8s.io/v1beta1	true
kind	string	PooledRemoteMachine	true
metadata	object	Refer to the Kubernetes API documentation for the fields of the `metadata` field.	true
spec	object		false
status	object		false

PooledRemoteMachine.spec#

^{^{↩ Parent}}

Name	Type	Description	Required
machine	object		true
pool	string		true

PooledRemoteMachine.spec.machine#

^{^{↩ Parent}}

Name	Type	Description	Required
address	string	Address is the IP address or DNS name of the remote machine.	true
sshKeyRef	object	SSHKeyRef is a reference to a secret that contains the SSH private key. The key must be placed on the secret using the key "value".	true
port	integer	Port is the SSH port of the remote machine. Default: 22	false
user	string	User is the user to use when connecting to the remote machine. Default: root	false

PooledRemoteMachine.spec.machine.sshKeyRef#

^{^{↩ Parent}}

SSHKeyRef is a reference to a secret that contains the SSH private key. The key must be placed on the secret using the key "value".

Name	Type	Description	Required
name	string	Name is the name of the secret.	true

PooledRemoteMachine.status#

^{^{↩ Parent}}

Name	Type	Description	Required
machineRef	object		true
reserved	boolean		true

PooledRemoteMachine.status.machineRef#

^{^{↩ Parent}}

Name	Type	Description	Required
name	string		true
namespace	string		true

RemoteCluster#

^{^{↩ Parent}}

Name	Type	Description	Required
apiVersion	string	infrastructure.cluster.x-k8s.io/v1beta1	true
kind	string	RemoteCluster	true
metadata	object	Refer to the Kubernetes API documentation for the fields of the `metadata` field.	true
spec	object	RemoteClusterSpec defines the desired state of RemoteCluster	false
status	object	RemoteClusterStatus defines the observed state of RemoteCluster	false

RemoteCluster.spec#

^{^{↩ Parent}}

RemoteClusterSpec defines the desired state of RemoteCluster

Name	Type	Description	Required
controlPlaneEndpoint	object	APIEndpoint represents a reachable Kubernetes API endpoint.	true

RemoteCluster.spec.controlPlaneEndpoint#

^{^{↩ Parent}}

APIEndpoint represents a reachable Kubernetes API endpoint.

Name	Type	Description	Required
host	string	The hostname on which the API server is serving.	true
port	integer	The port on which the API server is serving. Format: int32	true

RemoteCluster.status#

^{^{↩ Parent}}

RemoteClusterStatus defines the observed state of RemoteCluster

Name	Type	Description	Required
ready	boolean	Ready denotes that the remote cluster is ready to be used. Default: false	true

RemoteMachine#

^{^{↩ Parent}}

Name	Type	Description	Required
apiVersion	string	infrastructure.cluster.x-k8s.io/v1beta1	true
kind	string	RemoteMachine	true
metadata	object	Refer to the Kubernetes API documentation for the fields of the `metadata` field.	true
spec	object	RemoteMachineSpec defines the desired state of RemoteMachine	false
status	object	RemoteMachineStatus defines the observed state of RemoteMachine	false

RemoteMachine.spec#

^{^{↩ Parent}}

RemoteMachineSpec defines the desired state of RemoteMachine

Name	Type	Description	Required
address	string	Address is the IP address or DNS name of the remote machine.	false
pool	string	Pool is the name of the pool where the machine belongs to.	false
port	integer	Port is the SSH port of the remote machine. Default: 22	false
providerID	string	ProviderID is the ID of the machine in the provider.	false
provisionJob	object	ProvisionJob describes the kubernetes Job to use to provision the machine.	false
sshKeyRef	object	SSHKeyRef is a reference to a secret that contains the SSH private key. The key must be placed on the secret using the key "value".	false
useSudo	boolean		false
user	string	User is the user to use when connecting to the remote machine. Default: root	false

RemoteMachine.spec.provisionJob#

^{^{↩ Parent}}

ProvisionJob describes the kubernetes Job to use to provision the machine.

Name	Type	Description	Required
jobSpecTemplate	object	JobTemplate is the job template to use to provision the machine.	false
scpCommand	string	Default: scp	false
sshCommand	string	Default: ssh	false

RemoteMachine.spec.provisionJob.jobSpecTemplate#

^{^{↩ Parent}}

JobTemplate is the job template to use to provision the machine.

Name	Type	Description	Required
metadata	object	Standard object's metadata of the jobs created from this template. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata	false
spec	object	Specification of the desired behavior of the job. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.metadata#

^{^{↩ Parent}}

Standard object's metadata of the jobs created from this template. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

Name	Type	Required
annotations	map[string]string	false
finalizers	[]string	false
labels	map[string]string	false
name	string	false
namespace	string	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec#

^{^{↩ Parent}}

Specification of the desired behavior of the job. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

Name	Type	Description	Required
template	object	Describes the pod that will be created when executing a job. The only allowed template.spec.restartPolicy values are "Never" or "OnFailure". More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/	true
activeDeadlineSeconds	integer	Specifies the duration in seconds relative to the startTime that the job may be continuously active before the system tries to terminate it; value must be positive integer. If a Job is suspended (at creation or through an update), this timer will effectively be stopped and reset when the Job is resumed again. Format: int64	false
backoffLimit	integer	Specifies the number of retries before marking this job failed. Defaults to 6 Format: int32	false
backoffLimitPerIndex	integer	Specifies the limit for the number of retries within an index before marking this index as failed. When enabled the number of failures per index is kept in the pod's batch.kubernetes.io/job-index-failure-count annotation. It can only be set when Job's completionMode=Indexed, and the Pod's restart policy is Never. The field is immutable. This field is beta-level. It can be used when the `JobBackoffLimitPerIndex` feature gate is enabled (enabled by default). Format: int32	false
completionMode	string	completionMode specifies how Pod completions are tracked. It can be `NonIndexed` (default) or `Indexed`. `NonIndexed` means that the Job is considered complete when there have been .spec.completions successfully completed Pods. Each Pod completion is homologous to each other. `Indexed` means that the Pods of a Job get an associated completion index from 0 to (.spec.completions - 1), available in the annotation batch.kubernetes.io/job-completion-index. The Job is considered complete when there is one successfully completed Pod for each index. When value is `Indexed`, .spec.completions must be specified and `.spec.parallelism` must be less than or equal to 10^5. In addition, The Pod name takes the form `$(job-name)-$(index)-$(random-string)`, the Pod hostname takes the form `$(job-name)-$(index)`. More completion modes can be added in the future. If the Job controller observes a mode that it doesn't recognize, which is possible during upgrades due to version skew, the controller skips updates for the Job.	false
completions	integer	Specifies the desired number of successfully finished pods the job should be run with. Setting to null means that the success of any pod signals the success of all pods, and allows parallelism to have any positive value. Setting to 1 means that parallelism is limited to 1 and the success of that pod signals the success of the job. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/ Format: int32	false
managedBy	string	ManagedBy field indicates the controller that manages a Job. The k8s Job controller reconciles jobs which don't have this field at all or the field value is the reserved string `kubernetes.io/job-controller`, but skips reconciling Jobs with a custom value for this field. The value must be a valid domain-prefixed path (e.g. acme.io/foo) - all characters before the first "/" must be a valid subdomain as defined by RFC 1123. All characters trailing the first "/" must be valid HTTP Path characters as defined by RFC 3986. The value cannot exceed 64 characters. This field is alpha-level. The job controller accepts setting the field when the feature gate JobManagedBy is enabled (disabled by default).	false
manualSelector	boolean	manualSelector controls generation of pod labels and pod selectors. Leave `manualSelector` unset unless you are certain what you are doing. When false or unset, the system pick labels unique to this job and appends those labels to the pod template. When true, the user is responsible for picking unique labels and specifying the selector. Failure to pick a unique label may cause this and other jobs to not function correctly. However, You may see `manualSelector=true` in jobs that were created with the old `extensions/v1beta1` API. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/#specifying-your-own-pod-selector	false
maxFailedIndexes	integer	Specifies the maximal number of failed indexes before marking the Job as failed, when backoffLimitPerIndex is set. Once the number of failed indexes exceeds this number the entire Job is marked as Failed and its execution is terminated. When left as null the job continues execution of all of its indexes and is marked with the `Complete` Job condition. It can only be specified when backoffLimitPerIndex is set. It can be null or up to completions. It is required and must be less than or equal to 10^4 when is completions greater than 10^5. This field is beta-level. It can be used when the `JobBackoffLimitPerIndex` feature gate is enabled (enabled by default). Format: int32	false
parallelism	integer	Specifies the maximum desired number of pods the job should run at any given time. The actual number of pods running in steady state will be less than this number when ((.spec.completions - .status.successful) < .spec.parallelism), i.e. when the work left to do is less than max parallelism. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/ Format: int32	false
podFailurePolicy	object	Specifies the policy of handling failed pods. In particular, it allows to specify the set of actions and conditions which need to be satisfied to take the associated action. If empty, the default behaviour applies - the counter of failed pods, represented by the jobs's .status.failed field, is incremented and it is checked against the backoffLimit. This field cannot be used in combination with restartPolicy=OnFailure. This field is beta-level. It can be used when the `JobPodFailurePolicy` feature gate is enabled (enabled by default).	false
podReplacementPolicy	string	podReplacementPolicy specifies when to create replacement Pods. Possible values are: - TerminatingOrFailed means that we recreate pods when they are terminating (has a metadata.deletionTimestamp) or failed. - Failed means to wait until a previously created Pod is fully terminated (has phase Failed or Succeeded) before creating a replacement Pod. When using podFailurePolicy, Failed is the the only allowed value. TerminatingOrFailed and Failed are allowed values when podFailurePolicy is not in use. This is an beta field. To use this, enable the JobPodReplacementPolicy feature toggle. This is on by default.	false
selector	object	A label query over pods that should match the pod count. Normally, the system sets this field for you. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors	false
successPolicy	object	successPolicy specifies the policy when the Job can be declared as succeeded. If empty, the default behavior applies - the Job is declared as succeeded only when the number of succeeded pods equals to the completions. When the field is specified, it must be immutable and works only for the Indexed Jobs. Once the Job meets the SuccessPolicy, the lingering pods are terminated. This field is alpha-level. To use this field, you must enable the `JobSuccessPolicy` feature gate (disabled by default).	false
suspend	boolean	suspend specifies whether the Job controller should create Pods or not. If a Job is created with suspend set to true, no Pods are created by the Job controller. If a Job is suspended after creation (i.e. the flag goes from false to true), the Job controller will delete all active Pods associated with this Job. Users must design their workload to gracefully handle this. Suspending a Job will reset the StartTime field of the Job, effectively resetting the ActiveDeadlineSeconds timer too. Defaults to false.	false
ttlSecondsAfterFinished	integer	ttlSecondsAfterFinished limits the lifetime of a Job that has finished execution (either Complete or Failed). If this field is set, ttlSecondsAfterFinished after the Job finishes, it is eligible to be automatically deleted. When the Job is being deleted, its lifecycle guarantees (e.g. finalizers) will be honored. If this field is unset, the Job won't be automatically deleted. If this field is set to zero, the Job becomes eligible to be deleted immediately after it finishes. Format: int32	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template#

^{^{↩ Parent}}

Describes the pod that will be created when executing a job. The only allowed template.spec.restartPolicy values are "Never" or "OnFailure". More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/

Name	Type	Description	Required
metadata	object	Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata	false
spec	object	Specification of the desired behavior of the pod. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.metadata#

^{^{↩ Parent}}

Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

Name	Type	Required
annotations	map[string]string	false
finalizers	[]string	false
labels	map[string]string	false
name	string	false
namespace	string	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec#

^{^{↩ Parent}}

Specification of the desired behavior of the pod. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

Name	Type	Description	Required
containers	[]object	List of containers belonging to the pod. Containers cannot currently be added or removed. There must be at least one container in a Pod. Cannot be updated.	true
activeDeadlineSeconds	integer	Optional duration in seconds the pod may be active on the node relative to StartTime before the system will actively try to mark it failed and kill associated containers. Value must be a positive integer. Format: int64	false
affinity	object	If specified, the pod's scheduling constraints	false
automountServiceAccountToken	boolean	AutomountServiceAccountToken indicates whether a service account token should be automatically mounted.	false
dnsConfig	object	Specifies the DNS parameters of a pod. Parameters specified here will be merged to the generated DNS configuration based on DNSPolicy.	false
dnsPolicy	string	Set DNS policy for the pod. Defaults to "ClusterFirst". Valid values are 'ClusterFirstWithHostNet', 'ClusterFirst', 'Default' or 'None'. DNS parameters given in DNSConfig will be merged with the policy selected with DNSPolicy. To have DNS options set along with hostNetwork, you have to specify DNS policy explicitly to 'ClusterFirstWithHostNet'.	false
enableServiceLinks	boolean	EnableServiceLinks indicates whether information about services should be injected into pod's environment variables, matching the syntax of Docker links. Optional: Defaults to true.	false
ephemeralContainers	[]object	List of ephemeral containers run in this pod. Ephemeral containers may be run in an existing pod to perform user-initiated actions such as debugging. This list cannot be specified when creating a pod, and it cannot be modified by updating the pod spec. In order to add an ephemeral container to an existing pod, use the pod's ephemeralcontainers subresource.	false
hostAliases	[]object	HostAliases is an optional list of hosts and IPs that will be injected into the pod's hosts file if specified.	false
hostIPC	boolean	Use the host's ipc namespace. Optional: Default to false.	false
hostNetwork	boolean	Host networking requested for this pod. Use the host's network namespace. If this option is set, the ports that will be used must be specified. Default to false.	false
hostPID	boolean	Use the host's pid namespace. Optional: Default to false.	false
hostUsers	boolean	Use the host's user namespace. Optional: Default to true. If set to true or not present, the pod will be run in the host user namespace, useful for when the pod needs a feature only available to the host user namespace, such as loading a kernel module with CAP_SYS_MODULE. When set to false, a new userns is created for the pod. Setting false is useful for mitigating container breakout vulnerabilities even allowing users to run their containers as root without actually having root privileges on the host. This field is alpha-level and is only honored by servers that enable the UserNamespacesSupport feature.	false
hostname	string	Specifies the hostname of the Pod If not specified, the pod's hostname will be set to a system-defined value.	false
imagePullSecrets	[]object	ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec. If specified, these secrets will be passed to individual puller implementations for them to use. More info: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod	false
initContainers	[]object	List of initialization containers belonging to the pod. Init containers are executed in order prior to containers being started. If any init container fails, the pod is considered to have failed and is handled according to its restartPolicy. The name for an init container or normal container must be unique among all containers. Init containers may not have Lifecycle actions, Readiness probes, Liveness probes, or Startup probes. The resourceRequirements of an init container are taken into account during scheduling by finding the highest request/limit for each resource type, and then using the max of of that value or the sum of the normal containers. Limits are applied to init containers in a similar fashion. Init containers cannot currently be added or removed. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/	false
nodeName	string	NodeName is a request to schedule this pod onto a specific node. If it is non-empty, the scheduler simply schedules this pod onto that node, assuming that it fits resource requirements.	false
nodeSelector	map[string]string	NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node's labels for the pod to be scheduled on that node. More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/	false
os	object	Specifies the OS of the containers in the pod. Some pod and container fields are restricted if this is set. If the OS field is set to linux, the following fields must be unset: -securityContext.windowsOptions If the OS field is set to windows, following fields must be unset: - spec.hostPID - spec.hostIPC - spec.hostUsers - spec.securityContext.appArmorProfile - spec.securityContext.seLinuxOptions - spec.securityContext.seccompProfile - spec.securityContext.fsGroup - spec.securityContext.fsGroupChangePolicy - spec.securityContext.sysctls - spec.shareProcessNamespace - spec.securityContext.runAsUser - spec.securityContext.runAsGroup - spec.securityContext.supplementalGroups - spec.containers[].securityContext.appArmorProfile - spec.containers[].securityContext.seLinuxOptions - spec.containers[].securityContext.seccompProfile - spec.containers[].securityContext.capabilities - spec.containers[].securityContext.readOnlyRootFilesystem - spec.containers[].securityContext.privileged - spec.containers[].securityContext.allowPrivilegeEscalation - spec.containers[].securityContext.procMount - spec.containers[].securityContext.runAsUser - spec.containers[].securityContext.runAsGroup	false
overhead	map[string]int or string	Overhead represents the resource overhead associated with running a pod for a given RuntimeClass. This field will be autopopulated at admission time by the RuntimeClass admission controller. If the RuntimeClass admission controller is enabled, overhead must not be set in Pod create requests. The RuntimeClass admission controller will reject Pod create requests which have the overhead already set. If RuntimeClass is configured and selected in the PodSpec, Overhead will be set to the value defined in the corresponding RuntimeClass, otherwise it will remain unset and treated as zero. More info: https://git.k8s.io/enhancements/keps/sig-node/688-pod-overhead/README.md	false
preemptionPolicy	string	PreemptionPolicy is the Policy for preempting pods with lower priority. One of Never, PreemptLowerPriority. Defaults to PreemptLowerPriority if unset.	false
priority	integer	The priority value. Various system components use this field to find the priority of the pod. When Priority Admission Controller is enabled, it prevents users from setting this field. The admission controller populates this field from PriorityClassName. The higher the value, the higher the priority. Format: int32	false
priorityClassName	string	If specified, indicates the pod's priority. "system-node-critical" and "system-cluster-critical" are two special keywords which indicate the highest priorities with the former being the highest priority. Any other name must be defined by creating a PriorityClass object with that name. If not specified, the pod priority will be default or zero if there is no default.	false
readinessGates	[]object	If specified, all readiness gates will be evaluated for pod readiness. A pod is ready when all its containers are ready AND all conditions specified in the readiness gates have status equal to "True" More info: https://git.k8s.io/enhancements/keps/sig-network/580-pod-readiness-gates	false
resourceClaims	[]object	ResourceClaims defines which ResourceClaims must be allocated and reserved before the Pod is allowed to start. The resources will be made available to those containers which consume them by name. This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. This field is immutable.	false
restartPolicy	string	Restart policy for all containers within the pod. One of Always, OnFailure, Never. In some contexts, only a subset of those values may be permitted. Default to Always. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy	false
runtimeClassName	string	RuntimeClassName refers to a RuntimeClass object in the node.k8s.io group, which should be used to run this pod. If no RuntimeClass resource matches the named class, the pod will not be run. If unset or empty, the "legacy" RuntimeClass will be used, which is an implicit class with an empty definition that uses the default runtime handler. More info: https://git.k8s.io/enhancements/keps/sig-node/585-runtime-class	false
schedulerName	string	If specified, the pod will be dispatched by specified scheduler. If not specified, the pod will be dispatched by default scheduler.	false
schedulingGates	[]object	SchedulingGates is an opaque list of values that if specified will block scheduling the pod. If schedulingGates is not empty, the pod will stay in the SchedulingGated state and the scheduler will not attempt to schedule the pod. SchedulingGates can only be set at pod creation time, and be removed only afterwards.	false
securityContext	object	SecurityContext holds pod-level security attributes and common container settings. Optional: Defaults to empty. See type description for default values of each field.	false
serviceAccount	string	DeprecatedServiceAccount is a deprecated alias for ServiceAccountName. Deprecated: Use serviceAccountName instead.	false
serviceAccountName	string	ServiceAccountName is the name of the ServiceAccount to use to run this pod. More info: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/	false
setHostnameAsFQDN	boolean	If true the pod's hostname will be configured as the pod's FQDN, rather than the leaf name (the default). In Linux containers, this means setting the FQDN in the hostname field of the kernel (the nodename field of struct utsname). In Windows containers, this means setting the registry value of hostname for the registry key HKEY_LOCAL_MACHINE\\SYSTEM\\CurrentControlSet\\Services\\Tcpip\\Parameters to FQDN. If a pod does not have FQDN, this has no effect. Default to false.	false
shareProcessNamespace	boolean	Share a single process namespace between all of the containers in a pod. When this is set containers will be able to view and signal processes from other containers in the same pod, and the first process in each container will not be assigned PID 1. HostPID and ShareProcessNamespace cannot both be set. Optional: Default to false.	false
subdomain	string	If specified, the fully qualified Pod hostname will be "...svc.". If not specified, the pod will not have a domainname at all.	false
terminationGracePeriodSeconds	integer	Optional duration in seconds the pod needs to terminate gracefully. May be decreased in delete request. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). If this value is nil, the default grace period will be used instead. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. Defaults to 30 seconds. Format: int64	false
tolerations	[]object	If specified, the pod's tolerations.	false
topologySpreadConstraints	[]object	TopologySpreadConstraints describes how a group of pods ought to spread across topology domains. Scheduler will schedule pods in a way which abides by the constraints. All topologySpreadConstraints are ANDed.	false
volumes	[]object	List of volumes that can be mounted by containers belonging to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.containers[index]#

^{^{↩ Parent}}

A single application container that you want to run within a pod.

Name	Type	Description	Required
name	string	Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated.	true
args	[]string	Arguments to the entrypoint. The container image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell	false
command	[]string	Entrypoint array. Not executed within a shell. The container image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell	false
env	[]object	List of environment variables to set in the container. Cannot be updated.	false
envFrom	[]object	List of sources to populate environment variables in the container. The keys defined within a source 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.	false
image	string	Container image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets.	false
imagePullPolicy	string	Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images	false
lifecycle	object	Actions that the management system should take in response to container lifecycle events. Cannot be updated.	false
livenessProbe	object	Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes	false
ports	[]object	List of ports to expose from the container. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Modifying this array with strategic merge patch may corrupt the data. For more information See https://github.com/kubernetes/kubernetes/issues/108255. Cannot be updated.	false
readinessProbe	object	Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes	false
resizePolicy	[]object	Resources resize policy for the container.	false
resources	object	Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/	false
restartPolicy	string	RestartPolicy defines the restart behavior of individual containers in a pod. This field may only be set for init containers, and the only allowed value is "Always". For non-init containers or when this field is not specified, the restart behavior is defined by the Pod's restart policy and the container type. Setting the RestartPolicy as "Always" for the init container will have the following effect: this init container will be continually restarted on exit until all regular containers have terminated. Once all regular containers have completed, all init containers with restartPolicy "Always" will be shut down. This lifecycle differs from normal init containers and is often referred to as a "sidecar" container. Although this init container still starts in the init container sequence, it does not wait for the container to complete before proceeding to the next init container. Instead, the next init container starts immediately after this init container is started, or after any startupProbe has successfully completed.	false
securityContext	object	SecurityContext defines the security options the container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/	false
startupProbe	object	StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod's lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes	false
stdin	boolean	Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false.	false
stdinOnce	boolean	Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false	false
terminationMessagePath	string	Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated.	false
terminationMessagePolicy	string	Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.	false
tty	boolean	Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false.	false
volumeDevices	[]object	volumeDevices is the list of block devices to be used by the container.	false
volumeMounts	[]object	Pod volumes to mount into the container's filesystem. Cannot be updated.	false
workingDir	string	Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.containers[index].env[index]#

^{^{↩ Parent}}

EnvVar represents an environment variable present in a Container.

Name	Type	Description	Required
name	string	Name of the environment variable. Must be a C_IDENTIFIER.	true
value	string	Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "".	false
valueFrom	object	Source for the environment variable's value. Cannot be used if value is not empty.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.containers[index].env[index].valueFrom#

^{^{↩ Parent}}

Source for the environment variable's value. Cannot be used if value is not empty.

Name	Type	Description	Required
configMapKeyRef	object	Selects a key of a ConfigMap.	false
fieldRef	object	Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.	false
resourceFieldRef	object	Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.	false
secretKeyRef	object	Selects a key of a secret in the pod's namespace	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.containers[index].env[index].valueFrom.configMapKeyRef#

^{^{↩ Parent}}

Selects a key of a ConfigMap.

Name	Type	Description	Required
key	string	The key to select.	true
name	string	Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. TODO: Add other useful fields. apiVersion, kind, uid? 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. Default:	false
optional	boolean	Specify whether the ConfigMap or its key must be defined	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.containers[index].env[index].valueFrom.fieldRef#

^{^{↩ Parent}}

Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels['<KEY>'], metadata.annotations['<KEY>'], spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.

Name	Type	Description	Required
fieldPath	string	Path of the field to select in the specified API version.	true
apiVersion	string	Version of the schema the FieldPath is written in terms of, defaults to "v1".	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.containers[index].env[index].valueFrom.resourceFieldRef#

^{^{↩ Parent}}

Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.

Name	Type	Description	Required
resource	string	Required: resource to select	true
containerName	string	Container name: required for volumes, optional for env vars	false
divisor	int or string	Specifies the output format of the exposed resources, defaults to "1"	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.containers[index].env[index].valueFrom.secretKeyRef#

^{^{↩ Parent}}

Selects a key of a secret in the pod's namespace

Name	Type	Description	Required
key	string	The key of the secret to select from. Must be a valid secret key.	true
name	string	Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. TODO: Add other useful fields. apiVersion, kind, uid? 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. Default:	false
optional	boolean	Specify whether the Secret or its key must be defined	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.containers[index].envFrom[index]#

^{^{↩ Parent}}

EnvFromSource represents the source of a set of ConfigMaps

Name	Type	Description	Required
configMapRef	object	The ConfigMap to select from	false
prefix	string	An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.	false
secretRef	object	The Secret to select from	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.containers[index].envFrom[index].configMapRef#

^{^{↩ Parent}}

The ConfigMap to select from

Name	Type	Description	Required
name	string	Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. TODO: Add other useful fields. apiVersion, kind, uid? 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. Default:	false
optional	boolean	Specify whether the ConfigMap must be defined	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.containers[index].envFrom[index].secretRef#

^{^{↩ Parent}}

The Secret to select from

Name	Type	Description	Required
name	string	Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. TODO: Add other useful fields. apiVersion, kind, uid? 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. Default:	false
optional	boolean	Specify whether the Secret must be defined	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.containers[index].lifecycle#

^{^{↩ Parent}}

Actions that the management system should take in response to container lifecycle events. Cannot be updated.

Name	Type	Description	Required
postStart	object	PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks	false
preStop	object	PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The Pod's termination grace period countdown begins before the PreStop hook is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod's termination grace period (unless delayed by finalizers). Other management of the container blocks until the hook completes or until the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.containers[index].lifecycle.postStart#

^{^{↩ Parent}}

PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks

Name	Type	Description	Required
exec	object	Exec specifies the action to take.	false
httpGet	object	HTTPGet specifies the http request to perform.	false
sleep	object	Sleep represents the duration that the container should sleep before being terminated.	false
tcpSocket	object	Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for the backward compatibility. There are no validation of this field and lifecycle hooks will fail in runtime when tcp handler is specified.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.containers[index].lifecycle.postStart.exec#

^{^{↩ Parent}}

Exec specifies the action to take.

Name	Type	Description	Required
command	[]string	Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.containers[index].lifecycle.postStart.httpGet#

^{^{↩ Parent}}

HTTPGet specifies the http request to perform.

Name	Type	Description	Required
port	int or string	Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.	false
httpHeaders	[]object	Custom headers to set in the request. HTTP allows repeated headers.	false
path	string	Path to access on the HTTP server.	false
scheme	string	Scheme to use for connecting to the host. Defaults to HTTP.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.containers[index].lifecycle.postStart.httpGet.httpHeaders[index]#

^{^{↩ Parent}}

HTTPHeader describes a custom header to be used in HTTP probes

Name	Type	Description	Required
name	string	The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.	true
value	string	The header field value	true

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.containers[index].lifecycle.postStart.sleep#

^{^{↩ Parent}}

Sleep represents the duration that the container should sleep before being terminated.

Name	Type	Description	Required
seconds	integer	Seconds is the number of seconds to sleep. Format: int64	true

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.containers[index].lifecycle.postStart.tcpSocket#

^{^{↩ Parent}}

Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for the backward compatibility. There are no validation of this field and lifecycle hooks will fail in runtime when tcp handler is specified.

Name	Type	Description	Required
port	int or string	Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Optional: Host name to connect to, defaults to the pod IP.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.containers[index].lifecycle.preStop#

^{^{↩ Parent}}

PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The Pod's termination grace period countdown begins before the PreStop hook is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod's termination grace period (unless delayed by finalizers). Other management of the container blocks until the hook completes or until the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks

Name	Type	Description	Required
exec	object	Exec specifies the action to take.	false
httpGet	object	HTTPGet specifies the http request to perform.	false
sleep	object	Sleep represents the duration that the container should sleep before being terminated.	false
tcpSocket	object	Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for the backward compatibility. There are no validation of this field and lifecycle hooks will fail in runtime when tcp handler is specified.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.containers[index].lifecycle.preStop.exec#

^{^{↩ Parent}}

Exec specifies the action to take.

Name	Type	Description	Required
command	[]string	Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.containers[index].lifecycle.preStop.httpGet#

^{^{↩ Parent}}

HTTPGet specifies the http request to perform.

Name	Type	Description	Required
port	int or string	Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.	false
httpHeaders	[]object	Custom headers to set in the request. HTTP allows repeated headers.	false
path	string	Path to access on the HTTP server.	false
scheme	string	Scheme to use for connecting to the host. Defaults to HTTP.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.containers[index].lifecycle.preStop.httpGet.httpHeaders[index]#

^{^{↩ Parent}}

HTTPHeader describes a custom header to be used in HTTP probes

Name	Type	Description	Required
name	string	The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.	true
value	string	The header field value	true

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.containers[index].lifecycle.preStop.sleep#

^{^{↩ Parent}}

Sleep represents the duration that the container should sleep before being terminated.

Name	Type	Description	Required
seconds	integer	Seconds is the number of seconds to sleep. Format: int64	true

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.containers[index].lifecycle.preStop.tcpSocket#

^{^{↩ Parent}}

Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for the backward compatibility. There are no validation of this field and lifecycle hooks will fail in runtime when tcp handler is specified.

Name	Type	Description	Required
port	int or string	Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Optional: Host name to connect to, defaults to the pod IP.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.containers[index].livenessProbe#

^{^{↩ Parent}}

Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

Name	Type	Description	Required
exec	object	Exec specifies the action to take.	false
failureThreshold	integer	Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. Format: int32	false
grpc	object	GRPC specifies an action involving a GRPC port.	false
httpGet	object	HTTPGet specifies the http request to perform.	false
initialDelaySeconds	integer	Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32	false
periodSeconds	integer	How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Format: int32	false
successThreshold	integer	Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. Format: int32	false
tcpSocket	object	TCPSocket specifies an action involving a TCP port.	false
terminationGracePeriodSeconds	integer	Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. Format: int64	false
timeoutSeconds	integer	Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.containers[index].livenessProbe.exec#

^{^{↩ Parent}}

Exec specifies the action to take.

Name	Type	Description	Required
command	[]string	Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.containers[index].livenessProbe.grpc#

^{^{↩ Parent}}

GRPC specifies an action involving a GRPC port.

Name	Type	Description	Required
port	integer	Port number of the gRPC service. Number must be in the range 1 to 65535. Format: int32	true
service	string	Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.containers[index].livenessProbe.httpGet#

^{^{↩ Parent}}

HTTPGet specifies the http request to perform.

Name	Type	Description	Required
port	int or string	Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.	false
httpHeaders	[]object	Custom headers to set in the request. HTTP allows repeated headers.	false
path	string	Path to access on the HTTP server.	false
scheme	string	Scheme to use for connecting to the host. Defaults to HTTP.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.containers[index].livenessProbe.httpGet.httpHeaders[index]#

^{^{↩ Parent}}

HTTPHeader describes a custom header to be used in HTTP probes

Name	Type	Description	Required
name	string	The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.	true
value	string	The header field value	true

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.containers[index].livenessProbe.tcpSocket#

^{^{↩ Parent}}

TCPSocket specifies an action involving a TCP port.

Name	Type	Description	Required
port	int or string	Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Optional: Host name to connect to, defaults to the pod IP.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.containers[index].ports[index]#

^{^{↩ Parent}}

ContainerPort represents a network port in a single container.

Name	Type	Description	Required
containerPort	integer	Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536. Format: int32	true
hostIP	string	What host IP to bind the external port to.	false
hostPort	integer	Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this. Format: int32	false
name	string	If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services.	false
protocol	string	Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP". Default: TCP	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.containers[index].readinessProbe#

^{^{↩ Parent}}

Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

Name	Type	Description	Required
exec	object	Exec specifies the action to take.	false
failureThreshold	integer	Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. Format: int32	false
grpc	object	GRPC specifies an action involving a GRPC port.	false
httpGet	object	HTTPGet specifies the http request to perform.	false
initialDelaySeconds	integer	Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32	false
periodSeconds	integer	How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Format: int32	false
successThreshold	integer	Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. Format: int32	false
tcpSocket	object	TCPSocket specifies an action involving a TCP port.	false
terminationGracePeriodSeconds	integer	Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. Format: int64	false
timeoutSeconds	integer	Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.containers[index].readinessProbe.exec#

^{^{↩ Parent}}

Exec specifies the action to take.

Name	Type	Description	Required
command	[]string	Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.containers[index].readinessProbe.grpc#

^{^{↩ Parent}}

GRPC specifies an action involving a GRPC port.

Name	Type	Description	Required
port	integer	Port number of the gRPC service. Number must be in the range 1 to 65535. Format: int32	true
service	string	Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.containers[index].readinessProbe.httpGet#

^{^{↩ Parent}}

HTTPGet specifies the http request to perform.

Name	Type	Description	Required
port	int or string	Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.	false
httpHeaders	[]object	Custom headers to set in the request. HTTP allows repeated headers.	false
path	string	Path to access on the HTTP server.	false
scheme	string	Scheme to use for connecting to the host. Defaults to HTTP.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.containers[index].readinessProbe.httpGet.httpHeaders[index]#

^{^{↩ Parent}}

HTTPHeader describes a custom header to be used in HTTP probes

Name	Type	Description	Required
name	string	The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.	true
value	string	The header field value	true

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.containers[index].readinessProbe.tcpSocket#

^{^{↩ Parent}}

TCPSocket specifies an action involving a TCP port.

Name	Type	Description	Required
port	int or string	Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Optional: Host name to connect to, defaults to the pod IP.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.containers[index].resizePolicy[index]#

^{^{↩ Parent}}

ContainerResizePolicy represents resource resize policy for the container.

Name	Type	Description	Required
resourceName	string	Name of the resource to which this resource resize policy applies. Supported values: cpu, memory.	true
restartPolicy	string	Restart policy to apply when specified resource is resized. If not specified, it defaults to NotRequired.	true

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.containers[index].resources#

^{^{↩ Parent}}

Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

Name	Type	Description	Required
claims	[]object	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.	false
limits	map[string]int or string	Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/	false
requests	map[string]int or string	Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.containers[index].resources.claims[index]#

^{^{↩ Parent}}

ResourceClaim references one entry in PodSpec.ResourceClaims.

Name	Type	Description	Required
name	string	Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.	true

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.containers[index].securityContext#

^{^{↩ Parent}}

SecurityContext defines the security options the container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/

Name	Type	Description	Required
allowPrivilegeEscalation	boolean	AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN Note that this field cannot be set when spec.os.name is windows.	false
appArmorProfile	object	appArmorProfile is the AppArmor options to use by this container. If set, this profile overrides the pod's appArmorProfile. Note that this field cannot be set when spec.os.name is windows.	false
capabilities	object	The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. Note that this field cannot be set when spec.os.name is windows.	false
privileged	boolean	Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. Note that this field cannot be set when spec.os.name is windows.	false
procMount	string	procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. Note that this field cannot be set when spec.os.name is windows.	false
readOnlyRootFilesystem	boolean	Whether this container has a read-only root filesystem. Default is false. Note that this field cannot be set when spec.os.name is windows.	false
runAsGroup	integer	The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows. Format: int64	false
runAsNonRoot	boolean	Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.	false
runAsUser	integer	The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows. Format: int64	false
seLinuxOptions	object	The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.	false
seccompProfile	object	The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options. Note that this field cannot be set when spec.os.name is windows.	false
windowsOptions	object	The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is linux.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.containers[index].securityContext.appArmorProfile#

^{^{↩ Parent}}

appArmorProfile is the AppArmor options to use by this container. If set, this profile overrides the pod's appArmorProfile. Note that this field cannot be set when spec.os.name is windows.

Name	Type	Description	Required
type	string	type indicates which kind of AppArmor profile will be applied. Valid options are: Localhost - a profile pre-loaded on the node. RuntimeDefault - the container runtime's default profile. Unconfined - no AppArmor enforcement.	true
localhostProfile	string	localhostProfile indicates a profile loaded on the node that should be used. The profile must be preconfigured on the node to work. Must match the loaded name of the profile. Must be set if and only if type is "Localhost".	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.containers[index].securityContext.capabilities#

^{^{↩ Parent}}

The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. Note that this field cannot be set when spec.os.name is windows.

Name	Type	Description	Required
add	[]string	Added capabilities	false
drop	[]string	Removed capabilities	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.containers[index].securityContext.seLinuxOptions#

^{^{↩ Parent}}

The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.

Name	Type	Description	Required
level	string	Level is SELinux level label that applies to the container.	false
role	string	Role is a SELinux role label that applies to the container.	false
type	string	Type is a SELinux type label that applies to the container.	false
user	string	User is a SELinux user label that applies to the container.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.containers[index].securityContext.seccompProfile#

^{^{↩ Parent}}

The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options. Note that this field cannot be set when spec.os.name is windows.

Name	Type	Description	Required
type	string	type indicates which kind of seccomp profile will be applied. Valid options are: Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied.	true
localhostProfile	string	localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's configured seccomp profile location. Must be set if type is "Localhost". Must NOT be set for any other type.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.containers[index].securityContext.windowsOptions#

^{^{↩ Parent}}

The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is linux.

Name	Type	Description	Required
gmsaCredentialSpec	string	GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field.	false
gmsaCredentialSpecName	string	GMSACredentialSpecName is the name of the GMSA credential spec to use.	false
hostProcess	boolean	HostProcess determines if a container should be run as a 'Host Process' container. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true.	false
runAsUserName	string	The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.containers[index].startupProbe#

^{^{↩ Parent}}

StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod's lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

Name	Type	Description	Required
exec	object	Exec specifies the action to take.	false
failureThreshold	integer	Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. Format: int32	false
grpc	object	GRPC specifies an action involving a GRPC port.	false
httpGet	object	HTTPGet specifies the http request to perform.	false
initialDelaySeconds	integer	Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32	false
periodSeconds	integer	How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Format: int32	false
successThreshold	integer	Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. Format: int32	false
tcpSocket	object	TCPSocket specifies an action involving a TCP port.	false
terminationGracePeriodSeconds	integer	Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. Format: int64	false
timeoutSeconds	integer	Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.containers[index].startupProbe.exec#

^{^{↩ Parent}}

Exec specifies the action to take.

Name	Type	Description	Required
command	[]string	Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.containers[index].startupProbe.grpc#

^{^{↩ Parent}}

GRPC specifies an action involving a GRPC port.

Name	Type	Description	Required
port	integer	Port number of the gRPC service. Number must be in the range 1 to 65535. Format: int32	true
service	string	Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.containers[index].startupProbe.httpGet#

^{^{↩ Parent}}

HTTPGet specifies the http request to perform.

Name	Type	Description	Required
port	int or string	Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.	false
httpHeaders	[]object	Custom headers to set in the request. HTTP allows repeated headers.	false
path	string	Path to access on the HTTP server.	false
scheme	string	Scheme to use for connecting to the host. Defaults to HTTP.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.containers[index].startupProbe.httpGet.httpHeaders[index]#

^{^{↩ Parent}}

HTTPHeader describes a custom header to be used in HTTP probes

Name	Type	Description	Required
name	string	The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.	true
value	string	The header field value	true

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.containers[index].startupProbe.tcpSocket#

^{^{↩ Parent}}

TCPSocket specifies an action involving a TCP port.

Name	Type	Description	Required
port	int or string	Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Optional: Host name to connect to, defaults to the pod IP.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.containers[index].volumeDevices[index]#

^{^{↩ Parent}}

volumeDevice describes a mapping of a raw block device within a container.

Name	Type	Description	Required
devicePath	string	devicePath is the path inside of the container that the device will be mapped to.	true
name	string	name must match the name of a persistentVolumeClaim in the pod	true

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.containers[index].volumeMounts[index]#

^{^{↩ Parent}}

VolumeMount describes a mounting of a Volume within a container.

Name	Type	Description	Required
mountPath	string	Path within the container at which the volume should be mounted. Must not contain ':'.	true
name	string	This must match the Name of a Volume.	true
mountPropagation	string	mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10. When RecursiveReadOnly is set to IfPossible or to Enabled, MountPropagation must be None or unspecified (which defaults to None).	false
readOnly	boolean	Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.	false
recursiveReadOnly	string	RecursiveReadOnly specifies whether read-only mounts should be handled recursively. If ReadOnly is false, this field has no meaning and must be unspecified. If ReadOnly is true, and this field is set to Disabled, the mount is not made recursively read-only. If this field is set to IfPossible, the mount is made recursively read-only, if it is supported by the container runtime. If this field is set to Enabled, the mount is made recursively read-only if it is supported by the container runtime, otherwise the pod will not be started and an error will be generated to indicate the reason. If this field is set to IfPossible or Enabled, MountPropagation must be set to None (or be unspecified, which defaults to None). If this field is not specified, it is treated as an equivalent of Disabled.	false
subPath	string	Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root).	false
subPathExpr	string	Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to "" (volume's root). SubPathExpr and SubPath are mutually exclusive.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.affinity#

^{^{↩ Parent}}

If specified, the pod's scheduling constraints

Name	Type	Description	Required
nodeAffinity	object	Describes node affinity scheduling rules for the pod.	false
podAffinity	object	Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).	false
podAntiAffinity	object	Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.affinity.nodeAffinity#

^{^{↩ Parent}}

Describes node affinity scheduling rules for the pod.

Name	Type	Description	Required
preferredDuringSchedulingIgnoredDuringExecution	[]object	The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred.	false
requiredDuringSchedulingIgnoredDuringExecution	object	If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to an update), the system may or may not try to eventually evict the pod from its node.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index]#

^{^{↩ Parent}}

An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. it's a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op).

Name	Type	Description	Required
preference	object	A node selector term, associated with the corresponding weight.	true
weight	integer	Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100. Format: int32	true

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference#

^{^{↩ Parent}}

A node selector term, associated with the corresponding weight.

Name	Type	Description	Required
matchExpressions	[]object	A list of node selector requirements by node's labels.	false
matchFields	[]object	A list of node selector requirements by node's fields.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference.matchExpressions[index]#

^{^{↩ Parent}}

A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	The label key that the selector applies to.	true
operator	string	Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.	true
values	[]string	An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference.matchFields[index]#

^{^{↩ Parent}}

A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	The label key that the selector applies to.	true
operator	string	Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.	true
values	[]string	An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution#

^{^{↩ Parent}}

If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to an update), the system may or may not try to eventually evict the pod from its node.

Name	Type	Description	Required
nodeSelectorTerms	[]object	Required. A list of node selector terms. The terms are ORed.	true

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index]#

^{^{↩ Parent}}

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.

Name	Type	Description	Required
matchExpressions	[]object	A list of node selector requirements by node's labels.	false
matchFields	[]object	A list of node selector requirements by node's fields.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index].matchExpressions[index]#

^{^{↩ Parent}}

A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	The label key that the selector applies to.	true
operator	string	Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.	true
values	[]string	An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index].matchFields[index]#

^{^{↩ Parent}}

A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	The label key that the selector applies to.	true
operator	string	Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.	true
values	[]string	An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.affinity.podAffinity#

^{^{↩ Parent}}

Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).

Name	Type	Description	Required
preferredDuringSchedulingIgnoredDuringExecution	[]object	The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.	false
requiredDuringSchedulingIgnoredDuringExecution	[]object	If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index]#

^{^{↩ Parent}}

The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)

Name	Type	Description	Required
podAffinityTerm	object	Required. A pod affinity term, associated with the corresponding weight.	true
weight	integer	weight associated with matching the corresponding podAffinityTerm, in the range 1-100. Format: int32	true

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm#

^{^{↩ Parent}}

Required. A pod affinity term, associated with the corresponding weight.

Name	Type	Description	Required
topologyKey	string	This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.	true
labelSelector	object	A label query over a set of resources, in this case pods. If it's null, this PodAffinityTerm matches with no Pods.	false
matchLabelKeys	[]string	MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both matchLabelKeys and labelSelector. Also, matchLabelKeys cannot be set when labelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.	false
mismatchLabelKeys	[]string	MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. Also, mismatchLabelKeys cannot be set when labelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.	false
namespaceSelector	object	A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.	false
namespaces	[]string	namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace".	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector#

^{^{↩ Parent}}

A label query over a set of resources, in this case pods. If it's null, this PodAffinityTerm matches with no Pods.

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector.matchExpressions[index]#

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector#

^{^{↩ Parent}}

A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector.matchExpressions[index]#

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index]#

^{^{↩ Parent}}

Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running

Name	Type	Description	Required
topologyKey	string	This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.	true
labelSelector	object	A label query over a set of resources, in this case pods. If it's null, this PodAffinityTerm matches with no Pods.	false
matchLabelKeys	[]string	MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both matchLabelKeys and labelSelector. Also, matchLabelKeys cannot be set when labelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.	false
mismatchLabelKeys	[]string	MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. Also, mismatchLabelKeys cannot be set when labelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.	false
namespaceSelector	object	A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.	false
namespaces	[]string	namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace".	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector#

^{^{↩ Parent}}

A label query over a set of resources, in this case pods. If it's null, this PodAffinityTerm matches with no Pods.

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector.matchExpressions[index]#

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector#

^{^{↩ Parent}}

A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector.matchExpressions[index]#

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.affinity.podAntiAffinity#

^{^{↩ Parent}}

Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).

Name	Type	Description	Required
preferredDuringSchedulingIgnoredDuringExecution	[]object	The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.	false
requiredDuringSchedulingIgnoredDuringExecution	[]object	If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index]#

^{^{↩ Parent}}

The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)

Name	Type	Description	Required
podAffinityTerm	object	Required. A pod affinity term, associated with the corresponding weight.	true
weight	integer	weight associated with matching the corresponding podAffinityTerm, in the range 1-100. Format: int32	true

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm#

^{^{↩ Parent}}

Required. A pod affinity term, associated with the corresponding weight.

Name	Type	Description	Required
topologyKey	string	This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.	true
labelSelector	object	A label query over a set of resources, in this case pods. If it's null, this PodAffinityTerm matches with no Pods.	false
matchLabelKeys	[]string	MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both matchLabelKeys and labelSelector. Also, matchLabelKeys cannot be set when labelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.	false
mismatchLabelKeys	[]string	MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. Also, mismatchLabelKeys cannot be set when labelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.	false
namespaceSelector	object	A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.	false
namespaces	[]string	namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace".	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector#

^{^{↩ Parent}}

A label query over a set of resources, in this case pods. If it's null, this PodAffinityTerm matches with no Pods.

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector.matchExpressions[index]#

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector#

^{^{↩ Parent}}

A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector.matchExpressions[index]#

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index]#

^{^{↩ Parent}}

Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running

Name	Type	Description	Required
topologyKey	string	This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.	true
labelSelector	object	A label query over a set of resources, in this case pods. If it's null, this PodAffinityTerm matches with no Pods.	false
matchLabelKeys	[]string	MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both matchLabelKeys and labelSelector. Also, matchLabelKeys cannot be set when labelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.	false
mismatchLabelKeys	[]string	MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. Also, mismatchLabelKeys cannot be set when labelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.	false
namespaceSelector	object	A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.	false
namespaces	[]string	namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace".	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector#

^{^{↩ Parent}}

A label query over a set of resources, in this case pods. If it's null, this PodAffinityTerm matches with no Pods.

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector.matchExpressions[index]#

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector#

^{^{↩ Parent}}

A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector.matchExpressions[index]#

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.dnsConfig#

^{^{↩ Parent}}

Specifies the DNS parameters of a pod. Parameters specified here will be merged to the generated DNS configuration based on DNSPolicy.

Name	Type	Description	Required
nameservers	[]string	A list of DNS name server IP addresses. This will be appended to the base nameservers generated from DNSPolicy. Duplicated nameservers will be removed.	false
options	[]object	A list of DNS resolver options. This will be merged with the base options generated from DNSPolicy. Duplicated entries will be removed. Resolution options given in Options will override those that appear in the base DNSPolicy.	false
searches	[]string	A list of DNS search domains for host-name lookup. This will be appended to the base search paths generated from DNSPolicy. Duplicated search paths will be removed.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.dnsConfig.options[index]#

^{^{↩ Parent}}

PodDNSConfigOption defines DNS resolver options of a pod.

Name	Type	Description	Required
name	string	Required.	false
value	string		false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.ephemeralContainers[index]#

^{^{↩ Parent}}

An EphemeralContainer is a temporary container that you may add to an existing Pod for user-initiated activities such as debugging. Ephemeral containers have no resource or scheduling guarantees, and they will not be restarted when they exit or when a Pod is removed or restarted. The kubelet may evict a Pod if an ephemeral container causes the Pod to exceed its resource allocation.

To add an ephemeral container, use the ephemeralcontainers subresource of an existing Pod. Ephemeral containers may not be removed or restarted.

Name	Type	Description	Required
name	string	Name of the ephemeral container specified as a DNS_LABEL. This name must be unique among all containers, init containers and ephemeral containers.	true
args	[]string	Arguments to the entrypoint. The image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell	false
command	[]string	Entrypoint array. Not executed within a shell. The image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell	false
env	[]object	List of environment variables to set in the container. Cannot be updated.	false
envFrom	[]object	List of sources to populate environment variables in the container. The keys defined within a source 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.	false
image	string	Container image name. More info: https://kubernetes.io/docs/concepts/containers/images	false
imagePullPolicy	string	Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images	false
lifecycle	object	Lifecycle is not allowed for ephemeral containers.	false
livenessProbe	object	Probes are not allowed for ephemeral containers.	false
ports	[]object	Ports are not allowed for ephemeral containers.	false
readinessProbe	object	Probes are not allowed for ephemeral containers.	false
resizePolicy	[]object	Resources resize policy for the container.	false
resources	object	Resources are not allowed for ephemeral containers. Ephemeral containers use spare resources already allocated to the pod.	false
restartPolicy	string	Restart policy for the container to manage the restart behavior of each container within a pod. This may only be set for init containers. You cannot set this field on ephemeral containers.	false
securityContext	object	Optional: SecurityContext defines the security options the ephemeral container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext.	false
startupProbe	object	Probes are not allowed for ephemeral containers.	false
stdin	boolean	Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false.	false
stdinOnce	boolean	Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false	false
targetContainerName	string	If set, the name of the container from PodSpec that this ephemeral container targets. The ephemeral container will be run in the namespaces (IPC, PID, etc) of this container. If not set then the ephemeral container uses the namespaces configured in the Pod spec. The container runtime must implement support for this feature. If the runtime does not support namespace targeting then the result of setting this field is undefined.	false
terminationMessagePath	string	Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated.	false
terminationMessagePolicy	string	Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.	false
tty	boolean	Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false.	false
volumeDevices	[]object	volumeDevices is the list of block devices to be used by the container.	false
volumeMounts	[]object	Pod volumes to mount into the container's filesystem. Subpath mounts are not allowed for ephemeral containers. Cannot be updated.	false
workingDir	string	Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.ephemeralContainers[index].env[index]#

^{^{↩ Parent}}

EnvVar represents an environment variable present in a Container.

Name	Type	Description	Required
name	string	Name of the environment variable. Must be a C_IDENTIFIER.	true
value	string	Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "".	false
valueFrom	object	Source for the environment variable's value. Cannot be used if value is not empty.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.ephemeralContainers[index].env[index].valueFrom#

^{^{↩ Parent}}

Source for the environment variable's value. Cannot be used if value is not empty.

Name	Type	Description	Required
configMapKeyRef	object	Selects a key of a ConfigMap.	false
fieldRef	object	Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.	false
resourceFieldRef	object	Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.	false
secretKeyRef	object	Selects a key of a secret in the pod's namespace	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.ephemeralContainers[index].env[index].valueFrom.configMapKeyRef#

^{^{↩ Parent}}

Selects a key of a ConfigMap.

Name	Type	Description	Required
key	string	The key to select.	true
name	string	Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. TODO: Add other useful fields. apiVersion, kind, uid? 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. Default:	false
optional	boolean	Specify whether the ConfigMap or its key must be defined	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.ephemeralContainers[index].env[index].valueFrom.fieldRef#

^{^{↩ Parent}}

Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels['<KEY>'], metadata.annotations['<KEY>'], spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.

Name	Type	Description	Required
fieldPath	string	Path of the field to select in the specified API version.	true
apiVersion	string	Version of the schema the FieldPath is written in terms of, defaults to "v1".	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.ephemeralContainers[index].env[index].valueFrom.resourceFieldRef#

^{^{↩ Parent}}

Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.

Name	Type	Description	Required
resource	string	Required: resource to select	true
containerName	string	Container name: required for volumes, optional for env vars	false
divisor	int or string	Specifies the output format of the exposed resources, defaults to "1"	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.ephemeralContainers[index].env[index].valueFrom.secretKeyRef#

^{^{↩ Parent}}

Selects a key of a secret in the pod's namespace

Name	Type	Description	Required
key	string	The key of the secret to select from. Must be a valid secret key.	true
name	string	Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. TODO: Add other useful fields. apiVersion, kind, uid? 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. Default:	false
optional	boolean	Specify whether the Secret or its key must be defined	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.ephemeralContainers[index].envFrom[index]#

^{^{↩ Parent}}

EnvFromSource represents the source of a set of ConfigMaps

Name	Type	Description	Required
configMapRef	object	The ConfigMap to select from	false
prefix	string	An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.	false
secretRef	object	The Secret to select from	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.ephemeralContainers[index].envFrom[index].configMapRef#

^{^{↩ Parent}}

The ConfigMap to select from

Name	Type	Description	Required
name	string	Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. TODO: Add other useful fields. apiVersion, kind, uid? 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. Default:	false
optional	boolean	Specify whether the ConfigMap must be defined	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.ephemeralContainers[index].envFrom[index].secretRef#

^{^{↩ Parent}}

The Secret to select from

Name	Type	Description	Required
name	string	Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. TODO: Add other useful fields. apiVersion, kind, uid? 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. Default:	false
optional	boolean	Specify whether the Secret must be defined	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.ephemeralContainers[index].lifecycle#

^{^{↩ Parent}}

Lifecycle is not allowed for ephemeral containers.

Name	Type	Description	Required
postStart	object	PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks	false
preStop	object	PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The Pod's termination grace period countdown begins before the PreStop hook is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod's termination grace period (unless delayed by finalizers). Other management of the container blocks until the hook completes or until the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.ephemeralContainers[index].lifecycle.postStart#

^{^{↩ Parent}}

PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks

Name	Type	Description	Required
exec	object	Exec specifies the action to take.	false
httpGet	object	HTTPGet specifies the http request to perform.	false
sleep	object	Sleep represents the duration that the container should sleep before being terminated.	false
tcpSocket	object	Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for the backward compatibility. There are no validation of this field and lifecycle hooks will fail in runtime when tcp handler is specified.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.ephemeralContainers[index].lifecycle.postStart.exec#

^{^{↩ Parent}}

Exec specifies the action to take.

Name	Type	Description	Required
command	[]string	Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.ephemeralContainers[index].lifecycle.postStart.httpGet#

^{^{↩ Parent}}

HTTPGet specifies the http request to perform.

Name	Type	Description	Required
port	int or string	Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.	false
httpHeaders	[]object	Custom headers to set in the request. HTTP allows repeated headers.	false
path	string	Path to access on the HTTP server.	false
scheme	string	Scheme to use for connecting to the host. Defaults to HTTP.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.ephemeralContainers[index].lifecycle.postStart.httpGet.httpHeaders[index]#

^{^{↩ Parent}}

HTTPHeader describes a custom header to be used in HTTP probes

Name	Type	Description	Required
name	string	The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.	true
value	string	The header field value	true

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.ephemeralContainers[index].lifecycle.postStart.sleep#

^{^{↩ Parent}}

Sleep represents the duration that the container should sleep before being terminated.

Name	Type	Description	Required
seconds	integer	Seconds is the number of seconds to sleep. Format: int64	true

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.ephemeralContainers[index].lifecycle.postStart.tcpSocket#

^{^{↩ Parent}}

Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for the backward compatibility. There are no validation of this field and lifecycle hooks will fail in runtime when tcp handler is specified.

Name	Type	Description	Required
port	int or string	Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Optional: Host name to connect to, defaults to the pod IP.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.ephemeralContainers[index].lifecycle.preStop#

^{^{↩ Parent}}

PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The Pod's termination grace period countdown begins before the PreStop hook is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod's termination grace period (unless delayed by finalizers). Other management of the container blocks until the hook completes or until the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks

Name	Type	Description	Required
exec	object	Exec specifies the action to take.	false
httpGet	object	HTTPGet specifies the http request to perform.	false
sleep	object	Sleep represents the duration that the container should sleep before being terminated.	false
tcpSocket	object	Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for the backward compatibility. There are no validation of this field and lifecycle hooks will fail in runtime when tcp handler is specified.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.ephemeralContainers[index].lifecycle.preStop.exec#

^{^{↩ Parent}}

Exec specifies the action to take.

Name	Type	Description	Required
command	[]string	Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.ephemeralContainers[index].lifecycle.preStop.httpGet#

^{^{↩ Parent}}

HTTPGet specifies the http request to perform.

Name	Type	Description	Required
port	int or string	Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.	false
httpHeaders	[]object	Custom headers to set in the request. HTTP allows repeated headers.	false
path	string	Path to access on the HTTP server.	false
scheme	string	Scheme to use for connecting to the host. Defaults to HTTP.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.ephemeralContainers[index].lifecycle.preStop.httpGet.httpHeaders[index]#

^{^{↩ Parent}}

HTTPHeader describes a custom header to be used in HTTP probes

Name	Type	Description	Required
name	string	The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.	true
value	string	The header field value	true

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.ephemeralContainers[index].lifecycle.preStop.sleep#

^{^{↩ Parent}}

Sleep represents the duration that the container should sleep before being terminated.

Name	Type	Description	Required
seconds	integer	Seconds is the number of seconds to sleep. Format: int64	true

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.ephemeralContainers[index].lifecycle.preStop.tcpSocket#

^{^{↩ Parent}}

Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for the backward compatibility. There are no validation of this field and lifecycle hooks will fail in runtime when tcp handler is specified.

Name	Type	Description	Required
port	int or string	Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Optional: Host name to connect to, defaults to the pod IP.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.ephemeralContainers[index].livenessProbe#

^{^{↩ Parent}}

Probes are not allowed for ephemeral containers.

Name	Type	Description	Required
exec	object	Exec specifies the action to take.	false
failureThreshold	integer	Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. Format: int32	false
grpc	object	GRPC specifies an action involving a GRPC port.	false
httpGet	object	HTTPGet specifies the http request to perform.	false
initialDelaySeconds	integer	Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32	false
periodSeconds	integer	How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Format: int32	false
successThreshold	integer	Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. Format: int32	false
tcpSocket	object	TCPSocket specifies an action involving a TCP port.	false
terminationGracePeriodSeconds	integer	Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. Format: int64	false
timeoutSeconds	integer	Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.ephemeralContainers[index].livenessProbe.exec#

^{^{↩ Parent}}

Exec specifies the action to take.

Name	Type	Description	Required
command	[]string	Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.ephemeralContainers[index].livenessProbe.grpc#

^{^{↩ Parent}}

GRPC specifies an action involving a GRPC port.

Name	Type	Description	Required
port	integer	Port number of the gRPC service. Number must be in the range 1 to 65535. Format: int32	true
service	string	Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.ephemeralContainers[index].livenessProbe.httpGet#

^{^{↩ Parent}}

HTTPGet specifies the http request to perform.

Name	Type	Description	Required
port	int or string	Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.	false
httpHeaders	[]object	Custom headers to set in the request. HTTP allows repeated headers.	false
path	string	Path to access on the HTTP server.	false
scheme	string	Scheme to use for connecting to the host. Defaults to HTTP.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.ephemeralContainers[index].livenessProbe.httpGet.httpHeaders[index]#

^{^{↩ Parent}}

HTTPHeader describes a custom header to be used in HTTP probes

Name	Type	Description	Required
name	string	The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.	true
value	string	The header field value	true

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.ephemeralContainers[index].livenessProbe.tcpSocket#

^{^{↩ Parent}}

TCPSocket specifies an action involving a TCP port.

Name	Type	Description	Required
port	int or string	Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Optional: Host name to connect to, defaults to the pod IP.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.ephemeralContainers[index].ports[index]#

^{^{↩ Parent}}

ContainerPort represents a network port in a single container.

Name	Type	Description	Required
containerPort	integer	Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536. Format: int32	true
hostIP	string	What host IP to bind the external port to.	false
hostPort	integer	Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this. Format: int32	false
name	string	If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services.	false
protocol	string	Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP". Default: TCP	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.ephemeralContainers[index].readinessProbe#

^{^{↩ Parent}}

Probes are not allowed for ephemeral containers.

Name	Type	Description	Required
exec	object	Exec specifies the action to take.	false
failureThreshold	integer	Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. Format: int32	false
grpc	object	GRPC specifies an action involving a GRPC port.	false
httpGet	object	HTTPGet specifies the http request to perform.	false
initialDelaySeconds	integer	Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32	false
periodSeconds	integer	How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Format: int32	false
successThreshold	integer	Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. Format: int32	false
tcpSocket	object	TCPSocket specifies an action involving a TCP port.	false
terminationGracePeriodSeconds	integer	Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. Format: int64	false
timeoutSeconds	integer	Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.ephemeralContainers[index].readinessProbe.exec#

^{^{↩ Parent}}

Exec specifies the action to take.

Name	Type	Description	Required
command	[]string	Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.ephemeralContainers[index].readinessProbe.grpc#

^{^{↩ Parent}}

GRPC specifies an action involving a GRPC port.

Name	Type	Description	Required
port	integer	Port number of the gRPC service. Number must be in the range 1 to 65535. Format: int32	true
service	string	Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.ephemeralContainers[index].readinessProbe.httpGet#

^{^{↩ Parent}}

HTTPGet specifies the http request to perform.

Name	Type	Description	Required
port	int or string	Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.	false
httpHeaders	[]object	Custom headers to set in the request. HTTP allows repeated headers.	false
path	string	Path to access on the HTTP server.	false
scheme	string	Scheme to use for connecting to the host. Defaults to HTTP.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.ephemeralContainers[index].readinessProbe.httpGet.httpHeaders[index]#

^{^{↩ Parent}}

HTTPHeader describes a custom header to be used in HTTP probes

Name	Type	Description	Required
name	string	The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.	true
value	string	The header field value	true

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.ephemeralContainers[index].readinessProbe.tcpSocket#

^{^{↩ Parent}}

TCPSocket specifies an action involving a TCP port.

Name	Type	Description	Required
port	int or string	Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Optional: Host name to connect to, defaults to the pod IP.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.ephemeralContainers[index].resizePolicy[index]#

^{^{↩ Parent}}

ContainerResizePolicy represents resource resize policy for the container.

Name	Type	Description	Required
resourceName	string	Name of the resource to which this resource resize policy applies. Supported values: cpu, memory.	true
restartPolicy	string	Restart policy to apply when specified resource is resized. If not specified, it defaults to NotRequired.	true

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.ephemeralContainers[index].resources#

^{^{↩ Parent}}

Resources are not allowed for ephemeral containers. Ephemeral containers use spare resources already allocated to the pod.

Name	Type	Description	Required
claims	[]object	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.	false
limits	map[string]int or string	Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/	false
requests	map[string]int or string	Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.ephemeralContainers[index].resources.claims[index]#

^{^{↩ Parent}}

ResourceClaim references one entry in PodSpec.ResourceClaims.

Name	Type	Description	Required
name	string	Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.	true

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.ephemeralContainers[index].securityContext#

^{^{↩ Parent}}

Optional: SecurityContext defines the security options the ephemeral container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext.

Name	Type	Description	Required
allowPrivilegeEscalation	boolean	AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN Note that this field cannot be set when spec.os.name is windows.	false
appArmorProfile	object	appArmorProfile is the AppArmor options to use by this container. If set, this profile overrides the pod's appArmorProfile. Note that this field cannot be set when spec.os.name is windows.	false
capabilities	object	The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. Note that this field cannot be set when spec.os.name is windows.	false
privileged	boolean	Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. Note that this field cannot be set when spec.os.name is windows.	false
procMount	string	procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. Note that this field cannot be set when spec.os.name is windows.	false
readOnlyRootFilesystem	boolean	Whether this container has a read-only root filesystem. Default is false. Note that this field cannot be set when spec.os.name is windows.	false
runAsGroup	integer	The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows. Format: int64	false
runAsNonRoot	boolean	Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.	false
runAsUser	integer	The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows. Format: int64	false
seLinuxOptions	object	The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.	false
seccompProfile	object	The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options. Note that this field cannot be set when spec.os.name is windows.	false
windowsOptions	object	The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is linux.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.ephemeralContainers[index].securityContext.appArmorProfile#

^{^{↩ Parent}}

appArmorProfile is the AppArmor options to use by this container. If set, this profile overrides the pod's appArmorProfile. Note that this field cannot be set when spec.os.name is windows.

Name	Type	Description	Required
type	string	type indicates which kind of AppArmor profile will be applied. Valid options are: Localhost - a profile pre-loaded on the node. RuntimeDefault - the container runtime's default profile. Unconfined - no AppArmor enforcement.	true
localhostProfile	string	localhostProfile indicates a profile loaded on the node that should be used. The profile must be preconfigured on the node to work. Must match the loaded name of the profile. Must be set if and only if type is "Localhost".	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.ephemeralContainers[index].securityContext.capabilities#

^{^{↩ Parent}}

The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. Note that this field cannot be set when spec.os.name is windows.

Name	Type	Description	Required
add	[]string	Added capabilities	false
drop	[]string	Removed capabilities	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.ephemeralContainers[index].securityContext.seLinuxOptions#

^{^{↩ Parent}}

The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.

Name	Type	Description	Required
level	string	Level is SELinux level label that applies to the container.	false
role	string	Role is a SELinux role label that applies to the container.	false
type	string	Type is a SELinux type label that applies to the container.	false
user	string	User is a SELinux user label that applies to the container.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.ephemeralContainers[index].securityContext.seccompProfile#

^{^{↩ Parent}}

The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options. Note that this field cannot be set when spec.os.name is windows.

Name	Type	Description	Required
type	string	type indicates which kind of seccomp profile will be applied. Valid options are: Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied.	true
localhostProfile	string	localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's configured seccomp profile location. Must be set if type is "Localhost". Must NOT be set for any other type.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.ephemeralContainers[index].securityContext.windowsOptions#

^{^{↩ Parent}}

The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is linux.

Name	Type	Description	Required
gmsaCredentialSpec	string	GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field.	false
gmsaCredentialSpecName	string	GMSACredentialSpecName is the name of the GMSA credential spec to use.	false
hostProcess	boolean	HostProcess determines if a container should be run as a 'Host Process' container. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true.	false
runAsUserName	string	The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.ephemeralContainers[index].startupProbe#

^{^{↩ Parent}}

Probes are not allowed for ephemeral containers.

Name	Type	Description	Required
exec	object	Exec specifies the action to take.	false
failureThreshold	integer	Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. Format: int32	false
grpc	object	GRPC specifies an action involving a GRPC port.	false
httpGet	object	HTTPGet specifies the http request to perform.	false
initialDelaySeconds	integer	Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32	false
periodSeconds	integer	How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Format: int32	false
successThreshold	integer	Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. Format: int32	false
tcpSocket	object	TCPSocket specifies an action involving a TCP port.	false
terminationGracePeriodSeconds	integer	Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. Format: int64	false
timeoutSeconds	integer	Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.ephemeralContainers[index].startupProbe.exec#

^{^{↩ Parent}}

Exec specifies the action to take.

Name	Type	Description	Required
command	[]string	Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.ephemeralContainers[index].startupProbe.grpc#

^{^{↩ Parent}}

GRPC specifies an action involving a GRPC port.

Name	Type	Description	Required
port	integer	Port number of the gRPC service. Number must be in the range 1 to 65535. Format: int32	true
service	string	Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.ephemeralContainers[index].startupProbe.httpGet#

^{^{↩ Parent}}

HTTPGet specifies the http request to perform.

Name	Type	Description	Required
port	int or string	Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.	false
httpHeaders	[]object	Custom headers to set in the request. HTTP allows repeated headers.	false
path	string	Path to access on the HTTP server.	false
scheme	string	Scheme to use for connecting to the host. Defaults to HTTP.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.ephemeralContainers[index].startupProbe.httpGet.httpHeaders[index]#

^{^{↩ Parent}}

HTTPHeader describes a custom header to be used in HTTP probes

Name	Type	Description	Required
name	string	The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.	true
value	string	The header field value	true

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.ephemeralContainers[index].startupProbe.tcpSocket#

^{^{↩ Parent}}

TCPSocket specifies an action involving a TCP port.

Name	Type	Description	Required
port	int or string	Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Optional: Host name to connect to, defaults to the pod IP.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.ephemeralContainers[index].volumeDevices[index]#

^{^{↩ Parent}}

volumeDevice describes a mapping of a raw block device within a container.

Name	Type	Description	Required
devicePath	string	devicePath is the path inside of the container that the device will be mapped to.	true
name	string	name must match the name of a persistentVolumeClaim in the pod	true

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.ephemeralContainers[index].volumeMounts[index]#

^{^{↩ Parent}}

VolumeMount describes a mounting of a Volume within a container.

Name	Type	Description	Required
mountPath	string	Path within the container at which the volume should be mounted. Must not contain ':'.	true
name	string	This must match the Name of a Volume.	true
mountPropagation	string	mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10. When RecursiveReadOnly is set to IfPossible or to Enabled, MountPropagation must be None or unspecified (which defaults to None).	false
readOnly	boolean	Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.	false
recursiveReadOnly	string	RecursiveReadOnly specifies whether read-only mounts should be handled recursively. If ReadOnly is false, this field has no meaning and must be unspecified. If ReadOnly is true, and this field is set to Disabled, the mount is not made recursively read-only. If this field is set to IfPossible, the mount is made recursively read-only, if it is supported by the container runtime. If this field is set to Enabled, the mount is made recursively read-only if it is supported by the container runtime, otherwise the pod will not be started and an error will be generated to indicate the reason. If this field is set to IfPossible or Enabled, MountPropagation must be set to None (or be unspecified, which defaults to None). If this field is not specified, it is treated as an equivalent of Disabled.	false
subPath	string	Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root).	false
subPathExpr	string	Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to "" (volume's root). SubPathExpr and SubPath are mutually exclusive.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.hostAliases[index]#

^{^{↩ Parent}}

HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod's hosts file.

Name	Type	Description	Required
ip	string	IP address of the host file entry.	true
hostnames	[]string	Hostnames for the above IP address.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.imagePullSecrets[index]#

^{^{↩ Parent}}

LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.

Name	Type	Description	Required
name	string	Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. TODO: Add other useful fields. apiVersion, kind, uid? 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. Default:	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.initContainers[index]#

^{^{↩ Parent}}

A single application container that you want to run within a pod.

Name	Type	Description	Required
name	string	Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated.	true
args	[]string	Arguments to the entrypoint. The container image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell	false
command	[]string	Entrypoint array. Not executed within a shell. The container image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell	false
env	[]object	List of environment variables to set in the container. Cannot be updated.	false
envFrom	[]object	List of sources to populate environment variables in the container. The keys defined within a source 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.	false
image	string	Container image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets.	false
imagePullPolicy	string	Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images	false
lifecycle	object	Actions that the management system should take in response to container lifecycle events. Cannot be updated.	false
livenessProbe	object	Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes	false
ports	[]object	List of ports to expose from the container. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Modifying this array with strategic merge patch may corrupt the data. For more information See https://github.com/kubernetes/kubernetes/issues/108255. Cannot be updated.	false
readinessProbe	object	Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes	false
resizePolicy	[]object	Resources resize policy for the container.	false
resources	object	Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/	false
restartPolicy	string	RestartPolicy defines the restart behavior of individual containers in a pod. This field may only be set for init containers, and the only allowed value is "Always". For non-init containers or when this field is not specified, the restart behavior is defined by the Pod's restart policy and the container type. Setting the RestartPolicy as "Always" for the init container will have the following effect: this init container will be continually restarted on exit until all regular containers have terminated. Once all regular containers have completed, all init containers with restartPolicy "Always" will be shut down. This lifecycle differs from normal init containers and is often referred to as a "sidecar" container. Although this init container still starts in the init container sequence, it does not wait for the container to complete before proceeding to the next init container. Instead, the next init container starts immediately after this init container is started, or after any startupProbe has successfully completed.	false
securityContext	object	SecurityContext defines the security options the container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/	false
startupProbe	object	StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod's lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes	false
stdin	boolean	Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false.	false
stdinOnce	boolean	Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false	false
terminationMessagePath	string	Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated.	false
terminationMessagePolicy	string	Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.	false
tty	boolean	Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false.	false
volumeDevices	[]object	volumeDevices is the list of block devices to be used by the container.	false
volumeMounts	[]object	Pod volumes to mount into the container's filesystem. Cannot be updated.	false
workingDir	string	Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.initContainers[index].env[index]#

^{^{↩ Parent}}

EnvVar represents an environment variable present in a Container.

Name	Type	Description	Required
name	string	Name of the environment variable. Must be a C_IDENTIFIER.	true
value	string	Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "".	false
valueFrom	object	Source for the environment variable's value. Cannot be used if value is not empty.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.initContainers[index].env[index].valueFrom#

^{^{↩ Parent}}

Source for the environment variable's value. Cannot be used if value is not empty.

Name	Type	Description	Required
configMapKeyRef	object	Selects a key of a ConfigMap.	false
fieldRef	object	Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.	false
resourceFieldRef	object	Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.	false
secretKeyRef	object	Selects a key of a secret in the pod's namespace	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.initContainers[index].env[index].valueFrom.configMapKeyRef#

^{^{↩ Parent}}

Selects a key of a ConfigMap.

Name	Type	Description	Required
key	string	The key to select.	true
name	string	Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. TODO: Add other useful fields. apiVersion, kind, uid? 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. Default:	false
optional	boolean	Specify whether the ConfigMap or its key must be defined	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.initContainers[index].env[index].valueFrom.fieldRef#

^{^{↩ Parent}}

Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels['<KEY>'], metadata.annotations['<KEY>'], spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.

Name	Type	Description	Required
fieldPath	string	Path of the field to select in the specified API version.	true
apiVersion	string	Version of the schema the FieldPath is written in terms of, defaults to "v1".	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.initContainers[index].env[index].valueFrom.resourceFieldRef#

^{^{↩ Parent}}

Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.

Name	Type	Description	Required
resource	string	Required: resource to select	true
containerName	string	Container name: required for volumes, optional for env vars	false
divisor	int or string	Specifies the output format of the exposed resources, defaults to "1"	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.initContainers[index].env[index].valueFrom.secretKeyRef#

^{^{↩ Parent}}

Selects a key of a secret in the pod's namespace

Name	Type	Description	Required
key	string	The key of the secret to select from. Must be a valid secret key.	true
name	string	Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. TODO: Add other useful fields. apiVersion, kind, uid? 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. Default:	false
optional	boolean	Specify whether the Secret or its key must be defined	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.initContainers[index].envFrom[index]#

^{^{↩ Parent}}

EnvFromSource represents the source of a set of ConfigMaps

Name	Type	Description	Required
configMapRef	object	The ConfigMap to select from	false
prefix	string	An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.	false
secretRef	object	The Secret to select from	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.initContainers[index].envFrom[index].configMapRef#

^{^{↩ Parent}}

The ConfigMap to select from

Name	Type	Description	Required
name	string	Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. TODO: Add other useful fields. apiVersion, kind, uid? 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. Default:	false
optional	boolean	Specify whether the ConfigMap must be defined	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.initContainers[index].envFrom[index].secretRef#

^{^{↩ Parent}}

The Secret to select from

Name	Type	Description	Required
name	string	Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. TODO: Add other useful fields. apiVersion, kind, uid? 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. Default:	false
optional	boolean	Specify whether the Secret must be defined	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.initContainers[index].lifecycle#

^{^{↩ Parent}}

Actions that the management system should take in response to container lifecycle events. Cannot be updated.

Name	Type	Description	Required
postStart	object	PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks	false
preStop	object	PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The Pod's termination grace period countdown begins before the PreStop hook is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod's termination grace period (unless delayed by finalizers). Other management of the container blocks until the hook completes or until the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.initContainers[index].lifecycle.postStart#

^{^{↩ Parent}}

PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks

Name	Type	Description	Required
exec	object	Exec specifies the action to take.	false
httpGet	object	HTTPGet specifies the http request to perform.	false
sleep	object	Sleep represents the duration that the container should sleep before being terminated.	false
tcpSocket	object	Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for the backward compatibility. There are no validation of this field and lifecycle hooks will fail in runtime when tcp handler is specified.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.initContainers[index].lifecycle.postStart.exec#

^{^{↩ Parent}}

Exec specifies the action to take.

Name	Type	Description	Required
command	[]string	Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.initContainers[index].lifecycle.postStart.httpGet#

^{^{↩ Parent}}

HTTPGet specifies the http request to perform.

Name	Type	Description	Required
port	int or string	Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.	false
httpHeaders	[]object	Custom headers to set in the request. HTTP allows repeated headers.	false
path	string	Path to access on the HTTP server.	false
scheme	string	Scheme to use for connecting to the host. Defaults to HTTP.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.initContainers[index].lifecycle.postStart.httpGet.httpHeaders[index]#

^{^{↩ Parent}}

HTTPHeader describes a custom header to be used in HTTP probes

Name	Type	Description	Required
name	string	The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.	true
value	string	The header field value	true

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.initContainers[index].lifecycle.postStart.sleep#

^{^{↩ Parent}}

Sleep represents the duration that the container should sleep before being terminated.

Name	Type	Description	Required
seconds	integer	Seconds is the number of seconds to sleep. Format: int64	true

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.initContainers[index].lifecycle.postStart.tcpSocket#

^{^{↩ Parent}}

Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for the backward compatibility. There are no validation of this field and lifecycle hooks will fail in runtime when tcp handler is specified.

Name	Type	Description	Required
port	int or string	Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Optional: Host name to connect to, defaults to the pod IP.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.initContainers[index].lifecycle.preStop#

^{^{↩ Parent}}

PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The Pod's termination grace period countdown begins before the PreStop hook is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod's termination grace period (unless delayed by finalizers). Other management of the container blocks until the hook completes or until the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks

Name	Type	Description	Required
exec	object	Exec specifies the action to take.	false
httpGet	object	HTTPGet specifies the http request to perform.	false
sleep	object	Sleep represents the duration that the container should sleep before being terminated.	false
tcpSocket	object	Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for the backward compatibility. There are no validation of this field and lifecycle hooks will fail in runtime when tcp handler is specified.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.initContainers[index].lifecycle.preStop.exec#

^{^{↩ Parent}}

Exec specifies the action to take.

Name	Type	Description	Required
command	[]string	Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.initContainers[index].lifecycle.preStop.httpGet#

^{^{↩ Parent}}

HTTPGet specifies the http request to perform.

Name	Type	Description	Required
port	int or string	Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.	false
httpHeaders	[]object	Custom headers to set in the request. HTTP allows repeated headers.	false
path	string	Path to access on the HTTP server.	false
scheme	string	Scheme to use for connecting to the host. Defaults to HTTP.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.initContainers[index].lifecycle.preStop.httpGet.httpHeaders[index]#

^{^{↩ Parent}}

HTTPHeader describes a custom header to be used in HTTP probes

Name	Type	Description	Required
name	string	The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.	true
value	string	The header field value	true

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.initContainers[index].lifecycle.preStop.sleep#

^{^{↩ Parent}}

Sleep represents the duration that the container should sleep before being terminated.

Name	Type	Description	Required
seconds	integer	Seconds is the number of seconds to sleep. Format: int64	true

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.initContainers[index].lifecycle.preStop.tcpSocket#

^{^{↩ Parent}}

Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for the backward compatibility. There are no validation of this field and lifecycle hooks will fail in runtime when tcp handler is specified.

Name	Type	Description	Required
port	int or string	Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Optional: Host name to connect to, defaults to the pod IP.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.initContainers[index].livenessProbe#

^{^{↩ Parent}}

Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

Name	Type	Description	Required
exec	object	Exec specifies the action to take.	false
failureThreshold	integer	Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. Format: int32	false
grpc	object	GRPC specifies an action involving a GRPC port.	false
httpGet	object	HTTPGet specifies the http request to perform.	false
initialDelaySeconds	integer	Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32	false
periodSeconds	integer	How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Format: int32	false
successThreshold	integer	Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. Format: int32	false
tcpSocket	object	TCPSocket specifies an action involving a TCP port.	false
terminationGracePeriodSeconds	integer	Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. Format: int64	false
timeoutSeconds	integer	Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.initContainers[index].livenessProbe.exec#

^{^{↩ Parent}}

Exec specifies the action to take.

Name	Type	Description	Required
command	[]string	Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.initContainers[index].livenessProbe.grpc#

^{^{↩ Parent}}

GRPC specifies an action involving a GRPC port.

Name	Type	Description	Required
port	integer	Port number of the gRPC service. Number must be in the range 1 to 65535. Format: int32	true
service	string	Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.initContainers[index].livenessProbe.httpGet#

^{^{↩ Parent}}

HTTPGet specifies the http request to perform.

Name	Type	Description	Required
port	int or string	Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.	false
httpHeaders	[]object	Custom headers to set in the request. HTTP allows repeated headers.	false
path	string	Path to access on the HTTP server.	false
scheme	string	Scheme to use for connecting to the host. Defaults to HTTP.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.initContainers[index].livenessProbe.httpGet.httpHeaders[index]#

^{^{↩ Parent}}

HTTPHeader describes a custom header to be used in HTTP probes

Name	Type	Description	Required
name	string	The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.	true
value	string	The header field value	true

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.initContainers[index].livenessProbe.tcpSocket#

^{^{↩ Parent}}

TCPSocket specifies an action involving a TCP port.

Name	Type	Description	Required
port	int or string	Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Optional: Host name to connect to, defaults to the pod IP.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.initContainers[index].ports[index]#

^{^{↩ Parent}}

ContainerPort represents a network port in a single container.

Name	Type	Description	Required
containerPort	integer	Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536. Format: int32	true
hostIP	string	What host IP to bind the external port to.	false
hostPort	integer	Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this. Format: int32	false
name	string	If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services.	false
protocol	string	Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP". Default: TCP	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.initContainers[index].readinessProbe#

^{^{↩ Parent}}

Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

Name	Type	Description	Required
exec	object	Exec specifies the action to take.	false
failureThreshold	integer	Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. Format: int32	false
grpc	object	GRPC specifies an action involving a GRPC port.	false
httpGet	object	HTTPGet specifies the http request to perform.	false
initialDelaySeconds	integer	Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32	false
periodSeconds	integer	How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Format: int32	false
successThreshold	integer	Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. Format: int32	false
tcpSocket	object	TCPSocket specifies an action involving a TCP port.	false
terminationGracePeriodSeconds	integer	Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. Format: int64	false
timeoutSeconds	integer	Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.initContainers[index].readinessProbe.exec#

^{^{↩ Parent}}

Exec specifies the action to take.

Name	Type	Description	Required
command	[]string	Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.initContainers[index].readinessProbe.grpc#

^{^{↩ Parent}}

GRPC specifies an action involving a GRPC port.

Name	Type	Description	Required
port	integer	Port number of the gRPC service. Number must be in the range 1 to 65535. Format: int32	true
service	string	Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.initContainers[index].readinessProbe.httpGet#

^{^{↩ Parent}}

HTTPGet specifies the http request to perform.

Name	Type	Description	Required
port	int or string	Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.	false
httpHeaders	[]object	Custom headers to set in the request. HTTP allows repeated headers.	false
path	string	Path to access on the HTTP server.	false
scheme	string	Scheme to use for connecting to the host. Defaults to HTTP.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.initContainers[index].readinessProbe.httpGet.httpHeaders[index]#

^{^{↩ Parent}}

HTTPHeader describes a custom header to be used in HTTP probes

Name	Type	Description	Required
name	string	The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.	true
value	string	The header field value	true

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.initContainers[index].readinessProbe.tcpSocket#

^{^{↩ Parent}}

TCPSocket specifies an action involving a TCP port.

Name	Type	Description	Required
port	int or string	Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Optional: Host name to connect to, defaults to the pod IP.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.initContainers[index].resizePolicy[index]#

^{^{↩ Parent}}

ContainerResizePolicy represents resource resize policy for the container.

Name	Type	Description	Required
resourceName	string	Name of the resource to which this resource resize policy applies. Supported values: cpu, memory.	true
restartPolicy	string	Restart policy to apply when specified resource is resized. If not specified, it defaults to NotRequired.	true

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.initContainers[index].resources#

^{^{↩ Parent}}

Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

Name	Type	Description	Required
claims	[]object	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.	false
limits	map[string]int or string	Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/	false
requests	map[string]int or string	Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.initContainers[index].resources.claims[index]#

^{^{↩ Parent}}

ResourceClaim references one entry in PodSpec.ResourceClaims.

Name	Type	Description	Required
name	string	Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.	true

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.initContainers[index].securityContext#

^{^{↩ Parent}}

SecurityContext defines the security options the container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/

Name	Type	Description	Required
allowPrivilegeEscalation	boolean	AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN Note that this field cannot be set when spec.os.name is windows.	false
appArmorProfile	object	appArmorProfile is the AppArmor options to use by this container. If set, this profile overrides the pod's appArmorProfile. Note that this field cannot be set when spec.os.name is windows.	false
capabilities	object	The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. Note that this field cannot be set when spec.os.name is windows.	false
privileged	boolean	Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. Note that this field cannot be set when spec.os.name is windows.	false
procMount	string	procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. Note that this field cannot be set when spec.os.name is windows.	false
readOnlyRootFilesystem	boolean	Whether this container has a read-only root filesystem. Default is false. Note that this field cannot be set when spec.os.name is windows.	false
runAsGroup	integer	The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows. Format: int64	false
runAsNonRoot	boolean	Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.	false
runAsUser	integer	The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows. Format: int64	false
seLinuxOptions	object	The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.	false
seccompProfile	object	The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options. Note that this field cannot be set when spec.os.name is windows.	false
windowsOptions	object	The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is linux.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.initContainers[index].securityContext.appArmorProfile#

^{^{↩ Parent}}

appArmorProfile is the AppArmor options to use by this container. If set, this profile overrides the pod's appArmorProfile. Note that this field cannot be set when spec.os.name is windows.

Name	Type	Description	Required
type	string	type indicates which kind of AppArmor profile will be applied. Valid options are: Localhost - a profile pre-loaded on the node. RuntimeDefault - the container runtime's default profile. Unconfined - no AppArmor enforcement.	true
localhostProfile	string	localhostProfile indicates a profile loaded on the node that should be used. The profile must be preconfigured on the node to work. Must match the loaded name of the profile. Must be set if and only if type is "Localhost".	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.initContainers[index].securityContext.capabilities#

^{^{↩ Parent}}

The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. Note that this field cannot be set when spec.os.name is windows.

Name	Type	Description	Required
add	[]string	Added capabilities	false
drop	[]string	Removed capabilities	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.initContainers[index].securityContext.seLinuxOptions#

^{^{↩ Parent}}

The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.

Name	Type	Description	Required
level	string	Level is SELinux level label that applies to the container.	false
role	string	Role is a SELinux role label that applies to the container.	false
type	string	Type is a SELinux type label that applies to the container.	false
user	string	User is a SELinux user label that applies to the container.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.initContainers[index].securityContext.seccompProfile#

^{^{↩ Parent}}

The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options. Note that this field cannot be set when spec.os.name is windows.

Name	Type	Description	Required
type	string	type indicates which kind of seccomp profile will be applied. Valid options are: Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied.	true
localhostProfile	string	localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's configured seccomp profile location. Must be set if type is "Localhost". Must NOT be set for any other type.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.initContainers[index].securityContext.windowsOptions#

^{^{↩ Parent}}

The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is linux.

Name	Type	Description	Required
gmsaCredentialSpec	string	GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field.	false
gmsaCredentialSpecName	string	GMSACredentialSpecName is the name of the GMSA credential spec to use.	false
hostProcess	boolean	HostProcess determines if a container should be run as a 'Host Process' container. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true.	false
runAsUserName	string	The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.initContainers[index].startupProbe#

^{^{↩ Parent}}

StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod's lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

Name	Type	Description	Required
exec	object	Exec specifies the action to take.	false
failureThreshold	integer	Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. Format: int32	false
grpc	object	GRPC specifies an action involving a GRPC port.	false
httpGet	object	HTTPGet specifies the http request to perform.	false
initialDelaySeconds	integer	Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32	false
periodSeconds	integer	How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Format: int32	false
successThreshold	integer	Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. Format: int32	false
tcpSocket	object	TCPSocket specifies an action involving a TCP port.	false
terminationGracePeriodSeconds	integer	Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. Format: int64	false
timeoutSeconds	integer	Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.initContainers[index].startupProbe.exec#

^{^{↩ Parent}}

Exec specifies the action to take.

Name	Type	Description	Required
command	[]string	Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.initContainers[index].startupProbe.grpc#

^{^{↩ Parent}}

GRPC specifies an action involving a GRPC port.

Name	Type	Description	Required
port	integer	Port number of the gRPC service. Number must be in the range 1 to 65535. Format: int32	true
service	string	Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.initContainers[index].startupProbe.httpGet#

^{^{↩ Parent}}

HTTPGet specifies the http request to perform.

Name	Type	Description	Required
port	int or string	Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.	false
httpHeaders	[]object	Custom headers to set in the request. HTTP allows repeated headers.	false
path	string	Path to access on the HTTP server.	false
scheme	string	Scheme to use for connecting to the host. Defaults to HTTP.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.initContainers[index].startupProbe.httpGet.httpHeaders[index]#

^{^{↩ Parent}}

HTTPHeader describes a custom header to be used in HTTP probes

Name	Type	Description	Required
name	string	The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.	true
value	string	The header field value	true

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.initContainers[index].startupProbe.tcpSocket#

^{^{↩ Parent}}

TCPSocket specifies an action involving a TCP port.

Name	Type	Description	Required
port	int or string	Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Optional: Host name to connect to, defaults to the pod IP.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.initContainers[index].volumeDevices[index]#

^{^{↩ Parent}}

volumeDevice describes a mapping of a raw block device within a container.

Name	Type	Description	Required
devicePath	string	devicePath is the path inside of the container that the device will be mapped to.	true
name	string	name must match the name of a persistentVolumeClaim in the pod	true

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.initContainers[index].volumeMounts[index]#

^{^{↩ Parent}}

VolumeMount describes a mounting of a Volume within a container.

Name	Type	Description	Required
mountPath	string	Path within the container at which the volume should be mounted. Must not contain ':'.	true
name	string	This must match the Name of a Volume.	true
mountPropagation	string	mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10. When RecursiveReadOnly is set to IfPossible or to Enabled, MountPropagation must be None or unspecified (which defaults to None).	false
readOnly	boolean	Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.	false
recursiveReadOnly	string	RecursiveReadOnly specifies whether read-only mounts should be handled recursively. If ReadOnly is false, this field has no meaning and must be unspecified. If ReadOnly is true, and this field is set to Disabled, the mount is not made recursively read-only. If this field is set to IfPossible, the mount is made recursively read-only, if it is supported by the container runtime. If this field is set to Enabled, the mount is made recursively read-only if it is supported by the container runtime, otherwise the pod will not be started and an error will be generated to indicate the reason. If this field is set to IfPossible or Enabled, MountPropagation must be set to None (or be unspecified, which defaults to None). If this field is not specified, it is treated as an equivalent of Disabled.	false
subPath	string	Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root).	false
subPathExpr	string	Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to "" (volume's root). SubPathExpr and SubPath are mutually exclusive.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.os#

^{^{↩ Parent}}

Specifies the OS of the containers in the pod. Some pod and container fields are restricted if this is set.

If the OS field is set to linux, the following fields must be unset: -securityContext.windowsOptions

If the OS field is set to windows, following fields must be unset: - spec.hostPID - spec.hostIPC - spec.hostUsers - spec.securityContext.appArmorProfile - spec.securityContext.seLinuxOptions - spec.securityContext.seccompProfile - spec.securityContext.fsGroup - spec.securityContext.fsGroupChangePolicy - spec.securityContext.sysctls - spec.shareProcessNamespace - spec.securityContext.runAsUser - spec.securityContext.runAsGroup - spec.securityContext.supplementalGroups - spec.containers[].securityContext.appArmorProfile - spec.containers[].securityContext.seLinuxOptions - spec.containers[].securityContext.seccompProfile - spec.containers[].securityContext.capabilities - spec.containers[].securityContext.readOnlyRootFilesystem - spec.containers[].securityContext.privileged - spec.containers[].securityContext.allowPrivilegeEscalation - spec.containers[].securityContext.procMount - spec.containers[].securityContext.runAsUser - spec.containers[].securityContext.runAsGroup

Name	Type	Description	Required
name	string	Name is the name of the operating system. The currently supported values are linux and windows. Additional value may be defined in future and can be one of: https://github.com/opencontainers/runtime-spec/blob/master/config.md#platform-specific-configuration Clients should expect to handle additional values and treat unrecognized values in this field as os: null	true

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.readinessGates[index]#

^{^{↩ Parent}}

PodReadinessGate contains the reference to a pod condition

Name	Type	Description	Required
conditionType	string	ConditionType refers to a condition in the pod's condition list with matching type.	true

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.resourceClaims[index]#

^{^{↩ Parent}}

PodResourceClaim references exactly one ResourceClaim through a ClaimSource. It adds a name to it that uniquely identifies the ResourceClaim inside the Pod. Containers that need access to the ResourceClaim reference it with this name.

Name	Type	Description	Required
name	string	Name uniquely identifies this resource claim inside the pod. This must be a DNS_LABEL.	true
source	object	Source describes where to find the ResourceClaim.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.resourceClaims[index].source#

^{^{↩ Parent}}

Source describes where to find the ResourceClaim.

Name	Type	Description	Required
resourceClaimName	string	ResourceClaimName is the name of a ResourceClaim object in the same namespace as this pod.	false
resourceClaimTemplateName	string	ResourceClaimTemplateName is the name of a ResourceClaimTemplate object in the same namespace as this pod. The template will be used to create a new ResourceClaim, which will be bound to this pod. When this pod is deleted, the ResourceClaim will also be deleted. The pod name and resource name, along with a generated component, will be used to form a unique name for the ResourceClaim, which will be recorded in pod.status.resourceClaimStatuses. This field is immutable and no changes will be made to the corresponding ResourceClaim by the control plane after creating the ResourceClaim.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.schedulingGates[index]#

^{^{↩ Parent}}

PodSchedulingGate is associated to a Pod to guard its scheduling.

Name	Type	Description	Required
name	string	Name of the scheduling gate. Each scheduling gate must have a unique name field.	true

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.securityContext#

^{^{↩ Parent}}

SecurityContext holds pod-level security attributes and common container settings. Optional: Defaults to empty. See type description for default values of each field.

Name	Type	Description	Required
appArmorProfile	object	appArmorProfile is the AppArmor options to use by the containers in this pod. Note that this field cannot be set when spec.os.name is windows.	false
fsGroup	integer	A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod: 1. The owning GID will be the FSGroup 2. The setgid bit is set (new files created in the volume will be owned by FSGroup) 3. The permission bits are OR'd with rw-rw---- If unset, the Kubelet will not modify the ownership and permissions of any volume. Note that this field cannot be set when spec.os.name is windows. Format: int64	false
fsGroupChangePolicy	string	fsGroupChangePolicy defines behavior of changing ownership and permission of the volume before being exposed inside Pod. This field will only apply to volume types which support fsGroup based ownership(and permissions). It will have no effect on ephemeral volume types such as: secret, configmaps and emptydir. Valid values are "OnRootMismatch" and "Always". If not specified, "Always" is used. Note that this field cannot be set when spec.os.name is windows.	false
runAsGroup	integer	The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows. Format: int64	false
runAsNonRoot	boolean	Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.	false
runAsUser	integer	The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows. Format: int64	false
seLinuxOptions	object	The SELinux context to be applied to all containers. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows.	false
seccompProfile	object	The seccomp options to use by the containers in this pod. Note that this field cannot be set when spec.os.name is windows.	false
supplementalGroups	[]integer	A list of groups applied to the first process run in each container, in addition to the container's primary GID, the fsGroup (if specified), and group memberships defined in the container image for the uid of the container process. If unspecified, no additional groups are added to any container. Note that group memberships defined in the container image for the uid of the container process are still effective, even if they are not included in this list. Note that this field cannot be set when spec.os.name is windows.	false
sysctls	[]object	Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch. Note that this field cannot be set when spec.os.name is windows.	false
windowsOptions	object	The Windows specific settings applied to all containers. If unspecified, the options within a container's SecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is linux.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.securityContext.appArmorProfile#

^{^{↩ Parent}}

appArmorProfile is the AppArmor options to use by the containers in this pod. Note that this field cannot be set when spec.os.name is windows.

Name	Type	Description	Required
type	string	type indicates which kind of AppArmor profile will be applied. Valid options are: Localhost - a profile pre-loaded on the node. RuntimeDefault - the container runtime's default profile. Unconfined - no AppArmor enforcement.	true
localhostProfile	string	localhostProfile indicates a profile loaded on the node that should be used. The profile must be preconfigured on the node to work. Must match the loaded name of the profile. Must be set if and only if type is "Localhost".	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.securityContext.seLinuxOptions#

^{^{↩ Parent}}

The SELinux context to be applied to all containers. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows.

Name	Type	Description	Required
level	string	Level is SELinux level label that applies to the container.	false
role	string	Role is a SELinux role label that applies to the container.	false
type	string	Type is a SELinux type label that applies to the container.	false
user	string	User is a SELinux user label that applies to the container.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.securityContext.seccompProfile#

^{^{↩ Parent}}

The seccomp options to use by the containers in this pod. Note that this field cannot be set when spec.os.name is windows.

Name	Type	Description	Required
type	string	type indicates which kind of seccomp profile will be applied. Valid options are: Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied.	true
localhostProfile	string	localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's configured seccomp profile location. Must be set if type is "Localhost". Must NOT be set for any other type.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.securityContext.sysctls[index]#

^{^{↩ Parent}}

Sysctl defines a kernel parameter to be set

Name	Type	Description	Required
name	string	Name of a property to set	true
value	string	Value of a property to set	true

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.securityContext.windowsOptions#

^{^{↩ Parent}}

The Windows specific settings applied to all containers. If unspecified, the options within a container's SecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is linux.

Name	Type	Description	Required
gmsaCredentialSpec	string	GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field.	false
gmsaCredentialSpecName	string	GMSACredentialSpecName is the name of the GMSA credential spec to use.	false
hostProcess	boolean	HostProcess determines if a container should be run as a 'Host Process' container. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true.	false
runAsUserName	string	The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.tolerations[index]#

^{^{↩ Parent}}

The pod this Toleration is attached to tolerates any taint that matches the triple using the matching operator .

Name	Type	Description	Required
effect	string	Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.	false
key	string	Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys.	false
operator	string	Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category.	false
tolerationSeconds	integer	TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system. Format: int64	false
value	string	Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.topologySpreadConstraints[index]#

^{^{↩ Parent}}

TopologySpreadConstraint specifies how to spread matching pods among the given topology.

Name	Type	Description	Required
maxSkew	integer	MaxSkew describes the degree to which pods may be unevenly distributed. When `whenUnsatisfiable=DoNotSchedule`, it is the maximum permitted difference between the number of matching pods in the target topology and the global minimum. The global minimum is the minimum number of matching pods in an eligible domain or zero if the number of eligible domains is less than MinDomains. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 2/2/1: In this case, the global minimum is 1. \| zone1 \| zone2 \| zone3 \| \| P P \| P P \| P \| - if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 2/2/2; scheduling it onto zone1(zone2) would make the ActualSkew(3-1) on zone1(zone2) violate MaxSkew(1). - if MaxSkew is 2, incoming pod can be scheduled onto any zone. When `whenUnsatisfiable=ScheduleAnyway`, it is used to give higher precedence to topologies that satisfy it. It's a required field. Default value is 1 and 0 is not allowed. Format: int32	true
topologyKey	string	TopologyKey is the key of node labels. Nodes that have a label with this key and identical values are considered to be in the same topology. We consider each as a "bucket", and try to put balanced number of pods into each bucket. We define a domain as a particular instance of a topology. Also, we define an eligible domain as a domain whose nodes meet the requirements of nodeAffinityPolicy and nodeTaintsPolicy. e.g. If TopologyKey is "kubernetes.io/hostname", each Node is a domain of that topology. And, if TopologyKey is "topology.kubernetes.io/zone", each zone is a domain of that topology. It's a required field.	true
whenUnsatisfiable	string	WhenUnsatisfiable indicates how to deal with a pod if it doesn't satisfy the spread constraint. - DoNotSchedule (default) tells the scheduler not to schedule it. - ScheduleAnyway tells the scheduler to schedule the pod in any location, but giving higher precedence to topologies that would help reduce the skew. A constraint is considered "Unsatisfiable" for an incoming pod if and only if every possible node assignment for that pod would violate "MaxSkew" on some topology. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 3/1/1: \| zone1 \| zone2 \| zone3 \| \| P P P \| P \| P \| If WhenUnsatisfiable is set to DoNotSchedule, incoming pod can only be scheduled to zone2(zone3) to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3) satisfies MaxSkew(1). In other words, the cluster can still be imbalanced, but scheduler won't make it more imbalanced. It's a required field.	true
labelSelector	object	LabelSelector is used to find matching pods. Pods that match this label selector are counted to determine the number of pods in their corresponding topology domain.	false
matchLabelKeys	[]string	MatchLabelKeys is a set of pod label keys to select the pods over which spreading will be calculated. The keys are used to lookup values from the incoming pod labels, those key-value labels are ANDed with labelSelector to select the group of existing pods over which spreading will be calculated for the incoming pod. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector. MatchLabelKeys cannot be set when LabelSelector isn't set. Keys that don't exist in the incoming pod labels will be ignored. A null or empty list means only match against labelSelector. This is a beta field and requires the MatchLabelKeysInPodTopologySpread feature gate to be enabled (enabled by default).	false
minDomains	integer	MinDomains indicates a minimum number of eligible domains. When the number of eligible domains with matching topology keys is less than minDomains, Pod Topology Spread treats "global minimum" as 0, and then the calculation of Skew is performed. And when the number of eligible domains with matching topology keys equals or greater than minDomains, this value has no effect on scheduling. As a result, when the number of eligible domains is less than minDomains, scheduler won't schedule more than maxSkew Pods to those domains. If value is nil, the constraint behaves as if MinDomains is equal to 1. Valid values are integers greater than 0. When value is not nil, WhenUnsatisfiable must be DoNotSchedule. For example, in a 3-zone cluster, MaxSkew is set to 2, MinDomains is set to 5 and pods with the same labelSelector spread as 2/2/2: \| zone1 \| zone2 \| zone3 \| \| P P \| P P \| P P \| The number of domains is less than 5(MinDomains), so "global minimum" is treated as 0. In this situation, new pod with the same labelSelector cannot be scheduled, because computed skew will be 3(3 - 0) if new Pod is scheduled to any of the three zones, it will violate MaxSkew. Format: int32	false
nodeAffinityPolicy	string	NodeAffinityPolicy indicates how we will treat Pod's nodeAffinity/nodeSelector when calculating pod topology spread skew. Options are: - Honor: only nodes matching nodeAffinity/nodeSelector are included in the calculations. - Ignore: nodeAffinity/nodeSelector are ignored. All nodes are included in the calculations. If this value is nil, the behavior is equivalent to the Honor policy. This is a beta-level feature default enabled by the NodeInclusionPolicyInPodTopologySpread feature flag.	false
nodeTaintsPolicy	string	NodeTaintsPolicy indicates how we will treat node taints when calculating pod topology spread skew. Options are: - Honor: nodes without taints, along with tainted nodes for which the incoming pod has a toleration, are included. - Ignore: node taints are ignored. All nodes are included. If this value is nil, the behavior is equivalent to the Ignore policy. This is a beta-level feature default enabled by the NodeInclusionPolicyInPodTopologySpread feature flag.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.topologySpreadConstraints[index].labelSelector#

^{^{↩ Parent}}

LabelSelector is used to find matching pods. Pods that match this label selector are counted to determine the number of pods in their corresponding topology domain.

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.topologySpreadConstraints[index].labelSelector.matchExpressions[index]#

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.volumes[index]#

^{^{↩ Parent}}

Volume represents a named volume in a pod that may be accessed by any container in the pod.

Name	Type	Description	Required
name	string	name of the volume. Must be a DNS_LABEL and unique within the pod. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names	true
awsElasticBlockStore	object	awsElasticBlockStore represents an AWS Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore	false
azureDisk	object	azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.	false
azureFile	object	azureFile represents an Azure File Service mount on the host and bind mount to the pod.	false
cephfs	object	cephFS represents a Ceph FS mount on the host that shares a pod's lifetime	false
cinder	object	cinder represents a cinder volume attached and mounted on kubelets host machine. More info: https://examples.k8s.io/mysql-cinder-pd/README.md	false
configMap	object	configMap represents a configMap that should populate this volume	false
csi	object	csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature).	false
downwardAPI	object	downwardAPI represents downward API about the pod that should populate this volume	false
emptyDir	object	emptyDir represents a temporary directory that shares a pod's lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir	false
ephemeral	object	ephemeral represents a volume that is handled by a cluster storage driver. The volume's lifecycle is tied to the pod that defines it - it will be created before the pod starts, and deleted when the pod is removed. Use this if: a) the volume is only needed while the pod runs, b) features of normal volumes like restoring from snapshot or capacity tracking are needed, c) the storage driver is specified through a storage class, and d) the storage driver supports dynamic volume provisioning through a PersistentVolumeClaim (see EphemeralVolumeSource for more information on the connection between this volume type and PersistentVolumeClaim). Use PersistentVolumeClaim or one of the vendor-specific APIs for volumes that persist for longer than the lifecycle of an individual pod. Use CSI for light-weight local ephemeral volumes if the CSI driver is meant to be used that way - see the documentation of the driver for more information. A pod can use both types of ephemeral volumes and persistent volumes at the same time.	false
fc	object	fc represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod.	false
flexVolume	object	flexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.	false
flocker	object	flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running	false
gcePersistentDisk	object	gcePersistentDisk represents a GCE Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk	false
gitRepo	object	gitRepo represents a git repository at a particular revision. DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod's container.	false
glusterfs	object	glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/glusterfs/README.md	false
hostPath	object	hostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath --- TODO(jonesdl) We need to restrict who can use host directory mounts and who can/can not mount host directories as read/write.	false
iscsi	object	iscsi represents an ISCSI Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://examples.k8s.io/volumes/iscsi/README.md	false
nfs	object	nfs represents an NFS mount on the host that shares a pod's lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs	false
persistentVolumeClaim	object	persistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims	false
photonPersistentDisk	object	photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine	false
portworxVolume	object	portworxVolume represents a portworx volume attached and mounted on kubelets host machine	false
projected	object	projected items for all in one resources secrets, configmaps, and downward API	false
quobyte	object	quobyte represents a Quobyte mount on the host that shares a pod's lifetime	false
rbd	object	rbd represents a Rados Block Device mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/rbd/README.md	false
scaleIO	object	scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.	false
secret	object	secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret	false
storageos	object	storageOS represents a StorageOS volume attached and mounted on Kubernetes nodes.	false
vsphereVolume	object	vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.volumes[index].awsElasticBlockStore#

^{^{↩ Parent}}

awsElasticBlockStore represents an AWS Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore

Name	Type	Description	Required
volumeID	string	volumeID is unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore	true
fsType	string	fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore TODO: how do we prevent errors in the filesystem from compromising the machine	false
partition	integer	partition is the partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). Format: int32	false
readOnly	boolean	readOnly value true will force the readOnly setting in VolumeMounts. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.volumes[index].azureDisk#

^{^{↩ Parent}}

azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.

Name	Type	Description	Required
diskName	string	diskName is the Name of the data disk in the blob storage	true
diskURI	string	diskURI is the URI of data disk in the blob storage	true
cachingMode	string	cachingMode is the Host Caching mode: None, Read Only, Read Write.	false
fsType	string	fsType is Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.	false
kind	string	kind expected values are Shared: multiple blob disks per storage account Dedicated: single blob disk per storage account Managed: azure managed data disk (only in managed availability set). defaults to shared	false
readOnly	boolean	readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.volumes[index].azureFile#

^{^{↩ Parent}}

azureFile represents an Azure File Service mount on the host and bind mount to the pod.

Name	Type	Description	Required
secretName	string	secretName is the name of secret that contains Azure Storage Account Name and Key	true
shareName	string	shareName is the azure share Name	true
readOnly	boolean	readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.volumes[index].cephfs#

^{^{↩ Parent}}

cephFS represents a Ceph FS mount on the host that shares a pod's lifetime

Name	Type	Description	Required
monitors	[]string	monitors is Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it	true
path	string	path is Optional: Used as the mounted root, rather than the full Ceph tree, default is /	false
readOnly	boolean	readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it	false
secretFile	string	secretFile is Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it	false
secretRef	object	secretRef is Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it	false
user	string	user is optional: User is the rados user name, default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.volumes[index].cephfs.secretRef#

^{^{↩ Parent}}

secretRef is Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it

Name	Type	Description	Required
name	string	Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. TODO: Add other useful fields. apiVersion, kind, uid? 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. Default:	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.volumes[index].cinder#

^{^{↩ Parent}}

cinder represents a cinder volume attached and mounted on kubelets host machine. More info: https://examples.k8s.io/mysql-cinder-pd/README.md

Name	Type	Description	Required
volumeID	string	volumeID used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md	true
fsType	string	fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://examples.k8s.io/mysql-cinder-pd/README.md	false
readOnly	boolean	readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/mysql-cinder-pd/README.md	false
secretRef	object	secretRef is optional: points to a secret object containing parameters used to connect to OpenStack.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.volumes[index].cinder.secretRef#

^{^{↩ Parent}}

secretRef is optional: points to a secret object containing parameters used to connect to OpenStack.

Name	Type	Description	Required
name	string	Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. TODO: Add other useful fields. apiVersion, kind, uid? 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. Default:	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.volumes[index].configMap#

^{^{↩ Parent}}

configMap represents a configMap that should populate this volume

Name	Type	Description	Required
defaultMode	integer	defaultMode is optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false
items	[]object	items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.	false
name	string	Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. TODO: Add other useful fields. apiVersion, kind, uid? 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. Default:	false
optional	boolean	optional specify whether the ConfigMap or its keys must be defined	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.volumes[index].configMap.items[index]#

^{^{↩ Parent}}

Maps a string key to a path within a volume.

Name	Type	Description	Required
key	string	key is the key to project.	true
path	string	path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.	true
mode	integer	mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.volumes[index].csi#

^{^{↩ Parent}}

csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature).

Name	Type	Description	Required
driver	string	driver is the name of the CSI driver that handles this volume. Consult with your admin for the correct name as registered in the cluster.	true
fsType	string	fsType to mount. Ex. "ext4", "xfs", "ntfs". If not provided, the empty value is passed to the associated CSI driver which will determine the default filesystem to apply.	false
nodePublishSecretRef	object	nodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secret references are passed.	false
readOnly	boolean	readOnly specifies a read-only configuration for the volume. Defaults to false (read/write).	false
volumeAttributes	map[string]string	volumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver's documentation for supported values.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.volumes[index].csi.nodePublishSecretRef#

^{^{↩ Parent}}

nodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secret references are passed.

Name	Type	Description	Required
name	string	Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. TODO: Add other useful fields. apiVersion, kind, uid? 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. Default:	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.volumes[index].downwardAPI#

^{^{↩ Parent}}

downwardAPI represents downward API about the pod that should populate this volume

Name	Type	Description	Required
defaultMode	integer	Optional: mode bits to use on created files by default. Must be a Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false
items	[]object	Items is a list of downward API volume file	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.volumes[index].downwardAPI.items[index]#

^{^{↩ Parent}}

DownwardAPIVolumeFile represents information to create the file containing the pod field

Name	Type	Description	Required
path	string	Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'	true
fieldRef	object	Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported.	false
mode	integer	Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false
resourceFieldRef	object	Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.volumes[index].downwardAPI.items[index].fieldRef#

^{^{↩ Parent}}

Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported.

Name	Type	Description	Required
fieldPath	string	Path of the field to select in the specified API version.	true
apiVersion	string	Version of the schema the FieldPath is written in terms of, defaults to "v1".	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.volumes[index].downwardAPI.items[index].resourceFieldRef#

^{^{↩ Parent}}

Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.

Name	Type	Description	Required
resource	string	Required: resource to select	true
containerName	string	Container name: required for volumes, optional for env vars	false
divisor	int or string	Specifies the output format of the exposed resources, defaults to "1"	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.volumes[index].emptyDir#

^{^{↩ Parent}}

emptyDir represents a temporary directory that shares a pod's lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir

Name	Type	Description	Required
medium	string	medium represents what type of storage medium should back this directory. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir	false
sizeLimit	int or string	sizeLimit is the total amount of local storage required for this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers in a pod. The default is nil which means that the limit is undefined. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.volumes[index].ephemeral#

^{^{↩ Parent}}

ephemeral represents a volume that is handled by a cluster storage driver. The volume's lifecycle is tied to the pod that defines it - it will be created before the pod starts, and deleted when the pod is removed.

Use this if: a) the volume is only needed while the pod runs, b) features of normal volumes like restoring from snapshot or capacity tracking are needed, c) the storage driver is specified through a storage class, and d) the storage driver supports dynamic volume provisioning through a PersistentVolumeClaim (see EphemeralVolumeSource for more information on the connection between this volume type and PersistentVolumeClaim).

Use PersistentVolumeClaim or one of the vendor-specific APIs for volumes that persist for longer than the lifecycle of an individual pod.

Use CSI for light-weight local ephemeral volumes if the CSI driver is meant to be used that way - see the documentation of the driver for more information.

A pod can use both types of ephemeral volumes and persistent volumes at the same time.

Name	Type	Description	Required
volumeClaimTemplate	object	Will be used to create a stand-alone PVC to provision the volume. The pod in which this EphemeralVolumeSource is embedded will be the owner of the PVC, i.e. the PVC will be deleted together with the pod. The name of the PVC will be `-` where `` is the name from the `PodSpec.Volumes` array entry. Pod validation will reject the pod if the concatenated name is not valid for a PVC (for example, too long). An existing PVC with that name that is not owned by the pod will not be used for the pod to avoid using an unrelated volume by mistake. Starting the pod is then blocked until the unrelated PVC is removed. If such a pre-created PVC is meant to be used by the pod, the PVC has to updated with an owner reference to the pod once the pod exists. Normally this should not be necessary, but it may be useful when manually reconstructing a broken cluster. This field is read-only and no changes will be made by Kubernetes to the PVC after it has been created. Required, must not be nil.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.volumes[index].ephemeral.volumeClaimTemplate#

^{^{↩ Parent}}

Will be used to create a stand-alone PVC to provision the volume. The pod in which this EphemeralVolumeSource is embedded will be the owner of the PVC, i.e. the PVC will be deleted together with the pod. The name of the PVC will be <pod name>-<volume name> where <volume name> is the name from the PodSpec.Volumes array entry. Pod validation will reject the pod if the concatenated name is not valid for a PVC (for example, too long).

An existing PVC with that name that is not owned by the pod will not be used for the pod to avoid using an unrelated volume by mistake. Starting the pod is then blocked until the unrelated PVC is removed. If such a pre-created PVC is meant to be used by the pod, the PVC has to updated with an owner reference to the pod once the pod exists. Normally this should not be necessary, but it may be useful when manually reconstructing a broken cluster.

This field is read-only and no changes will be made by Kubernetes to the PVC after it has been created.

Required, must not be nil.

Name	Type	Description	Required
spec	object	The specification for the PersistentVolumeClaim. The entire content is copied unchanged into the PVC that gets created from this template. The same fields as in a PersistentVolumeClaim are also valid here.	true
metadata	object	May contain labels and annotations that will be copied into the PVC when creating it. No other fields are allowed and will be rejected during validation.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.volumes[index].ephemeral.volumeClaimTemplate.spec#

^{^{↩ Parent}}

The specification for the PersistentVolumeClaim. The entire content is copied unchanged into the PVC that gets created from this template. The same fields as in a PersistentVolumeClaim are also valid here.

Name	Type	Description	Required
accessModes	[]string	accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1	false
dataSource	object	dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. If the namespace is specified, then dataSourceRef will not be copied to dataSource.	false
dataSourceRef	object	dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the dataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, when namespace isn't specified in dataSourceRef, both fields (dataSource and dataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. When namespace is specified in dataSourceRef, dataSource isn't set to the same value and must be empty. There are three important differences between dataSource and dataSourceRef: * While dataSource only allows two specific types of objects, dataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While dataSource ignores disallowed values (dropping them), dataSourceRef preserves all values, and generates an error if a disallowed value is specified. * While dataSource only allows local objects, dataSourceRef allows objects in any namespaces. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.	false
resources	object	resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources	false
selector	object	selector is a label query over volumes to consider for binding.	false
storageClassName	string	storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1	false
volumeAttributesClassName	string	volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim. If specified, the CSI driver will create or update the volume with the attributes defined in the corresponding VolumeAttributesClass. This has a different purpose than storageClassName, it can be changed after the claim is created. An empty string 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/ (Alpha) Using this field requires the VolumeAttributesClass feature gate to be enabled.	false
volumeMode	string	volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.	false
volumeName	string	volumeName is the binding reference to the PersistentVolume backing this claim.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.volumes[index].ephemeral.volumeClaimTemplate.spec.dataSource#

^{^{↩ Parent}}

dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. If the namespace is specified, then dataSourceRef will not be copied to dataSource.

Name	Type	Description	Required
kind	string	Kind is the type of resource being referenced	true
name	string	Name is the name of resource being referenced	true
apiGroup	string	APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.volumes[index].ephemeral.volumeClaimTemplate.spec.dataSourceRef#

^{^{↩ Parent}}

dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the dataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, when namespace isn't specified in dataSourceRef, both fields (dataSource and dataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. When namespace is specified in dataSourceRef, dataSource isn't set to the same value and must be empty. There are three important differences between dataSource and dataSourceRef: * While dataSource only allows two specific types of objects, dataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While dataSource ignores disallowed values (dropping them), dataSourceRef preserves all values, and generates an error if a disallowed value is specified. * While dataSource only allows local objects, dataSourceRef allows objects in any namespaces. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.

Name	Type	Description	Required
kind	string	Kind is the type of resource being referenced	true
name	string	Name is the name of resource being referenced	true
apiGroup	string	APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.	false
namespace	string	Namespace is the namespace of resource being referenced Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. (Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.volumes[index].ephemeral.volumeClaimTemplate.spec.resources#

^{^{↩ Parent}}

resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources

Name	Type	Description	Required
limits	map[string]int or string	Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/	false
requests	map[string]int or string	Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.volumes[index].ephemeral.volumeClaimTemplate.spec.selector#

^{^{↩ Parent}}

selector is a label query over volumes to consider for binding.

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.volumes[index].ephemeral.volumeClaimTemplate.spec.selector.matchExpressions[index]#

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.volumes[index].ephemeral.volumeClaimTemplate.metadata#

^{^{↩ Parent}}

May contain labels and annotations that will be copied into the PVC when creating it. No other fields are allowed and will be rejected during validation.

Name	Type	Required
annotations	map[string]string	false
finalizers	[]string	false
labels	map[string]string	false
name	string	false
namespace	string	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.volumes[index].fc#

^{^{↩ Parent}}

fc represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod.

Name	Type	Description	Required
fsType	string	fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. TODO: how do we prevent errors in the filesystem from compromising the machine	false
lun	integer	lun is Optional: FC target lun number Format: int32	false
readOnly	boolean	readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.	false
targetWWNs	[]string	targetWWNs is Optional: FC target worldwide names (WWNs)	false
wwids	[]string	wwids Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.volumes[index].flexVolume#

^{^{↩ Parent}}

flexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.

Name	Type	Description	Required
driver	string	driver is the name of the driver to use for this volume.	true
fsType	string	fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script.	false
options	map[string]string	options is Optional: this field holds extra command options if any.	false
readOnly	boolean	readOnly is Optional: defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.	false
secretRef	object	secretRef is Optional: secretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.volumes[index].flexVolume.secretRef#

^{^{↩ Parent}}

secretRef is Optional: secretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts.

Name	Type	Description	Required
name	string	Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. TODO: Add other useful fields. apiVersion, kind, uid? 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. Default:	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.volumes[index].flocker#

^{^{↩ Parent}}

flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running

Name	Type	Description	Required
datasetName	string	datasetName is Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecated	false
datasetUUID	string	datasetUUID is the UUID of the dataset. This is unique identifier of a Flocker dataset	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.volumes[index].gcePersistentDisk#

^{^{↩ Parent}}

gcePersistentDisk represents a GCE Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk

Name	Type	Description	Required
pdName	string	pdName is unique name of the PD resource in GCE. Used to identify the disk in GCE. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk	true
fsType	string	fsType is filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk TODO: how do we prevent errors in the filesystem from compromising the machine	false
partition	integer	partition is the partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk Format: int32	false
readOnly	boolean	readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.volumes[index].gitRepo#

^{^{↩ Parent}}

gitRepo represents a git repository at a particular revision. DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod's container.

Name	Type	Description	Required
repository	string	repository is the URL	true
directory	string	directory is the target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name.	false
revision	string	revision is the commit hash for the specified revision.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.volumes[index].glusterfs#

^{^{↩ Parent}}

glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/glusterfs/README.md

Name	Type	Description	Required
endpoints	string	endpoints is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod	true
path	string	path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod	true
readOnly	boolean	readOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.volumes[index].hostPath#

^{^{↩ Parent}}

hostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath

TODO(jonesdl) We need to restrict who can use host directory mounts and who can/can not mount host directories as read/write.

Name	Type	Description	Required
path	string	path of the directory on the host. If the path is a symlink, it will follow the link to the real path. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath	true
type	string	type for HostPath Volume Defaults to "" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.volumes[index].iscsi#

^{^{↩ Parent}}

iscsi represents an ISCSI Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://examples.k8s.io/volumes/iscsi/README.md

Name	Type	Description	Required
iqn	string	iqn is the target iSCSI Qualified Name.	true
lun	integer	lun represents iSCSI Target Lun number. Format: int32	true
targetPortal	string	targetPortal is iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).	true
chapAuthDiscovery	boolean	chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication	false
chapAuthSession	boolean	chapAuthSession defines whether support iSCSI Session CHAP authentication	false
fsType	string	fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi TODO: how do we prevent errors in the filesystem from compromising the machine	false
initiatorName	string	initiatorName is the custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface : will be created for the connection.	false
iscsiInterface	string	iscsiInterface is the interface Name that uses an iSCSI transport. Defaults to 'default' (tcp).	false
portals	[]string	portals is the iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).	false
readOnly	boolean	readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.	false
secretRef	object	secretRef is the CHAP Secret for iSCSI target and initiator authentication	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.volumes[index].iscsi.secretRef#

^{^{↩ Parent}}

secretRef is the CHAP Secret for iSCSI target and initiator authentication

Name	Type	Description	Required
name	string	Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. TODO: Add other useful fields. apiVersion, kind, uid? 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. Default:	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.volumes[index].nfs#

^{^{↩ Parent}}

nfs represents an NFS mount on the host that shares a pod's lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

Name	Type	Description	Required
path	string	path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs	true
server	string	server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs	true
readOnly	boolean	readOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.volumes[index].persistentVolumeClaim#

^{^{↩ Parent}}

persistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

Name	Type	Description	Required
claimName	string	claimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims	true
readOnly	boolean	readOnly Will force the ReadOnly setting in VolumeMounts. Default false.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.volumes[index].photonPersistentDisk#

^{^{↩ Parent}}

photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine

Name	Type	Description	Required
pdID	string	pdID is the ID that identifies Photon Controller persistent disk	true
fsType	string	fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.volumes[index].portworxVolume#

^{^{↩ Parent}}

portworxVolume represents a portworx volume attached and mounted on kubelets host machine

Name	Type	Description	Required
volumeID	string	volumeID uniquely identifies a Portworx volume	true
fsType	string	fSType represents the filesystem type to mount Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs". Implicitly inferred to be "ext4" if unspecified.	false
readOnly	boolean	readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.volumes[index].projected#

^{^{↩ Parent}}

projected items for all in one resources secrets, configmaps, and downward API

Name	Type	Description	Required
defaultMode	integer	defaultMode are the mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false
sources	[]object	sources is the list of volume projections	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.volumes[index].projected.sources[index]#

^{^{↩ Parent}}

Projection that may be projected along with other supported volume types

Name	Type	Description	Required
clusterTrustBundle	object	ClusterTrustBundle allows a pod to access the `.spec.trustBundle` field of ClusterTrustBundle objects in an auto-updating file. Alpha, gated by the ClusterTrustBundleProjection feature gate. ClusterTrustBundle objects can either be selected by name, or by the combination of signer name and a label selector. Kubelet performs aggressive normalization of the PEM contents written into the pod filesystem. Esoteric PEM features such as inter-block comments and block headers are stripped. Certificates are deduplicated. The ordering of certificates within the file is arbitrary, and Kubelet may change the order over time.	false
configMap	object	configMap information about the configMap data to project	false
downwardAPI	object	downwardAPI information about the downwardAPI data to project	false
secret	object	secret information about the secret data to project	false
serviceAccountToken	object	serviceAccountToken is information about the serviceAccountToken data to project	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.volumes[index].projected.sources[index].clusterTrustBundle#

^{^{↩ Parent}}

ClusterTrustBundle allows a pod to access the .spec.trustBundle field of ClusterTrustBundle objects in an auto-updating file.

Alpha, gated by the ClusterTrustBundleProjection feature gate.

ClusterTrustBundle objects can either be selected by name, or by the combination of signer name and a label selector.

Kubelet performs aggressive normalization of the PEM contents written into the pod filesystem. Esoteric PEM features such as inter-block comments and block headers are stripped. Certificates are deduplicated. The ordering of certificates within the file is arbitrary, and Kubelet may change the order over time.

Name	Type	Description	Required
path	string	Relative path from the volume root to write the bundle.	true
labelSelector	object	Select all ClusterTrustBundles that match this label selector. Only has effect if signerName is set. Mutually-exclusive with name. If unset, interpreted as "match nothing". If set but empty, interpreted as "match everything".	false
name	string	Select a single ClusterTrustBundle by object name. Mutually-exclusive with signerName and labelSelector.	false
optional	boolean	If true, don't block pod startup if the referenced ClusterTrustBundle(s) aren't available. If using name, then the named ClusterTrustBundle is allowed not to exist. If using signerName, then the combination of signerName and labelSelector is allowed to match zero ClusterTrustBundles.	false
signerName	string	Select all ClusterTrustBundles that match this signer name. Mutually-exclusive with name. The contents of all selected ClusterTrustBundles will be unified and deduplicated.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.volumes[index].projected.sources[index].clusterTrustBundle.labelSelector#

^{^{↩ Parent}}

Select all ClusterTrustBundles that match this label selector. Only has effect if signerName is set. Mutually-exclusive with name. If unset, interpreted as "match nothing". If set but empty, interpreted as "match everything".

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.volumes[index].projected.sources[index].clusterTrustBundle.labelSelector.matchExpressions[index]#

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.volumes[index].projected.sources[index].configMap#

^{^{↩ Parent}}

configMap information about the configMap data to project

Name	Type	Description	Required
items	[]object	items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.	false
name	string	Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. TODO: Add other useful fields. apiVersion, kind, uid? 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. Default:	false
optional	boolean	optional specify whether the ConfigMap or its keys must be defined	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.volumes[index].projected.sources[index].configMap.items[index]#

^{^{↩ Parent}}

Maps a string key to a path within a volume.

Name	Type	Description	Required
key	string	key is the key to project.	true
path	string	path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.	true
mode	integer	mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.volumes[index].projected.sources[index].downwardAPI#

^{^{↩ Parent}}

downwardAPI information about the downwardAPI data to project

Name	Type	Description	Required
items	[]object	Items is a list of DownwardAPIVolume file	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.volumes[index].projected.sources[index].downwardAPI.items[index]#

^{^{↩ Parent}}

DownwardAPIVolumeFile represents information to create the file containing the pod field

Name	Type	Description	Required
path	string	Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'	true
fieldRef	object	Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported.	false
mode	integer	Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false
resourceFieldRef	object	Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.volumes[index].projected.sources[index].downwardAPI.items[index].fieldRef#

^{^{↩ Parent}}

Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported.

Name	Type	Description	Required
fieldPath	string	Path of the field to select in the specified API version.	true
apiVersion	string	Version of the schema the FieldPath is written in terms of, defaults to "v1".	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.volumes[index].projected.sources[index].downwardAPI.items[index].resourceFieldRef#

^{^{↩ Parent}}

Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.

Name	Type	Description	Required
resource	string	Required: resource to select	true
containerName	string	Container name: required for volumes, optional for env vars	false
divisor	int or string	Specifies the output format of the exposed resources, defaults to "1"	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.volumes[index].projected.sources[index].secret#

^{^{↩ Parent}}

secret information about the secret data to project

Name	Type	Description	Required
items	[]object	items if unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.	false
name	string	Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. TODO: Add other useful fields. apiVersion, kind, uid? 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. Default:	false
optional	boolean	optional field specify whether the Secret or its key must be defined	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.volumes[index].projected.sources[index].secret.items[index]#

^{^{↩ Parent}}

Maps a string key to a path within a volume.

Name	Type	Description	Required
key	string	key is the key to project.	true
path	string	path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.	true
mode	integer	mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.volumes[index].projected.sources[index].serviceAccountToken#

^{^{↩ Parent}}

serviceAccountToken is information about the serviceAccountToken data to project

Name	Type	Description	Required
path	string	path is the path relative to the mount point of the file to project the token into.	true
audience	string	audience is the intended audience of the token. A recipient of a token must identify itself with an identifier specified in the audience of the token, and otherwise should reject the token. The audience defaults to the identifier of the apiserver.	false
expirationSeconds	integer	expirationSeconds is the requested duration of validity of the service account token. As the token approaches expiration, the kubelet volume plugin will proactively rotate the service account token. The kubelet will start trying to rotate the token if the token is older than 80 percent of its time to live or if the token is older than 24 hours.Defaults to 1 hour and must be at least 10 minutes. Format: int64	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.volumes[index].quobyte#

^{^{↩ Parent}}

quobyte represents a Quobyte mount on the host that shares a pod's lifetime

Name	Type	Description	Required
registry	string	registry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumes	true
volume	string	volume is a string that references an already created Quobyte volume by name.	true
group	string	group to map volume access to Default is no group	false
readOnly	boolean	readOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false.	false
tenant	string	tenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes, value is set by the plugin	false
user	string	user to map volume access to Defaults to serivceaccount user	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.volumes[index].rbd#

^{^{↩ Parent}}

rbd represents a Rados Block Device mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/rbd/README.md

Name	Type	Description	Required
image	string	image is the rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it	true
monitors	[]string	monitors is a collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it	true
fsType	string	fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#rbd TODO: how do we prevent errors in the filesystem from compromising the machine	false
keyring	string	keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it	false
pool	string	pool is the rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it	false
readOnly	boolean	readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it	false
secretRef	object	secretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it	false
user	string	user is the rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.volumes[index].rbd.secretRef#

^{^{↩ Parent}}

secretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

Name	Type	Description	Required
name	string	Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. TODO: Add other useful fields. apiVersion, kind, uid? 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. Default:	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.volumes[index].scaleIO#

^{^{↩ Parent}}

scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.

Name	Type	Description	Required
gateway	string	gateway is the host address of the ScaleIO API Gateway.	true
secretRef	object	secretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail.	true
system	string	system is the name of the storage system as configured in ScaleIO.	true
fsType	string	fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Default is "xfs".	false
protectionDomain	string	protectionDomain is the name of the ScaleIO Protection Domain for the configured storage.	false
readOnly	boolean	readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.	false
sslEnabled	boolean	sslEnabled Flag enable/disable SSL communication with Gateway, default false	false
storageMode	string	storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned.	false
storagePool	string	storagePool is the ScaleIO Storage Pool associated with the protection domain.	false
volumeName	string	volumeName is the name of a volume already created in the ScaleIO system that is associated with this volume source.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.volumes[index].scaleIO.secretRef#

^{^{↩ Parent}}

secretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail.

Name	Type	Description	Required
name	string	Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. TODO: Add other useful fields. apiVersion, kind, uid? 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. Default:	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.volumes[index].secret#

^{^{↩ Parent}}

secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret

Name	Type	Description	Required
defaultMode	integer	defaultMode is Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false
items	[]object	items If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.	false
optional	boolean	optional field specify whether the Secret or its keys must be defined	false
secretName	string	secretName is the name of the secret in the pod's namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.volumes[index].secret.items[index]#

^{^{↩ Parent}}

Maps a string key to a path within a volume.

Name	Type	Description	Required
key	string	key is the key to project.	true
path	string	path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.	true
mode	integer	mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.volumes[index].storageos#

^{^{↩ Parent}}

storageOS represents a StorageOS volume attached and mounted on Kubernetes nodes.

Name	Type	Description	Required
fsType	string	fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.	false
readOnly	boolean	readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.	false
secretRef	object	secretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted.	false
volumeName	string	volumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace.	false
volumeNamespace	string	volumeNamespace specifies the scope of the volume within StorageOS. If no namespace is specified then the Pod's namespace will be used. This allows the Kubernetes name scoping to be mirrored within StorageOS for tighter integration. Set VolumeName to any name to override the default behaviour. Set to "default" if you are not using namespaces within StorageOS. Namespaces that do not pre-exist within StorageOS will be created.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.volumes[index].storageos.secretRef#

^{^{↩ Parent}}

secretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted.

Name	Type	Description	Required
name	string	Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. TODO: Add other useful fields. apiVersion, kind, uid? 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. Default:	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.volumes[index].vsphereVolume#

^{^{↩ Parent}}

vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine

Name	Type	Description	Required
volumePath	string	volumePath is the path that identifies vSphere volume vmdk	true
fsType	string	fsType is filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.	false
storagePolicyID	string	storagePolicyID is the storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.	false
storagePolicyName	string	storagePolicyName is the storage Policy Based Management (SPBM) profile name.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.podFailurePolicy#

^{^{↩ Parent}}

Specifies the policy of handling failed pods. In particular, it allows to specify the set of actions and conditions which need to be satisfied to take the associated action. If empty, the default behaviour applies - the counter of failed pods, represented by the jobs's .status.failed field, is incremented and it is checked against the backoffLimit. This field cannot be used in combination with restartPolicy=OnFailure.

This field is beta-level. It can be used when the JobPodFailurePolicy feature gate is enabled (enabled by default).

Name	Type	Description	Required
rules	[]object	A list of pod failure policy rules. The rules are evaluated in order. Once a rule matches a Pod failure, the remaining of the rules are ignored. When no rule matches the Pod failure, the default handling applies - the counter of pod failures is incremented and it is checked against the backoffLimit. At most 20 elements are allowed.	true

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.podFailurePolicy.rules[index]#

^{^{↩ Parent}}

PodFailurePolicyRule describes how a pod failure is handled when the requirements are met. One of onExitCodes and onPodConditions, but not both, can be used in each rule.

Name	Type	Description	Required
action	string	Specifies the action taken on a pod failure when the requirements are satisfied. Possible values are: - FailJob: indicates that the pod's job is marked as Failed and all running pods are terminated. - FailIndex: indicates that the pod's index is marked as Failed and will not be restarted. This value is beta-level. It can be used when the `JobBackoffLimitPerIndex` feature gate is enabled (enabled by default). - Ignore: indicates that the counter towards the .backoffLimit is not incremented and a replacement pod is created. - Count: indicates that the pod is handled in the default way - the counter towards the .backoffLimit is incremented. Additional values are considered to be added in the future. Clients should react to an unknown action by skipping the rule.	true
onExitCodes	object	Represents the requirement on the container exit codes.	false
onPodConditions	[]object	Represents the requirement on the pod conditions. The requirement is represented as a list of pod condition patterns. The requirement is satisfied if at least one pattern matches an actual pod condition. At most 20 elements are allowed.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.podFailurePolicy.rules[index].onExitCodes#

^{^{↩ Parent}}

Represents the requirement on the container exit codes.

Name	Type	Description	Required
operator	string	Represents the relationship between the container exit code(s) and the specified values. Containers completed with success (exit code 0) are excluded from the requirement check. Possible values are: - In: the requirement is satisfied if at least one container exit code (might be multiple if there are multiple containers not restricted by the 'containerName' field) is in the set of specified values. - NotIn: the requirement is satisfied if at least one container exit code (might be multiple if there are multiple containers not restricted by the 'containerName' field) is not in the set of specified values. Additional values are considered to be added in the future. Clients should react to an unknown operator by assuming the requirement is not satisfied.	true
values	[]integer	Specifies the set of values. Each returned container exit code (might be multiple in case of multiple containers) is checked against this set of values with respect to the operator. The list of values must be ordered and must not contain duplicates. Value '0' cannot be used for the In operator. At least one element is required. At most 255 elements are allowed.	true
containerName	string	Restricts the check for exit codes to the container with the specified name. When null, the rule applies to all containers. When specified, it should match one the container or initContainer names in the pod template.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.podFailurePolicy.rules[index].onPodConditions[index]#

^{^{↩ Parent}}

PodFailurePolicyOnPodConditionsPattern describes a pattern for matching an actual pod condition type.

Name	Type	Description	Required
status	string	Specifies the required Pod condition status. To match a pod condition it is required that the specified status equals the pod condition status. Defaults to True.	true
type	string	Specifies the required Pod condition type. To match a pod condition it is required that specified type equals the pod condition type.	true

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.selector#

^{^{↩ Parent}}

A label query over pods that should match the pod count. Normally, the system sets this field for you. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.selector.matchExpressions[index]#

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.successPolicy#

^{^{↩ Parent}}

successPolicy specifies the policy when the Job can be declared as succeeded. If empty, the default behavior applies - the Job is declared as succeeded only when the number of succeeded pods equals to the completions. When the field is specified, it must be immutable and works only for the Indexed Jobs. Once the Job meets the SuccessPolicy, the lingering pods are terminated.

This field is alpha-level. To use this field, you must enable the JobSuccessPolicy feature gate (disabled by default).

Name	Type	Description	Required
rules	[]object	rules represents the list of alternative rules for the declaring the Jobs as successful before `.status.succeeded >= .spec.completions`. Once any of the rules are met, the "SucceededCriteriaMet" condition is added, and the lingering pods are removed. The terminal state for such a Job has the "Complete" condition. Additionally, these rules are evaluated in order; Once the Job meets one of the rules, other rules are ignored. At most 20 elements are allowed.	true

RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.successPolicy.rules[index]#

^{^{↩ Parent}}

SuccessPolicyRule describes rule for declaring a Job as succeeded. Each rule must have at least one of the "succeededIndexes" or "succeededCount" specified.

Name	Type	Description	Required
succeededCount	integer	succeededCount specifies the minimal required size of the actual set of the succeeded indexes for the Job. When succeededCount is used along with succeededIndexes, the check is constrained only to the set of indexes specified by succeededIndexes. For example, given that succeededIndexes is "1-4", succeededCount is "3", and completed indexes are "1", "3", and "5", the Job isn't declared as succeeded because only "1" and "3" indexes are considered in that rules. When this field is null, this doesn't default to any value and is never evaluated at any time. When specified it needs to be a positive integer. Format: int32	false
succeededIndexes	string	succeededIndexes specifies the set of indexes which need to be contained in the actual set of the succeeded indexes for the Job. The list of indexes must be within 0 to ".spec.completions-1" and must not contain duplicates. At least one element is required. The indexes are represented as intervals separated by commas. The intervals can be a decimal integer or a pair of decimal integers separated by a hyphen. The number are listed in represented by the first and last element of the series, separated by a hyphen. For example, if the completed indexes are 1, 3, 4, 5 and 7, they are represented as "1,3-5,7". When this field is null, this field doesn't default to any value and is never evaluated at any time.	false

RemoteMachine.spec.sshKeyRef#

^{^{↩ Parent}}

SSHKeyRef is a reference to a secret that contains the SSH private key. The key must be placed on the secret using the key "value".

Name	Type	Description	Required
name	string	Name is the name of the secret.	true

RemoteMachine.status#

^{^{↩ Parent}}

RemoteMachineStatus defines the observed state of RemoteMachine

Name	Type	Description	Required
failureMessage	string		false
failureReason	string		false
ready	boolean	Ready denotes that the remote machine is ready to be used.	false

RemoteMachineTemplate#

^{^{↩ Parent}}

Name	Type	Description	Required
apiVersion	string	infrastructure.cluster.x-k8s.io/v1beta1	true
kind	string	RemoteMachineTemplate	true
metadata	object	Refer to the Kubernetes API documentation for the fields of the `metadata` field.	true
spec	object		false

RemoteMachineTemplate.spec#

^{^{↩ Parent}}

Name	Type	Description	Required
template	object		true

RemoteMachineTemplate.spec.template#

^{^{↩ Parent}}

Name	Type	Description	Required
metadata	object		false
spec	object		false

RemoteMachineTemplate.spec.template.metadata#

^{^{↩ Parent}}

Name	Type	Required
annotations	map[string]string	false
finalizers	[]string	false
labels	map[string]string	false
name	string	false
namespace	string	false

RemoteMachineTemplate.spec.template.spec#

^{^{↩ Parent}}

Name	Type	Description	Required
pool	string		true

k0smotron.io/v1beta1#

Resource Types:

Cluster

JoinTokenRequest

Cluster#

^{^{↩ Parent}}

Cluster is the Schema for the k0smotronclusters API

Name	Type	Description	Required
apiVersion	string	k0smotron.io/v1beta1	true
kind	string	Cluster	true
metadata	object	Refer to the Kubernetes API documentation for the fields of the `metadata` field.	true
spec	object	ClusterSpec defines the desired state of K0smotronCluster Default: map[service:map[type:NodePort]]	false
status	object	ClusterStatus defines the observed state of K0smotronCluster	false

Cluster.spec#

^{^{↩ Parent}}

ClusterSpec defines the desired state of K0smotronCluster

Name	Type	Description	Required
certificateRefs	[]object	CertificateRefs defines the certificate references.	false
controllerPlaneFlags	[]string	ControlPlaneFlags allows to configure additional flags for k0s control plane and to override existing ones. The default flags are kept unless they are overriden explicitly. Flags with arguments must be specified as a single string, e.g. --some-flag=argument	false
etcd	object	Etcd defines the etcd configuration. Default: map[image:quay.io/k0sproject/etcd:v3.5.13 persistence:map[]]	false
externalAddress	string	ExternalAddress defines k0s external address. See https://docs.k0sproject.io/stable/configuration/#specapi Will be detected automatically for service type LoadBalancer.	false
image	string	Image defines the k0s image to be deployed. If empty k0smotron will pick it automatically. Must not include the image tag. Default: k0sproject/k0s	false
k0sConfig	object	k0sConfig defines the k0s configuration. Note, that some fields will be overwritten by k0smotron. If empty, will be used default configuration. @see https://docs.k0sproject.io/stable/configuration/	false
kineDataSourceSecretName	string	KineDataSourceSecretName defines the name of kine datasource URL secret.	false
kineDataSourceURL	string	KineDataSourceURL defines the kine datasource URL.	false
manifests	[]object	Manifests allows to specify list of volumes with manifests to be deployed in the cluster. The volumes will be mounted in /var/lib/k0s/manifests/, for this reason each manifest is a stack. K0smotron allows any kind of volume, but the recommendation is to use secrets and configmaps. For more information check: https://docs.k0sproject.io/stable/manifests/ and https://kubernetes.io/docs/concepts/storage/volumes	false
monitoring	object	Monitoring defines the monitoring configuration.	false
mounts	[]object	Mounts allows to specify list of volumes with any files to be mounted in the controlplane pod. K0smotron allows any kind of volume, but the recommendation is to use secrets and configmaps. For more information check: https://kubernetes.io/docs/concepts/storage/volumes	false
persistence	object	Persistence defines the persistence configuration. If empty k0smotron will use emptyDir as a volume. See https://docs.k0smotron.io/stable/configuration/#persistence	false
replicas	integer	Replicas is the desired number of replicas of the k0s control planes. If unspecified, defaults to 1. If the value is above 1, k0smotron requires kine datasource URL to be set. Recommended value is 3. Format: int32 Default: 1	false
resources	object	Resources describes the compute resource requirements for the control plane pods.	false
service	object	Service defines the service configuration. Default: map[apiPort:30443 konnectivityPort:30132 type:ClusterIP]	false
version	string	Version defines the k0s version to be deployed. If empty k0smotron will pick it automatically.	false

Cluster.spec.certificateRefs[index]#

^{^{↩ Parent}}

Name	Type	Description	Required
type	enum	Enum: ca, sa, proxy, etcd, apiserver-etcd-client, etcd-peer, etcd-server	true
name	string		false

Cluster.spec.etcd#

^{^{↩ Parent}}

Etcd defines the etcd configuration.

Name	Type	Description	Required
image	string	Image defines the etcd image to be deployed. Default: quay.io/k0sproject/etcd:v3.5.13	true
args	[]string	Args defines the etcd arguments.	false
autoDeletePVCs	boolean	AutoDeletePVCs defines whether the PVC should be deleted when the etcd cluster is deleted. Default: false	false
defragJob	object	DefragJob defines the etcd defragmentation job configuration.	false
persistence	object	Persistence defines the persistence configuration.	false

Cluster.spec.etcd.defragJob#

^{^{↩ Parent}}

DefragJob defines the etcd defragmentation job configuration.

Name	Type	Description	Required
enabled	boolean	Enabled enables the etcd defragmentation job. Default: false	true
image	string	Image defines the etcd defragmentation job image. Default: ghcr.io/ahrtr/etcd-defrag:v0.16.0	true
rule	string	Rule defines the etcd defragmentation job defrag-rule. For more information check: https://github.com/ahrtr/etcd-defrag/tree/main?tab=readme-ov-file#defragmentation-rule Default: dbQuotaUsage > 0.8 \|\| dbSize - dbSizeInUse > 20010241024	true
schedule	string	Schedule defines the etcd defragmentation job schedule. Default: 0 12 * * *	true

Cluster.spec.etcd.persistence#

^{^{↩ Parent}}

Persistence defines the persistence configuration.

Name	Type	Description	Required
size	int or string	Size defines the size of the etcd volume. Default: 1Gi Default: 1Gi	false
storageClass	string	StorageClass defines the storage class to be used for etcd persistence. If empty, will be used the default storage class.	false

Cluster.spec.manifests[index]#

^{^{↩ Parent}}

Volume represents a named volume in a pod that may be accessed by any container in the pod.

Name	Type	Description	Required
name	string	name of the volume. Must be a DNS_LABEL and unique within the pod. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names	true
awsElasticBlockStore	object	awsElasticBlockStore represents an AWS Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore	false
azureDisk	object	azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.	false
azureFile	object	azureFile represents an Azure File Service mount on the host and bind mount to the pod.	false
cephfs	object	cephFS represents a Ceph FS mount on the host that shares a pod's lifetime	false
cinder	object	cinder represents a cinder volume attached and mounted on kubelets host machine. More info: https://examples.k8s.io/mysql-cinder-pd/README.md	false
configMap	object	configMap represents a configMap that should populate this volume	false
csi	object	csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature).	false
downwardAPI	object	downwardAPI represents downward API about the pod that should populate this volume	false
emptyDir	object	emptyDir represents a temporary directory that shares a pod's lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir	false
ephemeral	object	ephemeral represents a volume that is handled by a cluster storage driver. The volume's lifecycle is tied to the pod that defines it - it will be created before the pod starts, and deleted when the pod is removed. Use this if: a) the volume is only needed while the pod runs, b) features of normal volumes like restoring from snapshot or capacity tracking are needed, c) the storage driver is specified through a storage class, and d) the storage driver supports dynamic volume provisioning through a PersistentVolumeClaim (see EphemeralVolumeSource for more information on the connection between this volume type and PersistentVolumeClaim). Use PersistentVolumeClaim or one of the vendor-specific APIs for volumes that persist for longer than the lifecycle of an individual pod. Use CSI for light-weight local ephemeral volumes if the CSI driver is meant to be used that way - see the documentation of the driver for more information. A pod can use both types of ephemeral volumes and persistent volumes at the same time.	false
fc	object	fc represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod.	false
flexVolume	object	flexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.	false
flocker	object	flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running	false
gcePersistentDisk	object	gcePersistentDisk represents a GCE Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk	false
gitRepo	object	gitRepo represents a git repository at a particular revision. DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod's container.	false
glusterfs	object	glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/glusterfs/README.md	false
hostPath	object	hostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath --- TODO(jonesdl) We need to restrict who can use host directory mounts and who can/can not mount host directories as read/write.	false
iscsi	object	iscsi represents an ISCSI Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://examples.k8s.io/volumes/iscsi/README.md	false
nfs	object	nfs represents an NFS mount on the host that shares a pod's lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs	false
persistentVolumeClaim	object	persistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims	false
photonPersistentDisk	object	photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine	false
portworxVolume	object	portworxVolume represents a portworx volume attached and mounted on kubelets host machine	false
projected	object	projected items for all in one resources secrets, configmaps, and downward API	false
quobyte	object	quobyte represents a Quobyte mount on the host that shares a pod's lifetime	false
rbd	object	rbd represents a Rados Block Device mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/rbd/README.md	false
scaleIO	object	scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.	false
secret	object	secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret	false
storageos	object	storageOS represents a StorageOS volume attached and mounted on Kubernetes nodes.	false
vsphereVolume	object	vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine	false

Cluster.spec.manifests[index].awsElasticBlockStore#

^{^{↩ Parent}}

awsElasticBlockStore represents an AWS Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore

Name	Type	Description	Required
volumeID	string	volumeID is unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore	true
fsType	string	fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore TODO: how do we prevent errors in the filesystem from compromising the machine	false
partition	integer	partition is the partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). Format: int32	false
readOnly	boolean	readOnly value true will force the readOnly setting in VolumeMounts. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore	false

Cluster.spec.manifests[index].azureDisk#

^{^{↩ Parent}}

azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.

Name	Type	Description	Required
diskName	string	diskName is the Name of the data disk in the blob storage	true
diskURI	string	diskURI is the URI of data disk in the blob storage	true
cachingMode	string	cachingMode is the Host Caching mode: None, Read Only, Read Write.	false
fsType	string	fsType is Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.	false
kind	string	kind expected values are Shared: multiple blob disks per storage account Dedicated: single blob disk per storage account Managed: azure managed data disk (only in managed availability set). defaults to shared	false
readOnly	boolean	readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.	false

Cluster.spec.manifests[index].azureFile#

^{^{↩ Parent}}

azureFile represents an Azure File Service mount on the host and bind mount to the pod.

Name	Type	Description	Required
secretName	string	secretName is the name of secret that contains Azure Storage Account Name and Key	true
shareName	string	shareName is the azure share Name	true
readOnly	boolean	readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.	false

Cluster.spec.manifests[index].cephfs#

^{^{↩ Parent}}

cephFS represents a Ceph FS mount on the host that shares a pod's lifetime

Name	Type	Description	Required
monitors	[]string	monitors is Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it	true
path	string	path is Optional: Used as the mounted root, rather than the full Ceph tree, default is /	false
readOnly	boolean	readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it	false
secretFile	string	secretFile is Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it	false
secretRef	object	secretRef is Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it	false
user	string	user is optional: User is the rados user name, default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it	false

Cluster.spec.manifests[index].cephfs.secretRef#

^{^{↩ Parent}}

secretRef is Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it

Name	Type	Description	Required
name	string	Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. TODO: Add other useful fields. apiVersion, kind, uid? 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. Default:	false

Cluster.spec.manifests[index].cinder#

^{^{↩ Parent}}

cinder represents a cinder volume attached and mounted on kubelets host machine. More info: https://examples.k8s.io/mysql-cinder-pd/README.md

Name	Type	Description	Required
volumeID	string	volumeID used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md	true
fsType	string	fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://examples.k8s.io/mysql-cinder-pd/README.md	false
readOnly	boolean	readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/mysql-cinder-pd/README.md	false
secretRef	object	secretRef is optional: points to a secret object containing parameters used to connect to OpenStack.	false

Cluster.spec.manifests[index].cinder.secretRef#

^{^{↩ Parent}}

secretRef is optional: points to a secret object containing parameters used to connect to OpenStack.

Name	Type	Description	Required
name	string	Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. TODO: Add other useful fields. apiVersion, kind, uid? 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. Default:	false

Cluster.spec.manifests[index].configMap#

^{^{↩ Parent}}

configMap represents a configMap that should populate this volume

Name	Type	Description	Required
defaultMode	integer	defaultMode is optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false
items	[]object	items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.	false
name	string	Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. TODO: Add other useful fields. apiVersion, kind, uid? 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. Default:	false
optional	boolean	optional specify whether the ConfigMap or its keys must be defined	false

Cluster.spec.manifests[index].configMap.items[index]#

^{^{↩ Parent}}

Maps a string key to a path within a volume.

Name	Type	Description	Required
key	string	key is the key to project.	true
path	string	path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.	true
mode	integer	mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false

Cluster.spec.manifests[index].csi#

^{^{↩ Parent}}

csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature).

Name	Type	Description	Required
driver	string	driver is the name of the CSI driver that handles this volume. Consult with your admin for the correct name as registered in the cluster.	true
fsType	string	fsType to mount. Ex. "ext4", "xfs", "ntfs". If not provided, the empty value is passed to the associated CSI driver which will determine the default filesystem to apply.	false
nodePublishSecretRef	object	nodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secret references are passed.	false
readOnly	boolean	readOnly specifies a read-only configuration for the volume. Defaults to false (read/write).	false
volumeAttributes	map[string]string	volumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver's documentation for supported values.	false

Cluster.spec.manifests[index].csi.nodePublishSecretRef#

^{^{↩ Parent}}

nodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secret references are passed.

Name	Type	Description	Required
name	string	Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. TODO: Add other useful fields. apiVersion, kind, uid? 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. Default:	false

Cluster.spec.manifests[index].downwardAPI#

^{^{↩ Parent}}

downwardAPI represents downward API about the pod that should populate this volume

Name	Type	Description	Required
defaultMode	integer	Optional: mode bits to use on created files by default. Must be a Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false
items	[]object	Items is a list of downward API volume file	false

Cluster.spec.manifests[index].downwardAPI.items[index]#

^{^{↩ Parent}}

DownwardAPIVolumeFile represents information to create the file containing the pod field

Name	Type	Description	Required
path	string	Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'	true
fieldRef	object	Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported.	false
mode	integer	Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false
resourceFieldRef	object	Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.	false

Cluster.spec.manifests[index].downwardAPI.items[index].fieldRef#

^{^{↩ Parent}}

Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported.

Name	Type	Description	Required
fieldPath	string	Path of the field to select in the specified API version.	true
apiVersion	string	Version of the schema the FieldPath is written in terms of, defaults to "v1".	false

Cluster.spec.manifests[index].downwardAPI.items[index].resourceFieldRef#

^{^{↩ Parent}}

Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.

Name	Type	Description	Required
resource	string	Required: resource to select	true
containerName	string	Container name: required for volumes, optional for env vars	false
divisor	int or string	Specifies the output format of the exposed resources, defaults to "1"	false

Cluster.spec.manifests[index].emptyDir#

^{^{↩ Parent}}

emptyDir represents a temporary directory that shares a pod's lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir

Name	Type	Description	Required
medium	string	medium represents what type of storage medium should back this directory. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir	false
sizeLimit	int or string	sizeLimit is the total amount of local storage required for this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers in a pod. The default is nil which means that the limit is undefined. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir	false

Cluster.spec.manifests[index].ephemeral#

^{^{↩ Parent}}

ephemeral represents a volume that is handled by a cluster storage driver. The volume's lifecycle is tied to the pod that defines it - it will be created before the pod starts, and deleted when the pod is removed.

Use this if: a) the volume is only needed while the pod runs, b) features of normal volumes like restoring from snapshot or capacity tracking are needed, c) the storage driver is specified through a storage class, and d) the storage driver supports dynamic volume provisioning through a PersistentVolumeClaim (see EphemeralVolumeSource for more information on the connection between this volume type and PersistentVolumeClaim).

Use PersistentVolumeClaim or one of the vendor-specific APIs for volumes that persist for longer than the lifecycle of an individual pod.

Use CSI for light-weight local ephemeral volumes if the CSI driver is meant to be used that way - see the documentation of the driver for more information.

A pod can use both types of ephemeral volumes and persistent volumes at the same time.

Name	Type	Description	Required
volumeClaimTemplate	object	Will be used to create a stand-alone PVC to provision the volume. The pod in which this EphemeralVolumeSource is embedded will be the owner of the PVC, i.e. the PVC will be deleted together with the pod. The name of the PVC will be `-` where `` is the name from the `PodSpec.Volumes` array entry. Pod validation will reject the pod if the concatenated name is not valid for a PVC (for example, too long). An existing PVC with that name that is not owned by the pod will not be used for the pod to avoid using an unrelated volume by mistake. Starting the pod is then blocked until the unrelated PVC is removed. If such a pre-created PVC is meant to be used by the pod, the PVC has to updated with an owner reference to the pod once the pod exists. Normally this should not be necessary, but it may be useful when manually reconstructing a broken cluster. This field is read-only and no changes will be made by Kubernetes to the PVC after it has been created. Required, must not be nil.	false

Cluster.spec.manifests[index].ephemeral.volumeClaimTemplate#

^{^{↩ Parent}}

Will be used to create a stand-alone PVC to provision the volume. The pod in which this EphemeralVolumeSource is embedded will be the owner of the PVC, i.e. the PVC will be deleted together with the pod. The name of the PVC will be <pod name>-<volume name> where <volume name> is the name from the PodSpec.Volumes array entry. Pod validation will reject the pod if the concatenated name is not valid for a PVC (for example, too long).

An existing PVC with that name that is not owned by the pod will not be used for the pod to avoid using an unrelated volume by mistake. Starting the pod is then blocked until the unrelated PVC is removed. If such a pre-created PVC is meant to be used by the pod, the PVC has to updated with an owner reference to the pod once the pod exists. Normally this should not be necessary, but it may be useful when manually reconstructing a broken cluster.

This field is read-only and no changes will be made by Kubernetes to the PVC after it has been created.

Required, must not be nil.

Name	Type	Description	Required
spec	object	The specification for the PersistentVolumeClaim. The entire content is copied unchanged into the PVC that gets created from this template. The same fields as in a PersistentVolumeClaim are also valid here.	true
metadata	object	May contain labels and annotations that will be copied into the PVC when creating it. No other fields are allowed and will be rejected during validation.	false

Cluster.spec.manifests[index].ephemeral.volumeClaimTemplate.spec#

^{^{↩ Parent}}

The specification for the PersistentVolumeClaim. The entire content is copied unchanged into the PVC that gets created from this template. The same fields as in a PersistentVolumeClaim are also valid here.

Name	Type	Description	Required
accessModes	[]string	accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1	false
dataSource	object	dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. If the namespace is specified, then dataSourceRef will not be copied to dataSource.	false
dataSourceRef	object	dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the dataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, when namespace isn't specified in dataSourceRef, both fields (dataSource and dataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. When namespace is specified in dataSourceRef, dataSource isn't set to the same value and must be empty. There are three important differences between dataSource and dataSourceRef: * While dataSource only allows two specific types of objects, dataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While dataSource ignores disallowed values (dropping them), dataSourceRef preserves all values, and generates an error if a disallowed value is specified. * While dataSource only allows local objects, dataSourceRef allows objects in any namespaces. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.	false
resources	object	resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources	false
selector	object	selector is a label query over volumes to consider for binding.	false
storageClassName	string	storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1	false
volumeAttributesClassName	string	volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim. If specified, the CSI driver will create or update the volume with the attributes defined in the corresponding VolumeAttributesClass. This has a different purpose than storageClassName, it can be changed after the claim is created. An empty string 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/ (Alpha) Using this field requires the VolumeAttributesClass feature gate to be enabled.	false
volumeMode	string	volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.	false
volumeName	string	volumeName is the binding reference to the PersistentVolume backing this claim.	false

Cluster.spec.manifests[index].ephemeral.volumeClaimTemplate.spec.dataSource#

^{^{↩ Parent}}

dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. If the namespace is specified, then dataSourceRef will not be copied to dataSource.

Name	Type	Description	Required
kind	string	Kind is the type of resource being referenced	true
name	string	Name is the name of resource being referenced	true
apiGroup	string	APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.	false

Cluster.spec.manifests[index].ephemeral.volumeClaimTemplate.spec.dataSourceRef#

^{^{↩ Parent}}

dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the dataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, when namespace isn't specified in dataSourceRef, both fields (dataSource and dataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. When namespace is specified in dataSourceRef, dataSource isn't set to the same value and must be empty. There are three important differences between dataSource and dataSourceRef: * While dataSource only allows two specific types of objects, dataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While dataSource ignores disallowed values (dropping them), dataSourceRef preserves all values, and generates an error if a disallowed value is specified. * While dataSource only allows local objects, dataSourceRef allows objects in any namespaces. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.

Name	Type	Description	Required
kind	string	Kind is the type of resource being referenced	true
name	string	Name is the name of resource being referenced	true
apiGroup	string	APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.	false
namespace	string	Namespace is the namespace of resource being referenced Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. (Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.	false

Cluster.spec.manifests[index].ephemeral.volumeClaimTemplate.spec.resources#

^{^{↩ Parent}}

resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources

Name	Type	Description	Required
limits	map[string]int or string	Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/	false
requests	map[string]int or string	Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/	false

Cluster.spec.manifests[index].ephemeral.volumeClaimTemplate.spec.selector#

^{^{↩ Parent}}

selector is a label query over volumes to consider for binding.

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

Cluster.spec.manifests[index].ephemeral.volumeClaimTemplate.spec.selector.matchExpressions[index]#

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

Cluster.spec.manifests[index].ephemeral.volumeClaimTemplate.metadata#

^{^{↩ Parent}}

May contain labels and annotations that will be copied into the PVC when creating it. No other fields are allowed and will be rejected during validation.

Name	Type	Required
annotations	map[string]string	false
finalizers	[]string	false
labels	map[string]string	false
name	string	false
namespace	string	false

Cluster.spec.manifests[index].fc#

^{^{↩ Parent}}

fc represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod.

Name	Type	Description	Required
fsType	string	fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. TODO: how do we prevent errors in the filesystem from compromising the machine	false
lun	integer	lun is Optional: FC target lun number Format: int32	false
readOnly	boolean	readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.	false
targetWWNs	[]string	targetWWNs is Optional: FC target worldwide names (WWNs)	false
wwids	[]string	wwids Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously.	false

Cluster.spec.manifests[index].flexVolume#

^{^{↩ Parent}}

flexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.

Name	Type	Description	Required
driver	string	driver is the name of the driver to use for this volume.	true
fsType	string	fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script.	false
options	map[string]string	options is Optional: this field holds extra command options if any.	false
readOnly	boolean	readOnly is Optional: defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.	false
secretRef	object	secretRef is Optional: secretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts.	false

Cluster.spec.manifests[index].flexVolume.secretRef#

^{^{↩ Parent}}

secretRef is Optional: secretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts.

Name	Type	Description	Required
name	string	Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. TODO: Add other useful fields. apiVersion, kind, uid? 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. Default:	false

Cluster.spec.manifests[index].flocker#

^{^{↩ Parent}}

flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running

Name	Type	Description	Required
datasetName	string	datasetName is Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecated	false
datasetUUID	string	datasetUUID is the UUID of the dataset. This is unique identifier of a Flocker dataset	false

Cluster.spec.manifests[index].gcePersistentDisk#

^{^{↩ Parent}}

gcePersistentDisk represents a GCE Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk

Name	Type	Description	Required
pdName	string	pdName is unique name of the PD resource in GCE. Used to identify the disk in GCE. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk	true
fsType	string	fsType is filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk TODO: how do we prevent errors in the filesystem from compromising the machine	false
partition	integer	partition is the partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk Format: int32	false
readOnly	boolean	readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk	false

Cluster.spec.manifests[index].gitRepo#

^{^{↩ Parent}}

gitRepo represents a git repository at a particular revision. DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod's container.

Name	Type	Description	Required
repository	string	repository is the URL	true
directory	string	directory is the target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name.	false
revision	string	revision is the commit hash for the specified revision.	false

Cluster.spec.manifests[index].glusterfs#

^{^{↩ Parent}}

glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/glusterfs/README.md

Name	Type	Description	Required
endpoints	string	endpoints is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod	true
path	string	path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod	true
readOnly	boolean	readOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod	false

Cluster.spec.manifests[index].hostPath#

^{^{↩ Parent}}

hostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath

TODO(jonesdl) We need to restrict who can use host directory mounts and who can/can not mount host directories as read/write.

Name	Type	Description	Required
path	string	path of the directory on the host. If the path is a symlink, it will follow the link to the real path. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath	true
type	string	type for HostPath Volume Defaults to "" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath	false

Cluster.spec.manifests[index].iscsi#

^{^{↩ Parent}}

iscsi represents an ISCSI Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://examples.k8s.io/volumes/iscsi/README.md

Name	Type	Description	Required
iqn	string	iqn is the target iSCSI Qualified Name.	true
lun	integer	lun represents iSCSI Target Lun number. Format: int32	true
targetPortal	string	targetPortal is iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).	true
chapAuthDiscovery	boolean	chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication	false
chapAuthSession	boolean	chapAuthSession defines whether support iSCSI Session CHAP authentication	false
fsType	string	fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi TODO: how do we prevent errors in the filesystem from compromising the machine	false
initiatorName	string	initiatorName is the custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface : will be created for the connection.	false
iscsiInterface	string	iscsiInterface is the interface Name that uses an iSCSI transport. Defaults to 'default' (tcp).	false
portals	[]string	portals is the iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).	false
readOnly	boolean	readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.	false
secretRef	object	secretRef is the CHAP Secret for iSCSI target and initiator authentication	false

Cluster.spec.manifests[index].iscsi.secretRef#

^{^{↩ Parent}}

secretRef is the CHAP Secret for iSCSI target and initiator authentication

Name	Type	Description	Required
name	string	Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. TODO: Add other useful fields. apiVersion, kind, uid? 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. Default:	false

Cluster.spec.manifests[index].nfs#

^{^{↩ Parent}}

nfs represents an NFS mount on the host that shares a pod's lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

Name	Type	Description	Required
path	string	path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs	true
server	string	server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs	true
readOnly	boolean	readOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs	false

Cluster.spec.manifests[index].persistentVolumeClaim#

^{^{↩ Parent}}

persistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

Name	Type	Description	Required
claimName	string	claimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims	true
readOnly	boolean	readOnly Will force the ReadOnly setting in VolumeMounts. Default false.	false

Cluster.spec.manifests[index].photonPersistentDisk#

^{^{↩ Parent}}

photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine

Name	Type	Description	Required
pdID	string	pdID is the ID that identifies Photon Controller persistent disk	true
fsType	string	fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.	false

Cluster.spec.manifests[index].portworxVolume#

^{^{↩ Parent}}

portworxVolume represents a portworx volume attached and mounted on kubelets host machine

Name	Type	Description	Required
volumeID	string	volumeID uniquely identifies a Portworx volume	true
fsType	string	fSType represents the filesystem type to mount Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs". Implicitly inferred to be "ext4" if unspecified.	false
readOnly	boolean	readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.	false

Cluster.spec.manifests[index].projected#

^{^{↩ Parent}}

projected items for all in one resources secrets, configmaps, and downward API

Name	Type	Description	Required
defaultMode	integer	defaultMode are the mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false
sources	[]object	sources is the list of volume projections	false

Cluster.spec.manifests[index].projected.sources[index]#

^{^{↩ Parent}}

Projection that may be projected along with other supported volume types

Name	Type	Description	Required
clusterTrustBundle	object	ClusterTrustBundle allows a pod to access the `.spec.trustBundle` field of ClusterTrustBundle objects in an auto-updating file. Alpha, gated by the ClusterTrustBundleProjection feature gate. ClusterTrustBundle objects can either be selected by name, or by the combination of signer name and a label selector. Kubelet performs aggressive normalization of the PEM contents written into the pod filesystem. Esoteric PEM features such as inter-block comments and block headers are stripped. Certificates are deduplicated. The ordering of certificates within the file is arbitrary, and Kubelet may change the order over time.	false
configMap	object	configMap information about the configMap data to project	false
downwardAPI	object	downwardAPI information about the downwardAPI data to project	false
secret	object	secret information about the secret data to project	false
serviceAccountToken	object	serviceAccountToken is information about the serviceAccountToken data to project	false

Cluster.spec.manifests[index].projected.sources[index].clusterTrustBundle#

^{^{↩ Parent}}

ClusterTrustBundle allows a pod to access the .spec.trustBundle field of ClusterTrustBundle objects in an auto-updating file.

Alpha, gated by the ClusterTrustBundleProjection feature gate.

ClusterTrustBundle objects can either be selected by name, or by the combination of signer name and a label selector.

Kubelet performs aggressive normalization of the PEM contents written into the pod filesystem. Esoteric PEM features such as inter-block comments and block headers are stripped. Certificates are deduplicated. The ordering of certificates within the file is arbitrary, and Kubelet may change the order over time.

Name	Type	Description	Required
path	string	Relative path from the volume root to write the bundle.	true
labelSelector	object	Select all ClusterTrustBundles that match this label selector. Only has effect if signerName is set. Mutually-exclusive with name. If unset, interpreted as "match nothing". If set but empty, interpreted as "match everything".	false
name	string	Select a single ClusterTrustBundle by object name. Mutually-exclusive with signerName and labelSelector.	false
optional	boolean	If true, don't block pod startup if the referenced ClusterTrustBundle(s) aren't available. If using name, then the named ClusterTrustBundle is allowed not to exist. If using signerName, then the combination of signerName and labelSelector is allowed to match zero ClusterTrustBundles.	false
signerName	string	Select all ClusterTrustBundles that match this signer name. Mutually-exclusive with name. The contents of all selected ClusterTrustBundles will be unified and deduplicated.	false

Cluster.spec.manifests[index].projected.sources[index].clusterTrustBundle.labelSelector#

^{^{↩ Parent}}

Select all ClusterTrustBundles that match this label selector. Only has effect if signerName is set. Mutually-exclusive with name. If unset, interpreted as "match nothing". If set but empty, interpreted as "match everything".

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

Cluster.spec.manifests[index].projected.sources[index].clusterTrustBundle.labelSelector.matchExpressions[index]#

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

Cluster.spec.manifests[index].projected.sources[index].configMap#

^{^{↩ Parent}}

configMap information about the configMap data to project

Name	Type	Description	Required
items	[]object	items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.	false
name	string	Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. TODO: Add other useful fields. apiVersion, kind, uid? 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. Default:	false
optional	boolean	optional specify whether the ConfigMap or its keys must be defined	false

Cluster.spec.manifests[index].projected.sources[index].configMap.items[index]#

^{^{↩ Parent}}

Maps a string key to a path within a volume.

Name	Type	Description	Required
key	string	key is the key to project.	true
path	string	path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.	true
mode	integer	mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false

Cluster.spec.manifests[index].projected.sources[index].downwardAPI#

^{^{↩ Parent}}

downwardAPI information about the downwardAPI data to project

Name	Type	Description	Required
items	[]object	Items is a list of DownwardAPIVolume file	false

Cluster.spec.manifests[index].projected.sources[index].downwardAPI.items[index]#

^{^{↩ Parent}}

DownwardAPIVolumeFile represents information to create the file containing the pod field

Name	Type	Description	Required
path	string	Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'	true
fieldRef	object	Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported.	false
mode	integer	Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false
resourceFieldRef	object	Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.	false

Cluster.spec.manifests[index].projected.sources[index].downwardAPI.items[index].fieldRef#

^{^{↩ Parent}}

Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported.

Name	Type	Description	Required
fieldPath	string	Path of the field to select in the specified API version.	true
apiVersion	string	Version of the schema the FieldPath is written in terms of, defaults to "v1".	false

Cluster.spec.manifests[index].projected.sources[index].downwardAPI.items[index].resourceFieldRef#

^{^{↩ Parent}}

Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.

Name	Type	Description	Required
resource	string	Required: resource to select	true
containerName	string	Container name: required for volumes, optional for env vars	false
divisor	int or string	Specifies the output format of the exposed resources, defaults to "1"	false

Cluster.spec.manifests[index].projected.sources[index].secret#

^{^{↩ Parent}}

secret information about the secret data to project

Name	Type	Description	Required
items	[]object	items if unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.	false
name	string	Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. TODO: Add other useful fields. apiVersion, kind, uid? 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. Default:	false
optional	boolean	optional field specify whether the Secret or its key must be defined	false

Cluster.spec.manifests[index].projected.sources[index].secret.items[index]#

^{^{↩ Parent}}

Maps a string key to a path within a volume.

Name	Type	Description	Required
key	string	key is the key to project.	true
path	string	path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.	true
mode	integer	mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false

Cluster.spec.manifests[index].projected.sources[index].serviceAccountToken#

^{^{↩ Parent}}

serviceAccountToken is information about the serviceAccountToken data to project

Name	Type	Description	Required
path	string	path is the path relative to the mount point of the file to project the token into.	true
audience	string	audience is the intended audience of the token. A recipient of a token must identify itself with an identifier specified in the audience of the token, and otherwise should reject the token. The audience defaults to the identifier of the apiserver.	false
expirationSeconds	integer	expirationSeconds is the requested duration of validity of the service account token. As the token approaches expiration, the kubelet volume plugin will proactively rotate the service account token. The kubelet will start trying to rotate the token if the token is older than 80 percent of its time to live or if the token is older than 24 hours.Defaults to 1 hour and must be at least 10 minutes. Format: int64	false

Cluster.spec.manifests[index].quobyte#

^{^{↩ Parent}}

quobyte represents a Quobyte mount on the host that shares a pod's lifetime

Name	Type	Description	Required
registry	string	registry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumes	true
volume	string	volume is a string that references an already created Quobyte volume by name.	true
group	string	group to map volume access to Default is no group	false
readOnly	boolean	readOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false.	false
tenant	string	tenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes, value is set by the plugin	false
user	string	user to map volume access to Defaults to serivceaccount user	false

Cluster.spec.manifests[index].rbd#

^{^{↩ Parent}}

rbd represents a Rados Block Device mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/rbd/README.md

Name	Type	Description	Required
image	string	image is the rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it	true
monitors	[]string	monitors is a collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it	true
fsType	string	fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#rbd TODO: how do we prevent errors in the filesystem from compromising the machine	false
keyring	string	keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it	false
pool	string	pool is the rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it	false
readOnly	boolean	readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it	false
secretRef	object	secretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it	false
user	string	user is the rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it	false

Cluster.spec.manifests[index].rbd.secretRef#

^{^{↩ Parent}}

secretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

Name	Type	Description	Required
name	string	Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. TODO: Add other useful fields. apiVersion, kind, uid? 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. Default:	false

Cluster.spec.manifests[index].scaleIO#

^{^{↩ Parent}}

scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.

Name	Type	Description	Required
gateway	string	gateway is the host address of the ScaleIO API Gateway.	true
secretRef	object	secretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail.	true
system	string	system is the name of the storage system as configured in ScaleIO.	true
fsType	string	fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Default is "xfs".	false
protectionDomain	string	protectionDomain is the name of the ScaleIO Protection Domain for the configured storage.	false
readOnly	boolean	readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.	false
sslEnabled	boolean	sslEnabled Flag enable/disable SSL communication with Gateway, default false	false
storageMode	string	storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned.	false
storagePool	string	storagePool is the ScaleIO Storage Pool associated with the protection domain.	false
volumeName	string	volumeName is the name of a volume already created in the ScaleIO system that is associated with this volume source.	false

Cluster.spec.manifests[index].scaleIO.secretRef#

^{^{↩ Parent}}

secretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail.

Name	Type	Description	Required
name	string	Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. TODO: Add other useful fields. apiVersion, kind, uid? 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. Default:	false

Cluster.spec.manifests[index].secret#

^{^{↩ Parent}}

secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret

Name	Type	Description	Required
defaultMode	integer	defaultMode is Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false
items	[]object	items If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.	false
optional	boolean	optional field specify whether the Secret or its keys must be defined	false
secretName	string	secretName is the name of the secret in the pod's namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret	false

Cluster.spec.manifests[index].secret.items[index]#

^{^{↩ Parent}}

Maps a string key to a path within a volume.

Name	Type	Description	Required
key	string	key is the key to project.	true
path	string	path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.	true
mode	integer	mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false

Cluster.spec.manifests[index].storageos#

^{^{↩ Parent}}

storageOS represents a StorageOS volume attached and mounted on Kubernetes nodes.

Name	Type	Description	Required
fsType	string	fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.	false
readOnly	boolean	readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.	false
secretRef	object	secretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted.	false
volumeName	string	volumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace.	false
volumeNamespace	string	volumeNamespace specifies the scope of the volume within StorageOS. If no namespace is specified then the Pod's namespace will be used. This allows the Kubernetes name scoping to be mirrored within StorageOS for tighter integration. Set VolumeName to any name to override the default behaviour. Set to "default" if you are not using namespaces within StorageOS. Namespaces that do not pre-exist within StorageOS will be created.	false

Cluster.spec.manifests[index].storageos.secretRef#

^{^{↩ Parent}}

secretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted.

Name	Type	Description	Required
name	string	Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. TODO: Add other useful fields. apiVersion, kind, uid? 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. Default:	false

Cluster.spec.manifests[index].vsphereVolume#

^{^{↩ Parent}}

vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine

Name	Type	Description	Required
volumePath	string	volumePath is the path that identifies vSphere volume vmdk	true
fsType	string	fsType is filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.	false
storagePolicyID	string	storagePolicyID is the storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.	false
storagePolicyName	string	storagePolicyName is the storage Policy Based Management (SPBM) profile name.	false

Cluster.spec.monitoring#

^{^{↩ Parent}}

Monitoring defines the monitoring configuration.

Name	Type	Description	Required
enabled	boolean	Enabled enables prometheus sidecar that scrapes metrics from the child cluster system components and expose them as usual kubernetes pod metrics.	true
prometheusImage	string	PrometheusImage defines the image used for the prometheus sidecar. Default: quay.io/k0sproject/prometheus:v2.44.0	true
proxyImage	string	ProxyImage defines the image used for the nginx proxy sidecar. Default: nginx:1.19.10	true

Cluster.spec.mounts[index]#

^{^{↩ Parent}}

Name	Type	Description	Required
path	string		true
awsElasticBlockStore	object	awsElasticBlockStore represents an AWS Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore	false
azureDisk	object	azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.	false
azureFile	object	azureFile represents an Azure File Service mount on the host and bind mount to the pod.	false
cephfs	object	cephFS represents a Ceph FS mount on the host that shares a pod's lifetime	false
cinder	object	cinder represents a cinder volume attached and mounted on kubelets host machine. More info: https://examples.k8s.io/mysql-cinder-pd/README.md	false
configMap	object	configMap represents a configMap that should populate this volume	false
csi	object	csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature).	false
downwardAPI	object	downwardAPI represents downward API about the pod that should populate this volume	false
emptyDir	object	emptyDir represents a temporary directory that shares a pod's lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir	false
ephemeral	object	ephemeral represents a volume that is handled by a cluster storage driver. The volume's lifecycle is tied to the pod that defines it - it will be created before the pod starts, and deleted when the pod is removed. Use this if: a) the volume is only needed while the pod runs, b) features of normal volumes like restoring from snapshot or capacity tracking are needed, c) the storage driver is specified through a storage class, and d) the storage driver supports dynamic volume provisioning through a PersistentVolumeClaim (see EphemeralVolumeSource for more information on the connection between this volume type and PersistentVolumeClaim). Use PersistentVolumeClaim or one of the vendor-specific APIs for volumes that persist for longer than the lifecycle of an individual pod. Use CSI for light-weight local ephemeral volumes if the CSI driver is meant to be used that way - see the documentation of the driver for more information. A pod can use both types of ephemeral volumes and persistent volumes at the same time.	false
fc	object	fc represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod.	false
flexVolume	object	flexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.	false
flocker	object	flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running	false
gcePersistentDisk	object	gcePersistentDisk represents a GCE Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk	false
gitRepo	object	gitRepo represents a git repository at a particular revision. DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod's container.	false
glusterfs	object	glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/glusterfs/README.md	false
hostPath	object	hostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath --- TODO(jonesdl) We need to restrict who can use host directory mounts and who can/can not mount host directories as read/write.	false
iscsi	object	iscsi represents an ISCSI Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://examples.k8s.io/volumes/iscsi/README.md	false
nfs	object	nfs represents an NFS mount on the host that shares a pod's lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs	false
persistentVolumeClaim	object	persistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims	false
photonPersistentDisk	object	photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine	false
portworxVolume	object	portworxVolume represents a portworx volume attached and mounted on kubelets host machine	false
projected	object	projected items for all in one resources secrets, configmaps, and downward API	false
quobyte	object	quobyte represents a Quobyte mount on the host that shares a pod's lifetime	false
rbd	object	rbd represents a Rados Block Device mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/rbd/README.md	false
readOnly	boolean	ReadOnly specifies whether the volume should be mounted as read-only. (default: false, except for ConfigMaps and Secrets)	false
scaleIO	object	scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.	false
secret	object	secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret	false
storageos	object	storageOS represents a StorageOS volume attached and mounted on Kubernetes nodes.	false
vsphereVolume	object	vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine	false

Cluster.spec.mounts[index].awsElasticBlockStore#

^{^{↩ Parent}}

awsElasticBlockStore represents an AWS Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore

Name	Type	Description	Required
volumeID	string	volumeID is unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore	true
fsType	string	fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore TODO: how do we prevent errors in the filesystem from compromising the machine	false
partition	integer	partition is the partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). Format: int32	false
readOnly	boolean	readOnly value true will force the readOnly setting in VolumeMounts. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore	false

Cluster.spec.mounts[index].azureDisk#

^{^{↩ Parent}}

azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.

Name	Type	Description	Required
diskName	string	diskName is the Name of the data disk in the blob storage	true
diskURI	string	diskURI is the URI of data disk in the blob storage	true
cachingMode	string	cachingMode is the Host Caching mode: None, Read Only, Read Write.	false
fsType	string	fsType is Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.	false
kind	string	kind expected values are Shared: multiple blob disks per storage account Dedicated: single blob disk per storage account Managed: azure managed data disk (only in managed availability set). defaults to shared	false
readOnly	boolean	readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.	false

Cluster.spec.mounts[index].azureFile#

^{^{↩ Parent}}

azureFile represents an Azure File Service mount on the host and bind mount to the pod.

Name	Type	Description	Required
secretName	string	secretName is the name of secret that contains Azure Storage Account Name and Key	true
shareName	string	shareName is the azure share Name	true
readOnly	boolean	readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.	false

Cluster.spec.mounts[index].cephfs#

^{^{↩ Parent}}

cephFS represents a Ceph FS mount on the host that shares a pod's lifetime

Name	Type	Description	Required
monitors	[]string	monitors is Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it	true
path	string	path is Optional: Used as the mounted root, rather than the full Ceph tree, default is /	false
readOnly	boolean	readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it	false
secretFile	string	secretFile is Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it	false
secretRef	object	secretRef is Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it	false
user	string	user is optional: User is the rados user name, default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it	false

Cluster.spec.mounts[index].cephfs.secretRef#

^{^{↩ Parent}}

secretRef is Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it

Name	Type	Description	Required
name	string	Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. TODO: Add other useful fields. apiVersion, kind, uid? 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. Default:	false

Cluster.spec.mounts[index].cinder#

^{^{↩ Parent}}

cinder represents a cinder volume attached and mounted on kubelets host machine. More info: https://examples.k8s.io/mysql-cinder-pd/README.md

Name	Type	Description	Required
volumeID	string	volumeID used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md	true
fsType	string	fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://examples.k8s.io/mysql-cinder-pd/README.md	false
readOnly	boolean	readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/mysql-cinder-pd/README.md	false
secretRef	object	secretRef is optional: points to a secret object containing parameters used to connect to OpenStack.	false

Cluster.spec.mounts[index].cinder.secretRef#

^{^{↩ Parent}}

secretRef is optional: points to a secret object containing parameters used to connect to OpenStack.

Name	Type	Description	Required
name	string	Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. TODO: Add other useful fields. apiVersion, kind, uid? 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. Default:	false

Cluster.spec.mounts[index].configMap#

^{^{↩ Parent}}

configMap represents a configMap that should populate this volume

Name	Type	Description	Required
defaultMode	integer	defaultMode is optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false
items	[]object	items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.	false
name	string	Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. TODO: Add other useful fields. apiVersion, kind, uid? 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. Default:	false
optional	boolean	optional specify whether the ConfigMap or its keys must be defined	false

Cluster.spec.mounts[index].configMap.items[index]#

^{^{↩ Parent}}

Maps a string key to a path within a volume.

Name	Type	Description	Required
key	string	key is the key to project.	true
path	string	path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.	true
mode	integer	mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false

Cluster.spec.mounts[index].csi#

^{^{↩ Parent}}

csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature).

Name	Type	Description	Required
driver	string	driver is the name of the CSI driver that handles this volume. Consult with your admin for the correct name as registered in the cluster.	true
fsType	string	fsType to mount. Ex. "ext4", "xfs", "ntfs". If not provided, the empty value is passed to the associated CSI driver which will determine the default filesystem to apply.	false
nodePublishSecretRef	object	nodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secret references are passed.	false
readOnly	boolean	readOnly specifies a read-only configuration for the volume. Defaults to false (read/write).	false
volumeAttributes	map[string]string	volumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver's documentation for supported values.	false

Cluster.spec.mounts[index].csi.nodePublishSecretRef#

^{^{↩ Parent}}

nodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secret references are passed.

Name	Type	Description	Required
name	string	Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. TODO: Add other useful fields. apiVersion, kind, uid? 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. Default:	false

Cluster.spec.mounts[index].downwardAPI#

^{^{↩ Parent}}

downwardAPI represents downward API about the pod that should populate this volume

Name	Type	Description	Required
defaultMode	integer	Optional: mode bits to use on created files by default. Must be a Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false
items	[]object	Items is a list of downward API volume file	false

Cluster.spec.mounts[index].downwardAPI.items[index]#

^{^{↩ Parent}}

DownwardAPIVolumeFile represents information to create the file containing the pod field

Name	Type	Description	Required
path	string	Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'	true
fieldRef	object	Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported.	false
mode	integer	Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false
resourceFieldRef	object	Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.	false

Cluster.spec.mounts[index].downwardAPI.items[index].fieldRef#

^{^{↩ Parent}}

Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported.

Name	Type	Description	Required
fieldPath	string	Path of the field to select in the specified API version.	true
apiVersion	string	Version of the schema the FieldPath is written in terms of, defaults to "v1".	false

Cluster.spec.mounts[index].downwardAPI.items[index].resourceFieldRef#

^{^{↩ Parent}}

Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.

Name	Type	Description	Required
resource	string	Required: resource to select	true
containerName	string	Container name: required for volumes, optional for env vars	false
divisor	int or string	Specifies the output format of the exposed resources, defaults to "1"	false

Cluster.spec.mounts[index].emptyDir#

^{^{↩ Parent}}

emptyDir represents a temporary directory that shares a pod's lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir

Name	Type	Description	Required
medium	string	medium represents what type of storage medium should back this directory. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir	false
sizeLimit	int or string	sizeLimit is the total amount of local storage required for this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers in a pod. The default is nil which means that the limit is undefined. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir	false

Cluster.spec.mounts[index].ephemeral#

^{^{↩ Parent}}

ephemeral represents a volume that is handled by a cluster storage driver. The volume's lifecycle is tied to the pod that defines it - it will be created before the pod starts, and deleted when the pod is removed.

Use this if: a) the volume is only needed while the pod runs, b) features of normal volumes like restoring from snapshot or capacity tracking are needed, c) the storage driver is specified through a storage class, and d) the storage driver supports dynamic volume provisioning through a PersistentVolumeClaim (see EphemeralVolumeSource for more information on the connection between this volume type and PersistentVolumeClaim).

Use PersistentVolumeClaim or one of the vendor-specific APIs for volumes that persist for longer than the lifecycle of an individual pod.

Use CSI for light-weight local ephemeral volumes if the CSI driver is meant to be used that way - see the documentation of the driver for more information.

A pod can use both types of ephemeral volumes and persistent volumes at the same time.

Name	Type	Description	Required
volumeClaimTemplate	object	Will be used to create a stand-alone PVC to provision the volume. The pod in which this EphemeralVolumeSource is embedded will be the owner of the PVC, i.e. the PVC will be deleted together with the pod. The name of the PVC will be `-` where `` is the name from the `PodSpec.Volumes` array entry. Pod validation will reject the pod if the concatenated name is not valid for a PVC (for example, too long). An existing PVC with that name that is not owned by the pod will not be used for the pod to avoid using an unrelated volume by mistake. Starting the pod is then blocked until the unrelated PVC is removed. If such a pre-created PVC is meant to be used by the pod, the PVC has to updated with an owner reference to the pod once the pod exists. Normally this should not be necessary, but it may be useful when manually reconstructing a broken cluster. This field is read-only and no changes will be made by Kubernetes to the PVC after it has been created. Required, must not be nil.	false

Cluster.spec.mounts[index].ephemeral.volumeClaimTemplate#

^{^{↩ Parent}}

Will be used to create a stand-alone PVC to provision the volume. The pod in which this EphemeralVolumeSource is embedded will be the owner of the PVC, i.e. the PVC will be deleted together with the pod. The name of the PVC will be <pod name>-<volume name> where <volume name> is the name from the PodSpec.Volumes array entry. Pod validation will reject the pod if the concatenated name is not valid for a PVC (for example, too long).

An existing PVC with that name that is not owned by the pod will not be used for the pod to avoid using an unrelated volume by mistake. Starting the pod is then blocked until the unrelated PVC is removed. If such a pre-created PVC is meant to be used by the pod, the PVC has to updated with an owner reference to the pod once the pod exists. Normally this should not be necessary, but it may be useful when manually reconstructing a broken cluster.

This field is read-only and no changes will be made by Kubernetes to the PVC after it has been created.

Required, must not be nil.

Name	Type	Description	Required
spec	object	The specification for the PersistentVolumeClaim. The entire content is copied unchanged into the PVC that gets created from this template. The same fields as in a PersistentVolumeClaim are also valid here.	true
metadata	object	May contain labels and annotations that will be copied into the PVC when creating it. No other fields are allowed and will be rejected during validation.	false

Cluster.spec.mounts[index].ephemeral.volumeClaimTemplate.spec#

^{^{↩ Parent}}

The specification for the PersistentVolumeClaim. The entire content is copied unchanged into the PVC that gets created from this template. The same fields as in a PersistentVolumeClaim are also valid here.

Name	Type	Description	Required
accessModes	[]string	accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1	false
dataSource	object	dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. If the namespace is specified, then dataSourceRef will not be copied to dataSource.	false
dataSourceRef	object	dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the dataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, when namespace isn't specified in dataSourceRef, both fields (dataSource and dataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. When namespace is specified in dataSourceRef, dataSource isn't set to the same value and must be empty. There are three important differences between dataSource and dataSourceRef: * While dataSource only allows two specific types of objects, dataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While dataSource ignores disallowed values (dropping them), dataSourceRef preserves all values, and generates an error if a disallowed value is specified. * While dataSource only allows local objects, dataSourceRef allows objects in any namespaces. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.	false
resources	object	resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources	false
selector	object	selector is a label query over volumes to consider for binding.	false
storageClassName	string	storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1	false
volumeAttributesClassName	string	volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim. If specified, the CSI driver will create or update the volume with the attributes defined in the corresponding VolumeAttributesClass. This has a different purpose than storageClassName, it can be changed after the claim is created. An empty string 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/ (Alpha) Using this field requires the VolumeAttributesClass feature gate to be enabled.	false
volumeMode	string	volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.	false
volumeName	string	volumeName is the binding reference to the PersistentVolume backing this claim.	false

Cluster.spec.mounts[index].ephemeral.volumeClaimTemplate.spec.dataSource#

^{^{↩ Parent}}

dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. If the namespace is specified, then dataSourceRef will not be copied to dataSource.

Name	Type	Description	Required
kind	string	Kind is the type of resource being referenced	true
name	string	Name is the name of resource being referenced	true
apiGroup	string	APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.	false

Cluster.spec.mounts[index].ephemeral.volumeClaimTemplate.spec.dataSourceRef#

^{^{↩ Parent}}

dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the dataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, when namespace isn't specified in dataSourceRef, both fields (dataSource and dataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. When namespace is specified in dataSourceRef, dataSource isn't set to the same value and must be empty. There are three important differences between dataSource and dataSourceRef: * While dataSource only allows two specific types of objects, dataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While dataSource ignores disallowed values (dropping them), dataSourceRef preserves all values, and generates an error if a disallowed value is specified. * While dataSource only allows local objects, dataSourceRef allows objects in any namespaces. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.

Name	Type	Description	Required
kind	string	Kind is the type of resource being referenced	true
name	string	Name is the name of resource being referenced	true
apiGroup	string	APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.	false
namespace	string	Namespace is the namespace of resource being referenced Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. (Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.	false

Cluster.spec.mounts[index].ephemeral.volumeClaimTemplate.spec.resources#

^{^{↩ Parent}}

resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources

Name	Type	Description	Required
limits	map[string]int or string	Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/	false
requests	map[string]int or string	Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/	false

Cluster.spec.mounts[index].ephemeral.volumeClaimTemplate.spec.selector#

^{^{↩ Parent}}

selector is a label query over volumes to consider for binding.

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

Cluster.spec.mounts[index].ephemeral.volumeClaimTemplate.spec.selector.matchExpressions[index]#

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

Cluster.spec.mounts[index].ephemeral.volumeClaimTemplate.metadata#

^{^{↩ Parent}}

May contain labels and annotations that will be copied into the PVC when creating it. No other fields are allowed and will be rejected during validation.

Name	Type	Required
annotations	map[string]string	false
finalizers	[]string	false
labels	map[string]string	false
name	string	false
namespace	string	false

Cluster.spec.mounts[index].fc#

^{^{↩ Parent}}

fc represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod.

Name	Type	Description	Required
fsType	string	fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. TODO: how do we prevent errors in the filesystem from compromising the machine	false
lun	integer	lun is Optional: FC target lun number Format: int32	false
readOnly	boolean	readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.	false
targetWWNs	[]string	targetWWNs is Optional: FC target worldwide names (WWNs)	false
wwids	[]string	wwids Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously.	false

Cluster.spec.mounts[index].flexVolume#

^{^{↩ Parent}}

flexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.

Name	Type	Description	Required
driver	string	driver is the name of the driver to use for this volume.	true
fsType	string	fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script.	false
options	map[string]string	options is Optional: this field holds extra command options if any.	false
readOnly	boolean	readOnly is Optional: defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.	false
secretRef	object	secretRef is Optional: secretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts.	false

Cluster.spec.mounts[index].flexVolume.secretRef#

^{^{↩ Parent}}

secretRef is Optional: secretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts.

Name	Type	Description	Required
name	string	Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. TODO: Add other useful fields. apiVersion, kind, uid? 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. Default:	false

Cluster.spec.mounts[index].flocker#

^{^{↩ Parent}}

flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running

Name	Type	Description	Required
datasetName	string	datasetName is Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecated	false
datasetUUID	string	datasetUUID is the UUID of the dataset. This is unique identifier of a Flocker dataset	false

Cluster.spec.mounts[index].gcePersistentDisk#

^{^{↩ Parent}}

gcePersistentDisk represents a GCE Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk

Name	Type	Description	Required
pdName	string	pdName is unique name of the PD resource in GCE. Used to identify the disk in GCE. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk	true
fsType	string	fsType is filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk TODO: how do we prevent errors in the filesystem from compromising the machine	false
partition	integer	partition is the partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk Format: int32	false
readOnly	boolean	readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk	false

Cluster.spec.mounts[index].gitRepo#

^{^{↩ Parent}}

gitRepo represents a git repository at a particular revision. DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod's container.

Name	Type	Description	Required
repository	string	repository is the URL	true
directory	string	directory is the target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name.	false
revision	string	revision is the commit hash for the specified revision.	false

Cluster.spec.mounts[index].glusterfs#

^{^{↩ Parent}}

glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/glusterfs/README.md

Name	Type	Description	Required
endpoints	string	endpoints is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod	true
path	string	path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod	true
readOnly	boolean	readOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod	false

Cluster.spec.mounts[index].hostPath#

^{^{↩ Parent}}

hostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath

TODO(jonesdl) We need to restrict who can use host directory mounts and who can/can not mount host directories as read/write.

Name	Type	Description	Required
path	string	path of the directory on the host. If the path is a symlink, it will follow the link to the real path. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath	true
type	string	type for HostPath Volume Defaults to "" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath	false

Cluster.spec.mounts[index].iscsi#

^{^{↩ Parent}}

iscsi represents an ISCSI Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://examples.k8s.io/volumes/iscsi/README.md

Name	Type	Description	Required
iqn	string	iqn is the target iSCSI Qualified Name.	true
lun	integer	lun represents iSCSI Target Lun number. Format: int32	true
targetPortal	string	targetPortal is iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).	true
chapAuthDiscovery	boolean	chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication	false
chapAuthSession	boolean	chapAuthSession defines whether support iSCSI Session CHAP authentication	false
fsType	string	fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi TODO: how do we prevent errors in the filesystem from compromising the machine	false
initiatorName	string	initiatorName is the custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface : will be created for the connection.	false
iscsiInterface	string	iscsiInterface is the interface Name that uses an iSCSI transport. Defaults to 'default' (tcp).	false
portals	[]string	portals is the iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).	false
readOnly	boolean	readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.	false
secretRef	object	secretRef is the CHAP Secret for iSCSI target and initiator authentication	false

Cluster.spec.mounts[index].iscsi.secretRef#

^{^{↩ Parent}}

secretRef is the CHAP Secret for iSCSI target and initiator authentication

Name	Type	Description	Required
name	string	Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. TODO: Add other useful fields. apiVersion, kind, uid? 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. Default:	false

Cluster.spec.mounts[index].nfs#

^{^{↩ Parent}}

nfs represents an NFS mount on the host that shares a pod's lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

Name	Type	Description	Required
path	string	path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs	true
server	string	server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs	true
readOnly	boolean	readOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs	false

Cluster.spec.mounts[index].persistentVolumeClaim#

^{^{↩ Parent}}

persistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

Name	Type	Description	Required
claimName	string	claimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims	true
readOnly	boolean	readOnly Will force the ReadOnly setting in VolumeMounts. Default false.	false

Cluster.spec.mounts[index].photonPersistentDisk#

^{^{↩ Parent}}

photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine

Name	Type	Description	Required
pdID	string	pdID is the ID that identifies Photon Controller persistent disk	true
fsType	string	fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.	false

Cluster.spec.mounts[index].portworxVolume#

^{^{↩ Parent}}

portworxVolume represents a portworx volume attached and mounted on kubelets host machine

Name	Type	Description	Required
volumeID	string	volumeID uniquely identifies a Portworx volume	true
fsType	string	fSType represents the filesystem type to mount Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs". Implicitly inferred to be "ext4" if unspecified.	false
readOnly	boolean	readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.	false

Cluster.spec.mounts[index].projected#

^{^{↩ Parent}}

projected items for all in one resources secrets, configmaps, and downward API

Name	Type	Description	Required
defaultMode	integer	defaultMode are the mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false
sources	[]object	sources is the list of volume projections	false

Cluster.spec.mounts[index].projected.sources[index]#

^{^{↩ Parent}}

Projection that may be projected along with other supported volume types

Name	Type	Description	Required
clusterTrustBundle	object	ClusterTrustBundle allows a pod to access the `.spec.trustBundle` field of ClusterTrustBundle objects in an auto-updating file. Alpha, gated by the ClusterTrustBundleProjection feature gate. ClusterTrustBundle objects can either be selected by name, or by the combination of signer name and a label selector. Kubelet performs aggressive normalization of the PEM contents written into the pod filesystem. Esoteric PEM features such as inter-block comments and block headers are stripped. Certificates are deduplicated. The ordering of certificates within the file is arbitrary, and Kubelet may change the order over time.	false
configMap	object	configMap information about the configMap data to project	false
downwardAPI	object	downwardAPI information about the downwardAPI data to project	false
secret	object	secret information about the secret data to project	false
serviceAccountToken	object	serviceAccountToken is information about the serviceAccountToken data to project	false

Cluster.spec.mounts[index].projected.sources[index].clusterTrustBundle#

^{^{↩ Parent}}

ClusterTrustBundle allows a pod to access the .spec.trustBundle field of ClusterTrustBundle objects in an auto-updating file.

Alpha, gated by the ClusterTrustBundleProjection feature gate.

ClusterTrustBundle objects can either be selected by name, or by the combination of signer name and a label selector.

Kubelet performs aggressive normalization of the PEM contents written into the pod filesystem. Esoteric PEM features such as inter-block comments and block headers are stripped. Certificates are deduplicated. The ordering of certificates within the file is arbitrary, and Kubelet may change the order over time.

Name	Type	Description	Required
path	string	Relative path from the volume root to write the bundle.	true
labelSelector	object	Select all ClusterTrustBundles that match this label selector. Only has effect if signerName is set. Mutually-exclusive with name. If unset, interpreted as "match nothing". If set but empty, interpreted as "match everything".	false
name	string	Select a single ClusterTrustBundle by object name. Mutually-exclusive with signerName and labelSelector.	false
optional	boolean	If true, don't block pod startup if the referenced ClusterTrustBundle(s) aren't available. If using name, then the named ClusterTrustBundle is allowed not to exist. If using signerName, then the combination of signerName and labelSelector is allowed to match zero ClusterTrustBundles.	false
signerName	string	Select all ClusterTrustBundles that match this signer name. Mutually-exclusive with name. The contents of all selected ClusterTrustBundles will be unified and deduplicated.	false

Cluster.spec.mounts[index].projected.sources[index].clusterTrustBundle.labelSelector#

^{^{↩ Parent}}

Select all ClusterTrustBundles that match this label selector. Only has effect if signerName is set. Mutually-exclusive with name. If unset, interpreted as "match nothing". If set but empty, interpreted as "match everything".

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

Cluster.spec.mounts[index].projected.sources[index].clusterTrustBundle.labelSelector.matchExpressions[index]#

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

Cluster.spec.mounts[index].projected.sources[index].configMap#

^{^{↩ Parent}}

configMap information about the configMap data to project

Name	Type	Description	Required
items	[]object	items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.	false
name	string	Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. TODO: Add other useful fields. apiVersion, kind, uid? 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. Default:	false
optional	boolean	optional specify whether the ConfigMap or its keys must be defined	false

Cluster.spec.mounts[index].projected.sources[index].configMap.items[index]#

^{^{↩ Parent}}

Maps a string key to a path within a volume.

Name	Type	Description	Required
key	string	key is the key to project.	true
path	string	path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.	true
mode	integer	mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false

Cluster.spec.mounts[index].projected.sources[index].downwardAPI#

^{^{↩ Parent}}

downwardAPI information about the downwardAPI data to project

Name	Type	Description	Required
items	[]object	Items is a list of DownwardAPIVolume file	false

Cluster.spec.mounts[index].projected.sources[index].downwardAPI.items[index]#

^{^{↩ Parent}}

DownwardAPIVolumeFile represents information to create the file containing the pod field

Name	Type	Description	Required
path	string	Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'	true
fieldRef	object	Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported.	false
mode	integer	Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false
resourceFieldRef	object	Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.	false

Cluster.spec.mounts[index].projected.sources[index].downwardAPI.items[index].fieldRef#

^{^{↩ Parent}}

Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported.

Name	Type	Description	Required
fieldPath	string	Path of the field to select in the specified API version.	true
apiVersion	string	Version of the schema the FieldPath is written in terms of, defaults to "v1".	false

Cluster.spec.mounts[index].projected.sources[index].downwardAPI.items[index].resourceFieldRef#

^{^{↩ Parent}}

Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.

Name	Type	Description	Required
resource	string	Required: resource to select	true
containerName	string	Container name: required for volumes, optional for env vars	false
divisor	int or string	Specifies the output format of the exposed resources, defaults to "1"	false

Cluster.spec.mounts[index].projected.sources[index].secret#

^{^{↩ Parent}}

secret information about the secret data to project

Name	Type	Description	Required
items	[]object	items if unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.	false
name	string	Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. TODO: Add other useful fields. apiVersion, kind, uid? 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. Default:	false
optional	boolean	optional field specify whether the Secret or its key must be defined	false

Cluster.spec.mounts[index].projected.sources[index].secret.items[index]#

^{^{↩ Parent}}

Maps a string key to a path within a volume.

Name	Type	Description	Required
key	string	key is the key to project.	true
path	string	path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.	true
mode	integer	mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false

Cluster.spec.mounts[index].projected.sources[index].serviceAccountToken#

^{^{↩ Parent}}

serviceAccountToken is information about the serviceAccountToken data to project

Name	Type	Description	Required
path	string	path is the path relative to the mount point of the file to project the token into.	true
audience	string	audience is the intended audience of the token. A recipient of a token must identify itself with an identifier specified in the audience of the token, and otherwise should reject the token. The audience defaults to the identifier of the apiserver.	false
expirationSeconds	integer	expirationSeconds is the requested duration of validity of the service account token. As the token approaches expiration, the kubelet volume plugin will proactively rotate the service account token. The kubelet will start trying to rotate the token if the token is older than 80 percent of its time to live or if the token is older than 24 hours.Defaults to 1 hour and must be at least 10 minutes. Format: int64	false

Cluster.spec.mounts[index].quobyte#

^{^{↩ Parent}}

quobyte represents a Quobyte mount on the host that shares a pod's lifetime

Name	Type	Description	Required
registry	string	registry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumes	true
volume	string	volume is a string that references an already created Quobyte volume by name.	true
group	string	group to map volume access to Default is no group	false
readOnly	boolean	readOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false.	false
tenant	string	tenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes, value is set by the plugin	false
user	string	user to map volume access to Defaults to serivceaccount user	false

Cluster.spec.mounts[index].rbd#

^{^{↩ Parent}}

rbd represents a Rados Block Device mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/rbd/README.md

Name	Type	Description	Required
image	string	image is the rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it	true
monitors	[]string	monitors is a collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it	true
fsType	string	fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#rbd TODO: how do we prevent errors in the filesystem from compromising the machine	false
keyring	string	keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it	false
pool	string	pool is the rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it	false
readOnly	boolean	readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it	false
secretRef	object	secretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it	false
user	string	user is the rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it	false

Cluster.spec.mounts[index].rbd.secretRef#

^{^{↩ Parent}}

secretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

Name	Type	Description	Required
name	string	Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. TODO: Add other useful fields. apiVersion, kind, uid? 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. Default:	false

Cluster.spec.mounts[index].scaleIO#

^{^{↩ Parent}}

scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.

Name	Type	Description	Required
gateway	string	gateway is the host address of the ScaleIO API Gateway.	true
secretRef	object	secretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail.	true
system	string	system is the name of the storage system as configured in ScaleIO.	true
fsType	string	fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Default is "xfs".	false
protectionDomain	string	protectionDomain is the name of the ScaleIO Protection Domain for the configured storage.	false
readOnly	boolean	readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.	false
sslEnabled	boolean	sslEnabled Flag enable/disable SSL communication with Gateway, default false	false
storageMode	string	storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned.	false
storagePool	string	storagePool is the ScaleIO Storage Pool associated with the protection domain.	false
volumeName	string	volumeName is the name of a volume already created in the ScaleIO system that is associated with this volume source.	false

Cluster.spec.mounts[index].scaleIO.secretRef#

^{^{↩ Parent}}

secretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail.

Name	Type	Description	Required
name	string	Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. TODO: Add other useful fields. apiVersion, kind, uid? 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. Default:	false

Cluster.spec.mounts[index].secret#

^{^{↩ Parent}}

secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret

Name	Type	Description	Required
defaultMode	integer	defaultMode is Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false
items	[]object	items If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.	false
optional	boolean	optional field specify whether the Secret or its keys must be defined	false
secretName	string	secretName is the name of the secret in the pod's namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret	false

Cluster.spec.mounts[index].secret.items[index]#

^{^{↩ Parent}}

Maps a string key to a path within a volume.

Name	Type	Description	Required
key	string	key is the key to project.	true
path	string	path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.	true
mode	integer	mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false

Cluster.spec.mounts[index].storageos#

^{^{↩ Parent}}

storageOS represents a StorageOS volume attached and mounted on Kubernetes nodes.

Name	Type	Description	Required
fsType	string	fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.	false
readOnly	boolean	readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.	false
secretRef	object	secretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted.	false
volumeName	string	volumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace.	false
volumeNamespace	string	volumeNamespace specifies the scope of the volume within StorageOS. If no namespace is specified then the Pod's namespace will be used. This allows the Kubernetes name scoping to be mirrored within StorageOS for tighter integration. Set VolumeName to any name to override the default behaviour. Set to "default" if you are not using namespaces within StorageOS. Namespaces that do not pre-exist within StorageOS will be created.	false

Cluster.spec.mounts[index].storageos.secretRef#

^{^{↩ Parent}}

secretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted.

Name	Type	Description	Required
name	string	Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. TODO: Add other useful fields. apiVersion, kind, uid? 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. Default:	false

Cluster.spec.mounts[index].vsphereVolume#

^{^{↩ Parent}}

vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine

Name	Type	Description	Required
volumePath	string	volumePath is the path that identifies vSphere volume vmdk	true
fsType	string	fsType is filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.	false
storagePolicyID	string	storagePolicyID is the storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.	false
storagePolicyName	string	storagePolicyName is the storage Policy Based Management (SPBM) profile name.	false

Cluster.spec.persistence#

^{^{↩ Parent}}

Persistence defines the persistence configuration. If empty k0smotron will use emptyDir as a volume. See https://docs.k0smotron.io/stable/configuration/#persistence

Name	Type	Description	Required
type	string	Default: emptyDir	true
autoDeletePVCs	boolean	AutoDeletePVCs defines whether the PVC should be deleted when the cluster is deleted. Default: false	false
hostPath	string	HostPath defines the host path configuration. Will be used as is in case of .spec.persistence.type is hostPath.	false
persistentVolumeClaim	object	PersistentVolumeClaim defines the PVC configuration. Will be used as is in case of .spec.persistence.type is pvc.	false

Cluster.spec.persistence.persistentVolumeClaim#

^{^{↩ Parent}}

PersistentVolumeClaim defines the PVC configuration. Will be used as is in case of .spec.persistence.type is pvc.

Name	Type	Description	Required
apiVersion	string	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources	false
kind	string	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds	false
metadata	object	Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata	false
spec	object	spec defines the desired characteristics of a volume requested by a pod author. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims	false
status	object	status represents the current information/status of a persistent volume claim. Read-only. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims	false

Cluster.spec.persistence.persistentVolumeClaim.metadata#

^{^{↩ Parent}}

Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

Name	Type	Required
annotations	map[string]string	false
finalizers	[]string	false
labels	map[string]string	false
name	string	false
namespace	string	false

Cluster.spec.persistence.persistentVolumeClaim.spec#

^{^{↩ Parent}}

spec defines the desired characteristics of a volume requested by a pod author. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

Name	Type	Description	Required
accessModes	[]string	accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1	false
dataSource	object	dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. If the namespace is specified, then dataSourceRef will not be copied to dataSource.	false
dataSourceRef	object	dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the dataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, when namespace isn't specified in dataSourceRef, both fields (dataSource and dataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. When namespace is specified in dataSourceRef, dataSource isn't set to the same value and must be empty. There are three important differences between dataSource and dataSourceRef: * While dataSource only allows two specific types of objects, dataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While dataSource ignores disallowed values (dropping them), dataSourceRef preserves all values, and generates an error if a disallowed value is specified. * While dataSource only allows local objects, dataSourceRef allows objects in any namespaces. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.	false
resources	object	resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources	false
selector	object	selector is a label query over volumes to consider for binding.	false
storageClassName	string	storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1	false
volumeAttributesClassName	string	volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim. If specified, the CSI driver will create or update the volume with the attributes defined in the corresponding VolumeAttributesClass. This has a different purpose than storageClassName, it can be changed after the claim is created. An empty string 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/ (Alpha) Using this field requires the VolumeAttributesClass feature gate to be enabled.	false
volumeMode	string	volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.	false
volumeName	string	volumeName is the binding reference to the PersistentVolume backing this claim.	false

Cluster.spec.persistence.persistentVolumeClaim.spec.dataSource#

^{^{↩ Parent}}

dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. If the namespace is specified, then dataSourceRef will not be copied to dataSource.

Name	Type	Description	Required
kind	string	Kind is the type of resource being referenced	true
name	string	Name is the name of resource being referenced	true
apiGroup	string	APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.	false

Cluster.spec.persistence.persistentVolumeClaim.spec.dataSourceRef#

^{^{↩ Parent}}

dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the dataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, when namespace isn't specified in dataSourceRef, both fields (dataSource and dataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. When namespace is specified in dataSourceRef, dataSource isn't set to the same value and must be empty. There are three important differences between dataSource and dataSourceRef: * While dataSource only allows two specific types of objects, dataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While dataSource ignores disallowed values (dropping them), dataSourceRef preserves all values, and generates an error if a disallowed value is specified. * While dataSource only allows local objects, dataSourceRef allows objects in any namespaces. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.

Name	Type	Description	Required
kind	string	Kind is the type of resource being referenced	true
name	string	Name is the name of resource being referenced	true
apiGroup	string	APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.	false
namespace	string	Namespace is the namespace of resource being referenced Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. (Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.	false

Cluster.spec.persistence.persistentVolumeClaim.spec.resources#

^{^{↩ Parent}}

resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources

Name	Type	Description	Required
limits	map[string]int or string	Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/	false
requests	map[string]int or string	Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/	false

Cluster.spec.persistence.persistentVolumeClaim.spec.selector#

^{^{↩ Parent}}

selector is a label query over volumes to consider for binding.

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

Cluster.spec.persistence.persistentVolumeClaim.spec.selector.matchExpressions[index]#

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

Cluster.spec.persistence.persistentVolumeClaim.status#

^{^{↩ Parent}}

status represents the current information/status of a persistent volume claim. Read-only. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

Name	Type	Description	Required
accessModes	[]string	accessModes contains the actual access modes the volume backing the PVC has. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1	false
allocatedResourceStatuses	map[string]string	allocatedResourceStatuses stores status of resource being resized for the given PVC. Key names follow standard Kubernetes label syntax. Valid values are either: * Un-prefixed keys: - storage - the capacity of the volume. * Custom resources must use implementation-defined prefixed names such as "example.com/my-custom-resource" Apart from above values - keys that are unprefixed or have kubernetes.io prefix are considered reserved and hence may not be used. ClaimResourceStatus can be in any of following states: - ControllerResizeInProgress: State set when resize controller starts resizing the volume in control-plane. - ControllerResizeFailed: State set when resize has failed in resize controller with a terminal error. - NodeResizePending: State set when resize controller has finished resizing the volume but further resizing of volume is needed on the node. - NodeResizeInProgress: State set when kubelet starts resizing the volume. - NodeResizeFailed: State set when resizing has failed in kubelet with a terminal error. Transient errors don't set NodeResizeFailed. For example: if expanding a PVC for more capacity - this field can be one of the following states: - pvc.status.allocatedResourceStatus['storage'] = "ControllerResizeInProgress" - pvc.status.allocatedResourceStatus['storage'] = "ControllerResizeFailed" - pvc.status.allocatedResourceStatus['storage'] = "NodeResizePending" - pvc.status.allocatedResourceStatus['storage'] = "NodeResizeInProgress" - pvc.status.allocatedResourceStatus['storage'] = "NodeResizeFailed" When this field is not set, it means that no resize operation is in progress for the given PVC. A controller that receives PVC update with previously unknown resourceName or ClaimResourceStatus should ignore the update for the purpose it was designed. For example - a controller that only is responsible for resizing capacity of the volume, should ignore PVC updates that change other valid resources associated with PVC. This is an alpha field and requires enabling RecoverVolumeExpansionFailure feature.	false
allocatedResources	map[string]int or string	allocatedResources tracks the resources allocated to a PVC including its capacity. Key names follow standard Kubernetes label syntax. Valid values are either: * Un-prefixed keys: - storage - the capacity of the volume. * Custom resources must use implementation-defined prefixed names such as "example.com/my-custom-resource" Apart from above values - keys that are unprefixed or have kubernetes.io prefix are considered reserved and hence may not be used. Capacity reported here may be larger than the actual capacity when a volume expansion operation is requested. For storage quota, the larger value from allocatedResources and PVC.spec.resources is used. If allocatedResources is not set, PVC.spec.resources alone is used for quota calculation. If a volume expansion capacity request is lowered, allocatedResources is only lowered if there are no expansion operations in progress and if the actual volume capacity is equal or lower than the requested capacity. A controller that receives PVC update with previously unknown resourceName should ignore the update for the purpose it was designed. For example - a controller that only is responsible for resizing capacity of the volume, should ignore PVC updates that change other valid resources associated with PVC. This is an alpha field and requires enabling RecoverVolumeExpansionFailure feature.	false
capacity	map[string]int or string	capacity represents the actual resources of the underlying volume.	false
conditions	[]object	conditions is the current Condition of persistent volume claim. If underlying persistent volume is being resized then the Condition will be set to 'Resizing'.	false
currentVolumeAttributesClassName	string	currentVolumeAttributesClassName is the current name of the VolumeAttributesClass the PVC is using. When unset, there is no VolumeAttributeClass applied to this PersistentVolumeClaim This is an alpha field and requires enabling VolumeAttributesClass feature.	false
modifyVolumeStatus	object	ModifyVolumeStatus represents the status object of ControllerModifyVolume operation. When this is unset, there is no ModifyVolume operation being attempted. This is an alpha field and requires enabling VolumeAttributesClass feature.	false
phase	string	phase represents the current phase of PersistentVolumeClaim.	false

Cluster.spec.persistence.persistentVolumeClaim.status.conditions[index]#

^{^{↩ Parent}}

PersistentVolumeClaimCondition contains details about state of pvc

Name	Type	Description	Required
status	string		true
type	string	PersistentVolumeClaimConditionType is a valid value of PersistentVolumeClaimCondition.Type	true
lastProbeTime	string	lastProbeTime is the time we probed the condition. Format: date-time	false
lastTransitionTime	string	lastTransitionTime is the time the condition transitioned from one status to another. Format: date-time	false
message	string	message is the human-readable message indicating details about last transition.	false
reason	string	reason is a unique, this should be a short, machine understandable string that gives the reason for condition's last transition. If it reports "Resizing" that means the underlying persistent volume is being resized.	false

Cluster.spec.persistence.persistentVolumeClaim.status.modifyVolumeStatus#

^{^{↩ Parent}}

ModifyVolumeStatus represents the status object of ControllerModifyVolume operation. When this is unset, there is no ModifyVolume operation being attempted. This is an alpha field and requires enabling VolumeAttributesClass feature.

Name	Type	Description	Required
status	string	status is the status of the ControllerModifyVolume operation. It can be in any of following states: - Pending Pending indicates that the PersistentVolumeClaim cannot be modified due to unmet requirements, such as the specified VolumeAttributesClass not existing. - InProgress InProgress indicates that the volume is being modified. - Infeasible Infeasible indicates that the request has been rejected as invalid by the CSI driver. To resolve the error, a valid VolumeAttributesClass needs to be specified. Note: New statuses can be added in the future. Consumers should check for unknown statuses and fail appropriately.	true
targetVolumeAttributesClassName	string	targetVolumeAttributesClassName is the name of the VolumeAttributesClass the PVC currently being reconciled	false

Cluster.spec.resources#

^{^{↩ Parent}}

Resources describes the compute resource requirements for the control plane pods.

Name	Type	Description	Required
claims	[]object	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.	false
limits	map[string]int or string	Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/	false
requests	map[string]int or string	Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/	false

Cluster.spec.resources.claims[index]#

^{^{↩ Parent}}

ResourceClaim references one entry in PodSpec.ResourceClaims.

Name	Type	Description	Required
name	string	Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.	true

Cluster.spec.service#

^{^{↩ Parent}}

Service defines the service configuration.

Name	Type	Description	Required
type	enum	Service Type string describes ingress methods for a service Enum: ClusterIP, NodePort, LoadBalancer Default: ClusterIP	true
annotations	map[string]string	Annotations defines extra annotations to be added to the service.	false
apiPort	integer	APIPort defines the kubernetes API port. If empty k0smotron will pick it automatically. Default: 30443	false
konnectivityPort	integer	KonnectivityPort defines the konnectivity port. If empty k0smotron will pick it automatically. Default: 30132	false
labels	map[string]string	Labels defines extra labels to be added to the service.	false
loadBalancerClass	string	LoadBalancerClass defines the load balancer class to be used for the service. Used only when service type is LoadBalancer.	false

Cluster.status#

^{^{↩ Parent}}

ClusterStatus defines the observed state of K0smotronCluster

Name	Type	Description	Required
reconciliationStatus	string		true
ready	boolean		false

JoinTokenRequest#

^{^{↩ Parent}}

JoinTokenRequest is the Schema for the join token request API

Name	Type	Description	Required
apiVersion	string	k0smotron.io/v1beta1	true
kind	string	JoinTokenRequest	true
metadata	object	Refer to the Kubernetes API documentation for the fields of the `metadata` field.	true
spec	object	JoinTokenRequestSpec defines the desired state of K0smotronJoinTokenRequest	false
status	object	JoinTokenRequestStatus defines the observed state of K0smotronJoinTokenRequest	false

JoinTokenRequest.spec#

^{^{↩ Parent}}

JoinTokenRequestSpec defines the desired state of K0smotronJoinTokenRequest

Name	Type	Description	Required
clusterRef	object	ClusterRef is the reference to the cluster for which the join token is requested.	true
expiry	string	Expiration time of the token. Format 1.5h, 2h45m or 300ms. Default: 0s	false
role	enum	Role of the node for which the token is requested (worker or controller). Enum: worker, controller Default: worker	false

JoinTokenRequest.spec.clusterRef#

^{^{↩ Parent}}

ClusterRef is the reference to the cluster for which the join token is requested.

Name	Type	Description	Required
name	string	Name of the cluster.	true
namespace	string	Namespace of the cluster.	true

JoinTokenRequest.status#

^{^{↩ Parent}}

JoinTokenRequestStatus defines the observed state of K0smotronJoinTokenRequest

Name	Type	Description	Required
reconciliationStatus	string		true
clusterUID	string	UID is a type that holds unique ID values, including UUIDs. Because we don't ONLY use UUIDs, this is an alias to string. Being a type captures intent and helps make sure that UIDs and names do not get conflated.	false
tokenID	string		false