1. Docs
  2. Reference
  3. Platform API
  4. Cluster app charts
  5. cluster

Last modified November 27, 2024

cluster chart reference

The cluster chart is the main entry point for the Giant Swarm platform. It is the first app that is installed on a new cluster. It is responsible for setting up the basic infrastructure and installing the necessary components to make the cluster operational.

Chart Configuration Reference

Components

Advanced configuration of components that are running on all nodes.

.global.components.containerd

Containerd
object 
Configuration of containerd.

.global.components.containerd.containerRegistries

Container registries
object 
Endpoints and credentials configuration for container registries.

.global.components.containerd.containerRegistries.*

Registries
array 
Container registries and mirrors

.global.components.containerd.containerRegistries.*[*]

Registry
object 

.global.components.containerd.containerRegistries.*[*].credentials

Credentials
object 

.global.components.containerd.containerRegistries.*[*].credentials.auth

Auth
string 
Base64-encoded string from the concatenation of the username, a colon, and the password.

.global.components.containerd.containerRegistries.*[*].credentials.identitytoken

Identity token
string 
Used to authenticate the user and obtain an access token for the registry.

.global.components.containerd.containerRegistries.*[*].credentials.password

Password
string 
Used to authenticate for the registry with username/password.

.global.components.containerd.containerRegistries.*[*].credentials.username

Username
string 
Used to authenticate for the registry with username/password.

.global.components.containerd.containerRegistries.*[*].endpoint

Endpoint
string 
Endpoint for the container registry.

Connectivity

Configuration of connectivity and networking options.

.global.connectivity.baseDomain

Base DNS domain
string 

.global.connectivity.bastion

Bastion host
object 

.global.connectivity.bastion.enabled

Enable
boolean 

.global.connectivity.bastion.replicas

Number of hosts
integer 

.global.connectivity.network

Network
object 

.global.connectivity.network.pods

Pods
object 

.global.connectivity.network.pods.cidrBlocks

Pod subnets
array 

.global.connectivity.network.pods.cidrBlocks[*]

Pod subnet
string 
IPv4 address range for pods, in CIDR notation.

.global.connectivity.network.services

Services
object 

.global.connectivity.network.services.cidrBlocks

Kubernetes Service subnets
array 

.global.connectivity.network.services.cidrBlocks[*]

Service subnet
string 
IPv4 address range for kubernetes services, in CIDR notation.

.global.connectivity.proxy

Proxy
object 
Whether/how outgoing traffic is routed through proxy servers.

.global.connectivity.proxy.enabled

Enable
boolean 

.global.connectivity.proxy.httpProxy

HTTP proxy
string 
To be passed to the HTTP_PROXY environment variable in all hosts.

.global.connectivity.proxy.httpsProxy

HTTPS proxy
string 
To be passed to the HTTPS_PROXY environment variable in all hosts.

.global.connectivity.proxy.noProxy

No proxy
string 
Comma-separated addresses to be passed to the NO_PROXY environment variable in all hosts.

Control plane

Configuration of the control plane.

.global.controlPlane.apiServerPort

API server port
integer 
The API server Load Balancer port. This option sets the Spec.ClusterNetwork.APIServerPort field on the Cluster CR. In CAPI this field isn't used currently. It is instead used in providers. In CAPA this sets only the public facing port of the Load Balancer. In CAPZ both the public facing and the destination port are set to this value. CAPV and CAPVCD do not use it.

.global.controlPlane.customNodeTaints

Custom node taints
array 

.global.controlPlane.customNodeTaints[*]

object 

.global.controlPlane.customNodeTaints[*].effect

Effect
string 

.global.controlPlane.customNodeTaints[*].key

Key
string 

.global.controlPlane.customNodeTaints[*].value

Value
string 

.global.controlPlane.machineHealthCheck

Machine health check
object 

.global.controlPlane.machineHealthCheck.enabled

Enable
boolean 

.global.controlPlane.machineHealthCheck.maxUnhealthy

Maximum unhealthy nodes
string 

.global.controlPlane.machineHealthCheck.nodeStartupTimeout

Node startup timeout
string 
Determines how long a machine health check should wait for a node to join the cluster, before considering a machine unhealthy.

.global.controlPlane.machineHealthCheck.unhealthyNotReadyTimeout

Timeout for ready
string 
If a node is not in condition 'Ready' after this timeout, it will be considered unhealthy.

.global.controlPlane.machineHealthCheck.unhealthyUnknownTimeout

Timeout for unknown condition
string 
If a node is in 'Unknown' condition after this timeout, it will be considered unhealthy.

.global.controlPlane.oidc

OIDC authentication
object 

.global.controlPlane.oidc.caPem

Certificate authority
string 
Identity provider's CA certificate in PEM format.

.global.controlPlane.oidc.clientId

Client ID
string 

.global.controlPlane.oidc.groupsClaim

Groups claim
string 

.global.controlPlane.oidc.issuerUrl

Issuer URL
string 
Exact issuer URL that will be included in identity tokens.

.global.controlPlane.oidc.usernameClaim

Username claim
string 

.global.controlPlane.replicas

Replicas
integer 
The number of control plane nodes.

Internal

For Giant Swarm internal use only, not stable, or not supported by UIs.

.internal.advancedConfiguration

Advanced configuration
object 
Advanced configuration of cluster components, to be configured by Giant Swarm staff only.

.internal.advancedConfiguration.cgroupsv1

CGroups v1
boolean 
Force use of CGroups v1 for whole cluster.

.internal.advancedConfiguration.controlPlane

Control plane
object 
Advanced configuration of control plane components.

.internal.advancedConfiguration.controlPlane.apiServer

API server
object 
Advanced configuration of API server.

.internal.advancedConfiguration.controlPlane.apiServer.bindPort

Bind port
integer 
Kubernetes API bind port used for API server pod.

.internal.advancedConfiguration.controlPlane.apiServer.etcdPrefix

etcd prefix
string 
The prefix to prepend to all resource paths in etcd. If nothing is specified, the API server uses '/registry' prefix by default.

.internal.advancedConfiguration.controlPlane.apiServer.extraArgs

Extra CLI args
object 
A map with the additional CLI flags that are appended to the default flags. Use with caution, as there is no validation for these values, so you can set incorrect or duplicate flags.

.internal.advancedConfiguration.controlPlane.apiServer.extraCertificateSANs

Extra certificate SANs
array 
The additional certificate SANs that are appended to the default SANs. Use with caution, as there is no validation for these values, so you can set incorrect or duplicate certificates.

.internal.advancedConfiguration.controlPlane.apiServer.extraCertificateSANs[*]

Extra certificate SAN
string 

.internal.advancedConfiguration.controlPlane.etcd

etcd
object 
Configuration of etcd

.internal.advancedConfiguration.controlPlane.etcd.experimental

Experimental
object 

.internal.advancedConfiguration.controlPlane.etcd.experimental.peerSkipClientSanVerification

Peer skip client SAN verification
boolean 
Skip verification of SAN field in client certificate for peer connections.

.internal.advancedConfiguration.controlPlane.etcd.extraArgs

Extra args
object 

.internal.advancedConfiguration.controlPlane.etcd.initialCluster

Initial cluster
string 
Initial cluster configuration for bootstrapping.

.internal.advancedConfiguration.controlPlane.etcd.initialClusterState

Initial cluster state
string 

.internal.advancedConfiguration.controlPlane.etcd.quotaBackendBytesGiB

Quota backend bytes in GiB
integer 
Raise the etcd default backend bytes limit up to 16GiB.

.internal.advancedConfiguration.controlPlane.files

Files
array 
Custom cluster-specific files that are deployed to control plane nodes.

.internal.advancedConfiguration.controlPlane.files[*]

File from secret
object 
It defines a file with content in a Secret

.internal.advancedConfiguration.controlPlane.files[*].contentFrom

Content from
object 
It specifies where the file content is coming from.

.internal.advancedConfiguration.controlPlane.files[*].contentFrom.secret

Secret
object 
Kubernetes Secret resource with the file content.

.internal.advancedConfiguration.controlPlane.files[*].contentFrom.secret.key

Key
string 
Secret key where the file content is.

.internal.advancedConfiguration.controlPlane.files[*].contentFrom.secret.name

Name
string 
Name of the Secret resource.

.internal.advancedConfiguration.controlPlane.files[*].path

Path
string 
File path on the node.

.internal.advancedConfiguration.controlPlane.files[*].permissions

Permissions
string 
File permissions in form 0644

.internal.advancedConfiguration.controlPlane.postKubeadmCommands

Post-kubeadm commands
array 
Extra commands to run after kubeadm runs.

.internal.advancedConfiguration.controlPlane.postKubeadmCommands[*]

string 

.internal.advancedConfiguration.controlPlane.preKubeadmCommands

Pre-kubeadm commands
array 
Extra commands to run before kubeadm runs.

.internal.advancedConfiguration.controlPlane.preKubeadmCommands[*]

string 

.internal.advancedConfiguration.files

Files
array 
Custom cluster-specific files that are deployed to all nodes.

.internal.advancedConfiguration.files[*]

File from secret
object 
It defines a file with content in a Secret

.internal.advancedConfiguration.files[*].contentFrom

Content from
object 
It specifies where the file content is coming from.

.internal.advancedConfiguration.files[*].contentFrom.secret

Secret
object 
Kubernetes Secret resource with the file content.

.internal.advancedConfiguration.files[*].contentFrom.secret.key

Key
string 
Secret key where the file content is.

.internal.advancedConfiguration.files[*].contentFrom.secret.name

Name
string 
Name of the Secret resource.

.internal.advancedConfiguration.files[*].path

Path
string 
File path on the node.

.internal.advancedConfiguration.files[*].permissions

Permissions
string 
File permissions in form 0644

.internal.advancedConfiguration.postKubeadmCommands

Post-kubeadm commands
array 
Extra commands to run after kubeadm runs.

.internal.advancedConfiguration.postKubeadmCommands[*]

string 

.internal.advancedConfiguration.preKubeadmCommands

Pre-kubeadm commands
array 
Extra commands to run before kubeadm runs.

.internal.advancedConfiguration.preKubeadmCommands[*]

string 

.internal.advancedConfiguration.workers

Workers
object 
Advanced configuration of worker nodes.

.internal.advancedConfiguration.workers.files

Files
array 
Custom cluster-specific files that are deployed to worker nodes.

.internal.advancedConfiguration.workers.files[*]

File from secret
object 
It defines a file with content in a Secret

.internal.advancedConfiguration.workers.files[*].contentFrom

Content from
object 
It specifies where the file content is coming from.

.internal.advancedConfiguration.workers.files[*].contentFrom.secret

Secret
object 
Kubernetes Secret resource with the file content.

.internal.advancedConfiguration.workers.files[*].contentFrom.secret.key

Key
string 
Secret key where the file content is.

.internal.advancedConfiguration.workers.files[*].contentFrom.secret.name

Name
string 
Name of the Secret resource.

.internal.advancedConfiguration.workers.files[*].path

Path
string 
File path on the node.

.internal.advancedConfiguration.workers.files[*].permissions

Permissions
string 
File permissions in form 0644

.internal.advancedConfiguration.workers.postKubeadmCommands

Post-kubeadm commands
array 
Extra commands to run after kubeadm runs.

.internal.advancedConfiguration.workers.postKubeadmCommands[*]

string 

.internal.advancedConfiguration.workers.preKubeadmCommands

Pre-kubeadm commands
array 
Extra commands to run before kubeadm runs.

.internal.advancedConfiguration.workers.preKubeadmCommands[*]

string 

Metadata

.global.metadata.annotations

Annotations
object 
These annotations are added to all Kubernetes resources defining this cluster.

.global.metadata.annotations.PATTERN

Annotation
string 

.global.metadata.description

Cluster description
string 
User-friendly description of the cluster's purpose.

.global.metadata.labels

Labels
object 
These labels are added to all Kubernetes resources defining this cluster.

.global.metadata.labels.PATTERN

Label
string 

.global.metadata.name

Cluster name
string 
Unique identifier, cannot be changed after creation.

.global.metadata.organization

Organization
string 
The name of organization that owns the cluster.

.global.metadata.preventDeletion

Prevent cluster deletion
boolean 
Setting this to true will set giantswarm.io/prevent-deletion label to true, which will block cluster deletion.

.global.metadata.servicePriority

Service priority
string 
The relative importance of this cluster.

Node pools

.global.nodePools.PATTERN

Node pool
object 

.global.nodePools.PATTERN.annotations

Annotations
object 
These annotations are added to all Kubernetes resources defining this node pool.

.global.nodePools.PATTERN.annotations.PATTERN_2

Annotation
string 

.global.nodePools.PATTERN.labels

Labels
object 
These labels are added to all Kubernetes resources defining this node pool.

.global.nodePools.PATTERN.labels.PATTERN_2

Label
string 

.global.nodePools.PATTERN.nodeLabels

Node labels
object 
Labels that are passed to kubelet argument 'node-labels'.

.global.nodePools.PATTERN.nodeLabels.*

string 

.global.nodePools.PATTERN.nodeTaints

Custom node taints
array 

.global.nodePools.PATTERN.nodeTaints[*]

object 

.global.nodePools.PATTERN.nodeTaints[*].effect

Effect
string 

.global.nodePools.PATTERN.nodeTaints[*].key

Key
string 

.global.nodePools.PATTERN.nodeTaints[*].value

Value
string 

.global.nodePools.PATTERN.replicas

Replicas
integer 
The number of node pool nodes.

Other global

.global.managementCluster

Management cluster
string 
Name of the Cluster API cluster managing this workload cluster.

Pod Security Standards

.global.podSecurityStandards.enforced

Enforced
boolean 

Provider integration

Provider-specific properties that can be set by cluster-$provider chart in order to render correct templates for the provider.

.providerIntegration.bastion

Internal bastion configuration
object 

.providerIntegration.bastion.kubeadmConfig

Kubeadm config
object 
Configuration of bastion nodes.

.providerIntegration.bastion.kubeadmConfig.ignition

Ignition
object 
Ignition-specific configuration.

.providerIntegration.bastion.kubeadmConfig.ignition.containerLinuxConfig

Container Linux configuration
object 

.providerIntegration.bastion.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig

Additional config
object 
Additional configuration to be merged with the Ignition. More info: https://coreos.github.io/ignition/operator-notes/#config-merging.

.providerIntegration.bastion.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.storage

Storage
object 
It describes the desired state of the system’s storage devices.

.providerIntegration.bastion.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.storage.directories

Directories
array 
The list of directories to be created.

.providerIntegration.bastion.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.storage.directories[*]

Directory
object 
The directory to be created.

.providerIntegration.bastion.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.storage.directories[*].filesystem

Filesystem
string 
The internal identifier of the filesystem in which to create the directory. This matches the last filesystem with the given identifier.

.providerIntegration.bastion.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.storage.directories[*].group

Group
object 
It specifies the group of the owner.

.providerIntegration.bastion.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.storage.directories[*].group.id

ID
integer 
The group ID of the owner.

.providerIntegration.bastion.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.storage.directories[*].group.name

Name
string 
The group name of the owner.

.providerIntegration.bastion.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.storage.directories[*].mode

Mode
integer 
The directory’s permission mode.

.providerIntegration.bastion.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.storage.directories[*].overwrite

Overwrite
boolean 
Whether to delete preexisting nodes at the path.

.providerIntegration.bastion.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.storage.directories[*].path

Path
string 
The absolute path to the directory.

.providerIntegration.bastion.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.storage.directories[*].user

User
object 
It specifies the directory’s owner.

.providerIntegration.bastion.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.storage.directories[*].user.id

ID
integer 
The user ID of the owner.

.providerIntegration.bastion.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.storage.directories[*].user.name

Name
string 
The user name of the owner.

.providerIntegration.bastion.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.storage.filesystems

File systems
array 
The list of filesystems to be configured and/or used in the “files” section. Either “mount” or “path” needs to be specified.

.providerIntegration.bastion.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.storage.filesystems[*]

File system
object 
The filesystem to be configured and/or used in the “files” section. Either “mount” or “path” needs to be specified.

.providerIntegration.bastion.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.storage.filesystems[*].mount

Mount
object 
It contains the set of mount and formatting options for the filesystem. A non-null entry indicates that the filesystem should be mounted before it is used by Ignition.

.providerIntegration.bastion.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.storage.filesystems[*].mount.device

Device
string 
The absolute path to the device. Devices are typically referenced by the "/dev/disk/by-*" symlinks.

.providerIntegration.bastion.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.storage.filesystems[*].mount.format

Format
string 
The filesystem format (ext4, btrfs, or xfs).

.providerIntegration.bastion.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.storage.filesystems[*].mount.label

Label
string 
The label of the filesystem.

.providerIntegration.bastion.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.storage.filesystems[*].mount.options

Options
array 
Any additional options to be passed to the format-specific mkfs utility.

.providerIntegration.bastion.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.storage.filesystems[*].mount.options[*]

string 
An additional option to be passed to the format-specific mkfs utility.

.providerIntegration.bastion.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.storage.filesystems[*].mount.uuid

UUID
string 
The uuid of the filesystem.

.providerIntegration.bastion.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.storage.filesystems[*].mount.wipeFilesystem

Wipe filesystem
boolean 
Whether or not to wipe the device before filesystem creation, see Ignition’s documentation on filesystems for more information https://github.com/coreos/ignition/blob/main/docs/operator-notes.md#filesystem-reuse-semantics.

.providerIntegration.bastion.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.storage.filesystems[*].name

Name
string 
The identifier for the filesystem, internal to Ignition. This is only required if the filesystem needs to be referenced in the “files” section.

.providerIntegration.bastion.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.storage.filesystems[*].path

Path
string 
The mount-point of the filesystem. A non-null entry indicates that the filesystem has already been mounted by the system at the specified path. This is really only useful for “/sysroot”.

.providerIntegration.bastion.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.systemd

systemd
object 
It describes the desired state of the systemd units.

.providerIntegration.bastion.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.systemd.units

Units
array 

.providerIntegration.bastion.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.systemd.units[*]

systemd unit
object 

.providerIntegration.bastion.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.systemd.units[*].contents

Contents
object 
The contents of the unit.

.providerIntegration.bastion.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.systemd.units[*].contents.install

Install
object 
Configuration of the [Install] section.

.providerIntegration.bastion.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.systemd.units[*].contents.install.wantedBy

WantedBy
array 
Units with (weak) requirement dependencies on this unit.

.providerIntegration.bastion.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.systemd.units[*].contents.install.wantedBy[*]

string 

.providerIntegration.bastion.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.systemd.units[*].contents.mount

Mount
object 
Configuration of the [Mount] section.

.providerIntegration.bastion.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.systemd.units[*].contents.mount.type

Type
string 
A file system type to mount.

.providerIntegration.bastion.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.systemd.units[*].contents.mount.what

What
string 
An absolute path of a device node, file or other resource to mount.

.providerIntegration.bastion.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.systemd.units[*].contents.mount.where

Where
string 
An absolute path of a file or directory for the mount point; in particular, the destination cannot be a symbolic link.

.providerIntegration.bastion.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.systemd.units[*].contents.unit

Unit
object 
Configuration of the [Unit] section.

.providerIntegration.bastion.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.systemd.units[*].contents.unit.defaultDependencies

DefaultDependencies
boolean 
Flag that indicates if this systemd unit should have the default systemd unit dependencies.

.providerIntegration.bastion.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.systemd.units[*].contents.unit.description

Description
string 
systemd unit description.

.providerIntegration.bastion.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.systemd.units[*].dropins

Unit drop-ins
array 
The list of drop-ins for the unit

.providerIntegration.bastion.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.systemd.units[*].dropins[*]

Unit drop-in
object 

.providerIntegration.bastion.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.systemd.units[*].dropins[*].contents

Contents
string 
The contents of the drop-in.

.providerIntegration.bastion.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.systemd.units[*].dropins[*].name

Name
string 
The name of the drop-in. This must be suffixed with “.conf”

.providerIntegration.bastion.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.systemd.units[*].enabled

Enabled?
boolean 
Whether or not the service shall be enabled. When true, the service is enabled. When false, the service is disabled. When omitted, the service is unmodified. In order for this to have any effect, the unit must have an install section.

.providerIntegration.bastion.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.systemd.units[*].mask

Masked?
boolean 
Whether or not the service shall be masked. When true, the service is masked by symlinking it to /dev/null.

.providerIntegration.bastion.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.systemd.units[*].name

Name
string 
The name of the unit. This must be suffixed with a valid unit type (e.g. “thing.service”).

.providerIntegration.bastion.kubeadmConfig.ignition.containerLinuxConfig.strict

Strict
boolean 
It controls if AdditionalConfig should be strictly parsed. If so, warnings are treated as errors.

.providerIntegration.bastion.kubeadmConfig.preKubeadmCommands

Pre-kubeadm commands
array 
Extra commands to run before kubeadm runs.

.providerIntegration.bastion.kubeadmConfig.preKubeadmCommands[*]

string 

.providerIntegration.clusterAnnotationsTemplateName

Cluster annotations template name
string 
The name of the template that renders provider-specific annotations for the Cluster resource

.providerIntegration.components

Components
object 
Internal configuration of various components that form the Kubernetes cluster.

.providerIntegration.components.containerd

Containerd
object 
Configuration of containerd.

.providerIntegration.components.containerd.sandboxContainerImage

Sandbox image
object 
The image used by sandbox / pause container

.providerIntegration.components.containerd.sandboxContainerImage.name

Repository
string 

.providerIntegration.components.containerd.sandboxContainerImage.registry

Registry
string 

.providerIntegration.components.containerd.sandboxContainerImage.tag

Tag
string 

.providerIntegration.components.systemd

systemd

.providerIntegration.connectivity

Connectivity
object 
Internal connectivity configuration.

.providerIntegration.connectivity.proxy

Proxy
object 
Whether/how outgoing traffic is routed through proxy servers.

.providerIntegration.connectivity.proxy.noProxy

No proxy
object 
To be passed to the NO_PROXY environment variable in all hosts.

.providerIntegration.connectivity.proxy.noProxy.templateName

Template name
string 
Name of Helm template that renders a YAML array with NO_PROXY addresses.

.providerIntegration.connectivity.proxy.noProxy.value

Value
array 
Pre-defined static NO_PROXY values.

.providerIntegration.connectivity.proxy.noProxy.value[*]

string 

.providerIntegration.connectivity.sshSsoPublicKey

SSH public key for single sign-on
string 

.providerIntegration.controlPlane

Provider-specific control plane configuration
object 

.providerIntegration.controlPlane.kubeadmConfig

Kubeadm config
object 
Configuration of control plane nodes.

.providerIntegration.controlPlane.kubeadmConfig.clusterConfiguration

Cluster configuration
object 
Configuration of Kubernetes components.

.providerIntegration.controlPlane.kubeadmConfig.clusterConfiguration.apiServer

API server
object 
Configuration of API server.

.providerIntegration.controlPlane.kubeadmConfig.clusterConfiguration.apiServer.additionalAdmissionPlugins

Additional admission plugins
array 
A list of plugins to enable, in addition to the default ones that include DefaultStorageClass, DefaultTolerationSeconds, LimitRanger, MutatingAdmissionWebhook, NamespaceLifecycle, PersistentVolumeClaimResize, Priority, ResourceQuota, ServiceAccount and ValidatingAdmissionWebhook.

.providerIntegration.controlPlane.kubeadmConfig.clusterConfiguration.apiServer.additionalAdmissionPlugins[*]

Additional admission plugin
string 

.providerIntegration.controlPlane.kubeadmConfig.clusterConfiguration.apiServer.apiAudiences

API audiences
Identifiers of the API. The service account token authenticator will validate that tokens used against the API are bound to at least one of these audiences. If the --service-account-issuer flag is configured and this flag is not, 'api-audiences' field defaults to a single element list containing the issuer URL.

.providerIntegration.controlPlane.kubeadmConfig.clusterConfiguration.apiServer.featureGates

Feature gates
array 

.providerIntegration.controlPlane.kubeadmConfig.clusterConfiguration.apiServer.featureGates[*]

Feature gate
object 

.providerIntegration.controlPlane.kubeadmConfig.clusterConfiguration.apiServer.featureGates[*].enabled

Enabled
boolean 

.providerIntegration.controlPlane.kubeadmConfig.clusterConfiguration.apiServer.featureGates[*].name

Name
string 

.providerIntegration.controlPlane.kubeadmConfig.clusterConfiguration.apiServer.serviceAccountIssuer

Service account issuer
Configuration of the identifier of the service account token issuer. You must specify either URL or clusterDomainPrefix (only one, not both).

.providerIntegration.controlPlane.kubeadmConfig.files

Files
array 
Provider-specific files that are deployed to control plane nodes. They are specified in the cluster- apps.

.providerIntegration.controlPlane.kubeadmConfig.files[*]

File from secret
object 
It defines a file with content in a Secret

.providerIntegration.controlPlane.kubeadmConfig.files[*].contentFrom

Content from
object 
It specifies where the file content is coming from.

.providerIntegration.controlPlane.kubeadmConfig.files[*].contentFrom.secret

Secret
object 
Kubernetes Secret resource with the file content.

.providerIntegration.controlPlane.kubeadmConfig.files[*].contentFrom.secret.key

Key
string 
Secret key where the file content is.

.providerIntegration.controlPlane.kubeadmConfig.files[*].contentFrom.secret.name

Name
string 
Name of the Secret resource.

.providerIntegration.controlPlane.kubeadmConfig.files[*].path

Path
string 
File path on the node.

.providerIntegration.controlPlane.kubeadmConfig.files[*].permissions

Permissions
string 
File permissions in form 0644

.providerIntegration.controlPlane.kubeadmConfig.ignition

Ignition
object 
Ignition-specific configuration.

.providerIntegration.controlPlane.kubeadmConfig.ignition.containerLinuxConfig

Container Linux configuration
object 

.providerIntegration.controlPlane.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig

Additional config
object 
Additional configuration to be merged with the Ignition. More info: https://coreos.github.io/ignition/operator-notes/#config-merging.

.providerIntegration.controlPlane.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.storage

Storage
object 
It describes the desired state of the system’s storage devices.

.providerIntegration.controlPlane.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.storage.directories

Directories
array 
The list of directories to be created.

.providerIntegration.controlPlane.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.storage.directories[*]

Directory
object 
The directory to be created.

.providerIntegration.controlPlane.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.storage.directories[*].filesystem

Filesystem
string 
The internal identifier of the filesystem in which to create the directory. This matches the last filesystem with the given identifier.

.providerIntegration.controlPlane.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.storage.directories[*].group

Group
object 
It specifies the group of the owner.

.providerIntegration.controlPlane.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.storage.directories[*].group.id

ID
integer 
The group ID of the owner.

.providerIntegration.controlPlane.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.storage.directories[*].group.name

Name
string 
The group name of the owner.

.providerIntegration.controlPlane.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.storage.directories[*].mode

Mode
integer 
The directory’s permission mode.

.providerIntegration.controlPlane.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.storage.directories[*].overwrite

Overwrite
boolean 
Whether to delete preexisting nodes at the path.

.providerIntegration.controlPlane.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.storage.directories[*].path

Path
string 
The absolute path to the directory.

.providerIntegration.controlPlane.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.storage.directories[*].user

User
object 
It specifies the directory’s owner.

.providerIntegration.controlPlane.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.storage.directories[*].user.id

ID
integer 
The user ID of the owner.

.providerIntegration.controlPlane.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.storage.directories[*].user.name

Name
string 
The user name of the owner.

.providerIntegration.controlPlane.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.storage.filesystems

File systems
array 
The list of filesystems to be configured and/or used in the “files” section. Either “mount” or “path” needs to be specified.

.providerIntegration.controlPlane.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.storage.filesystems[*]

File system
object 
The filesystem to be configured and/or used in the “files” section. Either “mount” or “path” needs to be specified.

.providerIntegration.controlPlane.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.storage.filesystems[*].mount

Mount
object 
It contains the set of mount and formatting options for the filesystem. A non-null entry indicates that the filesystem should be mounted before it is used by Ignition.

.providerIntegration.controlPlane.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.storage.filesystems[*].mount.device

Device
string 
The absolute path to the device. Devices are typically referenced by the "/dev/disk/by-*" symlinks.

.providerIntegration.controlPlane.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.storage.filesystems[*].mount.format

Format
string 
The filesystem format (ext4, btrfs, or xfs).

.providerIntegration.controlPlane.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.storage.filesystems[*].mount.label

Label
string 
The label of the filesystem.

.providerIntegration.controlPlane.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.storage.filesystems[*].mount.options

Options
array 
Any additional options to be passed to the format-specific mkfs utility.

.providerIntegration.controlPlane.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.storage.filesystems[*].mount.options[*]

string 
An additional option to be passed to the format-specific mkfs utility.

.providerIntegration.controlPlane.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.storage.filesystems[*].mount.uuid

UUID
string 
The uuid of the filesystem.

.providerIntegration.controlPlane.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.storage.filesystems[*].mount.wipeFilesystem

Wipe filesystem
boolean 
Whether or not to wipe the device before filesystem creation, see Ignition’s documentation on filesystems for more information https://github.com/coreos/ignition/blob/main/docs/operator-notes.md#filesystem-reuse-semantics.

.providerIntegration.controlPlane.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.storage.filesystems[*].name

Name
string 
The identifier for the filesystem, internal to Ignition. This is only required if the filesystem needs to be referenced in the “files” section.

.providerIntegration.controlPlane.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.storage.filesystems[*].path

Path
string 
The mount-point of the filesystem. A non-null entry indicates that the filesystem has already been mounted by the system at the specified path. This is really only useful for “/sysroot”.

.providerIntegration.controlPlane.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.systemd

systemd
object 
It describes the desired state of the systemd units.

.providerIntegration.controlPlane.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.systemd.units

Units
array 

.providerIntegration.controlPlane.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.systemd.units[*]

systemd unit
object 

.providerIntegration.controlPlane.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.systemd.units[*].contents

Contents
object 
The contents of the unit.

.providerIntegration.controlPlane.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.systemd.units[*].contents.install

Install
object 
Configuration of the [Install] section.

.providerIntegration.controlPlane.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.systemd.units[*].contents.install.wantedBy

WantedBy
array 
Units with (weak) requirement dependencies on this unit.

.providerIntegration.controlPlane.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.systemd.units[*].contents.install.wantedBy[*]

string 

.providerIntegration.controlPlane.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.systemd.units[*].contents.mount

Mount
object 
Configuration of the [Mount] section.

.providerIntegration.controlPlane.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.systemd.units[*].contents.mount.type

Type
string 
A file system type to mount.

.providerIntegration.controlPlane.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.systemd.units[*].contents.mount.what

What
string 
An absolute path of a device node, file or other resource to mount.

.providerIntegration.controlPlane.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.systemd.units[*].contents.mount.where

Where
string 
An absolute path of a file or directory for the mount point; in particular, the destination cannot be a symbolic link.

.providerIntegration.controlPlane.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.systemd.units[*].contents.unit

Unit
object 
Configuration of the [Unit] section.

.providerIntegration.controlPlane.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.systemd.units[*].contents.unit.defaultDependencies

DefaultDependencies
boolean 
Flag that indicates if this systemd unit should have the default systemd unit dependencies.

.providerIntegration.controlPlane.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.systemd.units[*].contents.unit.description

Description
string 
systemd unit description.

.providerIntegration.controlPlane.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.systemd.units[*].dropins

Unit drop-ins
array 
The list of drop-ins for the unit

.providerIntegration.controlPlane.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.systemd.units[*].dropins[*]

Unit drop-in
object 

.providerIntegration.controlPlane.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.systemd.units[*].dropins[*].contents

Contents
string 
The contents of the drop-in.

.providerIntegration.controlPlane.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.systemd.units[*].dropins[*].name

Name
string 
The name of the drop-in. This must be suffixed with “.conf”

.providerIntegration.controlPlane.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.systemd.units[*].enabled

Enabled?
boolean 
Whether or not the service shall be enabled. When true, the service is enabled. When false, the service is disabled. When omitted, the service is unmodified. In order for this to have any effect, the unit must have an install section.

.providerIntegration.controlPlane.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.systemd.units[*].mask

Masked?
boolean 
Whether or not the service shall be masked. When true, the service is masked by symlinking it to /dev/null.

.providerIntegration.controlPlane.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.systemd.units[*].name

Name
string 
The name of the unit. This must be suffixed with a valid unit type (e.g. “thing.service”).

.providerIntegration.controlPlane.kubeadmConfig.ignition.containerLinuxConfig.strict

Strict
boolean 
It controls if AdditionalConfig should be strictly parsed. If so, warnings are treated as errors.

.providerIntegration.controlPlane.kubeadmConfig.postKubeadmCommands

Post-kubeadm commands
array 
Extra commands to run after kubeadm runs.

.providerIntegration.controlPlane.kubeadmConfig.postKubeadmCommands[*]

string 

.providerIntegration.controlPlane.kubeadmConfig.preKubeadmCommands

Pre-kubeadm commands
array 
Extra commands to run before kubeadm runs.

.providerIntegration.controlPlane.kubeadmConfig.preKubeadmCommands[*]

string 

.providerIntegration.controlPlane.resources

Resources configuration
object 
GVK and other configuration for control plane resources.

.providerIntegration.controlPlane.resources.controlPlane

Control plane resource config
object 

.providerIntegration.controlPlane.resources.controlPlane.api

Schema for Kubernetes API group, version and kind
object 
It can be used to specify which CustomResourceDefinition is used.

.providerIntegration.controlPlane.resources.controlPlane.api.group

API group
string 

.providerIntegration.controlPlane.resources.controlPlane.api.kind

API kind
string 

.providerIntegration.controlPlane.resources.controlPlane.api.version

API version
string 

.providerIntegration.controlPlane.resources.infrastructureMachineTemplate

Infrastructure Machine template
object 
Group, version and kind of provider-specific infrastructure Machine template resource.

.providerIntegration.controlPlane.resources.infrastructureMachineTemplate.group

API group
string 

.providerIntegration.controlPlane.resources.infrastructureMachineTemplate.kind

API kind
string 

.providerIntegration.controlPlane.resources.infrastructureMachineTemplate.version

API version
string 

.providerIntegration.controlPlane.resources.infrastructureMachineTemplateSpecTemplateName

Infrastructure Machine template spec template name
string 
The name of Helm template that renders Infrastructure Machine template spec.

.providerIntegration.hashSalt

Hash salt
string 
If specified, this token is used as a salt to the hash suffix of some resource names. Can be used to force-recreate some resources.

.providerIntegration.kubeadmConfig

Provider-specific kubeadm config
object 
Provider-specific kubeadm config that is common for all nodes, including both control plane and workers.

.providerIntegration.kubeadmConfig.files

Files
array 
Provider-specific files that are deployed to all nodes. They are specified in the cluster- apps.

.providerIntegration.kubeadmConfig.files[*]

File from secret
object 
It defines a file with content in a Secret

.providerIntegration.kubeadmConfig.files[*].contentFrom

Content from
object 
It specifies where the file content is coming from.

.providerIntegration.kubeadmConfig.files[*].contentFrom.secret

Secret
object 
Kubernetes Secret resource with the file content.

.providerIntegration.kubeadmConfig.files[*].contentFrom.secret.key

Key
string 
Secret key where the file content is.

.providerIntegration.kubeadmConfig.files[*].contentFrom.secret.name

Name
string 
Name of the Secret resource.

.providerIntegration.kubeadmConfig.files[*].path

Path
string 
File path on the node.

.providerIntegration.kubeadmConfig.files[*].permissions

Permissions
string 
File permissions in form 0644

.providerIntegration.kubeadmConfig.ignition

Ignition
object 
Ignition-specific configuration.

.providerIntegration.kubeadmConfig.ignition.containerLinuxConfig

Container Linux configuration
object 

.providerIntegration.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig

Additional config
object 
Additional configuration to be merged with the Ignition. More info: https://coreos.github.io/ignition/operator-notes/#config-merging.

.providerIntegration.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.storage

Storage
object 
It describes the desired state of the system’s storage devices.

.providerIntegration.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.storage.directories

Directories
array 
The list of directories to be created.

.providerIntegration.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.storage.directories[*]

Directory
object 
The directory to be created.

.providerIntegration.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.storage.directories[*].filesystem

Filesystem
string 
The internal identifier of the filesystem in which to create the directory. This matches the last filesystem with the given identifier.

.providerIntegration.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.storage.directories[*].group

Group
object 
It specifies the group of the owner.

.providerIntegration.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.storage.directories[*].group.id

ID
integer 
The group ID of the owner.

.providerIntegration.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.storage.directories[*].group.name

Name
string 
The group name of the owner.

.providerIntegration.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.storage.directories[*].mode

Mode
integer 
The directory’s permission mode.

.providerIntegration.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.storage.directories[*].overwrite

Overwrite
boolean 
Whether to delete preexisting nodes at the path.

.providerIntegration.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.storage.directories[*].path

Path
string 
The absolute path to the directory.

.providerIntegration.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.storage.directories[*].user

User
object 
It specifies the directory’s owner.

.providerIntegration.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.storage.directories[*].user.id

ID
integer 
The user ID of the owner.

.providerIntegration.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.storage.directories[*].user.name

Name
string 
The user name of the owner.

.providerIntegration.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.storage.filesystems

File systems
array 
The list of filesystems to be configured and/or used in the “files” section. Either “mount” or “path” needs to be specified.

.providerIntegration.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.storage.filesystems[*]

File system
object 
The filesystem to be configured and/or used in the “files” section. Either “mount” or “path” needs to be specified.

.providerIntegration.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.storage.filesystems[*].mount

Mount
object 
It contains the set of mount and formatting options for the filesystem. A non-null entry indicates that the filesystem should be mounted before it is used by Ignition.

.providerIntegration.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.storage.filesystems[*].mount.device

Device
string 
The absolute path to the device. Devices are typically referenced by the "/dev/disk/by-*" symlinks.

.providerIntegration.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.storage.filesystems[*].mount.format

Format
string 
The filesystem format (ext4, btrfs, or xfs).

.providerIntegration.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.storage.filesystems[*].mount.label

Label
string 
The label of the filesystem.

.providerIntegration.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.storage.filesystems[*].mount.options

Options
array 
Any additional options to be passed to the format-specific mkfs utility.

.providerIntegration.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.storage.filesystems[*].mount.options[*]

string 
An additional option to be passed to the format-specific mkfs utility.

.providerIntegration.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.storage.filesystems[*].mount.uuid

UUID
string 
The uuid of the filesystem.

.providerIntegration.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.storage.filesystems[*].mount.wipeFilesystem

Wipe filesystem
boolean 
Whether or not to wipe the device before filesystem creation, see Ignition’s documentation on filesystems for more information https://github.com/coreos/ignition/blob/main/docs/operator-notes.md#filesystem-reuse-semantics.

.providerIntegration.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.storage.filesystems[*].name

Name
string 
The identifier for the filesystem, internal to Ignition. This is only required if the filesystem needs to be referenced in the “files” section.

.providerIntegration.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.storage.filesystems[*].path

Path
string 
The mount-point of the filesystem. A non-null entry indicates that the filesystem has already been mounted by the system at the specified path. This is really only useful for “/sysroot”.

.providerIntegration.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.systemd

systemd
object 
It describes the desired state of the systemd units.

.providerIntegration.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.systemd.units

Units
array 

.providerIntegration.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.systemd.units[*]

systemd unit
object 

.providerIntegration.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.systemd.units[*].contents

Contents
object 
The contents of the unit.

.providerIntegration.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.systemd.units[*].contents.install

Install
object 
Configuration of the [Install] section.

.providerIntegration.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.systemd.units[*].contents.install.wantedBy

WantedBy
array 
Units with (weak) requirement dependencies on this unit.

.providerIntegration.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.systemd.units[*].contents.install.wantedBy[*]

string 

.providerIntegration.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.systemd.units[*].contents.mount

Mount
object 
Configuration of the [Mount] section.

.providerIntegration.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.systemd.units[*].contents.mount.type

Type
string 
A file system type to mount.

.providerIntegration.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.systemd.units[*].contents.mount.what

What
string 
An absolute path of a device node, file or other resource to mount.

.providerIntegration.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.systemd.units[*].contents.mount.where

Where
string 
An absolute path of a file or directory for the mount point; in particular, the destination cannot be a symbolic link.

.providerIntegration.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.systemd.units[*].contents.unit

Unit
object 
Configuration of the [Unit] section.

.providerIntegration.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.systemd.units[*].contents.unit.defaultDependencies

DefaultDependencies
boolean 
Flag that indicates if this systemd unit should have the default systemd unit dependencies.

.providerIntegration.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.systemd.units[*].contents.unit.description

Description
string 
systemd unit description.

.providerIntegration.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.systemd.units[*].dropins

Unit drop-ins
array 
The list of drop-ins for the unit

.providerIntegration.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.systemd.units[*].dropins[*]

Unit drop-in
object 

.providerIntegration.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.systemd.units[*].dropins[*].contents

Contents
string 
The contents of the drop-in.

.providerIntegration.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.systemd.units[*].dropins[*].name

Name
string 
The name of the drop-in. This must be suffixed with “.conf”

.providerIntegration.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.systemd.units[*].enabled

Enabled?
boolean 
Whether or not the service shall be enabled. When true, the service is enabled. When false, the service is disabled. When omitted, the service is unmodified. In order for this to have any effect, the unit must have an install section.

.providerIntegration.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.systemd.units[*].mask

Masked?
boolean 
Whether or not the service shall be masked. When true, the service is masked by symlinking it to /dev/null.

.providerIntegration.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.systemd.units[*].name

Name
string 
The name of the unit. This must be suffixed with a valid unit type (e.g. “thing.service”).

.providerIntegration.kubeadmConfig.ignition.containerLinuxConfig.strict

Strict
boolean 
It controls if AdditionalConfig should be strictly parsed. If so, warnings are treated as errors.

.providerIntegration.kubeadmConfig.postKubeadmCommands

Post-kubeadm commands
array 
Extra commands to run after kubeadm runs.

.providerIntegration.kubeadmConfig.postKubeadmCommands[*]

string 

.providerIntegration.kubeadmConfig.preKubeadmCommands

Pre-kubeadm commands
array 
Extra commands to run before kubeadm runs.

.providerIntegration.kubeadmConfig.preKubeadmCommands[*]

string 

.providerIntegration.kubernetesVersion

Kubernetes version
string 

.providerIntegration.pauseProperties

Pause properties
object 
A map of property names and their values that will affect setting pause annotation

.providerIntegration.pauseProperties.*

string, number, integer, boolean 

.providerIntegration.provider

Provider
string 
The name of the Cluster API provider. The name here must match the name of the provider in cluster- app name.

.providerIntegration.resourcesApi

Resources API
object 
Group, version and kind configuration that is required and used by a specific Cluster API provider.

.providerIntegration.resourcesApi.bastionResourceEnabled

Bastion resource enabled
boolean 
Flag that indicates if the Bastion resource is enabled and templated. This is meant only for the initial development purposes for the sake of incrementally integrating cluster chart into cluster-$provider apps.

.providerIntegration.resourcesApi.clusterResourceEnabled

Cluster resource enabled
boolean 
Flag that indicates if the Cluster resource is enabled and templated. This is meant only for the initial development purposes for the sake of incrementally integrating cluster chart into cluster-$provider apps.

.providerIntegration.resourcesApi.controlPlaneResourceEnabled

Control plane resource enabled
boolean 
Flag that indicates if the control plane resource is enabled and templated. This is meant only for the initial development purposes for the sake of incrementally integrating cluster chart into cluster-$provider apps.

.providerIntegration.resourcesApi.infrastructureCluster

Infrastructure cluster
object 
Group, version and kind of provider-specific infrastructure cluster resource.

.providerIntegration.resourcesApi.infrastructureCluster.group

API group
string 

.providerIntegration.resourcesApi.infrastructureCluster.kind

API kind
string 

.providerIntegration.resourcesApi.infrastructureCluster.version

API version
string 

.providerIntegration.resourcesApi.machineHealthCheckResourceEnabled

MachineHealthCheck resource enabled
boolean 
Flag that indicates if the MachineHealthCheck resource is enabled and templated. This is meant only for the initial development purposes for the sake of incrementally integrating cluster chart into cluster-$provider apps.

.providerIntegration.resourcesApi.machinePoolResourcesEnabled

Machine pool resources enabled
boolean 
Flag that indicates if the machine pool resources are enabled and templated. This is meant only for the initial development purposes for the sake of incrementally integrating cluster chart into cluster-$provider apps.

.providerIntegration.teleport

Teleport
object 

.providerIntegration.teleport.enabled

Enable teleport
boolean 

.providerIntegration.teleport.proxyAddr

Teleport proxy address
string 

.providerIntegration.teleport.version

Teleport version
string 

.providerIntegration.workers

Provider-specific workers configuration
object 

.providerIntegration.workers.kubeadmConfig

Kubeadm config
object 
Configuration of workers nodes.

.providerIntegration.workers.kubeadmConfig.files

Files
array 
Provider-specific files that are deployed to worker nodes. They are specified in the cluster- apps.

.providerIntegration.workers.kubeadmConfig.files[*]

File from secret
object 
It defines a file with content in a Secret

.providerIntegration.workers.kubeadmConfig.files[*].contentFrom

Content from
object 
It specifies where the file content is coming from.

.providerIntegration.workers.kubeadmConfig.files[*].contentFrom.secret

Secret
object 
Kubernetes Secret resource with the file content.

.providerIntegration.workers.kubeadmConfig.files[*].contentFrom.secret.key

Key
string 
Secret key where the file content is.

.providerIntegration.workers.kubeadmConfig.files[*].contentFrom.secret.name

Name
string 
Name of the Secret resource.

.providerIntegration.workers.kubeadmConfig.files[*].path

Path
string 
File path on the node.

.providerIntegration.workers.kubeadmConfig.files[*].permissions

Permissions
string 
File permissions in form 0644

.providerIntegration.workers.kubeadmConfig.ignition

Ignition
object 
Ignition-specific configuration.

.providerIntegration.workers.kubeadmConfig.ignition.containerLinuxConfig

Container Linux configuration
object 

.providerIntegration.workers.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig

Additional config
object 
Additional configuration to be merged with the Ignition. More info: https://coreos.github.io/ignition/operator-notes/#config-merging.

.providerIntegration.workers.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.storage

Storage
object 
It describes the desired state of the system’s storage devices.

.providerIntegration.workers.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.storage.directories

Directories
array 
The list of directories to be created.

.providerIntegration.workers.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.storage.directories[*]

Directory
object 
The directory to be created.

.providerIntegration.workers.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.storage.directories[*].filesystem

Filesystem
string 
The internal identifier of the filesystem in which to create the directory. This matches the last filesystem with the given identifier.

.providerIntegration.workers.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.storage.directories[*].group

Group
object 
It specifies the group of the owner.

.providerIntegration.workers.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.storage.directories[*].group.id

ID
integer 
The group ID of the owner.

.providerIntegration.workers.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.storage.directories[*].group.name

Name
string 
The group name of the owner.

.providerIntegration.workers.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.storage.directories[*].mode

Mode
integer 
The directory’s permission mode.

.providerIntegration.workers.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.storage.directories[*].overwrite

Overwrite
boolean 
Whether to delete preexisting nodes at the path.

.providerIntegration.workers.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.storage.directories[*].path

Path
string 
The absolute path to the directory.

.providerIntegration.workers.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.storage.directories[*].user

User
object 
It specifies the directory’s owner.

.providerIntegration.workers.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.storage.directories[*].user.id

ID
integer 
The user ID of the owner.

.providerIntegration.workers.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.storage.directories[*].user.name

Name
string 
The user name of the owner.

.providerIntegration.workers.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.storage.filesystems

File systems
array 
The list of filesystems to be configured and/or used in the “files” section. Either “mount” or “path” needs to be specified.

.providerIntegration.workers.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.storage.filesystems[*]

File system
object 
The filesystem to be configured and/or used in the “files” section. Either “mount” or “path” needs to be specified.

.providerIntegration.workers.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.storage.filesystems[*].mount

Mount
object 
It contains the set of mount and formatting options for the filesystem. A non-null entry indicates that the filesystem should be mounted before it is used by Ignition.

.providerIntegration.workers.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.storage.filesystems[*].mount.device

Device
string 
The absolute path to the device. Devices are typically referenced by the "/dev/disk/by-*" symlinks.

.providerIntegration.workers.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.storage.filesystems[*].mount.format

Format
string 
The filesystem format (ext4, btrfs, or xfs).

.providerIntegration.workers.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.storage.filesystems[*].mount.label

Label
string 
The label of the filesystem.

.providerIntegration.workers.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.storage.filesystems[*].mount.options

Options
array 
Any additional options to be passed to the format-specific mkfs utility.

.providerIntegration.workers.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.storage.filesystems[*].mount.options[*]

string 
An additional option to be passed to the format-specific mkfs utility.

.providerIntegration.workers.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.storage.filesystems[*].mount.uuid

UUID
string 
The uuid of the filesystem.

.providerIntegration.workers.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.storage.filesystems[*].mount.wipeFilesystem

Wipe filesystem
boolean 
Whether or not to wipe the device before filesystem creation, see Ignition’s documentation on filesystems for more information https://github.com/coreos/ignition/blob/main/docs/operator-notes.md#filesystem-reuse-semantics.

.providerIntegration.workers.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.storage.filesystems[*].name

Name
string 
The identifier for the filesystem, internal to Ignition. This is only required if the filesystem needs to be referenced in the “files” section.

.providerIntegration.workers.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.storage.filesystems[*].path

Path
string 
The mount-point of the filesystem. A non-null entry indicates that the filesystem has already been mounted by the system at the specified path. This is really only useful for “/sysroot”.

.providerIntegration.workers.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.systemd

systemd
object 
It describes the desired state of the systemd units.

.providerIntegration.workers.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.systemd.units

Units
array 

.providerIntegration.workers.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.systemd.units[*]

systemd unit
object 

.providerIntegration.workers.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.systemd.units[*].contents

Contents
object 
The contents of the unit.

.providerIntegration.workers.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.systemd.units[*].contents.install

Install
object 
Configuration of the [Install] section.

.providerIntegration.workers.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.systemd.units[*].contents.install.wantedBy

WantedBy
array 
Units with (weak) requirement dependencies on this unit.

.providerIntegration.workers.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.systemd.units[*].contents.install.wantedBy[*]

string 

.providerIntegration.workers.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.systemd.units[*].contents.mount

Mount
object 
Configuration of the [Mount] section.

.providerIntegration.workers.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.systemd.units[*].contents.mount.type

Type
string 
A file system type to mount.

.providerIntegration.workers.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.systemd.units[*].contents.mount.what

What
string 
An absolute path of a device node, file or other resource to mount.

.providerIntegration.workers.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.systemd.units[*].contents.mount.where

Where
string 
An absolute path of a file or directory for the mount point; in particular, the destination cannot be a symbolic link.

.providerIntegration.workers.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.systemd.units[*].contents.unit

Unit
object 
Configuration of the [Unit] section.

.providerIntegration.workers.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.systemd.units[*].contents.unit.defaultDependencies

DefaultDependencies
boolean 
Flag that indicates if this systemd unit should have the default systemd unit dependencies.

.providerIntegration.workers.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.systemd.units[*].contents.unit.description

Description
string 
systemd unit description.

.providerIntegration.workers.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.systemd.units[*].dropins

Unit drop-ins
array 
The list of drop-ins for the unit

.providerIntegration.workers.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.systemd.units[*].dropins[*]

Unit drop-in
object 

.providerIntegration.workers.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.systemd.units[*].dropins[*].contents

Contents
string 
The contents of the drop-in.

.providerIntegration.workers.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.systemd.units[*].dropins[*].name

Name
string 
The name of the drop-in. This must be suffixed with “.conf”

.providerIntegration.workers.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.systemd.units[*].enabled

Enabled?
boolean 
Whether or not the service shall be enabled. When true, the service is enabled. When false, the service is disabled. When omitted, the service is unmodified. In order for this to have any effect, the unit must have an install section.

.providerIntegration.workers.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.systemd.units[*].mask

Masked?
boolean 
Whether or not the service shall be masked. When true, the service is masked by symlinking it to /dev/null.

.providerIntegration.workers.kubeadmConfig.ignition.containerLinuxConfig.additionalConfig.systemd.units[*].name

Name
string 
The name of the unit. This must be suffixed with a valid unit type (e.g. “thing.service”).

.providerIntegration.workers.kubeadmConfig.ignition.containerLinuxConfig.strict

Strict
boolean 
It controls if AdditionalConfig should be strictly parsed. If so, warnings are treated as errors.

.providerIntegration.workers.kubeadmConfig.postKubeadmCommands

Post-kubeadm commands
array 
Extra commands to run after kubeadm runs.

.providerIntegration.workers.kubeadmConfig.postKubeadmCommands[*]

string 

.providerIntegration.workers.kubeadmConfig.preKubeadmCommands

Pre-kubeadm commands
array 
Extra commands to run before kubeadm runs.

.providerIntegration.workers.kubeadmConfig.preKubeadmCommands[*]

string 

Further reading

This part of our documentation refers to our vintage product. The content may be not valid anymore for our current product. Please check our new documentation hub for the latest state of our docs.