Deploy a Production Ready Kubernetes Cluster
 
 
 
 
 
Go to file
Xiaodu 63fa406c3c
Move host_architecture to kubespray-defaults (#5811)
The variable is defined in `kubernetes/preinstall` role and used in several roles. Since `kubernetes/preinstall` is not always included when `ansible-playbook` is run with tag selectors (see #5734 for reason), they will fail, or individual roles must copy the same fact definitions (as in #3846). Moving the definition to the always-included `kubespray-defaults` role will resolve the dependency problem.
2020-03-25 12:58:25 -07:00
.github Require a complete inventory with all variables in the bugreport (#5655) 2020-02-25 23:58:25 -08:00
.gitlab-ci Use a separate runner for light CI jobs (#5771) 2020-03-13 20:29:22 +03:00
contrib Fix deploy heketi show selector missing error. (#5738) 2020-03-16 03:32:36 -07:00
docs Fix broken internal links (#5799) 2020-03-20 15:40:44 -07:00
extra_playbooks [Openstack] Cleanup the old in-tree openstack cloud provider (#5742) 2020-03-11 05:13:36 -07:00
inventory Add variables to configure Containerd default runtime, untrusted runt… (#5497) 2020-03-16 03:48:36 -07:00
library recursive option for kube ansible module (#4273) 2019-02-25 22:17:23 -08:00
logo Add logo folders (#4515) 2019-04-12 11:00:47 -07:00
roles Move host_architecture to kubespray-defaults (#5811) 2020-03-25 12:58:25 -07:00
scripts Add documentation for scripts/openstack-cleanup (#5803) 2020-03-20 13:18:06 -07:00
test-infra/image-builder Add CentOS 8 image for testing (#5589) 2020-01-29 02:06:16 -08:00
tests Fix ERROR! the playbook: tests/testcases/020_check-nodes-ready.yml could not be found (#5798) 2020-03-20 01:14:35 -07:00
.ansible-lint Apply workaround for NetworkManager and calico (#5230) 2019-10-02 04:37:07 -07:00
.gitignore Tell git to ignore .terraform directory (#4428) 2019-04-05 01:27:18 -07:00
.gitlab-ci.yml Use the v2.12.3 docker image for CI (#5712) 2020-03-05 05:40:37 -08:00
.gitmodules Remove submodules 2016-03-04 16:14:01 +01:00
.markdownlint.yaml Add markdown CI (#5380) 2019-12-04 07:22:57 -08:00
.nojekyll Publish docs with docsify (#4193) 2019-02-07 04:52:08 -08:00
.yamllint Adding yamllinter to ci steps (#1556) 2017-08-24 12:09:52 +03:00
CNAME Update CNAME 2019-02-07 16:30:25 +03:00
CONTRIBUTING.md Add CNCF CLA to the contributing document (#4281) 2019-02-20 06:47:17 -08:00
Dockerfile Use kubespray/kubespray:v2.11.0 for CI (#5363) 2019-12-11 00:10:05 -08:00
LICENSE Create LICENSE 2016-03-01 15:37:01 +01:00
Makefile Add playbook to install mitogen (#3622) 2018-10-31 11:52:47 +01:00
OWNERS Updated OWNERS file pointing to docs (#4184) 2019-02-18 05:49:36 -08:00
OWNERS_ALIASES Add OWNERS file for kube-router (#5782) 2020-03-17 04:14:22 -07:00
README.md remove atomic support because reached end of live (#5783) 2020-03-17 14:31:27 -07:00
RELEASE.md Securing http link to https link (#5617) 2020-02-13 14:46:17 -08:00
SECURITY_CONTACTS Update security contacts (#5719) 2020-03-06 10:47:24 -08:00
Vagrantfile Fix to Vagrant config.rb apply correctly (#5525) 2020-02-18 00:13:28 -08:00
_config.yml Yamllint fixes (#4410) 2019-04-01 02:38:33 -07:00
ansible.cfg Do not display skipped hosts/tasks. (#5620) 2020-02-19 02:38:25 -08:00
cluster.yml External OpenStack Cloud Controller Manager implementation (#5491) 2020-02-18 04:47:28 -08:00
code-of-conduct.md Update code-of-conduct.md 2017-12-20 14:12:38 -05:00
index.html Add logo folders (#4515) 2019-04-12 11:00:47 -07:00
mitogen.yaml ansible-lint: add spaces around variables [E206] (#4699) 2019-05-02 14:24:21 -07:00
recover-control-plane.yml Check ansible version >=2.7.8 in recover-control-plane.yml playbook (#5724) 2020-03-07 10:17:34 -08:00
remove-node.yml Fixes issue #5160 (#5171) 2019-09-16 23:42:22 -07:00
requirements.txt Bump ansible from 2.7.12 to 2.7.16 (#5739) 2020-03-09 06:31:34 -07:00
reset.yml No need to gather facts on localhost (#5251) 2019-10-15 06:57:53 -07:00
scale.yml Refactor download role (#5697) 2020-03-05 07:31:39 -08:00
setup.cfg library files added to setup.cfg (#5274) 2019-11-11 03:59:41 -08:00
setup.py Add pbr build configuration 2017-08-18 12:56:01 +02:00
upgrade-cluster.yml install csi-driver not just cinder (#5766) 2020-03-13 05:34:39 -07:00

README.md

Deploy a Production Ready Kubernetes Cluster

Kubernetes Logo

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

  • Can be deployed on AWS, GCE, Azure, OpenStack, vSphere, Packet (bare metal), 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

Usage

# Install dependencies from ``requirements.txt``
sudo pip3 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.yaml python3 contrib/inventory_builder/inventory.py ${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 `--become` is required, as for example writing SSL keys in /etc/,
# installing packages and interacting with various systemd daemons.
# Without --become the playbook will fail to run!
ansible-playbook -i inventory/mycluster/hosts.yaml  --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.

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 Buster, Jessie, Stretch, Wheezy
  • Ubuntu 16.04, 18.04
  • CentOS/RHEL 7
  • Fedora 28
  • Fedora CoreOS (experimental: see fcos Note
  • openSUSE Leap 42.3/Tumbleweed
  • Oracle Linux 7

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

Supported Components

Note: The list of validated docker versions was updated to 1.13.1, 17.03, 17.06, 17.09, 18.06, 18.09. 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).

Requirements

  • Minimum required version of Kubernetes is v1.15
  • Ansible v2.7.8 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.

Hardware: These limits are safe guarded by Kubespray. Actual requirements for your workload can differ. For a sizing guide go to the Building Large Clusters guide.

  • Master
    • Memory: 1500 MB
  • Node
    • Memory: 1024 MB

Network Plugins

You can choose between 10 network plugins. (default: calico, except Vagrant uses flannel)

  • flannel: gre/vxlan (layer 2) networking.

  • Calico is a networking and network policy provider. Calico supports a flexible set of networking options designed to give you the most efficient networking across a range of situations, including non-overlay and overlay networks, with or without BGP. Calico uses the same engine to enforce network policy for hosts, pods, and (if using Istio and Envoy) applications at the service mesh layer.

  • 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-ovn: Kube-OVN integrates the OVN-based Network Virtualization with Kubernetes. It offers an advanced Container Network Fabric for Enterprises.

  • 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.

  • macvlan: Macvlan is a Linux network driver. Pods have their own unique Mac and Ip address, connected directly the physical (layer 2) network.

  • 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.