6.7 KiB

Raw Blame History

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

Quick Start

To deploy the cluster you can use :

Ansible

# 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
Ubuntu 16.04
CentOS/RHEL 7
Fedora/CentOS Atomic

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

Versions of supported components

kubernetes v1.9.5
etcd v3.2.4
flanneld v0.10.0
calico v2.5.0
canal (given calico/flannel versions)
cilium v1.0.0-rc4
contiv v1.0.3
weave v2.0.1
docker v17.03 (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.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.

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

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

6.7 KiB Raw Blame History