Skip to content

API Reference#

Packages:

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

Resource Types:

K0sControllerConfig#

↩ Parent

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

K0sControllerConfig.spec#

↩ Parent

Name Type Description Required
version string Version is the version of k0s to use. In case this is not set, 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/
true
args []string Args specifies extra arguments to be passed to k0s worker. See: https://docs.k0sproject.io/stable/advanced/worker-configuration/
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

K0sControllerConfig.spec.files[index]#

↩ Parent

Name Type Description Required
content string
false
path string
false
permissions string
false

K0sControllerConfig.spec.tunneling#

↩ Parent

Tunneling defines the tunneling configuration for the cluster.

Name Type Description Required
enabled boolean Enabled specifies whether tunneling is enabled.

Default: false
false
mode enum Mode describes tunneling mode. If empty, k0smotron will use the default one.

Enum: tunnel, proxy
Default: tunnel
false
serverAddress string Server address of the tunneling server. If empty, k0smotron will try to detect worker node address for.
false
serverNodePort integer NodePort to publish for server port of the tunneling server. If empty, k0smotron will use the default one.

Format: int32
Default: 31700
false
tunnelingNodePort integer NodePort to publish for tunneling port. If empty, k0smotron will use the default one.

Format: int32
Default: 31443
false

K0sControllerConfig.status#

↩ Parent

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

K0sWorkerConfig#

↩ Parent

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

K0sWorkerConfig.spec#

↩ Parent

Name Type Description Required
version string Version is the version of k0s to use. In case this is not set, 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/
true
args []string Args specifies extra arguments to be passed to k0s worker. See: https://docs.k0sproject.io/stable/advanced/worker-configuration/
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

K0sWorkerConfig.spec.files[index]#

↩ Parent

Name Type Description Required
content string
false
path string
false
permissions string
false

K0sWorkerConfig.spec.joinTokenSecretRef#

↩ Parent

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

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

K0sWorkerConfig.status#

↩ Parent

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

K0sWorkerConfigTemplate#

↩ Parent

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

K0sWorkerConfigTemplate.spec#

↩ Parent

Name Type Description Required
template object
false

K0sWorkerConfigTemplate.spec.template#

↩ Parent

Name Type Description Required
metadata object
false
spec object
false

K0sWorkerConfigTemplate.spec.template.metadata#

↩ Parent

Name Type 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#

↩ Parent

Name Type Description Required
version string Version is the version of k0s to use. In case this is not set, 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/
true
args []string Args specifies extra arguments to be passed to k0s worker. See: https://docs.k0sproject.io/stable/advanced/worker-configuration/
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

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

↩ Parent

Name Type Description Required
content string
false
path string
false
permissions string
false

K0sWorkerConfigTemplate.spec.template.spec.joinTokenSecretRef#

↩ Parent

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

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

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

Resource Types:

K0sControllerConfig#

↩ Parent

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

K0sControllerConfig.spec#

↩ Parent

Name Type Description Required
args []string Args specifies extra arguments to be passed to k0s worker. See: https://docs.k0sproject.io/stable/advanced/worker-configuration/
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
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

K0sControllerConfig.spec.files[index]#

↩ Parent

Name Type Description Required
content string
false
path string
false
permissions string
false

K0sControllerConfig.status#

↩ Parent

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

K0sControlPlane#

↩ Parent

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

K0sControlPlane.spec#

↩ Parent

Name Type Description Required
k0sConfigSpec object
true
k0sVersion string K0sVersion defines the k0s version to be deployed. If empty k0smotron will pick it automatically.
true
machineTemplate object
true
replicas integer

Format: int32
Default: 1
false

K0sControlPlane.spec.k0sConfigSpec#

↩ Parent

Name Type Description Required
args []string Args specifies extra arguments to be passed to k0s worker. See: https://docs.k0sproject.io/stable/advanced/worker-configuration/
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

K0sControlPlane.spec.k0sConfigSpec.files[index]#

↩ Parent

Name Type Description Required
content string
false
path string
false
permissions string
false

K0sControlPlane.spec.k0sConfigSpec.tunneling#

↩ Parent

Tunneling defines the tunneling configuration for the cluster.

Name Type Description Required
enabled boolean Enabled specifies whether tunneling is enabled.

Default: false
false
mode enum Mode describes tunneling mode. If empty, k0smotron will use the default one.

Enum: tunnel, proxy
Default: tunnel
false
serverAddress string Server address of the tunneling server. If empty, k0smotron will try to detect worker node address for.
false
serverNodePort integer NodePort to publish for server port of the tunneling server. If empty, k0smotron will use the default one.

Format: int32
Default: 31700
false
tunnelingNodePort integer NodePort to publish for tunneling port. If empty, k0smotron will use the default one.

Format: int32
Default: 31443
false

K0sControlPlane.spec.machineTemplate#

↩ Parent

Name Type Description Required
infrastructureRef object InfrastructureRef is a required reference to a custom resource offered by an infrastructure provider.
true
metadata object Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
false

K0sControlPlane.spec.machineTemplate.infrastructureRef#

↩ Parent

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

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

K0sControlPlane.spec.machineTemplate.metadata#

↩ Parent

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

Name Type Description Required
annotations map[string]string Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations
false
labels map[string]string Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels
false

K0sControlPlane.status#

↩ Parent

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

Format: int32
true

K0smotronControlPlane#

↩ Parent

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

K0smotronControlPlane.spec#

↩ Parent

ClusterSpec defines the desired state of K0smotronCluster

Name Type Description Required
certificateRefs []object CertificateRefs defines the certificate references.
false
controllerPlaneFlags []string ControlPlaneFlags allows to configure additional flags for k0s control plane and to override existing ones. The default flags are kept unless they are overriden explicitly. Flags with arguments must be specified as a single string, e.g. --some-flag=argument
false
enableMonitoring boolean EnableMonitoring enables prometheus sidecar that scrapes metrics from the child cluster system components and expose them as usual kubernetes pod metrics.
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
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
k0sImage string K0sImage defines the k0s image to be deployed. If empty k0smotron will pick it automatically. Must not include the image tag.

Default: k0sproject/k0s
false
k0sVersion string K0sVersion defines the k0s version to be deployed. If empty k0smotron will pick it automatically.
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/, for this reason each manifest is a stack. K0smotron allows any kind of volume, but the recommendation is to use secrets and configmaps. For more information check: https://docs.k0sproject.io/stable/manifests/ and https://kubernetes.io/docs/concepts/storage/volumes
false
persistence object Persistence defines the persistence configuration. If empty k0smotron will use emptyDir as a volume.
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

K0smotronControlPlane.spec.certificateRefs[index]#

↩ Parent

Name Type Description Required
type enum

Enum: ca, sa, proxy
true
name string
false

K0smotronControlPlane.spec.manifests[index]#

↩ Parent

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

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

K0smotronControlPlane.spec.manifests[index].awsElasticBlockStore#

↩ Parent

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

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

Format: int32
false
readOnly boolean readOnly value true will force the readOnly setting in VolumeMounts. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
false

K0smotronControlPlane.spec.manifests[index].azureDisk#

↩ Parent

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

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

K0smotronControlPlane.spec.manifests[index].azureFile#

↩ Parent

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

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

K0smotronControlPlane.spec.manifests[index].cephfs#

↩ Parent

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

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

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

↩ Parent

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

Name Type Description Required
name string Name of the referent. 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#

↩ Parent

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

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

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

↩ Parent

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

Name Type Description Required
name string Name of the referent. 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#

↩ Parent

configMap represents a configMap that should populate this volume

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

Format: int32
false
items []object items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
false
name string Name of the referent. 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]#

↩ Parent

Maps a string key to a path within a volume.

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

Format: int32
false

K0smotronControlPlane.spec.manifests[index].csi#

↩ Parent

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

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

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

↩ Parent

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

Name Type Description Required
name string Name of the referent. 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#

↩ Parent

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

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

Format: int32
false
items []object Items is a list of downward API volume file
false

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

↩ Parent

DownwardAPIVolumeFile represents information to create the file containing the pod field

Name Type Description Required
path string Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'
true
fieldRef object Required: Selects a field of the pod: only annotations, labels, name 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#

↩ Parent

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#

↩ Parent

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

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

K0smotronControlPlane.spec.manifests[index].emptyDir#

↩ Parent

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

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

K0smotronControlPlane.spec.manifests[index].ephemeral#

↩ Parent

ephemeral represents a volume that is handled by a cluster storage driver. The volume's lifecycle is tied to the pod that defines it - it will be created before the pod starts, and deleted when the pod is removed. Use this if: a) the volume is only needed while the pod runs, b) features of normal volumes like restoring from snapshot or capacity tracking are needed, c) the storage driver is specified through a storage class, and d) the storage driver supports dynamic volume provisioning through a PersistentVolumeClaim (see EphemeralVolumeSource for more information on the connection between this volume type and PersistentVolumeClaim). Use PersistentVolumeClaim or one of the vendor-specific APIs for volumes that persist for longer than the lifecycle of an individual pod. Use CSI for light-weight local ephemeral volumes if the CSI driver is meant to be used that way - see the documentation of the driver for more information. A pod can use both types of ephemeral volumes and persistent volumes at the same time.

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

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

↩ Parent

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

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

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

↩ Parent

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

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

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

↩ Parent

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

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

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

↩ Parent

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

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

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

↩ Parent

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

Name Type Description Required
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]#

↩ Parent

ResourceClaim references one entry in PodSpec.ResourceClaims.

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

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

↩ Parent

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

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

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

↩ Parent

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

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

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

↩ Parent

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

Name Type 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#

↩ Parent

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

Name Type Description Required
fsType string fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. TODO: how do we prevent errors in the filesystem from compromising the machine
false
lun integer lun is Optional: FC target lun number

Format: int32
false
readOnly boolean readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
false
targetWWNs []string targetWWNs is Optional: FC target worldwide names (WWNs)
false
wwids []string wwids Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously.
false

K0smotronControlPlane.spec.manifests[index].flexVolume#

↩ Parent

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

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

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

↩ Parent

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

Name Type Description Required
name string Name of the referent. 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#

↩ Parent

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

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

K0smotronControlPlane.spec.manifests[index].gcePersistentDisk#

↩ Parent

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

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

Format: int32
false
readOnly boolean readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
false

K0smotronControlPlane.spec.manifests[index].gitRepo#

↩ Parent

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

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

K0smotronControlPlane.spec.manifests[index].glusterfs#

↩ Parent

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

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

K0smotronControlPlane.spec.manifests[index].hostPath#

↩ Parent

hostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath --- TODO(jonesdl) We need to restrict who can use host directory mounts and who can/can not mount host directories as read/write.

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

K0smotronControlPlane.spec.manifests[index].iscsi#

↩ Parent

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

Name Type Description Required
iqn string iqn is the target iSCSI Qualified Name.
true
lun integer lun represents iSCSI Target Lun number.

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

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

↩ Parent

secretRef is the CHAP Secret for iSCSI target and initiator authentication

Name Type Description Required
name string Name of the referent. 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#

↩ Parent

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

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

K0smotronControlPlane.spec.manifests[index].persistentVolumeClaim#

↩ Parent

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

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

K0smotronControlPlane.spec.manifests[index].photonPersistentDisk#

↩ Parent

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

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

K0smotronControlPlane.spec.manifests[index].portworxVolume#

↩ Parent

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

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

K0smotronControlPlane.spec.manifests[index].projected#

↩ Parent

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

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

Format: int32
false
sources []object sources is the list of volume projections
false

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

↩ Parent

Projection that may be projected along with other supported volume types

Name Type Description Required
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#

↩ Parent

configMap information about the configMap data to project

Name Type Description Required
items []object items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
false
name string Name of the referent. 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]#

↩ Parent

Maps a string key to a path within a volume.

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

Format: int32
false

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

↩ Parent

downwardAPI information about the downwardAPI data to project

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

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

↩ Parent

DownwardAPIVolumeFile represents information to create the file containing the pod field

Name Type Description Required
path string Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'
true
fieldRef object Required: Selects a field of the pod: only annotations, labels, name 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#

↩ Parent

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#

↩ Parent

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

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

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

↩ Parent

secret information about the secret data to project

Name Type Description Required
items []object items if unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
false
name string Name of the referent. 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]#

↩ Parent

Maps a string key to a path within a volume.

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

Format: int32
false

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

↩ Parent

serviceAccountToken is information about the serviceAccountToken data to project

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

Format: int64
false

K0smotronControlPlane.spec.manifests[index].quobyte#

↩ Parent

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

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

K0smotronControlPlane.spec.manifests[index].rbd#

↩ Parent

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

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

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

↩ Parent

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

Name Type Description Required
name string Name of the referent. 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#

↩ Parent

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

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

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

↩ Parent

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

Name Type Description Required
name string Name of the referent. 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#

↩ Parent

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

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

Format: int32
false
items []object items If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
false
optional boolean optional field specify whether the Secret or its keys must be defined
false
secretName string secretName is the name of the secret in the pod's namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret
false

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

↩ Parent

Maps a string key to a path within a volume.

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

Format: int32
false

K0smotronControlPlane.spec.manifests[index].storageos#

↩ Parent

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

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

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

↩ Parent

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

Name Type Description Required
name string Name of the referent. 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#

↩ Parent

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

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

K0smotronControlPlane.spec.persistence#

↩ Parent

Persistence defines the persistence configuration. If empty k0smotron will use emptyDir as a volume.

Name Type Description Required
type string

Default: emptyDir
true
hostPath string HostPath defines the host path configuration. Will be used as is in case of .spec.persistence.type is hostPath.
false
persistentVolumeClaim object PersistentVolumeClaim defines the PVC configuration. Will be used as is in case of .spec.persistence.type is pvc.
false

K0smotronControlPlane.spec.persistence.persistentVolumeClaim#

↩ Parent

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

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

K0smotronControlPlane.spec.persistence.persistentVolumeClaim.metadata#

↩ Parent

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

Name Type 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#

↩ Parent

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

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

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

↩ Parent

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

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

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

↩ Parent

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

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

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

↩ Parent

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

Name Type Description Required
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]#

↩ Parent

ResourceClaim references one entry in PodSpec.ResourceClaims.

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

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

↩ Parent

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

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

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

↩ Parent

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

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

K0smotronControlPlane.spec.persistence.persistentVolumeClaim.status#

↩ Parent

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

Name Type Description Required
accessModes []string accessModes contains the actual access modes the volume backing the PVC has. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1
false
allocatedResources map[string]int or string allocatedResources is the storage resource within AllocatedResources tracks the capacity allocated to a PVC. It 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. 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
resizeStatus string resizeStatus stores status of resize operation. ResizeStatus is not set by default but when expansion is complete resizeStatus is set to empty string by resize controller or kubelet. This is an alpha field and requires enabling RecoverVolumeExpansionFailure feature.
false

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

↩ Parent

PersistentVolumeClaimCondition contains details about state of pvc

Name Type Description Required
status string
true
type string PersistentVolumeClaimConditionType is a valid value of PersistentVolumeClaimCondition.Type
true
lastProbeTime string lastProbeTime is the time we probed the condition.

Format: date-time
false
lastTransitionTime string lastTransitionTime is the time the condition transitioned from one status to another.

Format: date-time
false
message string message is the human-readable message indicating details about last transition.
false
reason string reason is a unique, this should be a short, machine understandable string that gives the reason for condition's last transition. If it reports "ResizeStarted" that means the underlying persistent volume is being resized.
false

K0smotronControlPlane.spec.resources#

↩ Parent

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

Name Type Description Required
claims []object Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. This field is immutable. It can only be set for containers.
false
limits map[string]int or string Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
false
requests map[string]int or string Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
false

K0smotronControlPlane.spec.resources.claims[index]#

↩ Parent

ResourceClaim references one entry in PodSpec.ResourceClaims.

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

K0smotronControlPlane.spec.service#

↩ Parent

Service defines the service configuration.

Name Type Description Required
type enum Service Type string describes ingress methods for a service

Enum: ClusterIP, NodePort, LoadBalancer
Default: ClusterIP
true
annotations map[string]string Annotations defines extra annotations to be added to the service.
false
apiPort integer APIPort defines the kubernetes API port. If empty k0smotron will pick it automatically.

Default: 30443
false
konnectivityPort integer KonnectivityPort defines the konnectivity port. If empty k0smotron will pick it automatically.

Default: 30132
false

K0smotronControlPlane.status#

↩ Parent

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

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

Resource Types:

PooledRemoteMachine#

↩ Parent

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

PooledRemoteMachine.spec#

↩ Parent

Name Type Description Required
machine object
true
pool string
true

PooledRemoteMachine.spec.machine#

↩ Parent

Name Type Description Required
address string Address is the IP address or DNS name of the remote machine.
true
sshKeyRef object SSHKeyRef is a reference to a secret that contains the SSH private key. The key must be placed on the secret using the key "value".
true
port integer Port is the SSH port of the remote machine.

Default: 22
false
user string User is the user to use when connecting to the remote machine.

Default: root
false

PooledRemoteMachine.spec.machine.sshKeyRef#

↩ Parent

SSHKeyRef is a reference to a secret that contains the SSH private key. The key must be placed on the secret using the key "value".

Name Type Description Required
name string Name is the name of the secret.
true

PooledRemoteMachine.status#

↩ Parent

Name Type Description Required
machineRef object
true
reserved boolean
true

PooledRemoteMachine.status.machineRef#

↩ Parent

Name Type Description Required
name string
true
namespace string
true

RemoteCluster#

↩ Parent

Name Type Description Required
apiVersion string infrastructure.cluster.x-k8s.io/v1beta1 true
kind string RemoteCluster true
metadata object Refer to the Kubernetes API documentation for the fields of the `metadata` field. true
spec object RemoteClusterSpec defines the desired state of RemoteCluster
false
status object RemoteClusterStatus defines the observed state of RemoteCluster
false

RemoteCluster.spec#

↩ Parent

RemoteClusterSpec defines the desired state of RemoteCluster

Name Type Description Required
controlPlaneEndpoint object APIEndpoint represents a reachable Kubernetes API endpoint.
true

RemoteCluster.spec.controlPlaneEndpoint#

↩ Parent

APIEndpoint represents a reachable Kubernetes API endpoint.

Name Type Description Required
host string The hostname on which the API server is serving.
true
port integer The port on which the API server is serving.

Format: int32
true

RemoteCluster.status#

↩ Parent

RemoteClusterStatus defines the observed state of RemoteCluster

Name Type Description Required
ready boolean Ready denotes that the remote cluster is ready to be used.

Default: false
true

RemoteMachine#

↩ Parent

Name Type Description Required
apiVersion string infrastructure.cluster.x-k8s.io/v1beta1 true
kind string RemoteMachine true
metadata object Refer to the Kubernetes API documentation for the fields of the `metadata` field. true
spec object RemoteMachineSpec defines the desired state of RemoteMachine
false
status object RemoteMachineStatus defines the observed state of RemoteMachine
false

RemoteMachine.spec#

↩ Parent

RemoteMachineSpec defines the desired state of RemoteMachine

Name Type Description Required
address string Address is the IP address or DNS name of the remote machine.
false
pool string Pool is the name of the pool where the machine belongs to.
false
port integer Port is the SSH port of the remote machine.

Default: 22
false
providerID string ProviderID is the ID of the machine in the provider.
false
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
user string User is the user to use when connecting to the remote machine.

Default: root
false

RemoteMachine.spec.sshKeyRef#

↩ Parent

SSHKeyRef is a reference to a secret that contains the SSH private key. The key must be placed on the secret using the key "value".

Name Type Description Required
name string Name is the name of the secret.
true

RemoteMachine.status#

↩ Parent

RemoteMachineStatus defines the observed state of RemoteMachine

Name Type Description Required
failureMessage string
false
failureReason string
false
ready boolean Ready denotes that the remote machine is ready to be used.
false

RemoteMachineTemplate#

↩ Parent

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

RemoteMachineTemplate.spec#

↩ Parent

Name Type Description Required
template object
true

RemoteMachineTemplate.spec.template#

↩ Parent

Name Type Description Required
metadata object
false
spec object
false

RemoteMachineTemplate.spec.template.metadata#

↩ Parent

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

RemoteMachineTemplate.spec.template.spec#

↩ Parent

Name Type Description Required
pool string
true

k0smotron.io/v1beta1#

Resource Types:

Cluster#

↩ Parent

Cluster is the Schema for the k0smotronclusters API

Name Type Description Required
apiVersion string k0smotron.io/v1beta1 true
kind string Cluster true
metadata object Refer to the Kubernetes API documentation for the fields of the `metadata` field. true
spec object ClusterSpec defines the desired state of K0smotronCluster

Default: map[service:map[type:NodePort]]
false
status object ClusterStatus defines the observed state of K0smotronCluster
false

Cluster.spec#

↩ Parent

ClusterSpec defines the desired state of K0smotronCluster

Name Type Description Required
certificateRefs []object CertificateRefs defines the certificate references.
false
controllerPlaneFlags []string ControlPlaneFlags allows to configure additional flags for k0s control plane and to override existing ones. The default flags are kept unless they are overriden explicitly. Flags with arguments must be specified as a single string, e.g. --some-flag=argument
false
enableMonitoring boolean EnableMonitoring enables prometheus sidecar that scrapes metrics from the child cluster system components and expose them as usual kubernetes pod metrics.
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
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
k0sImage string K0sImage defines the k0s image to be deployed. If empty k0smotron will pick it automatically. Must not include the image tag.

Default: k0sproject/k0s
false
k0sVersion string K0sVersion defines the k0s version to be deployed. If empty k0smotron will pick it automatically.
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/, for this reason each manifest is a stack. K0smotron allows any kind of volume, but the recommendation is to use secrets and configmaps. For more information check: https://docs.k0sproject.io/stable/manifests/ and https://kubernetes.io/docs/concepts/storage/volumes
false
persistence object Persistence defines the persistence configuration. If empty k0smotron will use emptyDir as a volume.
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

Cluster.spec.certificateRefs[index]#

↩ Parent

Name Type Description Required
type enum

Enum: ca, sa, proxy
true
name string
false

Cluster.spec.manifests[index]#

↩ Parent

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

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

Cluster.spec.manifests[index].awsElasticBlockStore#

↩ Parent

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

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

Format: int32
false
readOnly boolean readOnly value true will force the readOnly setting in VolumeMounts. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
false

Cluster.spec.manifests[index].azureDisk#

↩ Parent

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

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

Cluster.spec.manifests[index].azureFile#

↩ Parent

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

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

Cluster.spec.manifests[index].cephfs#

↩ Parent

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

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

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

↩ Parent

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

Name Type Description Required
name string Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
false

Cluster.spec.manifests[index].cinder#

↩ Parent

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

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

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

↩ Parent

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

Name Type Description Required
name string Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
false

Cluster.spec.manifests[index].configMap#

↩ Parent

configMap represents a configMap that should populate this volume

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

Format: int32
false
items []object items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
false
name string Name of the referent. 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

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

↩ Parent

Maps a string key to a path within a volume.

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

Format: int32
false

Cluster.spec.manifests[index].csi#

↩ Parent

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

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

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

↩ Parent

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

Name Type Description Required
name string Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
false

Cluster.spec.manifests[index].downwardAPI#

↩ Parent

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

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

Format: int32
false
items []object Items is a list of downward API volume file
false

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

↩ Parent

DownwardAPIVolumeFile represents information to create the file containing the pod field

Name Type Description Required
path string Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'
true
fieldRef object Required: Selects a field of the pod: only annotations, labels, name 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

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

↩ Parent

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

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

↩ Parent

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

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

Cluster.spec.manifests[index].emptyDir#

↩ Parent

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

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

Cluster.spec.manifests[index].ephemeral#

↩ Parent

ephemeral represents a volume that is handled by a cluster storage driver. The volume's lifecycle is tied to the pod that defines it - it will be created before the pod starts, and deleted when the pod is removed. Use this if: a) the volume is only needed while the pod runs, b) features of normal volumes like restoring from snapshot or capacity tracking are needed, c) the storage driver is specified through a storage class, and d) the storage driver supports dynamic volume provisioning through a PersistentVolumeClaim (see EphemeralVolumeSource for more information on the connection between this volume type and PersistentVolumeClaim). Use PersistentVolumeClaim or one of the vendor-specific APIs for volumes that persist for longer than the lifecycle of an individual pod. Use CSI for light-weight local ephemeral volumes if the CSI driver is meant to be used that way - see the documentation of the driver for more information. A pod can use both types of ephemeral volumes and persistent volumes at the same time.

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

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

↩ Parent

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

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

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

↩ Parent

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

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

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

↩ Parent

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

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

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

↩ Parent

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

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

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

↩ Parent

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

Name Type Description Required
claims []object Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. This field is immutable. It can only be set for containers.
false
limits map[string]int or string Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
false
requests map[string]int or string Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
false

Cluster.spec.manifests[index].ephemeral.volumeClaimTemplate.spec.resources.claims[index]#

↩ Parent

ResourceClaim references one entry in PodSpec.ResourceClaims.

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

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

↩ Parent

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

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

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

↩ Parent

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

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

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

↩ Parent

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

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

Cluster.spec.manifests[index].fc#

↩ Parent

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

Name Type Description Required
fsType string fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. TODO: how do we prevent errors in the filesystem from compromising the machine
false
lun integer lun is Optional: FC target lun number

Format: int32
false
readOnly boolean readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
false
targetWWNs []string targetWWNs is Optional: FC target worldwide names (WWNs)
false
wwids []string wwids Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously.
false

Cluster.spec.manifests[index].flexVolume#

↩ Parent

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

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

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

↩ Parent

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

Name Type Description Required
name string Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
false

Cluster.spec.manifests[index].flocker#

↩ Parent

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

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

Cluster.spec.manifests[index].gcePersistentDisk#

↩ Parent

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

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

Format: int32
false
readOnly boolean readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
false

Cluster.spec.manifests[index].gitRepo#

↩ Parent

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

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

Cluster.spec.manifests[index].glusterfs#

↩ Parent

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

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

Cluster.spec.manifests[index].hostPath#

↩ Parent

hostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath --- TODO(jonesdl) We need to restrict who can use host directory mounts and who can/can not mount host directories as read/write.

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

Cluster.spec.manifests[index].iscsi#

↩ Parent

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

Name Type Description Required
iqn string iqn is the target iSCSI Qualified Name.
true
lun integer lun represents iSCSI Target Lun number.

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

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

↩ Parent

secretRef is the CHAP Secret for iSCSI target and initiator authentication

Name Type Description Required
name string Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
false

Cluster.spec.manifests[index].nfs#

↩ Parent

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

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

Cluster.spec.manifests[index].persistentVolumeClaim#

↩ Parent

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

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

Cluster.spec.manifests[index].photonPersistentDisk#

↩ Parent

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

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

Cluster.spec.manifests[index].portworxVolume#

↩ Parent

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

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

Cluster.spec.manifests[index].projected#

↩ Parent

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

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

Format: int32
false
sources []object sources is the list of volume projections
false

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

↩ Parent

Projection that may be projected along with other supported volume types

Name Type Description Required
configMap object configMap information about the configMap data to project
false
downwardAPI object downwardAPI information about the downwardAPI data to project
false
secret object secret information about the secret data to project
false
serviceAccountToken object serviceAccountToken is information about the serviceAccountToken data to project
false

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

↩ Parent

configMap information about the configMap data to project

Name Type Description Required
items []object items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
false
name string Name of the referent. 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

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

↩ Parent

Maps a string key to a path within a volume.

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

Format: int32
false

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

↩ Parent

downwardAPI information about the downwardAPI data to project

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

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

↩ Parent

DownwardAPIVolumeFile represents information to create the file containing the pod field

Name Type Description Required
path string Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'
true
fieldRef object Required: Selects a field of the pod: only annotations, labels, name 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

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

↩ Parent

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

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

↩ Parent

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

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

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

↩ Parent

secret information about the secret data to project

Name Type Description Required
items []object items if unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
false
name string Name of the referent. 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

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

↩ Parent

Maps a string key to a path within a volume.

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

Format: int32
false

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

↩ Parent

serviceAccountToken is information about the serviceAccountToken data to project

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

Format: int64
false

Cluster.spec.manifests[index].quobyte#

↩ Parent

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

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

Cluster.spec.manifests[index].rbd#

↩ Parent

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

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

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

↩ Parent

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

Name Type Description Required
name string Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
false

Cluster.spec.manifests[index].scaleIO#

↩ Parent

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

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

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

↩ Parent

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

Name Type Description Required
name string Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
false

Cluster.spec.manifests[index].secret#

↩ Parent

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

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

Format: int32
false
items []object items If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
false
optional boolean optional field specify whether the Secret or its keys must be defined
false
secretName string secretName is the name of the secret in the pod's namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret
false

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

↩ Parent

Maps a string key to a path within a volume.

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

Format: int32
false

Cluster.spec.manifests[index].storageos#

↩ Parent

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

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

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

↩ Parent

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

Name Type Description Required
name string Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
false

Cluster.spec.manifests[index].vsphereVolume#

↩ Parent

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

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

Cluster.spec.persistence#

↩ Parent

Persistence defines the persistence configuration. If empty k0smotron will use emptyDir as a volume.

Name Type Description Required
type string

Default: emptyDir
true
hostPath string HostPath defines the host path configuration. Will be used as is in case of .spec.persistence.type is hostPath.
false
persistentVolumeClaim object PersistentVolumeClaim defines the PVC configuration. Will be used as is in case of .spec.persistence.type is pvc.
false

Cluster.spec.persistence.persistentVolumeClaim#

↩ Parent

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

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

Cluster.spec.persistence.persistentVolumeClaim.metadata#

↩ Parent

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

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

Cluster.spec.persistence.persistentVolumeClaim.spec#

↩ Parent

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

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

Cluster.spec.persistence.persistentVolumeClaim.spec.dataSource#

↩ Parent

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

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

Cluster.spec.persistence.persistentVolumeClaim.spec.dataSourceRef#

↩ Parent

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

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

Cluster.spec.persistence.persistentVolumeClaim.spec.resources#

↩ Parent

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

Name Type Description Required
claims []object Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. This field is immutable. It can only be set for containers.
false
limits map[string]int or string Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
false
requests map[string]int or string Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
false

Cluster.spec.persistence.persistentVolumeClaim.spec.resources.claims[index]#

↩ Parent

ResourceClaim references one entry in PodSpec.ResourceClaims.

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

Cluster.spec.persistence.persistentVolumeClaim.spec.selector#

↩ Parent

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

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

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

↩ Parent

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

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

Cluster.spec.persistence.persistentVolumeClaim.status#

↩ Parent

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

Name Type Description Required
accessModes []string accessModes contains the actual access modes the volume backing the PVC has. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1
false
allocatedResources map[string]int or string allocatedResources is the storage resource within AllocatedResources tracks the capacity allocated to a PVC. It 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. 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
resizeStatus string resizeStatus stores status of resize operation. ResizeStatus is not set by default but when expansion is complete resizeStatus is set to empty string by resize controller or kubelet. This is an alpha field and requires enabling RecoverVolumeExpansionFailure feature.
false

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

↩ Parent

PersistentVolumeClaimCondition contains details about state of pvc

Name Type Description Required
status string
true
type string PersistentVolumeClaimConditionType is a valid value of PersistentVolumeClaimCondition.Type
true
lastProbeTime string lastProbeTime is the time we probed the condition.

Format: date-time
false
lastTransitionTime string lastTransitionTime is the time the condition transitioned from one status to another.

Format: date-time
false
message string message is the human-readable message indicating details about last transition.
false
reason string reason is a unique, this should be a short, machine understandable string that gives the reason for condition's last transition. If it reports "ResizeStarted" that means the underlying persistent volume is being resized.
false

Cluster.spec.resources#

↩ Parent

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

Name Type Description Required
claims []object Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. This field is immutable. It can only be set for containers.
false
limits map[string]int or string Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
false
requests map[string]int or string Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
false

Cluster.spec.resources.claims[index]#

↩ Parent

ResourceClaim references one entry in PodSpec.ResourceClaims.

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

Cluster.spec.service#

↩ Parent

Service defines the service configuration.

Name Type Description Required
type enum Service Type string describes ingress methods for a service

Enum: ClusterIP, NodePort, LoadBalancer
Default: ClusterIP
true
annotations map[string]string Annotations defines extra annotations to be added to the service.
false
apiPort integer APIPort defines the kubernetes API port. If empty k0smotron will pick it automatically.

Default: 30443
false
konnectivityPort integer KonnectivityPort defines the konnectivity port. If empty k0smotron will pick it automatically.

Default: 30132
false

Cluster.status#

↩ Parent

ClusterStatus defines the observed state of K0smotronCluster

Name Type Description Required
reconciliationStatus string
true
ready boolean
false

JoinTokenRequest#

↩ Parent

JoinTokenRequest is the Schema for the join token request API

Name Type Description Required
apiVersion string k0smotron.io/v1beta1 true
kind string JoinTokenRequest true
metadata object Refer to the Kubernetes API documentation for the fields of the `metadata` field. true
spec object JoinTokenRequestSpec defines the desired state of K0smotronJoinTokenRequest
false
status object JoinTokenRequestStatus defines the observed state of K0smotronJoinTokenRequest
false

JoinTokenRequest.spec#

↩ Parent

JoinTokenRequestSpec defines the desired state of K0smotronJoinTokenRequest

Name Type Description Required
clusterRef object ClusterRef is the reference to the cluster for which the join token is requested.
true
expiry string Expiration time of the token. Format 1.5h, 2h45m or 300ms.

Default: 0s
false
role enum Role of the node for which the token is requested (worker or controller).

Enum: worker, controller
Default: worker
false

JoinTokenRequest.spec.clusterRef#

↩ Parent

ClusterRef is the reference to the cluster for which the join token is requested.

Name Type Description Required
name string Name of the cluster.
true
namespace string Namespace of the cluster.
true

JoinTokenRequest.status#

↩ Parent

JoinTokenRequestStatus defines the observed state of K0smotronJoinTokenRequest

Name Type Description Required
reconciliationStatus string
true
tokenID string
false