1 # Deploy a Production Ready Kubernetes Cluster
3 ![Kubernetes Logo](https://raw.githubusercontent.com/kubernetes-sigs/kubespray/master/docs/img/kubernetes-logo.png)
5 If you have questions, check the documentation at [kubespray.io](https://kubespray.io) and join us on the [kubernetes slack](https://kubernetes.slack.com), channel **\#kubespray**.
6 You can get your invite [here](http://slack.k8s.io/)
8 - Can be deployed on **[AWS](docs/aws.md), GCE, [Azure](docs/azure.md), [OpenStack](docs/openstack.md), [vSphere](docs/vsphere.md), [Equinix Metal](docs/equinix-metal.md) (bare metal), Oracle Cloud Infrastructure (Experimental), or Baremetal**
9 - **Highly available** cluster
10 - **Composable** (Choice of the network plugin for instance)
11 - Supports most popular **Linux distributions**
12 - **Continuous integration tests**
16 To deploy the cluster you can use :
22 Install Ansible according to [Ansible installation guide](/docs/ansible.md#installing-ansible)
23 then run the following steps:
26 # Copy ``inventory/sample`` as ``inventory/mycluster``
27 cp -rfp inventory/sample inventory/mycluster
29 # Update Ansible inventory file with inventory builder
30 declare -a IPS=(10.10.1.3 10.10.1.4 10.10.1.5)
31 CONFIG_FILE=inventory/mycluster/hosts.yaml python3 contrib/inventory_builder/inventory.py ${IPS[@]}
33 # Review and change parameters under ``inventory/mycluster/group_vars``
34 cat inventory/mycluster/group_vars/all/all.yml
35 cat inventory/mycluster/group_vars/k8s_cluster/k8s-cluster.yml
37 # Deploy Kubespray with Ansible Playbook - run the playbook as root
38 # The option `--become` is required, as for example writing SSL keys in /etc/,
39 # installing packages and interacting with various systemd daemons.
40 # Without --become the playbook will fail to run!
41 ansible-playbook -i inventory/mycluster/hosts.yaml --become --become-user=root cluster.yml
44 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).
45 As a consequence, `ansible-playbook` command will fail with:
48 ERROR! no action detected in task. This often indicates a misspelled module name, or incorrect module path.
51 probably pointing on a task depending on a module present in requirements.txt.
53 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.
54 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`.
56 A simple way to ensure you get all the correct version of Ansible is to use the [pre-built docker image from Quay](https://quay.io/repository/kubespray/kubespray?tab=tags).
57 You will then need to use [bind mounts](https://docs.docker.com/storage/bind-mounts/) to get the inventory and ssh key into the container, like this:
60 docker pull quay.io/kubespray/kubespray:v2.19.0
61 docker run --rm -it --mount type=bind,source="$(pwd)"/inventory/sample,dst=/inventory \
62 --mount type=bind,source="${HOME}"/.ssh/id_rsa,dst=/root/.ssh/id_rsa \
63 quay.io/kubespray/kubespray:v2.19.0 bash
64 # Inside the container you may now run the kubespray playbooks:
65 ansible-playbook -i /inventory/inventory.ini --private-key /root/.ssh/id_rsa cluster.yml
70 For Vagrant we need to install python dependencies for provisioning tasks.
71 Check if Python and pip are installed:
77 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/>
79 Install Ansible according to [Ansible installation guide](/docs/ansible.md#installing-ansible)
80 then run the following step:
88 - [Requirements](#requirements)
89 - [Kubespray vs ...](docs/comparisons.md)
90 - [Getting started](docs/getting-started.md)
91 - [Setting up your first cluster](docs/setting-up-your-first-cluster.md)
92 - [Ansible inventory and tags](docs/ansible.md)
93 - [Integration with existing ansible repo](docs/integration.md)
94 - [Deployment data variables](docs/vars.md)
95 - [DNS stack](docs/dns-stack.md)
96 - [HA mode](docs/ha-mode.md)
97 - [Network plugins](#network-plugins)
98 - [Vagrant install](docs/vagrant.md)
99 - [Flatcar Container Linux bootstrap](docs/flatcar.md)
100 - [Fedora CoreOS bootstrap](docs/fcos.md)
101 - [Debian Jessie setup](docs/debian.md)
102 - [openSUSE setup](docs/opensuse.md)
103 - [Downloaded artifacts](docs/downloads.md)
104 - [Cloud providers](docs/cloud.md)
105 - [OpenStack](docs/openstack.md)
107 - [Azure](docs/azure.md)
108 - [vSphere](docs/vsphere.md)
109 - [Equinix Metal](docs/equinix-metal.md)
110 - [Large deployments](docs/large-deployments.md)
111 - [Adding/replacing a node](docs/nodes.md)
112 - [Upgrades basics](docs/upgrades.md)
113 - [Air-Gap installation](docs/offline-environment.md)
115 - [Hardening](docs/hardening.md)
116 - [Roadmap](docs/roadmap.md)
118 ## Supported Linux Distributions
120 - **Flatcar Container Linux by Kinvolk**
121 - **Debian** Bullseye, Buster, Jessie, Stretch
122 - **Ubuntu** 16.04, 18.04, 20.04, 22.04
123 - **CentOS/RHEL** 7, [8](docs/centos.md#centos-8)
125 - **Fedora CoreOS** (see [fcos Note](docs/fcos.md))
126 - **openSUSE** Leap 15.x/Tumbleweed
127 - **Oracle Linux** 7, [8](docs/centos.md#centos-8)
128 - **Alma Linux** [8](docs/centos.md#centos-8)
129 - **Rocky Linux** [8](docs/centos.md#centos-8)
130 - **Kylin Linux Advanced Server V10** (experimental: see [kylin linux notes](docs/kylinlinux.md))
131 - **Amazon Linux 2** (experimental: see [amazon linux notes](docs/amazonlinux.md))
133 Note: Upstart/SysV init based OS types are not supported.
135 ## Supported Components
138 - [kubernetes](https://github.com/kubernetes/kubernetes) v1.24.4
139 - [etcd](https://github.com/etcd-io/etcd) v3.5.4
140 - [docker](https://www.docker.com/) v20.10 (see note)
141 - [containerd](https://containerd.io/) v1.6.8
142 - [cri-o](http://cri-o.io/) v1.24 (experimental: see [CRI-O Note](docs/cri-o.md). Only on fedora, ubuntu and centos based OS)
144 - [cni-plugins](https://github.com/containernetworking/plugins) v1.1.1
145 - [calico](https://github.com/projectcalico/calico) v3.23.3
146 - [canal](https://github.com/projectcalico/canal) (given calico/flannel versions)
147 - [cilium](https://github.com/cilium/cilium) v1.11.7
148 - [flannel](https://github.com/flannel-io/flannel) v0.18.1
149 - [kube-ovn](https://github.com/alauda/kube-ovn) v1.9.7
150 - [kube-router](https://github.com/cloudnativelabs/kube-router) v1.5.1
151 - [multus](https://github.com/intel/multus-cni) v3.8
152 - [weave](https://github.com/weaveworks/weave) v2.8.1
153 - [kube-vip](https://github.com/kube-vip/kube-vip) v0.4.2
155 - [cert-manager](https://github.com/jetstack/cert-manager) v1.9.0
156 - [coredns](https://github.com/coredns/coredns) v1.8.6
157 - [ingress-nginx](https://github.com/kubernetes/ingress-nginx) v1.3.0
158 - [krew](https://github.com/kubernetes-sigs/krew) v0.4.3
159 - [argocd](https://argoproj.github.io/) v2.4.7
160 - [helm](https://helm.sh/) v3.9.2
161 - [metallb](https://metallb.universe.tf/) v0.12.1
162 - [registry](https://github.com/distribution/distribution) v2.8.1
164 - [cephfs-provisioner](https://github.com/kubernetes-incubator/external-storage) v2.1.0-k8s1.11
165 - [rbd-provisioner](https://github.com/kubernetes-incubator/external-storage) v2.1.1-k8s1.11
166 - [aws-ebs-csi-plugin](https://github.com/kubernetes-sigs/aws-ebs-csi-driver) v0.5.0
167 - [azure-csi-plugin](https://github.com/kubernetes-sigs/azuredisk-csi-driver) v1.10.0
168 - [cinder-csi-plugin](https://github.com/kubernetes/cloud-provider-openstack/blob/master/docs/cinder-csi-plugin/using-cinder-csi-plugin.md) v1.22.0
169 - [gcp-pd-csi-plugin](https://github.com/kubernetes-sigs/gcp-compute-persistent-disk-csi-driver) v1.4.0
170 - [local-path-provisioner](https://github.com/rancher/local-path-provisioner) v0.0.22
171 - [local-volume-provisioner](https://github.com/kubernetes-sigs/sig-storage-local-static-provisioner) v2.4.0
173 ## Container Runtime Notes
175 - The list of available docker version is 18.09, 19.03 and 20.10. The recommended docker version is 20.10. 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).
176 - The cri-o version should be aligned with the respective kubernetes version (i.e. kube_version=1.20.x, crio_version=1.20)
180 - **Minimum required version of Kubernetes is v1.22**
181 - **Ansible v2.11+, Jinja 2.11+ and python-netaddr is installed on the machine that will run Ansible commands**
182 - The target servers must have **access to the Internet** in order to pull docker images. Otherwise, additional configuration is required (See [Offline Environment](docs/offline-environment.md))
183 - The target servers are configured to allow **IPv4 forwarding**.
184 - If using IPv6 for pods and services, the target servers are configured to allow **IPv6 forwarding**.
185 - The **firewalls are not managed**, you'll need to implement your own rules the way you used to.
186 in order to avoid any issue during deployment you should disable your firewall.
187 - If kubespray is ran from non-root user account, correct privilege escalation method
188 should be configured in the target servers. Then the `ansible_become` flag
189 or command parameters `--become or -b` should be specified.
192 These limits are safe guarded by Kubespray. Actual requirements for your workload can differ. For a sizing guide go to the [Building Large Clusters](https://kubernetes.io/docs/setup/cluster-large/#size-of-master-and-master-components) guide.
201 You can choose between 10 network plugins. (default: `calico`, except Vagrant uses `flannel`)
203 - [flannel](docs/flannel.md): gre/vxlan (layer 2) networking.
205 - [Calico](https://docs.projectcalico.org/latest/introduction/) is a networking and network policy provider. Calico supports a flexible set of networking options
206 designed to give you the most efficient networking across a range of situations, including non-overlay
207 and overlay networks, with or without BGP. Calico uses the same engine to enforce network policy for hosts,
208 pods, and (if using Istio and Envoy) applications at the service mesh layer.
210 - [canal](https://github.com/projectcalico/canal): a composition of calico and flannel plugins.
212 - [cilium](http://docs.cilium.io/en/latest/): 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.
214 - [weave](docs/weave.md): Weave is a lightweight container overlay network that doesn't require an external K/V database cluster.
215 (Please refer to `weave` [troubleshooting documentation](https://www.weave.works/docs/net/latest/troubleshooting/)).
217 - [kube-ovn](docs/kube-ovn.md): Kube-OVN integrates the OVN-based Network Virtualization with Kubernetes. It offers an advanced Container Network Fabric for Enterprises.
219 - [kube-router](docs/kube-router.md): Kube-router is a L3 CNI for Kubernetes networking aiming to provide operational
220 simplicity and high performance: it uses IPVS to provide Kube Services Proxy (if setup to replace kube-proxy),
221 iptables for network policies, and BGP for ods L3 networking (with optionally BGP peering with out-of-cluster BGP peers).
222 It can also optionally advertise routes to Kubernetes cluster Pods CIDRs, ClusterIPs, ExternalIPs and LoadBalancerIPs.
224 - [macvlan](docs/macvlan.md): Macvlan is a Linux network driver. Pods have their own unique Mac and Ip address, connected directly the physical (layer 2) network.
226 - [multus](docs/multus.md): 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.
228 The choice is defined with the variable `kube_network_plugin`. There is also an
229 option to leverage built-in cloud provider networking instead.
230 See also [Network checker](docs/netcheck.md).
234 - [nginx](https://kubernetes.github.io/ingress-nginx): the NGINX Ingress Controller.
236 - [metallb](docs/metallb.md): the MetalLB bare-metal service LoadBalancer provider.
238 ## Community docs and resources
240 - [kubernetes.io/docs/setup/production-environment/tools/kubespray/](https://kubernetes.io/docs/setup/production-environment/tools/kubespray/)
241 - [kubespray, monitoring and logging](https://github.com/gregbkr/kubernetes-kargo-logging-monitoring) by @gregbkr
242 - [Deploy Kubernetes w/ Ansible & Terraform](https://rsmitty.github.io/Terraform-Ansible-Kubernetes/) by @rsmitty
243 - [Deploy a Kubernetes Cluster with Kubespray (video)](https://www.youtube.com/watch?v=CJ5G4GpqDy0)
245 ## Tools and projects on top of Kubespray
247 - [Digital Rebar Provision](https://github.com/digitalrebar/provision/blob/v4/doc/integrations/ansible.rst)
248 - [Terraform Contrib](https://github.com/kubernetes-sigs/kubespray/tree/master/contrib/terraform)
252 [![Build graphs](https://gitlab.com/kargo-ci/kubernetes-sigs-kubespray/badges/master/pipeline.svg)](https://gitlab.com/kargo-ci/kubernetes-sigs-kubespray/pipelines)
254 CI/end-to-end tests sponsored by: [CNCF](https://cncf.io), [Equinix Metal](https://metal.equinix.com/), [OVHcloud](https://www.ovhcloud.com/), [ELASTX](https://elastx.se/).
256 See the [test matrix](docs/test_cases.md) for details.