plan-file-reference.md

Plan File Reference

Index

• cluster
  • name
  • admin_password
  • disable_package_installation
  • allow_package_installation (deprecated)
  • disconnected_installation
  • networking
    • type (deprecated)
    • pod_cidr_block
    • service_cidr_block
    • update_hosts_files
    • http_proxy
    • https_proxy
    • no_proxy
  • certificates
    • expiry
    • ca_expiry
  • ssh
    • user
    • ssh_key
    • ssh_port
  • kube_apiserver
    • option_overrides
  • kube_controller_manager
    • option_overrides
  • kube_scheduler
    • option_overrides
  • kube_proxy
    • option_overrides
  • kubelet
    • option_overrides
  • cloud_provider
    • provider
    • config
• docker
  • storage
    • direct_lvm
      • enabled
      • block_device
      • enable_deferred_deletion
• docker_registry
  • server
  • address (deprecated)
  • port (deprecated)
  • CA
  • username
  • password
• add_ons
  • cni
    • disable
    • provider
    • options
      • calico
        • mode
        • log_level
        • workload_mtu
        • felix_input_mtu
  • dns
    • disable
  • heapster
    • disable
    • options
      • heapster
        • replicas
        • service_type
        • sink
      • influxdb
        • pvc_name
      • heapster_replicas (deprecated)
      • influxdb_pvc_name (deprecated)
  • dashboard
    • disable
  • dashbard (deprecated)
    • disable
  • package_manager
    • disable
    • provider
  • rescheduler
    • disable
• features (deprecated)
  • package_manager (deprecated)
    • enabled (deprecated)
• etcd
  • expected_count
  • nodes
    • host
    • ip
    • internalip
    • labels
    • kubelet
      • option_overrides
• master
  • expected_count
  • load_balanced_fqdn
  • load_balanced_short_name
  • nodes
    • host
    • ip
    • internalip
    • labels
    • kubelet
      • option_overrides
• worker
  • expected_count
  • nodes
    • host
    • ip
    • internalip
    • labels
    • kubelet
      • option_overrides
• ingress
  • expected_count
  • nodes
    • host
    • ip
    • internalip
    • labels
    • kubelet
      • option_overrides
• storage
  • expected_count
  • nodes
    • host
    • ip
    • internalip
    • labels
    • kubelet
      • option_overrides
• nfs
  • nfs_volume
    • nfs_host
    • mount_path

cluster

Kubernetes cluster configuration

cluster.name

Name of the cluster to be used when generating assets that require a cluster name, such as kubeconfig files and certificates.

Kind	string
Required	Yes
Default

cluster.admin_password

The password for the admin user. This is mainly used to access the Kubernetes Dashboard.

Kind	string
Required	Yes
Default

cluster.disable_package_installation

Whether KET should install the packages on the cluster nodes. When true, KET will not install the required packages. Instead, it will verify that the packages have been installed by the operator.

Kind	bool
Required	No
Default	false

cluster.allow_package_installation (deprecated)

Whether KET should install the packages on the cluster nodes. Use DisablePackageInstallation instead.

Kind	bool
Required	No
Default	false

cluster.disconnected_installation

Whether the cluster nodes are disconnected from the internet. When set to true, internal package repositories and a container image registry are required for installation.

Kind	bool
Required	No
Default	false

cluster.networking

The Networking configuration for the cluster.

cluster.networking.type (deprecated)

The datapath technique that should be configured in Calico.

Kind	string
Required	No
Default	overlay
Options	overlay, routed

cluster.networking.pod_cidr_block

The pod network's CIDR block. For example: 172.16.0.0/16

Kind	string
Required	Yes
Default

cluster.networking.service_cidr_block

The Kubernetes service network's CIDR block. For example: 172.20.0.0/16

Kind	string
Required	Yes
Default

cluster.networking.update_hosts_files

Whether the /etc/hosts file should be updated on the cluster nodes. When set to true, KET will update the hosts file on all nodes to include entries for all other nodes in the cluster.

Kind	bool
Required	No
Default	false

cluster.networking.http_proxy

The URL of the proxy that should be used for HTTP connections.

Kind	string
Required	No
Default

cluster.networking.https_proxy

The URL of the proxy that should be used for HTTPS connections.

Kind	string
Required	No
Default

cluster.networking.no_proxy

Comma-separated list of host names and/or IPs for which connections should not go through a proxy. All nodes' 'host' and 'IPs' are always set.

Kind	string
Required	No
Default

cluster.certificates

The Certificates configuration for the cluster.

cluster.certificates.expiry

The length of time that the generated certificates should be valid for. For example: "17520h" for 2 years.

Kind	string
Required	Yes
Default

cluster.certificates.ca_expiry

The length of time that the generated Certificate Authority should be valid for. For example: "17520h" for 2 years.

Kind	string
Required	Yes
Default

cluster.ssh

The SSH configuration for the cluster nodes.

cluster.ssh.user

The user for accessing the cluster nodes via SSH. This user requires sudo elevation privileges on the cluster nodes.

Kind	string
Required	Yes
Default

cluster.ssh.ssh_key

The absolute path of the SSH key that should be used for accessing the cluster nodes via SSH.

Kind	string
Required	Yes
Default

cluster.ssh.ssh_port

The port number on which cluster nodes are listening for SSH connections.

Kind	int
Required	Yes
Default

cluster.kube_apiserver

Kubernetes API Server configuration.

cluster.kube_apiserver.option_overrides

Listing of option overrides that are to be applied to the Kubernetes API server configuration. This is an advanced feature that can prevent the API server from starting up if invalid configuration is provided.

Kind	map[string]string
Required	No
Default

cluster.kube_controller_manager

Kubernetes Controller Manager configuration.

cluster.kube_controller_manager.option_overrides

Listing of option overrides that are to be applied to the Kubernetes Controller Manager configuration. This is an advanced feature that can prevent the Controller Manager from starting up if invalid configuration is provided.

Kind	map[string]string
Required	No
Default

cluster.kube_scheduler

Kubernetes Scheduler configuration.

cluster.kube_scheduler.option_overrides

Listing of option overrides that are to be applied to the Kubernetes Scheduler configuration. This is an advanced feature that can prevent the Scheduler from starting up if invalid configuration is provided.

Kind	map[string]string
Required	No
Default

cluster.kube_proxy

Kubernetes Proxy configuration.

cluster.kube_proxy.option_overrides

Listing of option overrides that are to be applied to the Kubernetes Proxy configuration. This is an advanced feature that can prevent the Proxy from starting up if invalid configuration is provided.

Kind	map[string]string
Required	No
Default

cluster.kubelet

Kubelet configuration applied to all nodes.

cluster.kubelet.option_overrides

Listing of option overrides that are to be applied to the Kubelet configurations. This is an advanced feature that can prevent the Kubelet from starting up if invalid configuration is provided.

Kind	map[string]string
Required	No
Default

cluster.cloud_provider

The CloudProvider configuration for the cluster.

cluster.cloud_provider.provider

The cloud provider that should be set in the Kubernetes components

Kind	string
Required	No
Default
Options	aws, azure, cloudstack, fake, gce, mesos, openstack, ovirt, photon, rackspace, vsphere

cluster.cloud_provider.config

Path to the cloud provider config file. This will be copied to all the machines in the cluster

Kind	string
Required	No
Default

docker

Configuration for the docker engine installed by KET

docker.storage

Storage configuration for the docker engine

docker.storage.direct_lvm

DirectLVM is the configuration required for setting up device mapper in direct-lvm mode

docker.storage.direct_lvm.enabled

Whether the direct_lvm mode of the devicemapper storage driver should be enabled. When set to true, a dedicated block storage device must be available on each cluster node.

Kind	bool
Required	No
Default	false

docker.storage.direct_lvm.block_device

The path to the block storage device that will be used by the devicemapper storage driver.

Kind	string
Required	No
Default

docker.storage.direct_lvm.enable_deferred_deletion

Whether deferred deletion should be enabled when using devicemapper in direct_lvm mode.

Kind	bool
Required	No
Default	false

docker_registry

Docker registry configuration

docker_registry.server

The hostname or IP address and port of a private container image registry. Do not include http or https. When performing a disconnected installation, this registry will be used to fetch all the required container images.

Kind	string
Required	No
Default

docker_registry.address (deprecated)

The hostname or IP address of a private container image registry. When performing a disconnected installation, this registry will be used to fetch all the required container images.

Kind	string
Required	No
Default

docker_registry.port (deprecated)

The port on which the private container image registry is listening on.

Kind	int
Required	No
Default

docker_registry.CA

The absolute path of the Certificate Authority that should be installed on all cluster nodes that have a docker daemon. This is required to establish trust between the daemons and the private registry when the registry is using a self-signed certificate.

Kind	string
Required	No
Default

docker_registry.username

The username that should be used when connecting to a registry that has authentication enabled. Otherwise leave blank for unauthenticated access.

Kind	string
Required	No
Default

docker_registry.password

The password that should be used when connecting to a registry that has authentication enabled. Otherwise leave blank for unauthenticated access.

Kind	string
Required	No
Default

add_ons

Add on configuration

add_ons.cni

The Container Networking Interface (CNI) add-on configuration.

add_ons.cni.disable

Whether the CNI add-on is disabled. When set to true, CNI will not be installed on the cluster. Furthermore, the smoke test and any validation that depends on a functional pod network will be skipped.

Kind	bool
Required	No
Default	false

add_ons.cni.provider

The CNI provider that should be installed on the cluster.

Kind	string
Required	No
Default	calico
Options	calico, weave, contiv, custom

add_ons.cni.options

The CNI options that can be configured for each CNI provider.

add_ons.cni.options.calico

The options that can be configured for the Calico CNI provider.

add_ons.cni.options.calico.mode

The datapath technique that should be configured in Calico.

Kind	string
Required	No
Default	overlay
Options	overlay, routed

add_ons.cni.options.calico.log_level

The logging level for the CNI plugin

Kind	string
Required	No
Default	info
Options	warning, info, debug

add_ons.cni.options.calico.workload_mtu

MTU for the workload interface, configures the CNI config

Kind	int
Required	No
Default	1500

add_ons.cni.options.calico.felix_input_mtu

MTU for the tunnel device used if IPIP is enabled

Kind	int
Required	No
Default	1440

add_ons.dns

The DNS add-on configuration.

add_ons.dns.disable

Whether the DNS add-on should be disabled. When set to true, no DNS solution will be deployed on the cluster.

Kind	bool
Required	No
Default	false

add_ons.heapster

The Heapster Monitoring add-on configuration.

add_ons.heapster.disable

Whether the Heapster add-on should be disabled. When set to true, Heapster and InfluxDB will not be deployed on the cluster.

Kind	bool
Required	No
Default	false

add_ons.heapster.options

The options that can be configured for the Heapster add-on

add_ons.heapster.options.heapster

The Heapster configuration options.

add_ons.heapster.options.heapster.replicas

Number of Heapster replicas that should be scheduled on the cluster.

Kind	int
Required	No
Default	2

add_ons.heapster.options.heapster.service_type

Kubernetes service type of the Heapster service.

Kind	string
Required	No
Default	ClusterIP
Options	ClusterIP, NodePort, LoadBalancer, ExternalName

add_ons.heapster.options.heapster.sink

URL of the backend store that will be used as the Heapster sink.

Kind	string
Required	No
Default	influxdb:http://heapster-influxdb.kube-system.svc:8086

add_ons.heapster.options.influxdb

The InfluxDB configuration options.

add_ons.heapster.options.influxdb.pvc_name

Name of the Persistent Volume Claim that will be used by InfluxDB. This PVC must be created after the installation. If not set, InfluxDB will be configured with ephemeral storage.

Kind	string
Required	No
Default

add_ons.heapster.options.heapster_replicas (deprecated)

Number of Heapster replicas that should be scheduled on the cluster.

Kind	int
Required	No
Default

add_ons.heapster.options.influxdb_pvc_name (deprecated)

Name of the Persistent Volume Claim that will be used by InfluxDB. When set, this PVC must be created after the installation. If not set, InfluxDB will be configured with ephemeral storage.

Kind	string
Required	No
Default

add_ons.dashboard

The Dashboard add-on configuration.

add_ons.dashboard.disable

Whether the dashboard add-on should be disabled. When set to true, the Kubernetes Dashboard will not be installed on the cluster.

Kind	bool
Required	No
Default	false

add_ons.dashbard (deprecated)

The Dashboard add-on configuration.

add_ons.dashbard.disable

Whether the dashboard add-on should be disabled. When set to true, the Kubernetes Dashboard will not be installed on the cluster.

Kind	bool
Required	No
Default	false

add_ons.package_manager

The PackageManager add-on configuration.

add_ons.package_manager.disable

Whether the package manager add-on should be disabled. When set to true, the package manager will not be installed on the cluster.

Kind	bool
Required	No
Default	false

add_ons.package_manager.provider

This property indicates the package manager provider.

Kind	string
Required	Yes
Default
Options	helm

add_ons.rescheduler

The Rescheduler add-on configuration. Because the Rescheduler does not have leader election and therefore can only run as a single instance in a cluster, it will be deployed as a static pod on the first master. More information about the Rescheduler can be found here: https://kubernetes.io/docs/tasks/administer-cluster/guaranteed-scheduling-critical-addon-pods/

add_ons.rescheduler.disable

Whether the pod rescheduler add-on should be disabled. When set to true, the rescheduler will not be installed on the cluster.

Kind	bool
Required	No
Default	false

features (deprecated)

Feature configuration

features.package_manager (deprecated)

The PackageManager feature configuration.

features.package_manager.enabled (deprecated)

Whether the package manager add-on should be enabled.

Kind	bool
Required	No
Default	false

etcd

Etcd nodes of the cluster

etcd.expected_count

Number of nodes.

Kind	int
Required	Yes
Default

etcd.nodes

List of nodes.

etcd.nodes.host

The hostname of the node. The hostname is verified in the validation phase of the installation.

Kind	string
Required	Yes
Default

etcd.nodes.ip

The IP address of the node. This is the IP address that will be used to connect to the node over SSH.

Kind	string
Required	Yes
Default

etcd.nodes.internalip

The internal (or private) IP address of the node. If set, this IP will be used when configuring cluster components.

Kind	string
Required	No
Default

etcd.nodes.labels

Labels to add when installing the node in the cluster. If a node is defined under multiple roles, the labels for that node will be merged. If a label is repeated for the same node, only one will be used in this order: etcd,master,worker,ingress,storage roles where 'storage' has the highest precedence. It is recommended to use reverse-DNS notation to avoid collision with other labels.

Kind	map[string]string
Required	No
Default

etcd.nodes.kubelet

Kubelet configuration applied to this node. If a node is repeated for multiple roles, the overrides cannot be different.

etcd.nodes.kubelet.option_overrides

Listing of option overrides that are to be applied to the Kubelet configurations. This is an advanced feature that can prevent the Kubelet from starting up if invalid configuration is provided.

Kind	map[string]string
Required	No
Default

master

Master nodes of the cluster

master.expected_count

Number of master nodes that are part of the cluster.

Kind	int
Required	Yes
Default

master.load_balanced_fqdn

The FQDN of the load balancer that is fronting multiple master nodes. In the case where there is only one master node, this can be set to the IP address of the master node.

Kind	string
Required	Yes
Default

master.load_balanced_short_name

The short name of the load balancer that is fronting multiple master nodes. In the case where there is only one master node, this can be set to the IP address of the master nodes.

Kind	string
Required	Yes
Default

master.nodes

List of master nodes that are part of the cluster.

master.nodes.host

The hostname of the node. The hostname is verified in the validation phase of the installation.

Kind	string
Required	Yes
Default

master.nodes.ip

The IP address of the node. This is the IP address that will be used to connect to the node over SSH.

Kind	string
Required	Yes
Default

master.nodes.internalip

The internal (or private) IP address of the node. If set, this IP will be used when configuring cluster components.

Kind	string
Required	No
Default

master.nodes.labels

Labels to add when installing the node in the cluster. If a node is defined under multiple roles, the labels for that node will be merged. If a label is repeated for the same node, only one will be used in this order: etcd,master,worker,ingress,storage roles where 'storage' has the highest precedence. It is recommended to use reverse-DNS notation to avoid collision with other labels.

Kind	map[string]string
Required	No
Default

master.nodes.kubelet

Kubelet configuration applied to this node. If a node is repeated for multiple roles, the overrides cannot be different.

master.nodes.kubelet.option_overrides

Listing of option overrides that are to be applied to the Kubelet configurations. This is an advanced feature that can prevent the Kubelet from starting up if invalid configuration is provided.

Kind	map[string]string
Required	No
Default

worker

Worker nodes of the cluster

worker.expected_count

Number of nodes.

Kind	int
Required	Yes
Default

worker.nodes

List of nodes.

worker.nodes.host

The hostname of the node. The hostname is verified in the validation phase of the installation.

Kind	string
Required	Yes
Default

worker.nodes.ip

The IP address of the node. This is the IP address that will be used to connect to the node over SSH.

Kind	string
Required	Yes
Default

worker.nodes.internalip

The internal (or private) IP address of the node. If set, this IP will be used when configuring cluster components.

Kind	string
Required	No
Default

worker.nodes.labels

Labels to add when installing the node in the cluster. If a node is defined under multiple roles, the labels for that node will be merged. If a label is repeated for the same node, only one will be used in this order: etcd,master,worker,ingress,storage roles where 'storage' has the highest precedence. It is recommended to use reverse-DNS notation to avoid collision with other labels.

Kind	map[string]string
Required	No
Default

worker.nodes.kubelet

Kubelet configuration applied to this node. If a node is repeated for multiple roles, the overrides cannot be different.

worker.nodes.kubelet.option_overrides

Listing of option overrides that are to be applied to the Kubelet configurations. This is an advanced feature that can prevent the Kubelet from starting up if invalid configuration is provided.

Kind	map[string]string
Required	No
Default

ingress

Ingress nodes of the cluster

ingress.expected_count

Number of nodes.

Kind	int
Required	Yes
Default

ingress.nodes

List of nodes.

ingress.nodes.host

The hostname of the node. The hostname is verified in the validation phase of the installation.

Kind	string
Required	Yes
Default

ingress.nodes.ip

The IP address of the node. This is the IP address that will be used to connect to the node over SSH.

Kind	string
Required	Yes
Default

ingress.nodes.internalip

The internal (or private) IP address of the node. If set, this IP will be used when configuring cluster components.

Kind	string
Required	No
Default

ingress.nodes.labels

Labels to add when installing the node in the cluster. If a node is defined under multiple roles, the labels for that node will be merged. If a label is repeated for the same node, only one will be used in this order: etcd,master,worker,ingress,storage roles where 'storage' has the highest precedence. It is recommended to use reverse-DNS notation to avoid collision with other labels.

Kind	map[string]string
Required	No
Default

ingress.nodes.kubelet

Kubelet configuration applied to this node. If a node is repeated for multiple roles, the overrides cannot be different.

ingress.nodes.kubelet.option_overrides

Listing of option overrides that are to be applied to the Kubelet configurations. This is an advanced feature that can prevent the Kubelet from starting up if invalid configuration is provided.

Kind	map[string]string
Required	No
Default

storage

Storage nodes of the cluster.

storage.expected_count

Number of nodes.

Kind	int
Required	Yes
Default

storage.nodes

List of nodes.

storage.nodes.host

The hostname of the node. The hostname is verified in the validation phase of the installation.

Kind	string
Required	Yes
Default

storage.nodes.ip

The IP address of the node. This is the IP address that will be used to connect to the node over SSH.

Kind	string
Required	Yes
Default

storage.nodes.internalip

The internal (or private) IP address of the node. If set, this IP will be used when configuring cluster components.

Kind	string
Required	No
Default

storage.nodes.labels

Labels to add when installing the node in the cluster. If a node is defined under multiple roles, the labels for that node will be merged. If a label is repeated for the same node, only one will be used in this order: etcd,master,worker,ingress,storage roles where 'storage' has the highest precedence. It is recommended to use reverse-DNS notation to avoid collision with other labels.

Kind	map[string]string
Required	No
Default

storage.nodes.kubelet

Kubelet configuration applied to this node. If a node is repeated for multiple roles, the overrides cannot be different.

storage.nodes.kubelet.option_overrides

Listing of option overrides that are to be applied to the Kubelet configurations. This is an advanced feature that can prevent the Kubelet from starting up if invalid configuration is provided.

Kind	map[string]string
Required	No
Default

nfs

NFS volumes of the cluster.

nfs.nfs_volume

List of NFS volumes that should be attached to the cluster during the installation.

nfs.nfs_volume.nfs_host

The hostname or IP of the NFS volume.

Kind	string
Required	Yes
Default

nfs.nfs_volume.mount_path

The path where the NFS volume should be mounted.

Kind	string
Required	Yes
Default