Deploy a Production Ready Kubernetes Cluster

Max Gautier c6758fe544 Cleanup of kubernetes/preinstall (#11010) 12 hours ago
.github de4d6a69ee Make more fields mandatory in bug report template (#10883) 1 month ago
.gitlab-ci 12c8d0456f Move perma failing jobs in CI to manual run (#10886) 1 month ago
contrib 01c86af77f Make proxy protocol in upcloud LB configurable (#10971) 6 days ago
docs baf4842774 make kube-vip LeaderElection variables configurable (#11021) 4 days ago
extra_playbooks 51069223f5 Decouple kubespray-defaults from download (#10626) 3 months ago
inventory 10315590c7 Change hard-coded URLs to use variables (#11031) 1 day ago
library acbf44a1b4 Adds support for Ansible collections (#9582) 1 year ago
logo 2c93c997cf pre-commit autocorrected files (#9750) 1 year ago
meta 7f6ca804a1 Upgrade ansible-core to 2.16.4 (#10984) 2 weeks ago
playbooks 7f6ca804a1 Upgrade ansible-core to 2.16.4 (#10984) 2 weeks ago
plugins 73ce6aef97 kube.py support kubeconfig (#9982) 11 months ago
roles c6758fe544 Cleanup of kubernetes/preinstall (#11010) 12 hours ago
scripts 26af6c7fda scripts: ignore download_hash download failures (#10998) 2 weeks ago
test-infra b60220c597 Update almalinux-8 base image to 8.9 (#10918) 1 month ago
tests ef95eb078a Cleanup unused CI tooling (#11014) 1 week ago
.ansible-lint d21bfb84ad project: resolve ansible-lint key-order rule (#10314) 7 months ago
.ansible-lint-ignore 51069223f5 Decouple kubespray-defaults from download (#10626) 3 months ago
.editorconfig 4c1e0b188d Add .editorconfig file (#6307) 3 years ago
.gitignore 8fa5ae1865 bin: improve manage-offline-container-images script (#10857) 1 month ago
.gitlab-ci.yml 4317723d3c cleanup-for-2.24.1 (#10962) 1 month ago
.gitmodules 611c7744a1 Remove submodules 8 years ago
.markdownlint.yaml e6976a54e1 add pre-commit hook to facilitate local testing (#9158) 1 year ago
.nojekyll 9e76aafc1c Publish docs with docsify (#4193) 5 years ago
.pre-commit-config.yaml d2944d2813 Check jinja templates for syntax error (#10667) 3 months ago
.yamllint 6769bb32b1 Network plugin custom (#9819) 1 year ago
CHANGELOG.md 9312ae7c6e project: fix galaxy ansible-lint rule (#10277) 8 months ago
CNAME 2c93c997cf pre-commit autocorrected files (#9750) 1 year ago
CONTRIBUTING.md 25cb90bc2d Upgrade ansible (#10190) 9 months ago
Dockerfile 9a31f3285a chore(Dockerfile): best practices (#10708) 3 months ago
LICENSE 2c93c997cf pre-commit autocorrected files (#9750) 1 year ago
Makefile 8d553f7e91 Mitogen: deprecate the use of mitogen and remove coverage from CI (#8147) 2 years ago
OWNERS 2c93c997cf pre-commit autocorrected files (#9750) 1 year ago
OWNERS_ALIASES 4a259ee3f0 Remove mirwan from approvers (#10930) 1 month ago
README.md 03ac02afe4 [kubernetes] Add hashes for kubernetes 1.29.3, 1.28.8, 1.27.12 (#11035) 1 day ago
RELEASE.md 4e52fb7a1f Adjust the releases process documentation. (#10727) 2 months ago
SECURITY_CONTACTS 5603f9f374 Update security contacts file (#9235) 1 year ago
Vagrantfile 7ddc175b70 Show log on vagrant (#10958) 2 weeks ago
_config.yml 4c1e0b188d Add .editorconfig file (#6307) 3 years ago
ansible.cfg 44950efc34 fix ssh_args in ansible.cfg no effect (#10981) 3 weeks ago
cluster.yml acbf44a1b4 Adds support for Ansible collections (#9582) 1 year ago
code-of-conduct.md 3cd06b0eb4 Update code-of-conduct.md 6 years ago
galaxy.yml ad9f194c24 Adjust galaxy.yml (#10906) 1 month ago
index.html cc77a8c395 Add logo folders (#4515) 5 years ago
pipeline.Dockerfile a306f15a74 bump vagrant 2.3.7 (#10787) 2 months ago
recover-control-plane.yml 169eb34a59 Fix playbook names for galaxy (#10021) 11 months ago
remove-node.yml 169eb34a59 Fix playbook names for galaxy (#10021) 11 months ago
requirements.txt 7f6ca804a1 Upgrade ansible-core to 2.16.4 (#10984) 2 weeks ago
reset.yml acbf44a1b4 Adds support for Ansible collections (#9582) 1 year ago
run.rc 25cb90bc2d Upgrade ansible (#10190) 9 months ago
scale.yml acbf44a1b4 Adds support for Ansible collections (#9582) 1 year ago
setup.cfg a6853cb79d library files added to setup.cfg (#5274) 4 years ago
setup.py 8058cdbc0e Add pbr build configuration 6 years ago
upgrade-cluster.yml 169eb34a59 Fix playbook names for galaxy (#10021) 11 months ago

README.md

Deploy a Production Ready Kubernetes Cluster

Kubernetes Logo

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

  • Can be deployed on AWS, GCE, Azure, OpenStack, vSphere, Equinix Metal (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

Below are several ways to use Kubespray to deploy a Kubernetes cluster.

Ansible

Usage

Install Ansible according to Ansible installation guide then run the following steps:

# 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

# Clean up old Kubernetes cluster with Ansible Playbook - run the playbook as root
# The option `--become` is required, as for example cleaning up SSL keys in /etc/,
# uninstalling old packages and interacting with various systemd daemons.
# Without --become the playbook will fail to run!
# And be mind it will remove the current kubernetes cluster (if it's running)!
ansible-playbook -i inventory/mycluster/hosts.yaml  --become --become-user=root reset.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 node, 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, the ansible-playbook command will fail with:

ERROR! no action detected in task. This often indicates a misspelled module name, or incorrect module path.

This likely indicates that a task depends on a module present in requirements.txt.

One way of addressing this is to uninstall the system Ansible package then reinstall Ansible via pip, but this not always possible and one must take care regarding package versions. A workaround consists of setting the ANSIBLE_LIBRARY and ANSIBLE_MODULE_UTILS environment variables respectively to the ansible/modules and ansible/module_utils subdirectories of the pip installation location, which is the Location shown by running pip show [package] before executing ansible-playbook.

A simple way to ensure you get all the correct version of Ansible is to use the pre-built docker image from Quay. You will then need to use bind mounts to access the inventory and SSH key in the container, like this:

git checkout v2.24.1
docker pull quay.io/kubespray/kubespray:v2.24.1
docker run --rm -it --mount type=bind,source="$(pwd)"/inventory/sample,dst=/inventory \
  --mount type=bind,source="${HOME}"/.ssh/id_rsa,dst=/root/.ssh/id_rsa \
  quay.io/kubespray/kubespray:v2.24.1 bash
# Inside the container you may now run the kubespray playbooks:
ansible-playbook -i /inventory/inventory.ini --private-key /root/.ssh/id_rsa cluster.yml

Collection

See here if you wish to use this repository as an Ansible collection

Vagrant

For Vagrant we need to install Python dependencies for provisioning tasks. Check that 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 Ansible according to Ansible installation guide then run the following step:

vagrant up

Documents

Supported Linux Distributions

  • Flatcar Container Linux by Kinvolk
  • Debian Bookworm, Bullseye, Buster
  • Ubuntu 20.04, 22.04
  • CentOS/RHEL 7, 8, 9
  • Fedora 37, 38
  • Fedora CoreOS (see fcos Note)
  • openSUSE Leap 15.x/Tumbleweed
  • Oracle Linux 7, 8, 9
  • Alma Linux 8, 9
  • Rocky Linux 8, 9
  • Kylin Linux Advanced Server V10 (experimental: see kylin linux notes)
  • Amazon Linux 2 (experimental: see amazon linux notes)
  • UOS Linux (experimental: see uos linux notes)
  • openEuler (experimental: see openEuler notes)

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

Supported Components

Container Runtime Notes

  • Supported Docker versions are 18.09, 19.03, 20.10, 23.0 and 24.0. The recommended Docker version is 24.0. 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. the YUM versionlock plugin or apt pin).
  • The cri-o version should be aligned with the respective kubernetes version (i.e. kube_version=1.20.x, crio_version=1.20)

Requirements

  • Minimum required version of Kubernetes is v1.27
  • Ansible v2.14+, Jinja 2.11+ and python-netaddr is installed on the machine that will run Ansible commands
  • 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.
  • If using IPv6 for pods and services, the target servers are configured to allow IPv6 forwarding.
  • 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 run 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 safeguarded 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 among ten 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.

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

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

  • custom_cni : You can specify some manifests that will be applied to the clusters to bring you own CNI and use non-supported ones by Kubespray. See tests/files/custom_cni/README.md and tests/files/custom_cni/values.yamlfor an example with a CNI provided by a Helm Chart.

The network plugin to use is defined by the variable kube_network_plugin. There is also an option to leverage built-in cloud provider networking instead. See also Network checker.

Ingress Plugins

  • nginx: the NGINX Ingress Controller.

  • metallb: the MetalLB bare-metal service LoadBalancer provider.

Community docs and resources

Tools and projects on top of Kubespray

CI Tests

Build graphs

CI/end-to-end tests sponsored by: CNCF, Equinix Metal, OVHcloud, ELASTX.

See the test matrix for details.