Python Shell HCL Other
mattymo Fix vault file owner issues and k8s apiserver cert creation (#2985)
apiserver cert should be created only once
Latest commit 97e0de7 Jul 11, 2018
Failed to load latest commit information.
.github rename almost all mentions of kargo Jun 16, 2017
contrib Fix terraform env Not effective (#2966) Jul 5, 2018
docs add docker upgrade tag doc Jul 10, 2018
extra_playbooks cephfs-provisioner: Upgrade to 06fddbe2 Jul 3, 2018
inventory ingress-nginx: Upgrade to 0.16.2 Jul 10, 2018
library Revert "wip pr for improved cert sync" (#2849) Jun 6, 2018
roles Fix vault file owner issues and k8s apiserver cert creation (#2985) Jul 11, 2018
scripts use archive instead of command Mar 12, 2018
tests Upgrade k8s to 1.10.2 (#2748) May 15, 2018
.gitignore Vagrantfile: Add vagrant inventory file in any directory to .gitignore Apr 13, 2018
.gitlab-ci.yml refactor vault role (#2733) May 11, 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 Force to /usr/bin/python in CI Feb 12, 2018
LICENSE Create LICENSE Mar 1, 2016
OWNERS adds ability to have hosts with no floating ips on terraform/openstac… Nov 7, 2016 ingress-nginx: Upgrade to 0.16.2 Jul 10, 2018 fix typo 'on' > 'one' Jul 14, 2017
SECURITY_CONTACTS Adding SECURITY_CONTACTS fixes #2816 (#2833) May 31, 2018
Vagrantfile Revert "Revert "Add openSUSE support" (#2697)" (#2699) Apr 26, 2018
ansible.cfg Remove jinja2 dependency of do Apr 9, 2018
cluster.yml Improve variable handling for disabling etcd events cluster Jun 18, 2018 Update Dec 20, 2017
remove-node.yml move node selection from --limit to --extra-vars=node<nodename>" Jul 2, 2018
requirements.txt refactor vault role (#2733) May 11, 2018
reset.yml Fixes to reset (#2046) Dec 11, 2017
scale.yml Make it possible to skip docker role as a var (#2686) Apr 19, 2018
setup.cfg Use relative paths for data_files in setup.cfg (#2812) May 25, 2018 Add pbr build configuration Aug 18, 2017
upgrade-cluster.yml Make it possible to skip docker role as a var (#2686) Apr 19, 2018

Kubernetes Logo

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, vSphere 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 :


# 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.yml
cat inventory/mycluster/group_vars/k8s-cluster.yml

# Deploy Kubespray with Ansible Playbook
ansible-playbook -i inventory/mycluster/hosts.ini cluster.yml


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 Jessie, Stretch, Wheezy
  • Ubuntu 16.04
  • CentOS/RHEL 7
  • Fedora/CentOS Atomic
  • openSUSE Leap 42.3/Tumbleweed

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

Supported Components

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.


  • Ansible v2.4 (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.
  • 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).

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.