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#
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#
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]#
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#
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#
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#
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#
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#
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#
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#
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]#
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#
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#
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#
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#
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#
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#
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#
Name | Type | Description | Required |
---|---|---|---|
template | object |
|
false |
K0sWorkerConfigTemplate.spec.template#
Name | Type | Description | Required |
---|---|---|---|
metadata | object |
|
false |
spec | object |
|
false |
K0sWorkerConfigTemplate.spec.template.metadata#
Name | Type | Description | Required |
---|---|---|---|
annotations | map[string]string |
|
false |
finalizers | []string |
|
false |
labels | map[string]string |
|
false |
name | string |
|
false |
namespace | string |
|
false |
K0sWorkerConfigTemplate.spec.template.spec#
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]#
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#
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#
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#
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#
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#
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#
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#
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]#
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#
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#
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#
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#
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#
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 |
K0sControlPlane.spec.machineTemplate.infrastructureRef#
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#
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#
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]#
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#
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#
Name | Type | Description | Required |
---|---|---|---|
template | object |
|
false |
K0sControlPlaneTemplate.spec.template#
Name | Type | Description | Required |
---|---|---|---|
metadata | object |
|
false |
spec | object |
|
false |
K0sControlPlaneTemplate.spec.template.metadata#
Name | Type | Description | Required |
---|---|---|---|
annotations | map[string]string |
|
false |
finalizers | []string |
|
false |
labels | map[string]string |
|
false |
name | string |
|
false |
namespace | string |
|
false |
K0sControlPlaneTemplate.spec.template.spec#
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#
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]#
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#
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#
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#
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#
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#
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 |
K0sControlPlaneTemplate.spec.template.spec.machineTemplate.infrastructureRef#
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#
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#
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#
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.
KineDataSourceURL or KineDataSourceSecretName are required for HA controlplane setup
and one of them must be set if replicas > 1. |
false |
kineDataSourceURL | string |
KineDataSourceURL defines the kine datasource URL.
KineDataSourceURL or KineDataSourceSecretName are required for HA controlplane setup
and one of them must be set if replicas > 1. |
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/ |
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]#
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#
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#
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 > 200*1024*1024 |
true |
schedule | string |
Schedule defines the etcd defragmentation job schedule. Default: 0 12 * * * |
true |
K0smotronControlPlane.spec.etcd.persistence#
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]#
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#
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#
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#
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#
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#
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.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid? |
false |
K0smotronControlPlane.spec.manifests[index].cinder#
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#
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.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid? |
false |
K0smotronControlPlane.spec.manifests[index].configMap#
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.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid? |
false |
optional | boolean |
optional specify whether the ConfigMap or its keys must be defined |
false |
K0smotronControlPlane.spec.manifests[index].configMap.items[index]#
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#
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#
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.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid? |
false |
K0smotronControlPlane.spec.manifests[index].downwardAPI#
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]#
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 and namespace 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#
Required: Selects a field of the pod: only annotations, labels, name and namespace 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#
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#
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#
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 ` |
false |
K0smotronControlPlane.spec.manifests[index].ephemeral.volumeClaimTemplate#
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#
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 |
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#
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#
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#
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 |
---|---|---|---|
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.manifests[index].ephemeral.volumeClaimTemplate.spec.resources.claims[index]#
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.manifests[index].ephemeral.volumeClaimTemplate.spec.selector#
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]#
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#
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 | Description | 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#
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#
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#
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.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid? |
false |
K0smotronControlPlane.spec.manifests[index].flocker#
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#
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#
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#
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#
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#
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
|
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#
secretRef is the CHAP Secret for iSCSI target and initiator authentication
Name | Type | Description | Required |
---|---|---|---|
name | string |
Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid? |
false |
K0smotronControlPlane.spec.manifests[index].nfs#
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#
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#
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#
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#
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]#
Projection that may be projected along with other supported volume types
Name | Type | Description | Required |
---|---|---|---|
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].configMap#
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.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid? |
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]#
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#
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]#
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 and namespace 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#
Required: Selects a field of the pod: only annotations, labels, name and namespace 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#
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#
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.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid? |
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]#
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#
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#
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#
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#
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.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid? |
false |
K0smotronControlPlane.spec.manifests[index].scaleIO#
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#
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.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid? |
false |
K0smotronControlPlane.spec.manifests[index].secret#
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]#
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#
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#
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.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid? |
false |
K0smotronControlPlane.spec.manifests[index].vsphereVolume#
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#
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]#
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#
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#
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#
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#
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#
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.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid? |
false |
K0smotronControlPlane.spec.mounts[index].cinder#
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#
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.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid? |
false |
K0smotronControlPlane.spec.mounts[index].configMap#
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.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid? |
false |
optional | boolean |
optional specify whether the ConfigMap or its keys must be defined |
false |
K0smotronControlPlane.spec.mounts[index].configMap.items[index]#
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#
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#
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.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid? |
false |
K0smotronControlPlane.spec.mounts[index].downwardAPI#
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]#
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 and namespace 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#
Required: Selects a field of the pod: only annotations, labels, name and namespace 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#
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#
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#
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 ` |
false |
K0smotronControlPlane.spec.mounts[index].ephemeral.volumeClaimTemplate#
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#
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 |
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#
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#
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#
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 |
---|---|---|---|
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.mounts[index].ephemeral.volumeClaimTemplate.spec.resources.claims[index]#
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.mounts[index].ephemeral.volumeClaimTemplate.spec.selector#
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]#
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#
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 | Description | 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#
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#
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#
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.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid? |
false |
K0smotronControlPlane.spec.mounts[index].flocker#
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#
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#
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#
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#
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#
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
|
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#
secretRef is the CHAP Secret for iSCSI target and initiator authentication
Name | Type | Description | Required |
---|---|---|---|
name | string |
Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid? |
false |
K0smotronControlPlane.spec.mounts[index].nfs#
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#
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#
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#
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#
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]#
Projection that may be projected along with other supported volume types
Name | Type | Description | Required |
---|---|---|---|
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].configMap#
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.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid? |
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]#
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#
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]#
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 and namespace 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#
Required: Selects a field of the pod: only annotations, labels, name and namespace 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#
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#
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.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid? |
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]#
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#
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#
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#
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#
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.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid? |
false |
K0smotronControlPlane.spec.mounts[index].scaleIO#
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#
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.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid? |
false |
K0smotronControlPlane.spec.mounts[index].secret#
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]#
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#
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#
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.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid? |
false |
K0smotronControlPlane.spec.mounts[index].vsphereVolume#
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#
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#
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#
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 |
|
false |
finalizers | []string |
|
false |
labels | map[string]string |
|
false |
name | string |
|
false |
namespace | string |
|
false |
K0smotronControlPlane.spec.persistence.persistentVolumeClaim.spec#
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 |
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#
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#
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#
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 |
---|---|---|---|
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.persistence.persistentVolumeClaim.spec.resources.claims[index]#
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.persistence.persistentVolumeClaim.spec.selector#
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]#
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#
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 'ResizeStarted'. |
false |
phase | string |
phase represents the current phase of PersistentVolumeClaim. |
false |
K0smotronControlPlane.spec.persistence.persistentVolumeClaim.status.conditions[index]#
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 "ResizeStarted" that means the underlying
persistent volume is being resized. |
false |
K0smotronControlPlane.spec.resources#
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]#
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#
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 |
K0smotronControlPlane.status#
Name | Type | Description | Required |
---|---|---|---|
controlPlaneReady | boolean |
|
true |
externalManagedControlPlane | boolean |
|
true |
initialized | boolean |
|
true |
ready | boolean |
Ready denotes that the control plane is ready |
true |
K0smotronControlPlaneTemplate#
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#
Name | Type | Description | Required |
---|---|---|---|
template | object |
|
false |
K0smotronControlPlaneTemplate.spec.template#
Name | Type | Description | Required |
---|---|---|---|
metadata | object |
|
false |
spec | object |
ClusterSpec defines the desired state of K0smotronCluster |
false |
K0smotronControlPlaneTemplate.spec.template.metadata#
Name | Type | Description | Required |
---|---|---|---|
annotations | map[string]string |
|
false |
finalizers | []string |
|
false |
labels | map[string]string |
|
false |
name | string |
|
false |
namespace | string |
|
false |
K0smotronControlPlaneTemplate.spec.template.spec#
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.
KineDataSourceURL or KineDataSourceSecretName are required for HA controlplane setup
and one of them must be set if replicas > 1. |
false |
kineDataSourceURL | string |
KineDataSourceURL defines the kine datasource URL.
KineDataSourceURL or KineDataSourceSecretName are required for HA controlplane setup
and one of them must be set if replicas > 1. |
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/ |
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]#
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#
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#
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 > 200*1024*1024 |
true |
schedule | string |
Schedule defines the etcd defragmentation job schedule. Default: 0 12 * * * |
true |
K0smotronControlPlaneTemplate.spec.template.spec.etcd.persistence#
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]#
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#
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#
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#
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#
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#
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.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid? |
false |
K0smotronControlPlaneTemplate.spec.template.spec.manifests[index].cinder#
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#
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.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid? |
false |
K0smotronControlPlaneTemplate.spec.template.spec.manifests[index].configMap#
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.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid? |
false |
optional | boolean |
optional specify whether the ConfigMap or its keys must be defined |
false |
K0smotronControlPlaneTemplate.spec.template.spec.manifests[index].configMap.items[index]#
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#
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#
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.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid? |
false |
K0smotronControlPlaneTemplate.spec.template.spec.manifests[index].downwardAPI#
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]#
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 and namespace 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#
Required: Selects a field of the pod: only annotations, labels, name and namespace 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#
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#
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#
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 ` |
false |
K0smotronControlPlaneTemplate.spec.template.spec.manifests[index].ephemeral.volumeClaimTemplate#
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#
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 |
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#
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#
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#
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 |
---|---|---|---|
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.manifests[index].ephemeral.volumeClaimTemplate.spec.resources.claims[index]#
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.manifests[index].ephemeral.volumeClaimTemplate.spec.selector#
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]#
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#
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 | Description | 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#
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#
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#
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.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid? |
false |
K0smotronControlPlaneTemplate.spec.template.spec.manifests[index].flocker#
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#
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#
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#
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#
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#
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
|
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#
secretRef is the CHAP Secret for iSCSI target and initiator authentication
Name | Type | Description | Required |
---|---|---|---|
name | string |
Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid? |
false |
K0smotronControlPlaneTemplate.spec.template.spec.manifests[index].nfs#
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#
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#
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#
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#
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]#
Projection that may be projected along with other supported volume types
Name | Type | Description | Required |
---|---|---|---|
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].configMap#
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.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid? |
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]#
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#
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]#
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 and namespace 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#
Required: Selects a field of the pod: only annotations, labels, name and namespace 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#
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#
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.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid? |
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]#
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#
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#
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#
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#
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.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid? |
false |
K0smotronControlPlaneTemplate.spec.template.spec.manifests[index].scaleIO#
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#
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.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid? |
false |
K0smotronControlPlaneTemplate.spec.template.spec.manifests[index].secret#
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]#
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#
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#
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.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid? |
false |
K0smotronControlPlaneTemplate.spec.template.spec.manifests[index].vsphereVolume#
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#
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]#
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#
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#
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#
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#
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#
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.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid? |
false |
K0smotronControlPlaneTemplate.spec.template.spec.mounts[index].cinder#
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#
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.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid? |
false |
K0smotronControlPlaneTemplate.spec.template.spec.mounts[index].configMap#
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.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid? |
false |
optional | boolean |
optional specify whether the ConfigMap or its keys must be defined |
false |
K0smotronControlPlaneTemplate.spec.template.spec.mounts[index].configMap.items[index]#
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#
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#
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.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid? |
false |
K0smotronControlPlaneTemplate.spec.template.spec.mounts[index].downwardAPI#
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]#
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 and namespace 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#
Required: Selects a field of the pod: only annotations, labels, name and namespace 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#
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#
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#
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 ` |
false |
K0smotronControlPlaneTemplate.spec.template.spec.mounts[index].ephemeral.volumeClaimTemplate#
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#
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 |
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#
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#
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#
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 |
---|---|---|---|
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.mounts[index].ephemeral.volumeClaimTemplate.spec.resources.claims[index]#
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.mounts[index].ephemeral.volumeClaimTemplate.spec.selector#
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]#
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#
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 | Description | 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#
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#
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#
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.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid? |
false |
K0smotronControlPlaneTemplate.spec.template.spec.mounts[index].flocker#
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#
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#
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#
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#
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#
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
|
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#
secretRef is the CHAP Secret for iSCSI target and initiator authentication
Name | Type | Description | Required |
---|---|---|---|
name | string |
Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid? |
false |
K0smotronControlPlaneTemplate.spec.template.spec.mounts[index].nfs#
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#
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#
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#
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#
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]#
Projection that may be projected along with other supported volume types
Name | Type | Description | Required |
---|---|---|---|
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].configMap#
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.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid? |
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]#
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#
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]#
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 and namespace 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#
Required: Selects a field of the pod: only annotations, labels, name and namespace 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#
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#
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.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid? |
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]#
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#
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#
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#
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#
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.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid? |
false |
K0smotronControlPlaneTemplate.spec.template.spec.mounts[index].scaleIO#
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#
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.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid? |
false |
K0smotronControlPlaneTemplate.spec.template.spec.mounts[index].secret#
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]#
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#
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#
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.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid? |
false |
K0smotronControlPlaneTemplate.spec.template.spec.mounts[index].vsphereVolume#
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#
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#
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#
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 |
|
false |
finalizers | []string |
|
false |
labels | map[string]string |
|
false |
name | string |
|
false |
namespace | string |
|
false |
K0smotronControlPlaneTemplate.spec.template.spec.persistence.persistentVolumeClaim.spec#
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 |
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#
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#
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#
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 |
---|---|---|---|
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.persistence.persistentVolumeClaim.spec.resources.claims[index]#
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.persistence.persistentVolumeClaim.spec.selector#
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]#
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#
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 'ResizeStarted'. |
false |
phase | string |
phase represents the current phase of PersistentVolumeClaim. |
false |
K0smotronControlPlaneTemplate.spec.template.spec.persistence.persistentVolumeClaim.status.conditions[index]#
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 "ResizeStarted" that means the underlying
persistent volume is being resized. |
false |
K0smotronControlPlaneTemplate.spec.template.spec.resources#
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]#
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#
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 |
infrastructure.cluster.x-k8s.io/v1beta1#
Resource Types:
PooledRemoteMachine#
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#
Name | Type | Description | Required |
---|---|---|---|
machine | object |
|
true |
pool | string |
|
true |
PooledRemoteMachine.spec.machine#
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#
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#
Name | Type | Description | Required |
---|---|---|---|
machineRef | object |
|
true |
reserved | boolean |
|
true |
PooledRemoteMachine.status.machineRef#
Name | Type | Description | Required |
---|---|---|---|
name | string |
|
true |
namespace | string |
|
true |
RemoteCluster#
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#
RemoteClusterSpec defines the desired state of RemoteCluster
Name | Type | Description | Required |
---|---|---|---|
controlPlaneEndpoint | object |
APIEndpoint represents a reachable Kubernetes API endpoint. |
true |
RemoteCluster.spec.controlPlaneEndpoint#
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#
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#
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#
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#
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#
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#
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 | Description | 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#
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 alpha-level. It can be used when the `JobBackoffLimitPerIndex`
feature gate is enabled (disabled 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 |
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 alpha-level. It can be used when the `JobBackoffLimitPerIndex`
feature gate is enabled (disabled 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 alpha field. Enable JobPodReplacementPolicy to be able to use this field. |
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 |
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#
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#
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 |
|
false |
finalizers | []string |
|
false |
labels | map[string]string |
|
false |
name | string |
|
false |
namespace | string |
|
false |
RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec#
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. This is only valid for non-hostNetwork pods. |
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.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.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.
This is a beta feature enabled by the PodSchedulingReadiness feature gate. |
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 depreciated alias for ServiceAccountName.
Deprecated: Use serviceAccountName instead. |
false |
serviceAccountName | string |
ServiceAccountName is the name of the ServiceAccount to use to run this pod.
More info: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/ |
false |
setHostnameAsFQDN | boolean |
If true the pod's hostname will be configured as the pod's FQDN, rather than the leaf name (the default).
In Linux containers, this means setting the FQDN in the hostname field of the kernel (the nodename field of struct utsname).
In Windows containers, this means setting the registry value of hostname for the registry key HKEY_LOCAL_MACHINE\\SYSTEM\\CurrentControlSet\\Services\\Tcpip\\Parameters to FQDN.
If a pod does not have FQDN, this has no effect.
Default to false. |
false |
shareProcessNamespace | boolean |
Share a single process namespace between all of the containers in a pod.
When this is set containers will be able to view and signal processes from other containers
in the same pod, and the first process in each container will not be assigned PID 1.
HostPID and ShareProcessNamespace cannot both be set.
Optional: Default to false. |
false |
subdomain | string |
If specified, the fully qualified Pod hostname will be " |
false |
terminationGracePeriodSeconds | integer |
Optional duration in seconds the pod needs to terminate gracefully. May be decreased in delete request.
Value must be non-negative integer. The value zero indicates stop immediately via
the kill signal (no opportunity to shut down).
If this value is nil, the default grace period will be used instead.
The grace period is the duration in seconds after the processes running in the pod are sent
a termination signal and the time when the processes are forcibly halted with a kill signal.
Set this value longer than the expected cleanup time for your process.
Defaults to 30 seconds. Format: int64 |
false |
tolerations | []object |
If specified, the pod's tolerations. |
false |
topologySpreadConstraints | []object |
TopologySpreadConstraints describes how a group of pods ought to spread across topology
domains. Scheduler will schedule pods in a way which abides by the constraints.
All topologySpreadConstraints are ANDed. |
false |
volumes | []object |
List of volumes that can be mounted by containers belonging to the pod.
More info: https://kubernetes.io/docs/concepts/storage/volumes |
false |
RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.containers[index]#
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]#
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#
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[' |
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#
Selects a key of a ConfigMap.
Name | Type | Description | Required |
---|---|---|---|
key | string |
The key to select. |
true |
name | string |
Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid? |
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#
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#
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#
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.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid? |
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]#
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#
The ConfigMap to select from
Name | Type | Description | Required |
---|---|---|---|
name | string |
Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid? |
false |
optional | boolean |
Specify whether the ConfigMap must be defined |
false |
RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.containers[index].envFrom[index].secretRef#
The Secret to select from
Name | Type | Description | Required |
---|---|---|---|
name | string |
Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid? |
false |
optional | boolean |
Specify whether the Secret must be defined |
false |
RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.containers[index].lifecycle#
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#
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 |
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#
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#
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]#
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.tcpSocket#
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#
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 |
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#
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#
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]#
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.tcpSocket#
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#
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#
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#
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#
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]#
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#
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]#
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#
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#
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#
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#
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]#
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#
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]#
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#
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]#
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#
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 |
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.capabilities#
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#
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#
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#
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#
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#
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#
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#
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]#
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#
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]#
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]#
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. |
false |
readOnly | boolean |
Mounted read-only if true, read-write otherwise (false or unspecified).
Defaults to false. |
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#
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#
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]#
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#
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]#
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]#
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#
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]#
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]#
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]#
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#
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]#
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#
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. |
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#
A label query over a set of resources, in this case 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]#
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#
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]#
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]#
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
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. |
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#
A label query over a set of resources, in this case 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]#
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#
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]#
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#
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]#
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#
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. |
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#
A label query over a set of resources, in this case 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]#
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#
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]#
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]#
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
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. |
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#
A label query over a set of resources, in this case 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]#
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#
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]#
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#
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]#
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]#
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]#
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#
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[' |
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#
Selects a key of a ConfigMap.
Name | Type | Description | Required |
---|---|---|---|
key | string |
The key to select. |
true |
name | string |
Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid? |
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#
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#
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#
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.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid? |
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]#
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#
The ConfigMap to select from
Name | Type | Description | Required |
---|---|---|---|
name | string |
Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid? |
false |
optional | boolean |
Specify whether the ConfigMap must be defined |
false |
RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.ephemeralContainers[index].envFrom[index].secretRef#
The Secret to select from
Name | Type | Description | Required |
---|---|---|---|
name | string |
Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid? |
false |
optional | boolean |
Specify whether the Secret must be defined |
false |
RemoteMachine.spec.provisionJob.jobSpecTemplate.spec.template.spec.ephemeralContainers[index].lifecycle#
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#
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 |
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#
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#
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]#
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.tcpSocket#
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#
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 |
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#
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#
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]#
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.tcpSocket#
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#
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#
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#
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#
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]#
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#
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]#
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#
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#
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#
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#
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]#
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#
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]#
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#
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]#
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#
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 |
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.capabilities#
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#
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#
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#
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#
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 pr |