Deploy a Production Ready Kubernetes Cluster
 
 
 
 
 
Go to file
Andreas Krüger 1be399ab7b
Merge pull request #2772 from cruwe/cjr-correct-perms-on-kubeconfig
make admin.conf -> .kube/config non-executable
2018-05-15 13:26:33 +02:00
.github rename almost all mentions of kargo 2017-06-16 13:25:46 -04:00
contrib Rename ansible user env vars 2018-05-02 14:07:54 +07:00
docs add svc to netchecker-service.default.svc.cluster.local 2018-05-12 17:34:51 +04:30
extra_playbooks cephfs-provisioner: Upgrade to a71a49d4 2018-04-17 13:41:34 +08:00
inventory Add oidc-user-prefix and oidc-group-prefix args 2018-04-23 12:23:59 +09:00
library kube Module Enhancements 2018-03-07 14:50:09 -06:00
roles Merge pull request #2772 from cruwe/cjr-correct-perms-on-kubeconfig 2018-05-15 13:26:33 +02:00
scripts use archive instead of command 2018-03-12 19:59:22 +01:00
tests refactor vault role (#2733) 2018-05-11 19:11:38 +03:00
.gitignore Vagrantfile: Add vagrant inventory file in any directory to .gitignore 2018-04-13 10:54:21 -07:00
.gitlab-ci.yml refactor vault role (#2733) 2018-05-11 19:11:38 +03: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 2016-10-28 11:16:11 +04:00
README.md Update README.md 2018-05-14 20:11:57 +02:00
RELEASE.md fix typo 'on' > 'one' 2017-07-14 15:25:09 -04:00
Vagrantfile Revert "Revert "Add openSUSE support" (#2697)" (#2699) 2018-04-26 12:52:06 +03:00
ansible.cfg Remove jinja2 dependency of do 2018-04-09 12:27:53 +03:00
cluster.yml Make it possible to skip docker role as a var (#2686) 2018-04-19 16:47:20 +03:00
code-of-conduct.md Update code-of-conduct.md 2017-12-20 14:12:38 -05:00
remove-node.yml Merge pull request #2757 from qbl/master 2018-05-14 09:54:57 +08: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 Make it possible to skip docker role as a var (#2686) 2018-04-19 16:47:20 +03:00
setup.cfg Fix missing install remove-node feature 2018-04-11 17:30:01 +08:00
setup.py Add pbr build configuration 2017-08-18 12:56:01 +02:00
upgrade-cluster.yml Make it possible to skip docker role as a var (#2686) 2018-04-19 16:47:20 +03:00

README.md

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
  • High available cluster
  • Composable (Choice of the network plugin for instance)
  • Support 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

# Simply running `vagrant up` (for tests purposes)
vagrant up

Documents

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.

Versions of 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.

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

Gitlab Logo

Build graphs

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