README.md

Deploy a production ready kubernetes cluster

If you have questions, join us on the kubernetes slack, channel #kubespray.

• Can be deployed on AWS, GCE, Azure, OpenStack or Baremetal
• High available cluster
• Composable (Choice of the network plugin for instance)
• Support most popular Linux distributions
• Continuous integration tests

To deploy the cluster you can use :

kubespray-cli
Ansible usual commands and inventory builder
vagrant by simply running vagrant up (for tests purposes)

• Requirements
• Kubespray vs ...
• Getting started
• Ansible inventory and tags
• Integration with existing ansible repo
• Deployment data variables
• DNS stack
• HA mode
• Network plugins
• Vagrant install
• CoreOS bootstrap
• Downloaded artifacts
• Cloud providers
• OpenStack
• AWS
• Azure
• vSphere
• Large deployments
• Upgrades basics
• Roadmap

Supported Linux distributions

• Container Linux by CoreOS
• Debian Jessie
• Ubuntu 16.04
• CentOS/RHEL 7

Note: Upstart/SysV init based OS types are not supported.

Versions of supported components

kubernetes v1.6.7
etcd v3.0.17
flanneld v0.8.0
calicoctl v0.23.0
canal (given calico/flannel versions)
weave v2.0.1
docker v1.13.1 (see note)
rkt v1.21.0 (see Note 2)

Note: kubernetes doesn't support newer docker versions. Among other things kubelet currently breaks on docker's non-standard version numbering (it no longer uses semantic versioning). To ensure auto-updates don't break your cluster look into e.g. yum versionlock plugin or apt pin).

Note 2: rkt support as docker alternative is limited to control plane (etcd and kubelet). Docker is still used for Kubernetes cluster workloads and network plugins' related OS services. Also note, only one of the supported network plugins can be deployed for a given single cluster.

Requirements

• Ansible v2.3 (or newer) and python-netaddr is installed on the machine that will run Ansible commands
• Jinja 2.9 (or newer) is required to run the Ansible Playbooks
• The target servers must have access to the Internet in order to pull docker images.
• The target servers are configured to allow IPv4 forwarding.
• Your ssh key must be copied to all the servers part of your inventory.
• The firewalls are not managed, you'll need to implement your own rules the way you used to. in order to avoid any issue during deployment you should disable your firewall.

Network plugins

You can choose between 4 network plugins. (default: calico, except Vagrant uses flannel)

• flannel: gre/vxlan (layer 2) networking.

• calico: bgp (layer 3) networking.

• canal: a composition of calico and flannel plugins.

• weave: Weave is a lightweight container overlay network that doesn't require an external K/V database cluster.
  (Please refer to weave troubleshooting documentation).

The choice is defined with the variable kube_network_plugin. There is also an option to leverage built-in cloud provider networking instead. See also Network checker.

Community docs and resources

• kubernetes.io/docs/getting-started-guides/kubespray/
• kubespray, monitoring and logging by @gregbkr
• Deploy Kubernetes w/ Ansible & Terraform by @rsmitty
• Deploy a Kubernetes Cluster with Kubespray (video)

Tools and projects on top of Kubespray

• Digital Rebar
• Kubespray-cli
• Fuel-ccp-installer
• Terraform Contrib

CI Tests

CI/end-to-end tests sponsored by Google (GCE), DigitalOcean, teuto.net (openstack). See the test matrix for details.