kubeone

README

KubeOne

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-perm or bare-metal cluster.

Project Status

KubeOne is currently in the alpha phase, so breaking changes can be expected in the upcoming period. You can find more details about breaking changes and actions needed to migrate them in the Release Notes. In the upcoming weeks we're planning to enter the beta phase and and define a backwards compatibility policy.

KubeOne in Action

TBD

Features

• Supports Kubernetes 1.13+ High-Available (HA) clusters
• Uses kubeadm to 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, Hetzner and OpenStack

Installing KubeOne

The easiest way to install KubeOne is using go get:

go get -u github.com/kubermatic/kubeone

However, running of the master branch introduces potential risks as the project is currently in the alpha phase and backwards incompatible changes can be expected.

Alternatively, you can obtain KubeOne via GitHub Releases:

curl -LO https://github.com/kubermatic/kubeone/releases/download/v0.3.0/kubeone_0.3.0_linux_amd64.zip
unzip kubeone_0.3.0_linux_amd64.zip
sudo mv kubeone /usr/local/bin

If you already have KubeOne repository cloned, you can use Makefile to install KubeOne.

make install

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.

In the following table you can find what are supported Kubernetes 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.14	1.13	1.12
v0.3.0	-	+	-
v0.2.0	-	+	-
v0.1.0-beta0	-	+	+

Note: Versions v0.2.0 and v0.1.0-beta0 don't support upgrading to the newer Kubernetes version.

Getting Started

We have a getting started tutorial for each cloud provider we support in our documentation. For example, the following document shows how to get started with KubeOne on AWS.

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.

kubeone install config.yaml --tfjson tf.json

To learn more about KubeOne configuration, check out the example configuration file.

For advanced use cases and other features, check the KubeOne features document.

Getting Involved

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:

• loodse-dev mailing list
• Kubermatic Slack

Reporting Bugs

If you encounter issues, please create a new issue on GitHub or talk to us on the #KubeOne Slack channel. When reporting a bug please include the following information:

• KubeOne version or Git commit that you're running (kubeone version),
• description of the bug and logs from the relevant kubeone command (if applicable),
• steps to reproduce the issue,
• expected behavior

If you're reporting a security vulnerability, please follow the process for reporting security issues.

Changelog

See the list of releases to find out about feature changes.