You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
File is a path to the CA bundle file, used as a replacement for Bundle
string
false
certificateValidityPeriod
CertificateValidityPeriod specifies the validity period for a non-CA certificate generated by kubeadm. Default value: 8760h (365 days * 24 hours = 1 year)
*metav1.Duration
false
caCertificateValidityPeriod
CACertificateValidityPeriod specifies the validity period for a CA certificate generated by kubeadm. Default value: 87600h (365 days * 24 hours * 10 = 10 years)
KubeProxyReplacement defines weather cilium relies on underlying Kernel support to replace kube-proxy functionality by eBPF (strict), or disables a subset of those features so cilium does not bail out if the kernel support is missing (disabled). default is "disabled"
KubeProxyReplacementType
true
enableHubble
EnableHubble to deploy Hubble relay and UI default value is false
bool
true
enableL2Announcements
EnableL2Announcements enables the Layer 2 announcement feature for the Cilium CNI plugin. If not set, Cilium will use its default behavior.
IPFamily allows specifying IP family of a cluster. Valid values are IPv4 | IPv6 | IPv4+IPv6 | IPv6+IPv4.
IPFamily
false
nodeCIDRMaskSizeIPv4
NodeCIDRMaskSizeIPv4 is the mask size used to address the nodes within provided IPv4 Pods CIDR. It has to be larger than the provided IPv4 Pods CIDR. Defaults to 24.
*int
false
nodeCIDRMaskSizeIPv6
NodeCIDRMaskSizeIPv6 is the mask size used to address the nodes within provided IPv6 Pods CIDR. It has to be larger than the provided IPv6 Pods CIDR. Defaults to 64.
*int
false
dnsServiceIP
DNSServiceIP is an optional override for the cluster DNS service IP. If not set, it defaults to the 10th IP of the serviceSubnet (e.g. 10.96.0.10 for 10.96.0.0/12). When nodeLocalDNS is enabled, OSM always uses the NodeLocalDNS virtual IP regardless of this field.
Flags is a set of additional flags that will be passed to the control plane component. KubeOne internally configures some flags that are eseeential for the cluster to work. Those flags set by KubeOne will be merged with the ones specified in the configuration. In case of conflict the value provided by the user will be used. Usage of feature-gates is not allowed here, use FeatureGates field instead. IMPORTANT: Use of these flags is at the user's own risk, as KubeOne does not provide support for issues caused by invalid values and configurations.
map[string]string
false
featureGates
FeatureGates is a map of additional feature gates that will be passed on to the control plane component. KubeOne internally configures some feature gates that are eseeential for the cluster to work. Those feature gates set by KubeOne will be merged with the ones specified in the configuration. In case of conflict the value provided by the user will be used. IMPORTANT: Use of these featureGates is at the user's own risk, as KubeOne does not provide support for issues caused by invalid values and configurations.
ImageRepository allows users to specify the image registry to be used for CoreDNS. Kubeadm automatically appends /coredns at the end, so it's not necessary to specify it. By default it's empty, which means it'll be defaulted based on kubeadm defaults and if overwriteRegistry feature is used. ImageRepository has the highest priority, meaning that it'll override overwriteRegistry if specified.
HelmValues configure inputs to helm upgrade --install command analog.
Field
Description
Scheme
Required
valuesFile
ValuesFile is an optional path on the local file system containing helm values to override. An analog of --values flag of the helm upgrade command.
string
false
inline
Inline is optionally used as a convenient way to provide short user input overrides to the helm upgrade process. Is written to a temporary file and used as an analog of the helm upgrade --values=/tmp/inline-helm-values-XXX command.
HostConfig describes a single control plane or worker node.
Field
Description
Scheme
Required
publicAddress
PublicAddress is externally accessible IP address from public internet.
string
true
ipv6Addresses
IPv6Addresses is IPv6 addresses of the node, only the first one will be announced to the k8s control plane. It is a list because you can request lots of IPv6 addresses (for example in case you want to assign one address per service).
[]string
true
privateAddress
PrivateAddress is internal RFC-1918 IP address.
string
true
sshPort
SSHPort is port to connect ssh to. Default value is 22.
int
false
sshUsername
SSHUsername is system login name. Default value is "root".
string
false
sshPrivateKeyFile
SSHPrivateKeyFile is path to the file with PRIVATE AND CLEANTEXT ssh key. Default value is "".
string
false
sshCertFile
SSHCertFile is path to the file with the certificate of the private key. Default value is "".
string
false
sshHostPublicKey
SSHHostPublicKey if not empty, will be used to verify remote host public key
[]byte
false
sshAgentSocket
SSHAgentSocket path (or reference to the environment) to the SSH agent unix domain socket. Default value is "env:SSH_AUTH_SOCK".
string
false
bastion
Bastion is an IP or hostname of the bastion (or jump) host to connect to. Default value is "".
string
false
bastionPort
BastionPort is SSH port to use when connecting to the bastion if it's configured in .Bastion. Default value is 22.
int
false
bastionUser
BastionUser is system login name to use when connecting to bastion host. Default value is "root".
string
false
bastionHostPublicKey
BastionHostPublicKey if not empty, will be used to verify bastion SSH public key
[]byte
false
bastionPrivateKeyFile
BastionPrivateKeyFile is path to the file with PRIVATE AND CLEANTEXT ssh key. Default value is "".
string
false
hostname
Hostname is the hostname(1) of the host. Default value is populated at the runtime via running hostname -f command over ssh.
string
false
isLeader
IsLeader indicates this host as a session leader. Default value is populated at the runtime.
bool
false
taints
Taints are taints applied to nodes. Those taints are only applied when the node is being provisioned. If not provided (i.e. nil) for control plane nodes, it defaults to TaintEffectNoSchedule with key\n node-role.kubernetes.io/control-plane\nExplicitly empty (i.e. []corev1.Taint{}) means no taints will be applied (this is default for worker nodes).
IPVSConfig contains different options to configure IPVS kube-proxy mode
Field
Description
Scheme
Required
scheduler
ipvs scheduler, if it’s not configured, then round-robin (rr) is the default value. Can be one of: * rr: round-robin * lc: least connection (smallest number of open connections) * dh: destination hashing * sh: source hashing * sed: shortest expected delay * nq: never queue
string
true
excludeCIDRs
excludeCIDRs is a list of CIDR's which the ipvs proxier should not touch when cleaning up ipvs services.
[]string
true
strictARP
strict ARP configure arp_ignore and arp_announce to avoid answering ARP queries from kube-ipvs0 interface
bool
true
tcpTimeout
tcpTimeout is the timeout value used for idle IPVS TCP sessions. The default value is 0, which preserves the current timeout value on the system.
metav1.Duration
true
tcpFinTimeout
tcpFinTimeout is the timeout value used for IPVS TCP sessions after receiving a FIN. The default value is 0, which preserves the current timeout value on the system.
metav1.Duration
true
udpTimeout
udpTimeout is the timeout value used for IPVS UDP packets. The default value is 0, which preserves the current timeout value on the system.
HelmReleases configure helm charts to reconcile. For each HelmRelease it will run analog of: helm upgrade --namespace <NAMESPACE> --install --create-namespace <RELEASE> <CHART> [--values=values-override.yaml]
MaxPods configures maximum number of pods per node. If not provided, default value provided by kubelet will be used (max. 110 pods per node)
*int32
false
imageGCHighThresholdPercent
ImageGCHighThresholdPercent is the percent of disk usage after which image garbage collection is always run. The percent is calculated by dividing this field value by 100, so this field must be between 0 and 100, inclusive. When specified, the value must be greater than imageGCLowThresholdPercent. Default: 85
*int32
false
imageGCLowThresholdPercent
ImageGCLowThresholdPercent is the percent of disk usage before which image garbage collection is never run. Lowest disk usage to garbage collect to. The percent is calculated by dividing this field value by 100, so the field value must be between 0 and 100, inclusive. When specified, the value must be less than imageGCHighThresholdPercent. Default: 80
*int32
false
imageMinimumGCAge
ImageMinimumGCAge is the minimum age for an unused image before it is garbage collected. Default: "2m"
metav1.Duration
false
imageMaximumGCAge
ImageMaximumGCAge is the maximum age an image can be unused before it is garbage collected. The default of this field is "0s", which disables this field--meaning images won't be garbage collected based on being unused for too long. Default: "0s" (disabled)
InfraNamespace is the namespace that KubeVirt provider will use to create and manage resources in the infra cluster, such as VirtualMachines, VirtualMachineInstances, etc...
string
true
zoneAndRegionEnabled
ZoneAndRegionEnabled indicates if need to get Region and zone labels from the cloud provider
bool
false
loadBalancerEnabled
LoadBalancerEnabled indicates if the ccm should create and manage the clusters load balancers.
Annotations set MachineDeployment.ObjectMeta.Annotations
map[string]string
false
machineAnnotations
This field is NOOP and is only provided for backward compatibility reasons\n\nDeprecated: Use NodeAnnotations instead.
map[string]string
false
nodeAnnotations
NodeAnnotations set MachineDeployment.Spec.Template.Spec.ObjectMeta.Annotations as a way to annotate resulting Nodes
map[string]string
false
machineObjectAnnotations
MachineObjectAnnotations set MachineDeployment.Spec.Template.Metadata.Annotations as a way to annotate resulting Machine objects. Those annotations are not propagated to Node objects. If you want to annotate resulting Nodes as well, see NodeAnnotations
RegistryConfiguration controls how images used for components deployed by
KubeOne and kubeadm are pulled from an image registry
Field
Description
Scheme
Required
overwriteRegistry
OverwriteRegistry specifies a custom Docker registry which will be used for all images required for KubeOne and kubeadm. This also applies to addons deployed by KubeOne. This field doesn't modify the user/organization part of the image. For example, if OverwriteRegistry is set to 127.0.0.1:5000/example, image called calico/cni would translate to 127.0.0.1:5000/example/calico/cni. Default: ""
string
false
insecureRegistry
InsecureRegistry configures Docker to threat the registry specified in OverwriteRegistry as an insecure registry. This is also propagated to the worker nodes managed by machine-controller and/or KubeOne.