kubernetes.adm.common role – Common Variables

Note

This role is part of the kubernetes.adm collection (version 1.0.0).

To install it use: ansible-galaxy collection install kubernetes.adm.

To use it in a playbook, specify: kubernetes.adm.common.

Entry point main – Common Variables

Synopsis

Parameters

Parameter

Comments

cluster_apiserver_port

string

The API server port (non-load-balanced).

Default: "6443"

cluster_dns_domain

string

The cluster domain name.

Default: "cluster.local"

cluster_name

string

The cluster name.

Default: "kubernetes"

cluster_pod_cidr

string / required

The Pod network CIDR.

cluster_service_cidr

string / required

The service network CIDR.

control_plane_endpoint

string / required

The control plane endpoint in the format ‘LOAD_BALANCER_DNS:LOAD_BALANCER_PORT’.

See kubeadm documentation for more information.

control_plane_hostgroup

string / required

Inventory group name with all the control plane nodes.

joined_control_plane_node

string

Some tasks require a control plane node to delegate to.

For example, joining a second control plane node, an existing control plane is needed to perform the join.

In such case, we use ‘joined_control_plane_node’ as the existing node.

Default: "First node in control_plane_hostgroup"

kubeadm_apiversion

string / required

The kubeadm configuration API version. For example ‘v1beta3’.

kubeadm_certSANs

list / elements=string

Add additional Subject Alternative Names (SANs) for the API server certificate.

Default: []

kubeadm_cluster_configuration

string

The kubeadm ClusterConfiguration object.

To override use kubeadm_cluster_configuration_override

kubeadm_cluster_configuration_override

string

Can be used to override part of the kubeadm_cluster_configuration object.

A simple merge using the combine filter.

kubeadm_config_path

string

Where to store the kubeadm config file.

Default: "/etc/kubernetes"

kubeadm_init_configuration

string

The kubeadm InitConfiguration object.

To override use kubeadm_init_configuration_override

kubeadm_init_configuration_override

string

Can be used to override part of the kubeadm_init_configuration object.

A simple merge using the combine filter.

kubeadm_join_configuration

string

The kubeadm JoinConfiguration object.

To override use kubeadm_join_configuration_override

kubeadm_join_configuration_override

string

Can be used to override part of the kubeadm_join_configuration object.

A simple merge using the combine filter.

kubeadm_kubelet_configuration

string

The kubeadm KubeletConfiguration object.

To override use kubeadm_kubelet_configuration_override

kubeadm_kubelet_configuration_override

string

Can be used to override part of the kubeadm_kubelet_configuration object.

A simple merge using the combine filter.

kubeadm_patches_directory

string

kubeadm components patches directory.

Default: "/etc/kubernetes/patches"

kubeadm_skip_phases

list / elements=string

List of kubeadm init phases that will be skipped.

Default: []

kubernetes_version

string / required

The Kubernetes version to install/upgrade.

node_hostname

string

To allow for a shorter inventory names, node_hostname can be used to transform the short inventory name to a FQDN.

Typically, it will be defined in terms of inventory_hostname.

For example, {{ node_hostname }}.example.com.

It’s REQUIRED that the hostname command outputs the same value as node_hostname and that DNS resolves it to the host’s IP.

Default: "inventory_hostname"