Deploy a Production Ready Kubernetes Cluster
Clone or download
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github rename almost all mentions of kargo Jun 16, 2017
contrib Remove vault role from inventory_builder. (#3863) Dec 9, 2018
docs Remove non-kubeadm deployment (#3811) Dec 6, 2018
extra_playbooks Offline deployment: PyPi repo (#3542) Oct 24, 2018
inventory Upgrade kubernetes to v1.13.0 (#3810) Dec 6, 2018
library Revert "wip pr for improved cert sync" (#2849) Jun 6, 2018
roles Setting host_architecture var (#3846) Dec 7, 2018
scripts Fix path to Kubespray in CI auth check Nov 27, 2018
tests Remove non-kubeadm deployment (#3811) Dec 6, 2018
.gitignore update .gitigonre Aug 2, 2018
.gitlab-ci.yml Upgrade kubernetes to v1.13.0 (#3810) Dec 6, 2018
.gitmodules Remove submodules Mar 4, 2016
.yamllint Adding yamllinter to ci steps (#1556) Aug 24, 2017 files needed to move kargo to k8s Aug 16, 2016
Dockerfile fix typo: remove redundant space (#3429) Oct 8, 2018
LICENSE Create LICENSE Mar 1, 2016
Makefile Add playbook to install mitogen (#3622) Oct 31, 2018
OWNERS Update OWNERS Aug 16, 2018
OWNERS_ALIASES Add mirwan as Reviewer Aug 30, 2018 Remove mention of fuel in README (#3826) Dec 7, 2018 fix typo 'on' > 'one' Jul 14, 2017
SECURITY_CONTACTS Adding SECURITY_CONTACTS fixes #2816 (#2833) May 31, 2018
Vagrantfile cleaned up vagrantfile (#3717) Nov 16, 2018
ansible.cfg Add playbook to install mitogen (#3622) Oct 31, 2018
cluster.yml Remove non-kubeadm deployment (#3811) Dec 6, 2018 Update Dec 20, 2017
mitogen.yaml Add playbook to install mitogen (#3622) Oct 31, 2018
remove-node.yml remove-node: fix assert for ansible_version (#3703) Nov 13, 2018
requirements.txt Remove Vault (#3684) Nov 10, 2018
reset.yml Remove Vault (#3684) Nov 10, 2018
scale.yml Remove non-kubeadm deployment (#3811) Dec 6, 2018
setup.cfg Update all kubernetes-incubator/kubespray refs to kubernetes-sigs/kub… Nov 28, 2018 Add pbr build configuration Aug 18, 2017
upgrade-cluster.yml Remove non-kubeadm deployment (#3811) Dec 6, 2018

Kubernetes Logo

Deploy a Production Ready Kubernetes Cluster

If you have questions, join us on the kubernetes slack, channel #kubespray. You can get your invite here

  • Can be deployed on AWS, GCE, Azure, OpenStack, vSphere, Oracle Cloud Infrastructure (Experimental), or Baremetal
  • Highly available cluster
  • Composable (Choice of the network plugin for instance)
  • Supports most popular Linux distributions
  • Continuous integration tests

Quick Start

To deploy the cluster you can use :


Ansible version

Ansible v2.7.0 is failing and/or produce unexpected results due to ansible/ansible/issues/46600


# Install dependencies from ``requirements.txt``
sudo pip install -r requirements.txt

# Copy ``inventory/sample`` as ``inventory/mycluster``
cp -rfp inventory/sample inventory/mycluster

# Update Ansible inventory file with inventory builder
declare -a IPS=(
CONFIG_FILE=inventory/mycluster/hosts.ini python3 contrib/inventory_builder/ ${IPS[@]}

# Review and change parameters under ``inventory/mycluster/group_vars``
cat inventory/mycluster/group_vars/all/all.yml
cat inventory/mycluster/group_vars/k8s-cluster/k8s-cluster.yml

# Deploy Kubespray with Ansible Playbook - run the playbook as root
# The option `-b` is required, as for example writing SSL keys in /etc/,
# installing packages and interacting with various systemd daemons.
# Without -b the playbook will fail to run!
ansible-playbook -i inventory/mycluster/hosts.ini --become --become-user=root cluster.yml

Note: When Ansible is already installed via system packages on the control machine, other python packages installed via sudo pip install -r requirements.txt will go to a different directory tree (e.g. /usr/local/lib/python2.7/dist-packages on Ubuntu) from Ansible's (e.g. /usr/lib/python2.7/dist-packages/ansible still on Ubuntu). As a consequence, ansible-playbook command will fail with:

ERROR! no action detected in task. This often indicates a misspelled module name, or incorrect module path.

probably pointing on a task depending on a module present in requirements.txt (i.e. "unseal vault").

One way of solving this would be to uninstall the Ansible package and then, to install it via pip but it is not always possible. A workaround consists of setting ANSIBLE_LIBRARY and ANSIBLE_MODULE_UTILS environment variables respectively to the ansible/modules and ansible/module_utils subdirectories of pip packages installation location, which can be found in the Location field of the output of pip show [package] before executing ansible-playbook.


For Vagrant we need to install python dependencies for provisioning tasks. Check if Python and pip are installed:

python -V && pip -V

If this returns the version of the software, you're good to go. If not, download and install Python from here Install the necessary requirements

sudo pip install -r requirements.txt
vagrant up


Supported Linux Distributions

  • Container Linux by CoreOS
  • Debian Buster, Jessie, Stretch, Wheezy
  • Ubuntu 16.04, 18.04
  • CentOS/RHEL 7
  • Fedora 28
  • Fedora/CentOS Atomic
  • openSUSE Leap 42.3/Tumbleweed

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

Supported Components

Note: The list of validated docker versions was updated to 1.11.1, 1.12.1, 1.13.1, 17.03, 17.06, 17.09, 18.06. kubeadm now properly recognizes Docker 18.09.0 and newer, but still treats 18.06 as the default supported version. The kubelet might break 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.


  • Ansible v2.5 (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. Otherwise, additional configuration is required (See Offline Environment)
  • 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.
  • If kubespray is ran from non-root user account, correct privilege escalation method should be configured in the target servers. Then the ansible_become flag or command parameters --become or -b should be specified.

Network Plugins

You can choose between 6 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.

  • cilium: layer 3/4 networking (as well as layer 7 to protect and secure application protocols), supports dynamic insertion of BPF bytecode into the Linux kernel to implement security services, networking and visibility logic.

  • contiv: supports vlan, vxlan, bgp and Cisco SDN networking. This plugin is able to apply firewall policies, segregate containers in multiple network and bridging pods onto physical networks.

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

  • kube-router: Kube-router is a L3 CNI for Kubernetes networking aiming to provide operational simplicity and high performance: it uses IPVS to provide Kube Services Proxy (if setup to replace kube-proxy), iptables for network policies, and BGP for ods L3 networking (with optionally BGP peering with out-of-cluster BGP peers). It can also optionally advertise routes to Kubernetes cluster Pods CIDRs, ClusterIPs, ExternalIPs and LoadBalancerIPs.

  • multus: Multus is a meta CNI plugin that provides multiple network interface support to pods. For each interface Multus delegates CNI calls to secondary CNI plugins such as Calico, macvlan, etc.

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

Tools and projects on top of Kubespray

CI Tests

Build graphs

CI/end-to-end tests sponsored by Google (GCE) See the test matrix for details.