Deploy a Production Ready Kubernetes Cluster
 
 
 
 
 
Go to file
k8s-ci-robot 2faa8f1e37
Merge pull request #3254 from mattymo/calico_upgrade_tweaks
Fix backward compatibility with calico 2.6
2018-09-06 06:20:52 -07:00
.github rename almost all mentions of kargo 2017-06-16 13:25:46 -04:00
contrib Merge pull request #2931 from torvitas/master 2018-09-06 03:07:35 -07:00
docs Merge pull request #3234 from warmchang/tryUpdateNodeStatus 2018-09-05 00:21:33 -07:00
extra_playbooks cephfs-provisioner: Upgrade to 06fddbe2 2018-07-03 10:15:24 +08:00
inventory Introducing credentials_dir in order to be able to override it 2018-09-03 18:04:50 +02:00
library Revert "wip pr for improved cert sync" (#2849) 2018-06-06 17:22:25 +03:00
roles Merge pull request #3254 from mattymo/calico_upgrade_tweaks 2018-09-06 06:20:52 -07:00
scripts use archive instead of command 2018-03-12 19:59:22 +01:00
tests Reduce instance sizes in gce 2018-09-06 15:22:46 +03:00
.gitignore update .gitigonre 2018-08-02 11:30:55 +08:00
.gitlab-ci.yml CI: switch ubuntu18 to manual job 2018-08-31 13:45:08 +02:00
.gitmodules Remove submodules 2016-03-04 16:14:01 +01:00
.yamllint Adding yamllinter to ci steps (#1556) 2017-08-24 12:09:52 +03:00
CONTRIBUTING.md files needed to move kargo to k8s 2016-08-16 14:01:03 +02:00
Dockerfile Force to /usr/bin/python in CI 2018-02-12 17:38:32 +01:00
LICENSE Create LICENSE 2016-03-01 15:37:01 +01:00
OWNERS Update OWNERS 2018-08-16 13:32:46 +02:00
OWNERS_ALIASES Add mirwan as Reviewer 2018-08-30 11:53:50 +02:00
README.md Merge pull request #3233 from mgsergio/patch-2 2018-09-04 17:27:10 +02:00
RELEASE.md fix typo 'on' > 'one' 2017-07-14 15:25:09 -04:00
SECURITY_CONTACTS Adding SECURITY_CONTACTS fixes #2816 (#2833) 2018-05-31 10:48:49 +03:00
Vagrantfile Define custom playbook in Vagrantfile 2018-08-14 12:12:07 -04:00
ansible.cfg credentials directory should be ignored as inventory 2018-09-03 18:04:34 +02:00
cluster.yml Merge pull request #3200 from pablodav/feature/k8s_win_v1.11 2018-09-03 04:51:23 -07:00
code-of-conduct.md Update code-of-conduct.md 2017-12-20 14:12:38 -05:00
remove-node.yml move node selection from --limit to --extra-vars=node<nodename>" 2018-07-02 20:04:36 +02:00
requirements.txt refactor vault role (#2733) 2018-05-11 19:11:38 +03:00
reset.yml Fixes to reset (#2046) 2017-12-11 12:49:21 +00:00
scale.yml container_manager variable to specify runtime. 2018-08-28 06:23:38 +00:00
setup.cfg Use relative paths for data_files in setup.cfg (#2812) 2018-05-25 11:57:03 +02:00
setup.py Add pbr build configuration 2017-08-18 12:56:01 +02:00
upgrade-cluster.yml container_manager variable to specify runtime. 2018-08-28 06:23:38 +00:00

README.md

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

# 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=(10.10.1.3 10.10.1.4 10.10.1.5)
CONFIG_FILE=inventory/mycluster/hosts.ini python3 contrib/inventory_builder/inventory.py ${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

Vagrant

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 https://www.python.org/downloads/source/ Install the necessary requirements

sudo pip install -r requirements.txt
vagrant up

Documents

Supported Linux Distributions

  • Container Linux by CoreOS
  • Debian Jessie, Stretch, Wheezy
  • Ubuntu 16.04, 18.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 ("Version 17.03 is recommended... Versions 17.06+ might work, but have not yet been tested and verified by the Kubernetes node team" cf. Bootstrapping Clusters with kubeadm). 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.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.