API Reference

Packages:

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

bootstrap.cluster.x-k8s.io/v1beta1

Resource Types:

• K0sControllerConfig

• K0sWorkerConfig

• K0sWorkerConfigTemplate

K0sControllerConfig

^{↩ Parent}

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

K0sControllerConfig.spec

^{↩ Parent}

Name	Type	Description	Required
args	[]string	Args specifies extra arguments to be passed to k0s controller. See: https://docs.k0sproject.io/stable/cli/k0s_controller/	false
customUserDataRef	object	CustomUserDataRef is a reference to a secret or a configmap that contains the custom user data. Provided user-data will be merged with the one generated by k0smotron. Note that you may want to specify the merge type. See: https://cloudinit.readthedocs.io/en/latest/reference/merging.html	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. Supported protocols are: http, https, oci. Using 'oci' scheme requires 'oras' to be installed on the target system. If 'oci' schema is used and the OCI registry requires authentication, make sure to set up the authentication beforehand by adding a file to the Files section that contains the necessary config for ORAS. See: https://oras.land/docs/how_to_guides/authentication/ The file must be placed at `/root` directory (HOME for cloud-init execution time) and named `config.json`. NOTE: use `.preStartCommands` to set DOCKER_CONFIG environment variable in order to let ORAS pick up your custom config file.	false
files	[]object	Files specifies extra files to be passed to user_data upon creation.	false
ignition	object	Ignition defines the ignition configuration. If empty, k0smotron will use cloud-init.	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
k0sInstallDir	string	K0sInstallDir specifies the directory where k0s binary will be installed. If empty, k0smotron will use /usr/local/bin, which is the default install path used by k0s get script. Default: /usr/local/bin	false
postStartCommands	[]string	PostStartCommands specifies commands to be run after starting k0s worker.	false
preInstalledK0s	boolean	PreInstallK0s specifies whether k0s binary is pre-installed on the node.	false
preStartCommands	[]string	PreStartCommands specifies commands to be run before starting k0s worker.	false
tunneling	object	Tunneling defines the tunneling configuration for the cluster.	false
useSystemHostname	boolean	UseSystemHostname specifies whether to use the system hostname for the kubernetes node name. By default, k0smotron will use Machine name as a node name. If true, it will pick it from `hostname` command output. Default: false	false
version	string	Version is the version of k0s to use. In case this is not set, k0smotron will use a version field of the Machine object. If it's empty, the latest version is used. Make sure the version is compatible with the k0s version running on the control plane. For reference see the Kubernetes version skew policy: https://kubernetes.io/docs/setup/release/version-skew-policy/	false
workingDir	string	WorkingDir specifies the working directory where k0smotron will place its files.	false

K0sControllerConfig.spec.customUserDataRef

^{↩ Parent}

CustomUserDataRef is a reference to a secret or a configmap that contains the custom user data. Provided user-data will be merged with the one generated by k0smotron. Note that you may want to specify the merge type. See: https://cloudinit.readthedocs.io/en/latest/reference/merging.html

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

K0sControllerConfig.spec.customUserDataRef.configMapRef

^{↩ Parent}

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

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

K0sControllerConfig.spec.customUserDataRef.secretRef

^{↩ Parent}

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

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

K0sControllerConfig.spec.files[index]

^{↩ Parent}

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

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

K0sControllerConfig.spec.files[index].contentFrom

^{↩ Parent}

ContentFrom specifies the source of the content.

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

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

^{↩ Parent}

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

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

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

^{↩ Parent}

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

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

K0sControllerConfig.spec.ignition

^{↩ Parent}

Ignition defines the ignition configuration. If empty, k0smotron will use cloud-init.

Name	Type	Description	Required
variant	enum	Variant declares which distribution variant the generated config is for. Check the supported variants and versions here: https://coreos.github.io/butane/specs/#butane-specifications-and-ignition-specifications Enum: fcos, flatcar, openshift, r4e, fiot	true
version	string	Version is the schema version of the Butane config to use Check the supported variants and versions here: https://coreos.github.io/butane/specs/#butane-specifications-and-ignition-specifications	true
additionalConfig	string	AdditionalConfig is an unstructured object that contains additional config to be merged with the generated one. The format follows Butane spec: https://coreos.github.io/butane/	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
conditions	[]object	Conditions defines current service state of the K0sControllerConfig.	false
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

K0sControllerConfig.status.conditions[index]

^{↩ Parent}

Condition contains details for one aspect of the current state of this API Resource.

Name	Type	Description	Required
lastTransitionTime	string	lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable. Format: date-time	true
message	string	message is a human readable message indicating details about the transition. This may be an empty string.	true
reason	string	reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.	true
status	enum	status of the condition, one of True, False, Unknown. Enum: True, False, Unknown	true
type	string	type of condition in CamelCase or in foo.example.com/CamelCase.	true
observedGeneration	integer	observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance. Format: int64 Minimum: 0	false

K0sWorkerConfig

^{↩ Parent}

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

K0sWorkerConfig.spec

^{↩ Parent}

Name	Type	Description	Required
args	[]string	Args specifies extra arguments to be passed to k0s worker. See: https://docs.k0sproject.io/stable/worker-node-config/ See: https://docs.k0sproject.io/stable/cli/k0s_worker/	false
customUserDataRef	object	CustomUserDataRef is a reference to a secret or a configmap that contains the custom user data. Provided user-data will be merged with the one generated by k0smotron. Note that you may want to specify the merge type. See: https://cloudinit.readthedocs.io/en/latest/reference/merging.html	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
ignition	object	Ignition defines the ignition configuration. If empty, k0smotron will use cloud-init.	false
k0sInstallDir	string	K0sInstallDir specifies the directory where k0s binary will be installed. If empty, k0smotron will use /usr/local/bin, which is the default install path used by k0s get script. Default: /usr/local/bin	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
secretMetadata	object	SecretMetadata specifies metadata (labels and annotations) to be propagated to the bootstrap Secret.	false
useSystemHostname	boolean	UseSystemHostname specifies whether to use the system hostname for the kubernetes node name. By default, k0smotron will use Machine name as a node name. If true, it will pick it from `hostname` command output. Default: false	false
version	string	Version is the version of k0s to use. In case this is not set, k0smotron will use a version field of the Machine object. If it's empty, the latest version is used. Make sure the version is compatible with the k0s version running on the control plane. For reference see the Kubernetes version skew policy: https://kubernetes.io/docs/setup/release/version-skew-policy/	false
workingDir	string	WorkingDir specifies the working directory where k0smotron will place its files.	false

K0sWorkerConfig.spec.customUserDataRef

^{↩ Parent}

CustomUserDataRef is a reference to a secret or a configmap that contains the custom user data. Provided user-data will be merged with the one generated by k0smotron. Note that you may want to specify the merge type. See: https://cloudinit.readthedocs.io/en/latest/reference/merging.html

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

K0sWorkerConfig.spec.customUserDataRef.configMapRef

^{↩ Parent}

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

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

K0sWorkerConfig.spec.customUserDataRef.secretRef

^{↩ Parent}

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

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

K0sWorkerConfig.spec.files[index]

^{↩ Parent}

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

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

K0sWorkerConfig.spec.files[index].contentFrom

^{↩ Parent}

ContentFrom specifies the source of the content.

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

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

^{↩ Parent}

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

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

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

^{↩ Parent}

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

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

K0sWorkerConfig.spec.ignition

^{↩ Parent}

Ignition defines the ignition configuration. If empty, k0smotron will use cloud-init.

Name	Type	Description	Required
variant	enum	Variant declares which distribution variant the generated config is for. Check the supported variants and versions here: https://coreos.github.io/butane/specs/#butane-specifications-and-ignition-specifications Enum: fcos, flatcar, openshift, r4e, fiot	true
version	string	Version is the schema version of the Butane config to use Check the supported variants and versions here: https://coreos.github.io/butane/specs/#butane-specifications-and-ignition-specifications	true
additionalConfig	string	AdditionalConfig is an unstructured object that contains additional config to be merged with the generated one. The format follows Butane spec: https://coreos.github.io/butane/	false

K0sWorkerConfig.spec.secretMetadata

^{↩ Parent}

SecretMetadata specifies metadata (labels and annotations) to be propagated to the bootstrap Secret.

Name	Type	Description	Required
annotations	map[string]string	Annotations to be added to the bootstrap Secret	false
labels	map[string]string	Labels to be added to the bootstrap Secret	false

K0sWorkerConfig.status

^{↩ Parent}

Name	Type	Description	Required
conditions	[]object	Conditions defines current service state of the K0sWorkerConfig.	false
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.status.conditions[index]

^{↩ Parent}

Condition contains details for one aspect of the current state of this API Resource.

Name	Type	Description	Required
lastTransitionTime	string	lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable. Format: date-time	true
message	string	message is a human readable message indicating details about the transition. This may be an empty string.	true
reason	string	reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.	true
status	enum	status of the condition, one of True, False, Unknown. Enum: True, False, Unknown	true
type	string	type of condition in CamelCase or in foo.example.com/CamelCase.	true
observedGeneration	integer	observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance. Format: int64 Minimum: 0	false

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
args	[]string	Args specifies extra arguments to be passed to k0s worker. See: https://docs.k0sproject.io/stable/worker-node-config/ See: https://docs.k0sproject.io/stable/cli/k0s_worker/	false
customUserDataRef	object	CustomUserDataRef is a reference to a secret or a configmap that contains the custom user data. Provided user-data will be merged with the one generated by k0smotron. Note that you may want to specify the merge type. See: https://cloudinit.readthedocs.io/en/latest/reference/merging.html	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
ignition	object	Ignition defines the ignition configuration. If empty, k0smotron will use cloud-init.	false
k0sInstallDir	string	K0sInstallDir specifies the directory where k0s binary will be installed. If empty, k0smotron will use /usr/local/bin, which is the default install path used by k0s get script. Default: /usr/local/bin	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
secretMetadata	object	SecretMetadata specifies metadata (labels and annotations) to be propagated to the bootstrap Secret.	false
useSystemHostname	boolean	UseSystemHostname specifies whether to use the system hostname for the kubernetes node name. By default, k0smotron will use Machine name as a node name. If true, it will pick it from `hostname` command output. Default: false	false
version	string	Version is the version of k0s to use. In case this is not set, k0smotron will use a version field of the Machine object. If it's empty, the latest version is used. Make sure the version is compatible with the k0s version running on the control plane. For reference see the Kubernetes version skew policy: https://kubernetes.io/docs/setup/release/version-skew-policy/	false
workingDir	string	WorkingDir specifies the working directory where k0smotron will place its files.	false

K0sWorkerConfigTemplate.spec.template.spec.customUserDataRef

^{↩ Parent}

CustomUserDataRef is a reference to a secret or a configmap that contains the custom user data. Provided user-data will be merged with the one generated by k0smotron. Note that you may want to specify the merge type. See: https://cloudinit.readthedocs.io/en/latest/reference/merging.html

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

K0sWorkerConfigTemplate.spec.template.spec.customUserDataRef.configMapRef

^{↩ Parent}

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

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

K0sWorkerConfigTemplate.spec.template.spec.customUserDataRef.secretRef

^{↩ Parent}

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

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

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

^{↩ Parent}

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

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

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

^{↩ Parent}

ContentFrom specifies the source of the content.

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

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

^{↩ Parent}

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

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

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

^{↩ Parent}

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

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

K0sWorkerConfigTemplate.spec.template.spec.ignition

^{↩ Parent}

Ignition defines the ignition configuration. If empty, k0smotron will use cloud-init.

Name	Type	Description	Required
variant	enum	Variant declares which distribution variant the generated config is for. Check the supported variants and versions here: https://coreos.github.io/butane/specs/#butane-specifications-and-ignition-specifications Enum: fcos, flatcar, openshift, r4e, fiot	true
version	string	Version is the schema version of the Butane config to use Check the supported variants and versions here: https://coreos.github.io/butane/specs/#butane-specifications-and-ignition-specifications	true
additionalConfig	string	AdditionalConfig is an unstructured object that contains additional config to be merged with the generated one. The format follows Butane spec: https://coreos.github.io/butane/	false

K0sWorkerConfigTemplate.spec.template.spec.secretMetadata

^{↩ Parent}

SecretMetadata specifies metadata (labels and annotations) to be propagated to the bootstrap Secret.

Name	Type	Description	Required
annotations	map[string]string	Annotations to be added to the bootstrap Secret	false
labels	map[string]string	Labels to be added to the bootstrap Secret	false