kubeone

README

KubeOne

KubeOne makes installing and upgrading a HA Kubernetes cluster a breeze. It integrates with your favorite infrastructure tools or can be used standalone.

From a bird eye view, KubeOne connects to your machines using SSH and then uses kubeadm to bootstrap the cluster.

Features

• Kubernetes 1.12 support
• easy Terraform integration
• provides rolling cluster upgrades (TODO)

Usage

First, build the binary by running make. After that you need to provide KubeOne with a configuration with details about the node IPs, Kubernetes versions etc.

By default, the configuration happens by providing a single YAML file. Take a look at the config.yaml.dist for more details and create a copy of it to make adjustments.

Armed with your configuration, you can now run KubeOne:

./kubeone install myconfig.yaml

This will SSH into the machines, install the required dependencies and then perform the necessary steps to bring up an etcd ring and a HA Kubernetes control plane.

Config

TBD

Workers definition

Worker nodes are managed by machine-controller project (that kubeone automatically deploy).

Config section workers: [] used as a source for MachineDeployment (cluster-api).

Worker's cloudProviderSpec

It's cloud provider specific, actual fields are defined in https://github.com/kubermatic/machine-controller/tree/master/pkg/cloudprovider/provider RawConfig structure in corresponding provider package.

Worker's cloudProviderSpec for AWS

Param	Description
region	TBD
availabilityZone	TBD
vpcId	TBD
subnetId	TBD
securityGroupIDs	TBD
instanceProfile	TBD
instanceType	TBD
ami	TBD
diskSize	TBD
diskType	TBD

Terraform Integration

If you use Terraform to provision your infrastructure, you can make KubeOne read its output to learn about the nodes in your cluster. Take a look at the terraform/aws and especially the output.tf file to learn more about what data KubeOne expects to read from Terraform.

To use Terraform's output, use the --tfjson CLI flag:

terraform apply
terraform output -json > tf.json
./kubeone install --tfjson tf.json myconfig.yaml

This will overwrite the nodes in your myconfig.yaml (if any) before installing Kubernetes.

Terraform output params

Output param names and types correspond to cloudProviderSpec for chosen provider, for more information please consult https://github.com/kubermatic/machine-controller/tree/master/pkg/cloudprovider/provider RawConfig structure in corresponding provider package.

Debugging

To see exactly what's happening during installation, pass the --verbose flag to KubeOne:

./kubeone --verbose install myconfig.yaml

This will stream the output of all shell commands to your shell.

License

Apache License