kubeone is a CLI tool and a Go library for installing, managing, and upgrading
Kubernetes High-Available (HA) clusters. It can be used on any cloud provider,
on-prem or bare-metal cluster.
As of v0.6.0, KubeOne is in the beta phase. Check out the Backwards Compatibility Policy for more details on backwards compatibility, KubeOne versioning, and maturity of each KubeOne component.
Versions earlier than v0.6.0 are considered alpha and it's strongly advised to upgrade to the v0.6.0 or newer as soon as possible.
KubeOne in Action
- Supports Kubernetes 1.13+ High-Available (HA) clusters
kubeadmto provision clusters
- Comes with a straightforward and easy to use CLI
- Choice of Linux distributions between Ubuntu, CentOS and CoreOS
- Integrates with Cluster-API and Kubermatic machine-controller to manage worker nodes
- Integrates with Terraform for sourcing data about infrastructure and control plane nodes
- Officially supports AWS, DigitalOcean, GCE, Hetzner, Packet, OpenStack, VMware vSphere and Azure
Downloading a binary from GitHub Releases
The recommended way to obtain KubeOne is to grab the
binary from the GitHub Releases page. On the
releases page, find the binary for your operating system
and architecture and download it or grab the URL and use
curl to download the binary.
curl -LO https://github.com/kubermatic/kubeone/releases/download/v<version>/kubeone_<version>_linux_amd64.zip
Extract the binary. On Linux and macOS, you can use
kubeone binary to your path, so you can easily
invoke it from your terminal.
sudo mv kubeone /usr/local/bin
The alternative way to install KubeOne is using
go get -u github.com/kubermatic/kubeone
While running of the master branch is a great way to peak at and test the new features before they are released, note that master branch can break at any time or may contain bugs. Official releases are considered stable and recommended for the production usage.
If you already have KubeOne repository cloned, you can use
to install it.
Using package managers
Support for packages managers is still work in progress and expected to be finished for one of the upcoming release. For details about the progress follow the issue #471
We have a package in the AUR here.
Use your favorite method to build it on your system, for example by using
aur sync kubeone && pacman -S kubeone
Shell completion and generating documentation
KubeOne comes with commands for generating scripts for the shell completion and for the documentation in format of man pages and more.
To activate completions for
zsh), run or put this command
. <(kubeone completion bash)
To put changes in the effect, source your
To generate documentation (man pages for example, more available), run:
kubeone document man -o /tmp/man
Kubernetes Versions Compatibility
Each KubeOne version is supposed to support and work with a set of Kubernetes minor versions. We're targeting to support at least 3 minor Kubernetes versions, however for early KubeOne releases we're supporting only one or two minor versions.
New KubeOne release will be done for each minor Kubernetes version. Usually, a new release is targeted 2-3 weeks after Kubernetes release, depending on number of changes needed to support a new version.
Since some terraform releases introduces incompatibilities to previuos versions, only a specific version range is supported with each KubeOne release.
In the following table you can find what are supported Kubernetes and Terraform versions for each KubeOne version. KubeOne versions that are crossed out are not supported. It's highly recommended to use the latest version whenever possible.
|KubeOne version||1.15||1.14||1.13||Terraform||Supported providers|
|v0.9.0+||+||+||+||v0.12+||AWS, DigitalOcean, GCE, Hetzner, Packet, OpenStack, vSphere, Azure|
|v0.8.0+||-||+||+||v0.11||AWS, DigitalOcean, GCE, Hetzner, Packet, OpenStack, vSphere|
|v0.6.0+||-||+||+||v0.11||AWS, DigitalOcean, GCE, Hetzner, Packet, OpenStack|
|v0.5.0||-||+||+||v0.11||AWS, DigitalOcean, GCE, Hetzner, OpenStack|
A cluster is created using the
kubeone install command. It takes a KubeOne configuration file and optionally Terraform state used to source information about the infrastructure. You may also use our Ansible roles to create the configuration file.
kubeone install config.yaml --tfjson tf.json
To learn more about KubeOne configuration, please run
kubeone config print --full.
For advanced use cases and other features, check the KubeOne features document.
We very appreciate contributions! If you want to contribute or have an idea for a new feature or improvement, please check out our contributing guide.
If you want to get in touch with us and discuss about improvements and new features, please create a new issue on GitHub or connect with us over the mailing list or Slack:
- KubeOne version or Git commit that you're running (
- description of the bug and logs from the relevant
kubeonecommand (if applicable),
- steps to reproduce the issue,
- expected behavior
If you're reporting a security vulnerability, please follow the process for reporting security issues.
See the list of releases to find out about feature changes.