Last generated June 29, 2022

KubeadmConfig

KubeadmConfig is the Schema for the kubeadmconfigs API.

Full name:
kubeadmconfigs.bootstrap.cluster.x-k8s.io
Group:
bootstrap.cluster.x-k8s.io
Singular name:
kubeadmconfig
Plural name:
kubeadmconfigs
Scope:
Namespaced
Versions:
v1alpha3v1alpha4v1beta1

Version v1alpha3

Properties

.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

.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

.metadata

object

.spec

object

KubeadmConfigSpec defines the desired state of KubeadmConfig. Either ClusterConfiguration and InitConfiguration should be defined or the JoinConfiguration should be defined.

.spec.clusterConfiguration

object

ClusterConfiguration along with InitConfiguration are the configurations necessary for the init command

.spec.clusterConfiguration.apiServer

object

APIServer contains extra settings for the API server control plane component

.spec.clusterConfiguration.apiServer.certSANs

array

CertSANs sets extra Subject Alternative Names for the API Server signing cert.

.spec.clusterConfiguration.apiServer.certSANs[*]

string

.spec.clusterConfiguration.apiServer.extraArgs

object

ExtraArgs is an extra set of flags to pass to the control plane component. TODO: This is temporary and ideally we would like to switch all components to use ComponentConfig + ConfigMaps.

.spec.clusterConfiguration.apiServer.extraVolumes

array

ExtraVolumes is an extra set of host volumes, mounted to the control plane component.

.spec.clusterConfiguration.apiServer.extraVolumes[*]

object

HostPathMount contains elements describing volumes that are mounted from the host.

.spec.clusterConfiguration.apiServer.extraVolumes[*].hostPath

string Required

HostPath is the path in the host that will be mounted inside the pod.

.spec.clusterConfiguration.apiServer.extraVolumes[*].mountPath

string Required

MountPath is the path inside the pod where hostPath will be mounted.

.spec.clusterConfiguration.apiServer.extraVolumes[*].name

string Required

Name of the volume inside the pod template.

.spec.clusterConfiguration.apiServer.extraVolumes[*].pathType

string

PathType is the type of the HostPath.

.spec.clusterConfiguration.apiServer.extraVolumes[*].readOnly

boolean

ReadOnly controls write access to the volume

.spec.clusterConfiguration.apiServer.timeoutForControlPlane

string

TimeoutForControlPlane controls the timeout that we use for API server to appear

.spec.clusterConfiguration.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

.spec.clusterConfiguration.certificatesDir

string

CertificatesDir specifies where to store or look for all required certificates. NB: if not provided, this will default to /etc/kubernetes/pki

.spec.clusterConfiguration.clusterName

string

The cluster name

.spec.clusterConfiguration.controlPlaneEndpoint

string

ControlPlaneEndpoint sets a stable IP address or DNS name for the control plane; it can be a valid IP address or a RFC-1123 DNS subdomain, both with optional TCP port. In case the ControlPlaneEndpoint is not specified, the AdvertiseAddress + BindPort are used; in case the ControlPlaneEndpoint is specified but without a TCP port, the BindPort is used. Possible usages are: e.g. In a cluster with more than one control plane instances, this field should be assigned the address of the external load balancer in front of the control plane instances. e.g. in environments with enforced node recycling, the ControlPlaneEndpoint could be used for assigning a stable DNS to the control plane. NB: This value defaults to the first value in the Cluster object status.apiEndpoints array.

.spec.clusterConfiguration.controllerManager

object

ControllerManager contains extra settings for the controller manager control plane component

.spec.clusterConfiguration.controllerManager.extraArgs

object

ExtraArgs is an extra set of flags to pass to the control plane component. TODO: This is temporary and ideally we would like to switch all components to use ComponentConfig + ConfigMaps.

.spec.clusterConfiguration.controllerManager.extraVolumes

array

ExtraVolumes is an extra set of host volumes, mounted to the control plane component.

.spec.clusterConfiguration.controllerManager.extraVolumes[*]

object

HostPathMount contains elements describing volumes that are mounted from the host.

.spec.clusterConfiguration.controllerManager.extraVolumes[*].hostPath

string Required

HostPath is the path in the host that will be mounted inside the pod.

.spec.clusterConfiguration.controllerManager.extraVolumes[*].mountPath

string Required

MountPath is the path inside the pod where hostPath will be mounted.

.spec.clusterConfiguration.controllerManager.extraVolumes[*].name

string Required

Name of the volume inside the pod template.

.spec.clusterConfiguration.controllerManager.extraVolumes[*].pathType

string

PathType is the type of the HostPath.

.spec.clusterConfiguration.controllerManager.extraVolumes[*].readOnly

boolean

ReadOnly controls write access to the volume

.spec.clusterConfiguration.dns

object

DNS defines the options for the DNS add-on installed in the cluster.

.spec.clusterConfiguration.dns.imageRepository

string

ImageRepository sets the container registry to pull images from. if not set, the ImageRepository defined in ClusterConfiguration will be used instead.

.spec.clusterConfiguration.dns.imageTag

string

ImageTag allows to specify a tag for the image. In case this value is set, kubeadm does not change automatically the version of the above components during upgrades.

.spec.clusterConfiguration.dns.type

string

Type defines the DNS add-on to be used

.spec.clusterConfiguration.etcd

object

Etcd holds configuration for etcd. NB: This value defaults to a Local (stacked) etcd

.spec.clusterConfiguration.etcd.external

object

External describes how to connect to an external etcd cluster Local and External are mutually exclusive

.spec.clusterConfiguration.etcd.external.caFile

string Required

CAFile is an SSL Certificate Authority file used to secure etcd communication. Required if using a TLS connection.

.spec.clusterConfiguration.etcd.external.certFile

string Required

CertFile is an SSL certification file used to secure etcd communication. Required if using a TLS connection.

.spec.clusterConfiguration.etcd.external.endpoints

array Required

Endpoints of etcd members. Required for ExternalEtcd.

.spec.clusterConfiguration.etcd.external.endpoints[*]

string

.spec.clusterConfiguration.etcd.external.keyFile

string Required

KeyFile is an SSL key file used to secure etcd communication. Required if using a TLS connection.

.spec.clusterConfiguration.etcd.local

object

Local provides configuration knobs for configuring the local etcd instance Local and External are mutually exclusive

.spec.clusterConfiguration.etcd.local.dataDir

string

DataDir is the directory etcd will place its data. Defaults to “/var/lib/etcd”.

.spec.clusterConfiguration.etcd.local.extraArgs

object

ExtraArgs are extra arguments provided to the etcd binary when run inside a static pod.

.spec.clusterConfiguration.etcd.local.imageRepository

string

ImageRepository sets the container registry to pull images from. if not set, the ImageRepository defined in ClusterConfiguration will be used instead.

.spec.clusterConfiguration.etcd.local.imageTag

string

ImageTag allows to specify a tag for the image. In case this value is set, kubeadm does not change automatically the version of the above components during upgrades.

.spec.clusterConfiguration.etcd.local.peerCertSANs

array

PeerCertSANs sets extra Subject Alternative Names for the etcd peer signing cert.

.spec.clusterConfiguration.etcd.local.peerCertSANs[*]

string

.spec.clusterConfiguration.etcd.local.serverCertSANs

array

ServerCertSANs sets extra Subject Alternative Names for the etcd server signing cert.

.spec.clusterConfiguration.etcd.local.serverCertSANs[*]

string

.spec.clusterConfiguration.featureGates

object

FeatureGates enabled by the user.

.spec.clusterConfiguration.imageRepository

string

ImageRepository sets the container registry to pull images from. If empty, k8s.gcr.io will be used by default; in case of kubernetes version is a CI build (kubernetes version starts with ci/ or ci-cross/) gcr.io/k8s-staging-ci-images will be used as a default for control plane components and for kube-proxy, while k8s.gcr.io will be used for all the other images.

.spec.clusterConfiguration.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

.spec.clusterConfiguration.kubernetesVersion

string

KubernetesVersion is the target version of the control plane. NB: This value defaults to the Machine object spec.version

.spec.clusterConfiguration.networking

object

Networking holds configuration for the networking topology of the cluster. NB: This value defaults to the Cluster object spec.clusterNetwork.

.spec.clusterConfiguration.networking.dnsDomain

string

DNSDomain is the dns domain used by k8s services. Defaults to “cluster.local”.

.spec.clusterConfiguration.networking.podSubnet

string

PodSubnet is the subnet used by pods. If unset, the API server will not allocate CIDR ranges for every node. Defaults to a comma-delimited string of the Cluster object’s spec.clusterNetwork.services.cidrBlocks if that is set

.spec.clusterConfiguration.networking.serviceSubnet

string

ServiceSubnet is the subnet used by k8s services. Defaults to a comma-delimited string of the Cluster object’s spec.clusterNetwork.pods.cidrBlocks, or to “10.96.0.0/12” if that’s unset.

.spec.clusterConfiguration.scheduler

object

Scheduler contains extra settings for the scheduler control plane component

.spec.clusterConfiguration.scheduler.extraArgs

object

ExtraArgs is an extra set of flags to pass to the control plane component. TODO: This is temporary and ideally we would like to switch all components to use ComponentConfig + ConfigMaps.

.spec.clusterConfiguration.scheduler.extraVolumes

array

ExtraVolumes is an extra set of host volumes, mounted to the control plane component.

.spec.clusterConfiguration.scheduler.extraVolumes[*]

object

HostPathMount contains elements describing volumes that are mounted from the host.

.spec.clusterConfiguration.scheduler.extraVolumes[*].hostPath

string Required

HostPath is the path in the host that will be mounted inside the pod.

.spec.clusterConfiguration.scheduler.extraVolumes[*].mountPath

string Required

MountPath is the path inside the pod where hostPath will be mounted.

.spec.clusterConfiguration.scheduler.extraVolumes[*].name

string Required

Name of the volume inside the pod template.

.spec.clusterConfiguration.scheduler.extraVolumes[*].pathType

string

PathType is the type of the HostPath.

.spec.clusterConfiguration.scheduler.extraVolumes[*].readOnly

boolean

ReadOnly controls write access to the volume

.spec.clusterConfiguration.useHyperKubeImage

boolean

UseHyperKubeImage controls if hyperkube should be used for Kubernetes components instead of their respective separate images

.spec.diskSetup

object

DiskSetup specifies options for the creation of partition tables and file systems on devices.

.spec.diskSetup.filesystems

array

Filesystems specifies the list of file systems to setup.

.spec.diskSetup.filesystems[*]

object

Filesystem defines the file systems to be created.

.spec.diskSetup.filesystems[*].device

string Required

Device specifies the device name

.spec.diskSetup.filesystems[*].extraOpts

array

ExtraOpts defined extra options to add to the command for creating the file system.

.spec.diskSetup.filesystems[*].extraOpts[*]

string

.spec.diskSetup.filesystems[*].filesystem

string Required

Filesystem specifies the file system type.

.spec.diskSetup.filesystems[*].label

string Required

Label specifies the file system label to be used. If set to None, no label is used.

.spec.diskSetup.filesystems[*].overwrite

boolean

Overwrite defines whether or not to overwrite any existing filesystem. If true, any pre-existing file system will be destroyed. Use with Caution.

.spec.diskSetup.filesystems[*].partition

string

Partition specifies the partition to use. The valid options are: “auto|any”, “auto”, “any”, “none”, and , where NUM is the actual partition number.

.spec.diskSetup.filesystems[*].replaceFS

string

ReplaceFS is a special directive, used for Microsoft Azure that instructs cloud-init to replace a file system of . NOTE: unless you define a label, this requires the use of the ‘any’ partition directive.

.spec.diskSetup.partitions

array

Partitions specifies the list of the partitions to setup.

.spec.diskSetup.partitions[*]

object

Partition defines how to create and layout a partition.

.spec.diskSetup.partitions[*].device

string Required

Device is the name of the device.

.spec.diskSetup.partitions[*].layout

boolean Required

Layout specifies the device layout. If it is true, a single partition will be created for the entire device. When layout is false, it means don’t partition or ignore existing partitioning.

.spec.diskSetup.partitions[*].overwrite

boolean

Overwrite describes whether to skip checks and create the partition if a partition or filesystem is found on the device. Use with caution. Default is ‘false’.

.spec.diskSetup.partitions[*].tableType

string

TableType specifies the tupe of partition table. The following are supported: ‘mbr’: default and setups a MS-DOS partition table ‘gpt’: setups a GPT partition table

.spec.files

array

Files specifies extra files to be passed to user_data upon creation.

.spec.files[*]

object

File defines the input for generating write_files in cloud-init.

.spec.files[*].content

string

Content is the actual content of the file.

.spec.files[*].contentFrom

object

ContentFrom is a referenced source of content to populate the file.

.spec.files[*].contentFrom.secret

object Required

Secret represents a secret that should populate this file.

.spec.files[*].contentFrom.secret.key

string Required

Key is the key in the secret’s data map for this value.

.spec.files[*].contentFrom.secret.name

string Required

Name of the secret in the KubeadmBootstrapConfig’s namespace to use.

.spec.files[*].encoding

string

Encoding specifies the encoding of the file contents.

.spec.files[*].owner

string

Owner specifies the ownership of the file, e.g. “root:root”.

.spec.files[*].path

string Required

Path specifies the full path on disk where to store the file.

.spec.files[*].permissions

string

Permissions specifies the permissions to assign to the file, e.g. “0640”.

.spec.format

string

Format specifies the output format of the bootstrap data

.spec.initConfiguration

object

InitConfiguration along with ClusterConfiguration are the configurations necessary for the init command

.spec.initConfiguration.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

.spec.initConfiguration.bootstrapTokens

array

BootstrapTokens is respected at kubeadm init time and describes a set of Bootstrap Tokens to create. This information IS NOT uploaded to the kubeadm cluster configmap, partly because of its sensitive nature

.spec.initConfiguration.bootstrapTokens[*]

object

BootstrapToken describes one bootstrap token, stored as a Secret in the cluster.

.spec.initConfiguration.bootstrapTokens[*].description

string

Description sets a human-friendly message why this token exists and what it’s used for, so other administrators can know its purpose.

.spec.initConfiguration.bootstrapTokens[*].expires

string

Expires specifies the timestamp when this token expires. Defaults to being set dynamically at runtime based on the TTL. Expires and TTL are mutually exclusive.

.spec.initConfiguration.bootstrapTokens[*].groups

array

Groups specifies the extra groups that this token will authenticate as when/if used for authentication

.spec.initConfiguration.bootstrapTokens[*].groups[*]

string

.spec.initConfiguration.bootstrapTokens[*].token

string Required

Token is used for establishing bidirectional trust between nodes and control-planes. Used for joining nodes in the cluster.

.spec.initConfiguration.bootstrapTokens[*].ttl

string

TTL defines the time to live for this token. Defaults to 24h. Expires and TTL are mutually exclusive.

.spec.initConfiguration.bootstrapTokens[*].usages

array

Usages describes the ways in which this token can be used. Can by default be used for establishing bidirectional trust, but that can be changed here.

.spec.initConfiguration.bootstrapTokens[*].usages[*]

string

.spec.initConfiguration.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

.spec.initConfiguration.localAPIEndpoint

object

LocalAPIEndpoint represents the endpoint of the API server instance that’s deployed on this control plane node In HA setups, this differs from ClusterConfiguration.ControlPlaneEndpoint in the sense that ControlPlaneEndpoint is the global endpoint for the cluster, which then loadbalances the requests to each individual API server. This configuration object lets you customize what IP/DNS name and port the local API server advertises it’s accessible on. By default, kubeadm tries to auto-detect the IP of the default interface and use that, but in case that process fails you may set the desired value here.

.spec.initConfiguration.localAPIEndpoint.advertiseAddress

string Required

AdvertiseAddress sets the IP address for the API server to advertise.

.spec.initConfiguration.localAPIEndpoint.bindPort

integer Required

BindPort sets the secure port for the API Server to bind to. Defaults to 6443.

.spec.initConfiguration.nodeRegistration

object

NodeRegistration holds fields that relate to registering the new control-plane node to the cluster. When used in the context of control plane nodes, NodeRegistration should remain consistent across both InitConfiguration and JoinConfiguration

.spec.initConfiguration.nodeRegistration.criSocket

string

CRISocket is used to retrieve container runtime info. This information will be annotated to the Node API object, for later re-use

.spec.initConfiguration.nodeRegistration.kubeletExtraArgs

object

KubeletExtraArgs passes through extra arguments to the kubelet. The arguments here are passed to the kubelet command line via the environment file kubeadm writes at runtime for the kubelet to source. This overrides the generic base-level configuration in the kubelet-config-1.X ConfigMap Flags have higher priority when parsing. These values are local and specific to the node kubeadm is executing on.

.spec.initConfiguration.nodeRegistration.name

string

Name is the .Metadata.Name field of the Node API object that will be created in this kubeadm init or kubeadm join operation. This field is also used in the CommonName field of the kubelet’s client certificate to the API server. Defaults to the hostname of the node if not provided.

.spec.initConfiguration.nodeRegistration.taints

array

Taints specifies the taints the Node API object should be registered with. If this field is unset, i.e. nil, in the kubeadm init process it will be defaulted to []v1.Taint{‘node-role.kubernetes.io/master=“”’}. If you don’t want to taint your control-plane node, set this field to an empty slice, i.e. taints: {} in the YAML file. This field is solely used for Node registration.

.spec.initConfiguration.nodeRegistration.taints[*]

object

The node this Taint is attached to has the “effect” on any pod that does not tolerate the Taint.

.spec.initConfiguration.nodeRegistration.taints[*].effect

string Required

Required. The effect of the taint on pods that do not tolerate the taint. Valid effects are NoSchedule, PreferNoSchedule and NoExecute.

.spec.initConfiguration.nodeRegistration.taints[*].key

string Required

Required. The taint key to be applied to a node.

.spec.initConfiguration.nodeRegistration.taints[*].timeAdded

string

TimeAdded represents the time at which the taint was added. It is only written for NoExecute taints.

.spec.initConfiguration.nodeRegistration.taints[*].value

string

The taint value corresponding to the taint key.

.spec.joinConfiguration

object

JoinConfiguration is the kubeadm configuration for the join command

.spec.joinConfiguration.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

.spec.joinConfiguration.caCertPath

string

CACertPath is the path to the SSL certificate authority used to secure comunications between node and control-plane. Defaults to “/etc/kubernetes/pki/ca.crt”. TODO: revisit when there is defaulting from k/k

.spec.joinConfiguration.controlPlane

object

ControlPlane defines the additional control plane instance to be deployed on the joining node. If nil, no additional control plane instance will be deployed.

.spec.joinConfiguration.controlPlane.localAPIEndpoint

object

LocalAPIEndpoint represents the endpoint of the API server instance to be deployed on this node.

.spec.joinConfiguration.controlPlane.localAPIEndpoint.advertiseAddress

string Required

AdvertiseAddress sets the IP address for the API server to advertise.

.spec.joinConfiguration.controlPlane.localAPIEndpoint.bindPort

integer Required

BindPort sets the secure port for the API Server to bind to. Defaults to 6443.

.spec.joinConfiguration.discovery

object

Discovery specifies the options for the kubelet to use during the TLS Bootstrap process TODO: revisit when there is defaulting from k/k

.spec.joinConfiguration.discovery.bootstrapToken

object

BootstrapToken is used to set the options for bootstrap token based discovery BootstrapToken and File are mutually exclusive

.spec.joinConfiguration.discovery.bootstrapToken.apiServerEndpoint

string

APIServerEndpoint is an IP or domain name to the API server from which info will be fetched.

.spec.joinConfiguration.discovery.bootstrapToken.caCertHashes

array

CACertHashes specifies a set of public key pins to verify when token-based discovery is used. The root CA found during discovery must match one of these values. Specifying an empty set disables root CA pinning, which can be unsafe. Each hash is specified as “:”, where the only currently supported type is “sha256”. This is a hex-encoded SHA-256 hash of the Subject Public Key Info (SPKI) object in DER-encoded ASN.1. These hashes can be calculated using, for example, OpenSSL: openssl x509 -pubkey -in ca.crt openssl rsa -pubin -outform der 2>&/dev/null | openssl dgst -sha256 -hex

.spec.joinConfiguration.discovery.bootstrapToken.caCertHashes[*]

string

.spec.joinConfiguration.discovery.bootstrapToken.token

string Required

Token is a token used to validate cluster information fetched from the control-plane.

.spec.joinConfiguration.discovery.bootstrapToken.unsafeSkipCAVerification

boolean Required

UnsafeSkipCAVerification allows token-based discovery without CA verification via CACertHashes. This can weaken the security of kubeadm since other nodes can impersonate the control-plane.

.spec.joinConfiguration.discovery.file

object

File is used to specify a file or URL to a kubeconfig file from which to load cluster information BootstrapToken and File are mutually exclusive

.spec.joinConfiguration.discovery.file.kubeConfigPath

string Required

KubeConfigPath is used to specify the actual file path or URL to the kubeconfig file from which to load cluster information

.spec.joinConfiguration.discovery.timeout

string

Timeout modifies the discovery timeout

.spec.joinConfiguration.discovery.tlsBootstrapToken

string

TLSBootstrapToken is a token used for TLS bootstrapping. If .BootstrapToken is set, this field is defaulted to .BootstrapToken.Token, but can be overridden. If .File is set, this field must be set in case the KubeConfigFile does not contain any other authentication information TODO: revisit when there is defaulting from k/k

.spec.joinConfiguration.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

.spec.joinConfiguration.nodeRegistration

object

NodeRegistration holds fields that relate to registering the new control-plane node to the cluster. When used in the context of control plane nodes, NodeRegistration should remain consistent across both InitConfiguration and JoinConfiguration

.spec.joinConfiguration.nodeRegistration.criSocket

string

CRISocket is used to retrieve container runtime info. This information will be annotated to the Node API object, for later re-use

.spec.joinConfiguration.nodeRegistration.kubeletExtraArgs

object

KubeletExtraArgs passes through extra arguments to the kubelet. The arguments here are passed to the kubelet command line via the environment file kubeadm writes at runtime for the kubelet to source. This overrides the generic base-level configuration in the kubelet-config-1.X ConfigMap Flags have higher priority when parsing. These values are local and specific to the node kubeadm is executing on.

.spec.joinConfiguration.nodeRegistration.name

string

Name is the .Metadata.Name field of the Node API object that will be created in this kubeadm init or kubeadm join operation. This field is also used in the CommonName field of the kubelet’s client certificate to the API server. Defaults to the hostname of the node if not provided.

.spec.joinConfiguration.nodeRegistration.taints

array

Taints specifies the taints the Node API object should be registered with. If this field is unset, i.e. nil, in the kubeadm init process it will be defaulted to []v1.Taint{‘node-role.kubernetes.io/master=“”’}. If you don’t want to taint your control-plane node, set this field to an empty slice, i.e. taints: {} in the YAML file. This field is solely used for Node registration.

.spec.joinConfiguration.nodeRegistration.taints[*]

object

The node this Taint is attached to has the “effect” on any pod that does not tolerate the Taint.

.spec.joinConfiguration.nodeRegistration.taints[*].effect

string Required

Required. The effect of the taint on pods that do not tolerate the taint. Valid effects are NoSchedule, PreferNoSchedule and NoExecute.

.spec.joinConfiguration.nodeRegistration.taints[*].key

string Required

Required. The taint key to be applied to a node.

.spec.joinConfiguration.nodeRegistration.taints[*].timeAdded

string

TimeAdded represents the time at which the taint was added. It is only written for NoExecute taints.

.spec.joinConfiguration.nodeRegistration.taints[*].value

string

The taint value corresponding to the taint key.

.spec.mounts

array

Mounts specifies a list of mount points to be setup.

.spec.mounts[*]

array

MountPoints defines input for generated mounts in cloud-init.

.spec.ntp

object

NTP specifies NTP configuration

.spec.ntp.enabled

boolean

Enabled specifies whether NTP should be enabled

.spec.ntp.servers

array

Servers specifies which NTP servers to use

.spec.ntp.servers[*]

string

.spec.postKubeadmCommands

array

PostKubeadmCommands specifies extra commands to run after kubeadm runs

.spec.postKubeadmCommands[*]

string

.spec.preKubeadmCommands

array

PreKubeadmCommands specifies extra commands to run before kubeadm runs

.spec.preKubeadmCommands[*]

string

.spec.useExperimentalRetryJoin

boolean

UseExperimentalRetryJoin replaces a basic kubeadm command with a shell script with retries for joins. This is meant to be an experimental temporary workaround on some environments where joins fail due to timing (and other issues). The long term goal is to add retries to kubeadm proper and use that functionality. This will add about 40KB to userdata For more information, refer to https://github.com/kubernetes-sigs/cluster-api/pull/2763#discussion_r397306055.

.spec.users

array

Users specifies extra users to add

.spec.users[*]

object

User defines the input for a generated user in cloud-init.

.spec.users[*].gecos

string

Gecos specifies the gecos to use for the user

.spec.users[*].groups

string

Groups specifies the additional groups for the user

.spec.users[*].homeDir

string

HomeDir specifies the home directory to use for the user

.spec.users[*].inactive

boolean

Inactive specifies whether to mark the user as inactive

.spec.users[*].lockPassword

boolean

LockPassword specifies if password login should be disabled

.spec.users[*].name

string Required

Name specifies the user name

.spec.users[*].passwd

string

Passwd specifies a hashed password for the user

.spec.users[*].primaryGroup

string

PrimaryGroup specifies the primary group for the user

.spec.users[*].shell

string

Shell specifies the user’s shell

.spec.users[*].sshAuthorizedKeys

array

SSHAuthorizedKeys specifies a list of ssh authorized keys for the user

.spec.users[*].sshAuthorizedKeys[*]

string

.spec.users[*].sudo

string

Sudo specifies a sudo role for the user

.spec.verbosity

integer

Verbosity is the number for the kubeadm log level verbosity. It overrides the --v flag in kubeadm commands.

.status

object

KubeadmConfigStatus defines the observed state of KubeadmConfig.

.status.bootstrapData

string

BootstrapData will be a cloud-init script for now. Deprecated: Switch to DataSecretName.

.status.conditions

array

Conditions defines current service state of the KubeadmConfig.

.status.conditions[*]

object

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

.status.conditions[*].lastTransitionTime

string

Last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.

.status.conditions[*].message

string

A human readable message indicating details about the transition. This field may be empty.

.status.conditions[*].reason

string

The reason for the condition’s last transition in CamelCase. The specific API may choose whether or not this field is considered a guaranteed API. This field may not be empty.

.status.conditions[*].severity

string

Severity provides an explicit classification of Reason code, so the users or machines can immediately understand the current situation and act accordingly. The Severity field MUST be set only when Status=False.

.status.conditions[*].status

string Required

Status of the condition, one of True, False, Unknown.

.status.conditions[*].type

string Required

Type of condition in CamelCase or in foo.example.com/CamelCase. Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be useful (see .node.status.conditions), the ability to deconflict is important.

.status.dataSecretName

string

DataSecretName is the name of the secret that stores the bootstrap data script.

.status.failureMessage

string

FailureMessage will be set on non-retryable errors

.status.failureReason

string

FailureReason will be set on non-retryable errors

.status.observedGeneration

integer

ObservedGeneration is the latest generation observed by the controller.

.status.ready

boolean

Ready indicates the BootstrapData field is ready to be consumed

Version v1alpha4

Properties

.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

.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

.metadata

object

.spec

object

KubeadmConfigSpec defines the desired state of KubeadmConfig. Either ClusterConfiguration and InitConfiguration should be defined or the JoinConfiguration should be defined.

.spec.clusterConfiguration

object

ClusterConfiguration along with InitConfiguration are the configurations necessary for the init command

.spec.clusterConfiguration.apiServer

object

APIServer contains extra settings for the API server control plane component

.spec.clusterConfiguration.apiServer.certSANs

array

CertSANs sets extra Subject Alternative Names for the API Server signing cert.

.spec.clusterConfiguration.apiServer.certSANs[*]

string

.spec.clusterConfiguration.apiServer.extraArgs

object

ExtraArgs is an extra set of flags to pass to the control plane component. TODO: This is temporary and ideally we would like to switch all components to use ComponentConfig + ConfigMaps.

.spec.clusterConfiguration.apiServer.extraVolumes

array

ExtraVolumes is an extra set of host volumes, mounted to the control plane component.

.spec.clusterConfiguration.apiServer.extraVolumes[*]

object

HostPathMount contains elements describing volumes that are mounted from the host.

.spec.clusterConfiguration.apiServer.extraVolumes[*].hostPath

string Required

HostPath is the path in the host that will be mounted inside the pod.

.spec.clusterConfiguration.apiServer.extraVolumes[*].mountPath

string Required

MountPath is the path inside the pod where hostPath will be mounted.

.spec.clusterConfiguration.apiServer.extraVolumes[*].name

string Required

Name of the volume inside the pod template.

.spec.clusterConfiguration.apiServer.extraVolumes[*].pathType

string

PathType is the type of the HostPath.

.spec.clusterConfiguration.apiServer.extraVolumes[*].readOnly

boolean

ReadOnly controls write access to the volume

.spec.clusterConfiguration.apiServer.timeoutForControlPlane

string

TimeoutForControlPlane controls the timeout that we use for API server to appear

.spec.clusterConfiguration.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

.spec.clusterConfiguration.certificatesDir

string

CertificatesDir specifies where to store or look for all required certificates. NB: if not provided, this will default to /etc/kubernetes/pki

.spec.clusterConfiguration.clusterName

string

The cluster name

.spec.clusterConfiguration.controlPlaneEndpoint

string

ControlPlaneEndpoint sets a stable IP address or DNS name for the control plane; it can be a valid IP address or a RFC-1123 DNS subdomain, both with optional TCP port. In case the ControlPlaneEndpoint is not specified, the AdvertiseAddress + BindPort are used; in case the ControlPlaneEndpoint is specified but without a TCP port, the BindPort is used. Possible usages are: e.g. In a cluster with more than one control plane instances, this field should be assigned the address of the external load balancer in front of the control plane instances. e.g. in environments with enforced node recycling, the ControlPlaneEndpoint could be used for assigning a stable DNS to the control plane. NB: This value defaults to the first value in the Cluster object status.apiEndpoints array.

.spec.clusterConfiguration.controllerManager

object

ControllerManager contains extra settings for the controller manager control plane component

.spec.clusterConfiguration.controllerManager.extraArgs

object

ExtraArgs is an extra set of flags to pass to the control plane component. TODO: This is temporary and ideally we would like to switch all components to use ComponentConfig + ConfigMaps.

.spec.clusterConfiguration.controllerManager.extraVolumes

array

ExtraVolumes is an extra set of host volumes, mounted to the control plane component.

.spec.clusterConfiguration.controllerManager.extraVolumes[*]

object

HostPathMount contains elements describing volumes that are mounted from the host.

.spec.clusterConfiguration.controllerManager.extraVolumes[*].hostPath

string Required

HostPath is the path in the host that will be mounted inside the pod.

.spec.clusterConfiguration.controllerManager.extraVolumes[*].mountPath

string Required

MountPath is the path inside the pod where hostPath will be mounted.

.spec.clusterConfiguration.controllerManager.extraVolumes[*].name

string Required

Name of the volume inside the pod template.

.spec.clusterConfiguration.controllerManager.extraVolumes[*].pathType

string

PathType is the type of the HostPath.

.spec.clusterConfiguration.controllerManager.extraVolumes[*].readOnly

boolean

ReadOnly controls write access to the volume

.spec.clusterConfiguration.dns

object

DNS defines the options for the DNS add-on installed in the cluster.

.spec.clusterConfiguration.dns.imageRepository

string

ImageRepository sets the container registry to pull images from. if not set, the ImageRepository defined in ClusterConfiguration will be used instead.

.spec.clusterConfiguration.dns.imageTag

string

ImageTag allows to specify a tag for the image. In case this value is set, kubeadm does not change automatically the version of the above components during upgrades.

.spec.clusterConfiguration.etcd

object

Etcd holds configuration for etcd. NB: This value defaults to a Local (stacked) etcd

.spec.clusterConfiguration.etcd.external

object

External describes how to connect to an external etcd cluster Local and External are mutually exclusive

.spec.clusterConfiguration.etcd.external.caFile

string Required

CAFile is an SSL Certificate Authority file used to secure etcd communication. Required if using a TLS connection.

.spec.clusterConfiguration.etcd.external.certFile

string Required

CertFile is an SSL certification file used to secure etcd communication. Required if using a TLS connection.

.spec.clusterConfiguration.etcd.external.endpoints

array Required

Endpoints of etcd members. Required for ExternalEtcd.

.spec.clusterConfiguration.etcd.external.endpoints[*]

string

.spec.clusterConfiguration.etcd.external.keyFile

string Required

KeyFile is an SSL key file used to secure etcd communication. Required if using a TLS connection.

.spec.clusterConfiguration.etcd.local

object

Local provides configuration knobs for configuring the local etcd instance Local and External are mutually exclusive

.spec.clusterConfiguration.etcd.local.dataDir

string

DataDir is the directory etcd will place its data. Defaults to “/var/lib/etcd”.

.spec.clusterConfiguration.etcd.local.extraArgs

object

ExtraArgs are extra arguments provided to the etcd binary when run inside a static pod.

.spec.clusterConfiguration.etcd.local.imageRepository

string

ImageRepository sets the container registry to pull images from. if not set, the ImageRepository defined in ClusterConfiguration will be used instead.

.spec.clusterConfiguration.etcd.local.imageTag

string

ImageTag allows to specify a tag for the image. In case this value is set, kubeadm does not change automatically the version of the above components during upgrades.

.spec.clusterConfiguration.etcd.local.peerCertSANs

array

PeerCertSANs sets extra Subject Alternative Names for the etcd peer signing cert.

.spec.clusterConfiguration.etcd.local.peerCertSANs[*]

string

.spec.clusterConfiguration.etcd.local.serverCertSANs

array

ServerCertSANs sets extra Subject Alternative Names for the etcd server signing cert.

.spec.clusterConfiguration.etcd.local.serverCertSANs[*]

string

.spec.clusterConfiguration.featureGates

object

FeatureGates enabled by the user.

.spec.clusterConfiguration.imageRepository

string

ImageRepository sets the container registry to pull images from. If empty, k8s.gcr.io will be used by default; in case of kubernetes version is a CI build (kubernetes version starts with ci/ or ci-cross/) gcr.io/k8s-staging-ci-images will be used as a default for control plane components and for kube-proxy, while k8s.gcr.io will be used for all the other images.

.spec.clusterConfiguration.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

.spec.clusterConfiguration.kubernetesVersion

string

KubernetesVersion is the target version of the control plane. NB: This value defaults to the Machine object spec.version

.spec.clusterConfiguration.networking

object

Networking holds configuration for the networking topology of the cluster. NB: This value defaults to the Cluster object spec.clusterNetwork.

.spec.clusterConfiguration.networking.dnsDomain

string

DNSDomain is the dns domain used by k8s services. Defaults to “cluster.local”.

.spec.clusterConfiguration.networking.podSubnet

string

PodSubnet is the subnet used by pods. If unset, the API server will not allocate CIDR ranges for every node. Defaults to a comma-delimited string of the Cluster object’s spec.clusterNetwork.services.cidrBlocks if that is set

.spec.clusterConfiguration.networking.serviceSubnet

string

ServiceSubnet is the subnet used by k8s services. Defaults to a comma-delimited string of the Cluster object’s spec.clusterNetwork.pods.cidrBlocks, or to “10.96.0.0/12” if that’s unset.

.spec.clusterConfiguration.scheduler

object

Scheduler contains extra settings for the scheduler control plane component

.spec.clusterConfiguration.scheduler.extraArgs

object

ExtraArgs is an extra set of flags to pass to the control plane component. TODO: This is temporary and ideally we would like to switch all components to use ComponentConfig + ConfigMaps.

.spec.clusterConfiguration.scheduler.extraVolumes

array

ExtraVolumes is an extra set of host volumes, mounted to the control plane component.

.spec.clusterConfiguration.scheduler.extraVolumes[*]

object

HostPathMount contains elements describing volumes that are mounted from the host.

.spec.clusterConfiguration.scheduler.extraVolumes[*].hostPath

string Required

HostPath is the path in the host that will be mounted inside the pod.

.spec.clusterConfiguration.scheduler.extraVolumes[*].mountPath

string Required

MountPath is the path inside the pod where hostPath will be mounted.

.spec.clusterConfiguration.scheduler.extraVolumes[*].name

string Required

Name of the volume inside the pod template.

.spec.clusterConfiguration.scheduler.extraVolumes[*].pathType

string

PathType is the type of the HostPath.

.spec.clusterConfiguration.scheduler.extraVolumes[*].readOnly

boolean

ReadOnly controls write access to the volume

.spec.diskSetup

object

DiskSetup specifies options for the creation of partition tables and file systems on devices.

.spec.diskSetup.filesystems

array

Filesystems specifies the list of file systems to setup.

.spec.diskSetup.filesystems[*]

object

Filesystem defines the file systems to be created.

.spec.diskSetup.filesystems[*].device

string Required

Device specifies the device name

.spec.diskSetup.filesystems[*].extraOpts

array

ExtraOpts defined extra options to add to the command for creating the file system.

.spec.diskSetup.filesystems[*].extraOpts[*]

string

.spec.diskSetup.filesystems[*].filesystem

string Required

Filesystem specifies the file system type.

.spec.diskSetup.filesystems[*].label

string Required

Label specifies the file system label to be used. If set to None, no label is used.

.spec.diskSetup.filesystems[*].overwrite

boolean

Overwrite defines whether or not to overwrite any existing filesystem. If true, any pre-existing file system will be destroyed. Use with Caution.

.spec.diskSetup.filesystems[*].partition

string

Partition specifies the partition to use. The valid options are: “auto|any”, “auto”, “any”, “none”, and , where NUM is the actual partition number.

.spec.diskSetup.filesystems[*].replaceFS

string

ReplaceFS is a special directive, used for Microsoft Azure that instructs cloud-init to replace a file system of . NOTE: unless you define a label, this requires the use of the ‘any’ partition directive.

.spec.diskSetup.partitions

array

Partitions specifies the list of the partitions to setup.

.spec.diskSetup.partitions[*]

object

Partition defines how to create and layout a partition.

.spec.diskSetup.partitions[*].device

string Required

Device is the name of the device.

.spec.diskSetup.partitions[*].layout

boolean Required

Layout specifies the device layout. If it is true, a single partition will be created for the entire device. When layout is false, it means don’t partition or ignore existing partitioning.

.spec.diskSetup.partitions[*].overwrite

boolean

Overwrite describes whether to skip checks and create the partition if a partition or filesystem is found on the device. Use with caution. Default is ‘false’.

.spec.diskSetup.partitions[*].tableType

string

TableType specifies the tupe of partition table. The following are supported: ‘mbr’: default and setups a MS-DOS partition table ‘gpt’: setups a GPT partition table

.spec.files

array

Files specifies extra files to be passed to user_data upon creation.

.spec.files[*]

object

File defines the input for generating write_files in cloud-init.

.spec.files[*].content

string

Content is the actual content of the file.

.spec.files[*].contentFrom

object

ContentFrom is a referenced source of content to populate the file.

.spec.files[*].contentFrom.secret

object Required

Secret represents a secret that should populate this file.

.spec.files[*].contentFrom.secret.key

string Required

Key is the key in the secret’s data map for this value.

.spec.files[*].contentFrom.secret.name

string Required

Name of the secret in the KubeadmBootstrapConfig’s namespace to use.

.spec.files[*].encoding

string

Encoding specifies the encoding of the file contents.

.spec.files[*].owner

string

Owner specifies the ownership of the file, e.g. “root:root”.

.spec.files[*].path

string Required

Path specifies the full path on disk where to store the file.

.spec.files[*].permissions

string

Permissions specifies the permissions to assign to the file, e.g. “0640”.

.spec.format

string

Format specifies the output format of the bootstrap data

.spec.initConfiguration

object

InitConfiguration along with ClusterConfiguration are the configurations necessary for the init command

.spec.initConfiguration.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

.spec.initConfiguration.bootstrapTokens

array

BootstrapTokens is respected at kubeadm init time and describes a set of Bootstrap Tokens to create. This information IS NOT uploaded to the kubeadm cluster configmap, partly because of its sensitive nature

.spec.initConfiguration.bootstrapTokens[*]

object

BootstrapToken describes one bootstrap token, stored as a Secret in the cluster.

.spec.initConfiguration.bootstrapTokens[*].description

string

Description sets a human-friendly message why this token exists and what it’s used for, so other administrators can know its purpose.

.spec.initConfiguration.bootstrapTokens[*].expires

string

Expires specifies the timestamp when this token expires. Defaults to being set dynamically at runtime based on the TTL. Expires and TTL are mutually exclusive.

.spec.initConfiguration.bootstrapTokens[*].groups

array

Groups specifies the extra groups that this token will authenticate as when/if used for authentication

.spec.initConfiguration.bootstrapTokens[*].groups[*]

string

.spec.initConfiguration.bootstrapTokens[*].token

string Required

Token is used for establishing bidirectional trust between nodes and control-planes. Used for joining nodes in the cluster.

.spec.initConfiguration.bootstrapTokens[*].ttl

string

TTL defines the time to live for this token. Defaults to 24h. Expires and TTL are mutually exclusive.

.spec.initConfiguration.bootstrapTokens[*].usages

array

Usages describes the ways in which this token can be used. Can by default be used for establishing bidirectional trust, but that can be changed here.

.spec.initConfiguration.bootstrapTokens[*].usages[*]

string

.spec.initConfiguration.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

.spec.initConfiguration.localAPIEndpoint

object

LocalAPIEndpoint represents the endpoint of the API server instance that’s deployed on this control plane node In HA setups, this differs from ClusterConfiguration.ControlPlaneEndpoint in the sense that ControlPlaneEndpoint is the global endpoint for the cluster, which then loadbalances the requests to each individual API server. This configuration object lets you customize what IP/DNS name and port the local API server advertises it’s accessible on. By default, kubeadm tries to auto-detect the IP of the default interface and use that, but in case that process fails you may set the desired value here.

.spec.initConfiguration.localAPIEndpoint.advertiseAddress

string

AdvertiseAddress sets the IP address for the API server to advertise.

.spec.initConfiguration.localAPIEndpoint.bindPort

integer

BindPort sets the secure port for the API Server to bind to. Defaults to 6443.

.spec.initConfiguration.nodeRegistration

object

NodeRegistration holds fields that relate to registering the new control-plane node to the cluster. When used in the context of control plane nodes, NodeRegistration should remain consistent across both InitConfiguration and JoinConfiguration

.spec.initConfiguration.nodeRegistration.criSocket

string

CRISocket is used to retrieve container runtime info. This information will be annotated to the Node API object, for later re-use

.spec.initConfiguration.nodeRegistration.ignorePreflightErrors

array

IgnorePreflightErrors provides a slice of pre-flight errors to be ignored when the current node is registered.

.spec.initConfiguration.nodeRegistration.ignorePreflightErrors[*]

string

.spec.initConfiguration.nodeRegistration.kubeletExtraArgs

object

KubeletExtraArgs passes through extra arguments to the kubelet. The arguments here are passed to the kubelet command line via the environment file kubeadm writes at runtime for the kubelet to source. This overrides the generic base-level configuration in the kubelet-config-1.X ConfigMap Flags have higher priority when parsing. These values are local and specific to the node kubeadm is executing on.

.spec.initConfiguration.nodeRegistration.name

string

Name is the .Metadata.Name field of the Node API object that will be created in this kubeadm init or kubeadm join operation. This field is also used in the CommonName field of the kubelet’s client certificate to the API server. Defaults to the hostname of the node if not provided.

.spec.initConfiguration.nodeRegistration.taints

array

Taints specifies the taints the Node API object should be registered with. If this field is unset, i.e. nil, in the kubeadm init process it will be defaulted to []v1.Taint{‘node-role.kubernetes.io/master=“”’}. If you don’t want to taint your control-plane node, set this field to an empty slice, i.e. taints: {} in the YAML file. This field is solely used for Node registration.

.spec.initConfiguration.nodeRegistration.taints[*]

object

The node this Taint is attached to has the “effect” on any pod that does not tolerate the Taint.

.spec.initConfiguration.nodeRegistration.taints[*].effect

string Required

Required. The effect of the taint on pods that do not tolerate the taint. Valid effects are NoSchedule, PreferNoSchedule and NoExecute.

.spec.initConfiguration.nodeRegistration.taints[*].key

string Required

Required. The taint key to be applied to a node.

.spec.initConfiguration.nodeRegistration.taints[*].timeAdded

string

TimeAdded represents the time at which the taint was added. It is only written for NoExecute taints.

.spec.initConfiguration.nodeRegistration.taints[*].value

string

The taint value corresponding to the taint key.

.spec.joinConfiguration

object

JoinConfiguration is the kubeadm configuration for the join command

.spec.joinConfiguration.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

.spec.joinConfiguration.caCertPath

string

CACertPath is the path to the SSL certificate authority used to secure comunications between node and control-plane. Defaults to “/etc/kubernetes/pki/ca.crt”. TODO: revisit when there is defaulting from k/k

.spec.joinConfiguration.controlPlane

object

ControlPlane defines the additional control plane instance to be deployed on the joining node. If nil, no additional control plane instance will be deployed.

.spec.joinConfiguration.controlPlane.localAPIEndpoint

object

LocalAPIEndpoint represents the endpoint of the API server instance to be deployed on this node.

.spec.joinConfiguration.controlPlane.localAPIEndpoint.advertiseAddress

string

AdvertiseAddress sets the IP address for the API server to advertise.

.spec.joinConfiguration.controlPlane.localAPIEndpoint.bindPort

integer

BindPort sets the secure port for the API Server to bind to. Defaults to 6443.

.spec.joinConfiguration.discovery

object

Discovery specifies the options for the kubelet to use during the TLS Bootstrap process TODO: revisit when there is defaulting from k/k

.spec.joinConfiguration.discovery.bootstrapToken

object

BootstrapToken is used to set the options for bootstrap token based discovery BootstrapToken and File are mutually exclusive

.spec.joinConfiguration.discovery.bootstrapToken.apiServerEndpoint

string

APIServerEndpoint is an IP or domain name to the API server from which info will be fetched.

.spec.joinConfiguration.discovery.bootstrapToken.caCertHashes

array

CACertHashes specifies a set of public key pins to verify when token-based discovery is used. The root CA found during discovery must match one of these values. Specifying an empty set disables root CA pinning, which can be unsafe. Each hash is specified as “:”, where the only currently supported type is “sha256”. This is a hex-encoded SHA-256 hash of the Subject Public Key Info (SPKI) object in DER-encoded ASN.1. These hashes can be calculated using, for example, OpenSSL: openssl x509 -pubkey -in ca.crt openssl rsa -pubin -outform der 2>&/dev/null | openssl dgst -sha256 -hex

.spec.joinConfiguration.discovery.bootstrapToken.caCertHashes[*]

string

.spec.joinConfiguration.discovery.bootstrapToken.token

string Required

Token is a token used to validate cluster information fetched from the control-plane.

.spec.joinConfiguration.discovery.bootstrapToken.unsafeSkipCAVerification

boolean

UnsafeSkipCAVerification allows token-based discovery without CA verification via CACertHashes. This can weaken the security of kubeadm since other nodes can impersonate the control-plane.

.spec.joinConfiguration.discovery.file

object

File is used to specify a file or URL to a kubeconfig file from which to load cluster information BootstrapToken and File are mutually exclusive

.spec.joinConfiguration.discovery.file.kubeConfigPath

string Required

KubeConfigPath is used to specify the actual file path or URL to the kubeconfig file from which to load cluster information

.spec.joinConfiguration.discovery.timeout

string

Timeout modifies the discovery timeout

.spec.joinConfiguration.discovery.tlsBootstrapToken

string

TLSBootstrapToken is a token used for TLS bootstrapping. If .BootstrapToken is set, this field is defaulted to .BootstrapToken.Token, but can be overridden. If .File is set, this field must be set in case the KubeConfigFile does not contain any other authentication information

.spec.joinConfiguration.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

.spec.joinConfiguration.nodeRegistration

object

NodeRegistration holds fields that relate to registering the new control-plane node to the cluster. When used in the context of control plane nodes, NodeRegistration should remain consistent across both InitConfiguration and JoinConfiguration

.spec.joinConfiguration.nodeRegistration.criSocket

string

CRISocket is used to retrieve container runtime info. This information will be annotated to the Node API object, for later re-use

.spec.joinConfiguration.nodeRegistration.ignorePreflightErrors

array

IgnorePreflightErrors provides a slice of pre-flight errors to be ignored when the current node is registered.

.spec.joinConfiguration.nodeRegistration.ignorePreflightErrors[*]

string

.spec.joinConfiguration.nodeRegistration.kubeletExtraArgs

object

KubeletExtraArgs passes through extra arguments to the kubelet. The arguments here are passed to the kubelet command line via the environment file kubeadm writes at runtime for the kubelet to source. This overrides the generic base-level configuration in the kubelet-config-1.X ConfigMap Flags have higher priority when parsing. These values are local and specific to the node kubeadm is executing on.

.spec.joinConfiguration.nodeRegistration.name

string

Name is the .Metadata.Name field of the Node API object that will be created in this kubeadm init or kubeadm join operation. This field is also used in the CommonName field of the kubelet’s client certificate to the API server. Defaults to the hostname of the node if not provided.

.spec.joinConfiguration.nodeRegistration.taints

array

Taints specifies the taints the Node API object should be registered with. If this field is unset, i.e. nil, in the kubeadm init process it will be defaulted to []v1.Taint{‘node-role.kubernetes.io/master=“”’}. If you don’t want to taint your control-plane node, set this field to an empty slice, i.e. taints: {} in the YAML file. This field is solely used for Node registration.

.spec.joinConfiguration.nodeRegistration.taints[*]

object

The node this Taint is attached to has the “effect” on any pod that does not tolerate the Taint.

.spec.joinConfiguration.nodeRegistration.taints[*].effect

string Required

Required. The effect of the taint on pods that do not tolerate the taint. Valid effects are NoSchedule, PreferNoSchedule and NoExecute.

.spec.joinConfiguration.nodeRegistration.taints[*].key

string Required

Required. The taint key to be applied to a node.

.spec.joinConfiguration.nodeRegistration.taints[*].timeAdded

string

TimeAdded represents the time at which the taint was added. It is only written for NoExecute taints.

.spec.joinConfiguration.nodeRegistration.taints[*].value

string

The taint value corresponding to the taint key.

.spec.mounts

array

Mounts specifies a list of mount points to be setup.

.spec.mounts[*]

array

MountPoints defines input for generated mounts in cloud-init.

.spec.ntp

object

NTP specifies NTP configuration

.spec.ntp.enabled

boolean

Enabled specifies whether NTP should be enabled

.spec.ntp.servers

array

Servers specifies which NTP servers to use

.spec.ntp.servers[*]

string

.spec.postKubeadmCommands

array

PostKubeadmCommands specifies extra commands to run after kubeadm runs

.spec.postKubeadmCommands[*]

string

.spec.preKubeadmCommands

array

PreKubeadmCommands specifies extra commands to run before kubeadm runs

.spec.preKubeadmCommands[*]

string

.spec.useExperimentalRetryJoin

boolean

UseExperimentalRetryJoin replaces a basic kubeadm command with a shell script with retries for joins. This is meant to be an experimental temporary workaround on some environments where joins fail due to timing (and other issues). The long term goal is to add retries to kubeadm proper and use that functionality. This will add about 40KB to userdata For more information, refer to https://github.com/kubernetes-sigs/cluster-api/pull/2763#discussion_r397306055.

.spec.users

array

Users specifies extra users to add

.spec.users[*]

object

User defines the input for a generated user in cloud-init.

.spec.users[*].gecos

string

Gecos specifies the gecos to use for the user

.spec.users[*].groups

string

Groups specifies the additional groups for the user

.spec.users[*].homeDir

string

HomeDir specifies the home directory to use for the user

.spec.users[*].inactive

boolean

Inactive specifies whether to mark the user as inactive

.spec.users[*].lockPassword

boolean

LockPassword specifies if password login should be disabled

.spec.users[*].name

string Required

Name specifies the user name

.spec.users[*].passwd

string

Passwd specifies a hashed password for the user

.spec.users[*].primaryGroup

string

PrimaryGroup specifies the primary group for the user

.spec.users[*].shell

string

Shell specifies the user’s shell

.spec.users[*].sshAuthorizedKeys

array

SSHAuthorizedKeys specifies a list of ssh authorized keys for the user

.spec.users[*].sshAuthorizedKeys[*]

string

.spec.users[*].sudo

string

Sudo specifies a sudo role for the user

.spec.verbosity

integer

Verbosity is the number for the kubeadm log level verbosity. It overrides the --v flag in kubeadm commands.

.status

object

KubeadmConfigStatus defines the observed state of KubeadmConfig.

.status.conditions

array

Conditions defines current service state of the KubeadmConfig.

.status.conditions[*]

object

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

.status.conditions[*].lastTransitionTime

string

Last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.

.status.conditions[*].message

string

A human readable message indicating details about the transition. This field may be empty.

.status.conditions[*].reason

string

The reason for the condition’s last transition in CamelCase. The specific API may choose whether or not this field is considered a guaranteed API. This field may not be empty.

.status.conditions[*].severity

string

Severity provides an explicit classification of Reason code, so the users or machines can immediately understand the current situation and act accordingly. The Severity field MUST be set only when Status=False.

.status.conditions[*].status

string Required

Status of the condition, one of True, False, Unknown.

.status.conditions[*].type

string Required

Type of condition in CamelCase or in foo.example.com/CamelCase. Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be useful (see .node.status.conditions), the ability to deconflict is important.

.status.dataSecretName

string

DataSecretName is the name of the secret that stores the bootstrap data script.

.status.failureMessage

string

FailureMessage will be set on non-retryable errors

.status.failureReason

string

FailureReason will be set on non-retryable errors

.status.observedGeneration

integer

ObservedGeneration is the latest generation observed by the controller.

.status.ready

boolean

Ready indicates the BootstrapData field is ready to be consumed

Version v1beta1

Properties

.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

.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

.metadata

object

.spec

object

KubeadmConfigSpec defines the desired state of KubeadmConfig. Either ClusterConfiguration and InitConfiguration should be defined or the JoinConfiguration should be defined.

.spec.clusterConfiguration

object

ClusterConfiguration along with InitConfiguration are the configurations necessary for the init command

.spec.clusterConfiguration.apiServer

object

APIServer contains extra settings for the API server control plane component

.spec.clusterConfiguration.apiServer.certSANs

array

CertSANs sets extra Subject Alternative Names for the API Server signing cert.

.spec.clusterConfiguration.apiServer.certSANs[*]

string

.spec.clusterConfiguration.apiServer.extraArgs

object

ExtraArgs is an extra set of flags to pass to the control plane component. TODO: This is temporary and ideally we would like to switch all components to use ComponentConfig + ConfigMaps.

.spec.clusterConfiguration.apiServer.extraVolumes

array

ExtraVolumes is an extra set of host volumes, mounted to the control plane component.

.spec.clusterConfiguration.apiServer.extraVolumes[*]

object

HostPathMount contains elements describing volumes that are mounted from the host.

.spec.clusterConfiguration.apiServer.extraVolumes[*].hostPath

string Required

HostPath is the path in the host that will be mounted inside the pod.

.spec.clusterConfiguration.apiServer.extraVolumes[*].mountPath

string Required

MountPath is the path inside the pod where hostPath will be mounted.

.spec.clusterConfiguration.apiServer.extraVolumes[*].name

string Required

Name of the volume inside the pod template.

.spec.clusterConfiguration.apiServer.extraVolumes[*].pathType

string

PathType is the type of the HostPath.

.spec.clusterConfiguration.apiServer.extraVolumes[*].readOnly

boolean

ReadOnly controls write access to the volume

.spec.clusterConfiguration.apiServer.timeoutForControlPlane

string

TimeoutForControlPlane controls the timeout that we use for API server to appear

.spec.clusterConfiguration.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

.spec.clusterConfiguration.certificatesDir

string

CertificatesDir specifies where to store or look for all required certificates. NB: if not provided, this will default to /etc/kubernetes/pki

.spec.clusterConfiguration.clusterName

string

The cluster name

.spec.clusterConfiguration.controlPlaneEndpoint

string

ControlPlaneEndpoint sets a stable IP address or DNS name for the control plane; it can be a valid IP address or a RFC-1123 DNS subdomain, both with optional TCP port. In case the ControlPlaneEndpoint is not specified, the AdvertiseAddress + BindPort are used; in case the ControlPlaneEndpoint is specified but without a TCP port, the BindPort is used. Possible usages are: e.g. In a cluster with more than one control plane instances, this field should be assigned the address of the external load balancer in front of the control plane instances. e.g. in environments with enforced node recycling, the ControlPlaneEndpoint could be used for assigning a stable DNS to the control plane. NB: This value defaults to the first value in the Cluster object status.apiEndpoints array.

.spec.clusterConfiguration.controllerManager

object

ControllerManager contains extra settings for the controller manager control plane component

.spec.clusterConfiguration.controllerManager.extraArgs

object

ExtraArgs is an extra set of flags to pass to the control plane component. TODO: This is temporary and ideally we would like to switch all components to use ComponentConfig + ConfigMaps.

.spec.clusterConfiguration.controllerManager.extraVolumes

array

ExtraVolumes is an extra set of host volumes, mounted to the control plane component.

.spec.clusterConfiguration.controllerManager.extraVolumes[*]

object

HostPathMount contains elements describing volumes that are mounted from the host.

.spec.clusterConfiguration.controllerManager.extraVolumes[*].hostPath

string Required

HostPath is the path in the host that will be mounted inside the pod.

.spec.clusterConfiguration.controllerManager.extraVolumes[*].mountPath

string Required

MountPath is the path inside the pod where hostPath will be mounted.

.spec.clusterConfiguration.controllerManager.extraVolumes[*].name

string Required

Name of the volume inside the pod template.

.spec.clusterConfiguration.controllerManager.extraVolumes[*].pathType

string

PathType is the type of the HostPath.

.spec.clusterConfiguration.controllerManager.extraVolumes[*].readOnly

boolean

ReadOnly controls write access to the volume

.spec.clusterConfiguration.dns

object

DNS defines the options for the DNS add-on installed in the cluster.

.spec.clusterConfiguration.dns.imageRepository

string

ImageRepository sets the container registry to pull images from. if not set, the ImageRepository defined in ClusterConfiguration will be used instead.

.spec.clusterConfiguration.dns.imageTag

string

ImageTag allows to specify a tag for the image. In case this value is set, kubeadm does not change automatically the version of the above components during upgrades.

.spec.clusterConfiguration.etcd

object

Etcd holds configuration for etcd. NB: This value defaults to a Local (stacked) etcd

.spec.clusterConfiguration.etcd.external

object

External describes how to connect to an external etcd cluster Local and External are mutually exclusive

.spec.clusterConfiguration.etcd.external.caFile

string Required

CAFile is an SSL Certificate Authority file used to secure etcd communication. Required if using a TLS connection.

.spec.clusterConfiguration.etcd.external.certFile

string Required

CertFile is an SSL certification file used to secure etcd communication. Required if using a TLS connection.

.spec.clusterConfiguration.etcd.external.endpoints

array Required

Endpoints of etcd members. Required for ExternalEtcd.

.spec.clusterConfiguration.etcd.external.endpoints[*]

string

.spec.clusterConfiguration.etcd.external.keyFile

string Required

KeyFile is an SSL key file used to secure etcd communication. Required if using a TLS connection.

.spec.clusterConfiguration.etcd.local

object

Local provides configuration knobs for configuring the local etcd instance Local and External are mutually exclusive

.spec.clusterConfiguration.etcd.local.dataDir

string

DataDir is the directory etcd will place its data. Defaults to “/var/lib/etcd”.

.spec.clusterConfiguration.etcd.local.extraArgs

object

ExtraArgs are extra arguments provided to the etcd binary when run inside a static pod.

.spec.clusterConfiguration.etcd.local.imageRepository

string

ImageRepository sets the container registry to pull images from. if not set, the ImageRepository defined in ClusterConfiguration will be used instead.

.spec.clusterConfiguration.etcd.local.imageTag

string

ImageTag allows to specify a tag for the image. In case this value is set, kubeadm does not change automatically the version of the above components during upgrades.

.spec.clusterConfiguration.etcd.local.peerCertSANs

array

PeerCertSANs sets extra Subject Alternative Names for the etcd peer signing cert.

.spec.clusterConfiguration.etcd.local.peerCertSANs[*]

string

.spec.clusterConfiguration.etcd.local.serverCertSANs

array

ServerCertSANs sets extra Subject Alternative Names for the etcd server signing cert.

.spec.clusterConfiguration.etcd.local.serverCertSANs[*]

string

.spec.clusterConfiguration.featureGates

object

FeatureGates enabled by the user.

.spec.clusterConfiguration.imageRepository

string

ImageRepository sets the container registry to pull images from. If empty, k8s.gcr.io will be used by default; in case of kubernetes version is a CI build (kubernetes version starts with ci/ or ci-cross/) gcr.io/k8s-staging-ci-images will be used as a default for control plane components and for kube-proxy, while k8s.gcr.io will be used for all the other images.

.spec.clusterConfiguration.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

.spec.clusterConfiguration.kubernetesVersion

string

KubernetesVersion is the target version of the control plane. NB: This value defaults to the Machine object spec.version

.spec.clusterConfiguration.networking

object

Networking holds configuration for the networking topology of the cluster. NB: This value defaults to the Cluster object spec.clusterNetwork.

.spec.clusterConfiguration.networking.dnsDomain

string

DNSDomain is the dns domain used by k8s services. Defaults to “cluster.local”.

.spec.clusterConfiguration.networking.podSubnet

string

PodSubnet is the subnet used by pods. If unset, the API server will not allocate CIDR ranges for every node. Defaults to a comma-delimited string of the Cluster object’s spec.clusterNetwork.services.cidrBlocks if that is set

.spec.clusterConfiguration.networking.serviceSubnet

string

ServiceSubnet is the subnet used by k8s services. Defaults to a comma-delimited string of the Cluster object’s spec.clusterNetwork.pods.cidrBlocks, or to “10.96.0.0/12” if that’s unset.

.spec.clusterConfiguration.scheduler

object

Scheduler contains extra settings for the scheduler control plane component

.spec.clusterConfiguration.scheduler.extraArgs

object

ExtraArgs is an extra set of flags to pass to the control plane component. TODO: This is temporary and ideally we would like to switch all components to use ComponentConfig + ConfigMaps.

.spec.clusterConfiguration.scheduler.extraVolumes

array

ExtraVolumes is an extra set of host volumes, mounted to the control plane component.

.spec.clusterConfiguration.scheduler.extraVolumes[*]

object

HostPathMount contains elements describing volumes that are mounted from the host.

.spec.clusterConfiguration.scheduler.extraVolumes[*].hostPath

string Required

HostPath is the path in the host that will be mounted inside the pod.

.spec.clusterConfiguration.scheduler.extraVolumes[*].mountPath

string Required

MountPath is the path inside the pod where hostPath will be mounted.

.spec.clusterConfiguration.scheduler.extraVolumes[*].name

string Required

Name of the volume inside the pod template.

.spec.clusterConfiguration.scheduler.extraVolumes[*].pathType

string

PathType is the type of the HostPath.

.spec.clusterConfiguration.scheduler.extraVolumes[*].readOnly

boolean

ReadOnly controls write access to the volume

.spec.diskSetup

object

DiskSetup specifies options for the creation of partition tables and file systems on devices.

.spec.diskSetup.filesystems

array

Filesystems specifies the list of file systems to setup.

.spec.diskSetup.filesystems[*]

object

Filesystem defines the file systems to be created.

.spec.diskSetup.filesystems[*].device

string Required

Device specifies the device name

.spec.diskSetup.filesystems[*].extraOpts

array

ExtraOpts defined extra options to add to the command for creating the file system.

.spec.diskSetup.filesystems[*].extraOpts[*]

string

.spec.diskSetup.filesystems[*].filesystem

string Required

Filesystem specifies the file system type.

.spec.diskSetup.filesystems[*].label

string Required

Label specifies the file system label to be used. If set to None, no label is used.

.spec.diskSetup.filesystems[*].overwrite

boolean

Overwrite defines whether or not to overwrite any existing filesystem. If true, any pre-existing file system will be destroyed. Use with Caution.

.spec.diskSetup.filesystems[*].partition

string

Partition specifies the partition to use. The valid options are: “auto|any”, “auto”, “any”, “none”, and , where NUM is the actual partition number.

.spec.diskSetup.filesystems[*].replaceFS

string

ReplaceFS is a special directive, used for Microsoft Azure that instructs cloud-init to replace a file system of . NOTE: unless you define a label, this requires the use of the ‘any’ partition directive.

.spec.diskSetup.partitions

array

Partitions specifies the list of the partitions to setup.

.spec.diskSetup.partitions[*]

object

Partition defines how to create and layout a partition.

.spec.diskSetup.partitions[*].device

string Required

Device is the name of the device.

.spec.diskSetup.partitions[*].layout

boolean Required

Layout specifies the device layout. If it is true, a single partition will be created for the entire device. When layout is false, it means don’t partition or ignore existing partitioning.

.spec.diskSetup.partitions[*].overwrite

boolean

Overwrite describes whether to skip checks and create the partition if a partition or filesystem is found on the device. Use with caution. Default is ‘false’.

.spec.diskSetup.partitions[*].tableType

string

TableType specifies the tupe of partition table. The following are supported: ‘mbr’: default and setups a MS-DOS partition table ‘gpt’: setups a GPT partition table

.spec.files

array

Files specifies extra files to be passed to user_data upon creation.

.spec.files[*]

object

File defines the input for generating write_files in cloud-init.

.spec.files[*].content

string

Content is the actual content of the file.

.spec.files[*].contentFrom

object

ContentFrom is a referenced source of content to populate the file.

.spec.files[*].contentFrom.secret

object Required

Secret represents a secret that should populate this file.

.spec.files[*].contentFrom.secret.key

string Required

Key is the key in the secret’s data map for this value.

.spec.files[*].contentFrom.secret.name

string Required

Name of the secret in the KubeadmBootstrapConfig’s namespace to use.

.spec.files[*].encoding

string

Encoding specifies the encoding of the file contents.

.spec.files[*].owner

string

Owner specifies the ownership of the file, e.g. “root:root”.

.spec.files[*].path

string Required

Path specifies the full path on disk where to store the file.

.spec.files[*].permissions

string

Permissions specifies the permissions to assign to the file, e.g. “0640”.

.spec.format

string

Format specifies the output format of the bootstrap data

.spec.initConfiguration

object

InitConfiguration along with ClusterConfiguration are the configurations necessary for the init command

.spec.initConfiguration.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

.spec.initConfiguration.bootstrapTokens

array

BootstrapTokens is respected at kubeadm init time and describes a set of Bootstrap Tokens to create. This information IS NOT uploaded to the kubeadm cluster configmap, partly because of its sensitive nature

.spec.initConfiguration.bootstrapTokens[*]

object

BootstrapToken describes one bootstrap token, stored as a Secret in the cluster.

.spec.initConfiguration.bootstrapTokens[*].description

string

Description sets a human-friendly message why this token exists and what it’s used for, so other administrators can know its purpose.

.spec.initConfiguration.bootstrapTokens[*].expires

string

Expires specifies the timestamp when this token expires. Defaults to being set dynamically at runtime based on the TTL. Expires and TTL are mutually exclusive.

.spec.initConfiguration.bootstrapTokens[*].groups

array

Groups specifies the extra groups that this token will authenticate as when/if used for authentication

.spec.initConfiguration.bootstrapTokens[*].groups[*]

string

.spec.initConfiguration.bootstrapTokens[*].token

string Required

Token is used for establishing bidirectional trust between nodes and control-planes. Used for joining nodes in the cluster.

.spec.initConfiguration.bootstrapTokens[*].ttl

string

TTL defines the time to live for this token. Defaults to 24h. Expires and TTL are mutually exclusive.

.spec.initConfiguration.bootstrapTokens[*].usages

array

Usages describes the ways in which this token can be used. Can by default be used for establishing bidirectional trust, but that can be changed here.

.spec.initConfiguration.bootstrapTokens[*].usages[*]

string

.spec.initConfiguration.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

.spec.initConfiguration.localAPIEndpoint

object

LocalAPIEndpoint represents the endpoint of the API server instance that’s deployed on this control plane node In HA setups, this differs from ClusterConfiguration.ControlPlaneEndpoint in the sense that ControlPlaneEndpoint is the global endpoint for the cluster, which then loadbalances the requests to each individual API server. This configuration object lets you customize what IP/DNS name and port the local API server advertises it’s accessible on. By default, kubeadm tries to auto-detect the IP of the default interface and use that, but in case that process fails you may set the desired value here.

.spec.initConfiguration.localAPIEndpoint.advertiseAddress

string

AdvertiseAddress sets the IP address for the API server to advertise.

.spec.initConfiguration.localAPIEndpoint.bindPort

integer

BindPort sets the secure port for the API Server to bind to. Defaults to 6443.

.spec.initConfiguration.nodeRegistration

object

NodeRegistration holds fields that relate to registering the new control-plane node to the cluster. When used in the context of control plane nodes, NodeRegistration should remain consistent across both InitConfiguration and JoinConfiguration

.spec.initConfiguration.nodeRegistration.criSocket

string

CRISocket is used to retrieve container runtime info. This information will be annotated to the Node API object, for later re-use

.spec.initConfiguration.nodeRegistration.ignorePreflightErrors

array

IgnorePreflightErrors provides a slice of pre-flight errors to be ignored when the current node is registered.

.spec.initConfiguration.nodeRegistration.ignorePreflightErrors[*]

string

.spec.initConfiguration.nodeRegistration.kubeletExtraArgs

object

KubeletExtraArgs passes through extra arguments to the kubelet. The arguments here are passed to the kubelet command line via the environment file kubeadm writes at runtime for the kubelet to source. This overrides the generic base-level configuration in the kubelet-config-1.X ConfigMap Flags have higher priority when parsing. These values are local and specific to the node kubeadm is executing on.

.spec.initConfiguration.nodeRegistration.name

string

Name is the .Metadata.Name field of the Node API object that will be created in this kubeadm init or kubeadm join operation. This field is also used in the CommonName field of the kubelet’s client certificate to the API server. Defaults to the hostname of the node if not provided.

.spec.initConfiguration.nodeRegistration.taints

array

Taints specifies the taints the Node API object should be registered with. If this field is unset, i.e. nil, in the kubeadm init process it will be defaulted to []v1.Taint{‘node-role.kubernetes.io/master=“”’}. If you don’t want to taint your control-plane node, set this field to an empty slice, i.e. taints: {} in the YAML file. This field is solely used for Node registration.

.spec.initConfiguration.nodeRegistration.taints[*]

object

The node this Taint is attached to has the “effect” on any pod that does not tolerate the Taint.

.spec.initConfiguration.nodeRegistration.taints[*].effect

string Required

Required. The effect of the taint on pods that do not tolerate the taint. Valid effects are NoSchedule, PreferNoSchedule and NoExecute.

.spec.initConfiguration.nodeRegistration.taints[*].key

string Required

Required. The taint key to be applied to a node.

.spec.initConfiguration.nodeRegistration.taints[*].timeAdded

string

TimeAdded represents the time at which the taint was added. It is only written for NoExecute taints.

.spec.initConfiguration.nodeRegistration.taints[*].value

string

The taint value corresponding to the taint key.

.spec.joinConfiguration

object

JoinConfiguration is the kubeadm configuration for the join command

.spec.joinConfiguration.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

.spec.joinConfiguration.caCertPath

string

CACertPath is the path to the SSL certificate authority used to secure comunications between node and control-plane. Defaults to “/etc/kubernetes/pki/ca.crt”. TODO: revisit when there is defaulting from k/k

.spec.joinConfiguration.controlPlane

object

ControlPlane defines the additional control plane instance to be deployed on the joining node. If nil, no additional control plane instance will be deployed.

.spec.joinConfiguration.controlPlane.localAPIEndpoint

object

LocalAPIEndpoint represents the endpoint of the API server instance to be deployed on this node.

.spec.joinConfiguration.controlPlane.localAPIEndpoint.advertiseAddress

string

AdvertiseAddress sets the IP address for the API server to advertise.

.spec.joinConfiguration.controlPlane.localAPIEndpoint.bindPort

integer

BindPort sets the secure port for the API Server to bind to. Defaults to 6443.

.spec.joinConfiguration.discovery

object

Discovery specifies the options for the kubelet to use during the TLS Bootstrap process TODO: revisit when there is defaulting from k/k

.spec.joinConfiguration.discovery.bootstrapToken

object

BootstrapToken is used to set the options for bootstrap token based discovery BootstrapToken and File are mutually exclusive

.spec.joinConfiguration.discovery.bootstrapToken.apiServerEndpoint

string

APIServerEndpoint is an IP or domain name to the API server from which info will be fetched.

.spec.joinConfiguration.discovery.bootstrapToken.caCertHashes

array

CACertHashes specifies a set of public key pins to verify when token-based discovery is used. The root CA found during discovery must match one of these values. Specifying an empty set disables root CA pinning, which can be unsafe. Each hash is specified as “:”, where the only currently supported type is “sha256”. This is a hex-encoded SHA-256 hash of the Subject Public Key Info (SPKI) object in DER-encoded ASN.1. These hashes can be calculated using, for example, OpenSSL: openssl x509 -pubkey -in ca.crt openssl rsa -pubin -outform der 2>&/dev/null | openssl dgst -sha256 -hex

.spec.joinConfiguration.discovery.bootstrapToken.caCertHashes[*]

string

.spec.joinConfiguration.discovery.bootstrapToken.token

string Required

Token is a token used to validate cluster information fetched from the control-plane.

.spec.joinConfiguration.discovery.bootstrapToken.unsafeSkipCAVerification

boolean

UnsafeSkipCAVerification allows token-based discovery without CA verification via CACertHashes. This can weaken the security of kubeadm since other nodes can impersonate the control-plane.

.spec.joinConfiguration.discovery.file

object

File is used to specify a file or URL to a kubeconfig file from which to load cluster information BootstrapToken and File are mutually exclusive

.spec.joinConfiguration.discovery.file.kubeConfigPath

string Required

KubeConfigPath is used to specify the actual file path or URL to the kubeconfig file from which to load cluster information

.spec.joinConfiguration.discovery.timeout

string

Timeout modifies the discovery timeout

.spec.joinConfiguration.discovery.tlsBootstrapToken

string

TLSBootstrapToken is a token used for TLS bootstrapping. If .BootstrapToken is set, this field is defaulted to .BootstrapToken.Token, but can be overridden. If .File is set, this field must be set in case the KubeConfigFile does not contain any other authentication information

.spec.joinConfiguration.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

.spec.joinConfiguration.nodeRegistration

object

NodeRegistration holds fields that relate to registering the new control-plane node to the cluster. When used in the context of control plane nodes, NodeRegistration should remain consistent across both InitConfiguration and JoinConfiguration

.spec.joinConfiguration.nodeRegistration.criSocket

string

CRISocket is used to retrieve container runtime info. This information will be annotated to the Node API object, for later re-use

.spec.joinConfiguration.nodeRegistration.ignorePreflightErrors

array

IgnorePreflightErrors provides a slice of pre-flight errors to be ignored when the current node is registered.

.spec.joinConfiguration.nodeRegistration.ignorePreflightErrors[*]

string

.spec.joinConfiguration.nodeRegistration.kubeletExtraArgs

object

KubeletExtraArgs passes through extra arguments to the kubelet. The arguments here are passed to the kubelet command line via the environment file kubeadm writes at runtime for the kubelet to source. This overrides the generic base-level configuration in the kubelet-config-1.X ConfigMap Flags have higher priority when parsing. These values are local and specific to the node kubeadm is executing on.

.spec.joinConfiguration.nodeRegistration.name

string

Name is the .Metadata.Name field of the Node API object that will be created in this kubeadm init or kubeadm join operation. This field is also used in the CommonName field of the kubelet’s client certificate to the API server. Defaults to the hostname of the node if not provided.

.spec.joinConfiguration.nodeRegistration.taints

array

Taints specifies the taints the Node API object should be registered with. If this field is unset, i.e. nil, in the kubeadm init process it will be defaulted to []v1.Taint{‘node-role.kubernetes.io/master=“”’}. If you don’t want to taint your control-plane node, set this field to an empty slice, i.e. taints: {} in the YAML file. This field is solely used for Node registration.

.spec.joinConfiguration.nodeRegistration.taints[*]

object

The node this Taint is attached to has the “effect” on any pod that does not tolerate the Taint.

.spec.joinConfiguration.nodeRegistration.taints[*].effect

string Required

Required. The effect of the taint on pods that do not tolerate the taint. Valid effects are NoSchedule, PreferNoSchedule and NoExecute.

.spec.joinConfiguration.nodeRegistration.taints[*].key

string Required

Required. The taint key to be applied to a node.

.spec.joinConfiguration.nodeRegistration.taints[*].timeAdded

string

TimeAdded represents the time at which the taint was added. It is only written for NoExecute taints.

.spec.joinConfiguration.nodeRegistration.taints[*].value

string

The taint value corresponding to the taint key.

.spec.mounts

array

Mounts specifies a list of mount points to be setup.

.spec.mounts[*]

array

MountPoints defines input for generated mounts in cloud-init.

.spec.ntp

object

NTP specifies NTP configuration

.spec.ntp.enabled

boolean

Enabled specifies whether NTP should be enabled

.spec.ntp.servers

array

Servers specifies which NTP servers to use

.spec.ntp.servers[*]

string

.spec.postKubeadmCommands

array

PostKubeadmCommands specifies extra commands to run after kubeadm runs

.spec.postKubeadmCommands[*]

string

.spec.preKubeadmCommands

array

PreKubeadmCommands specifies extra commands to run before kubeadm runs

.spec.preKubeadmCommands[*]

string

.spec.useExperimentalRetryJoin

boolean

UseExperimentalRetryJoin replaces a basic kubeadm command with a shell script with retries for joins. This is meant to be an experimental temporary workaround on some environments where joins fail due to timing (and other issues). The long term goal is to add retries to kubeadm proper and use that functionality. This will add about 40KB to userdata For more information, refer to https://github.com/kubernetes-sigs/cluster-api/pull/2763#discussion_r397306055.

.spec.users

array

Users specifies extra users to add

.spec.users[*]

object

User defines the input for a generated user in cloud-init.

.spec.users[*].gecos

string

Gecos specifies the gecos to use for the user

.spec.users[*].groups

string

Groups specifies the additional groups for the user

.spec.users[*].homeDir

string

HomeDir specifies the home directory to use for the user

.spec.users[*].inactive

boolean

Inactive specifies whether to mark the user as inactive

.spec.users[*].lockPassword

boolean

LockPassword specifies if password login should be disabled

.spec.users[*].name

string Required

Name specifies the user name

.spec.users[*].passwd

string

Passwd specifies a hashed password for the user

.spec.users[*].primaryGroup

string

PrimaryGroup specifies the primary group for the user

.spec.users[*].shell

string

Shell specifies the user’s shell

.spec.users[*].sshAuthorizedKeys

array

SSHAuthorizedKeys specifies a list of ssh authorized keys for the user

.spec.users[*].sshAuthorizedKeys[*]

string

.spec.users[*].sudo

string

Sudo specifies a sudo role for the user

.spec.verbosity

integer

Verbosity is the number for the kubeadm log level verbosity. It overrides the --v flag in kubeadm commands.

.status

object

KubeadmConfigStatus defines the observed state of KubeadmConfig.

.status.conditions

array

Conditions defines current service state of the KubeadmConfig.

.status.conditions[*]

object

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

.status.conditions[*].lastTransitionTime

string Required

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.

.status.conditions[*].message

string

A human readable message indicating details about the transition. This field may be empty.

.status.conditions[*].reason

string

The reason for the condition’s last transition in CamelCase. The specific API may choose whether or not this field is considered a guaranteed API. This field may not be empty.

.status.conditions[*].severity

string

Severity provides an explicit classification of Reason code, so the users or machines can immediately understand the current situation and act accordingly. The Severity field MUST be set only when Status=False.

.status.conditions[*].status

string Required

Status of the condition, one of True, False, Unknown.

.status.conditions[*].type

string Required

Type of condition in CamelCase or in foo.example.com/CamelCase. Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be useful (see .node.status.conditions), the ability to deconflict is important.

.status.dataSecretName

string

DataSecretName is the name of the secret that stores the bootstrap data script.

.status.failureMessage

string

FailureMessage will be set on non-retryable errors

.status.failureReason

string

FailureReason will be set on non-retryable errors

.status.observedGeneration

integer

ObservedGeneration is the latest generation observed by the controller.

.status.ready

boolean

Ready indicates the BootstrapData field is ready to be consumed


This documentation page shows information based on apiextensions v5.0.0.