If you have questions, check the documentation atkubespray.ioand join us on thekubernetes slack,channel#kubespray. You can get your invitehere
- Can be deployed onAWS,GCE,Azure,OpenStack,vSphere,Equinix Metal(bare metal), Oracle Cloud Infrastructure (Experimental), or Baremetal
- Highly availablecluster
- Composable(Choice of the network plugin for instance)
- Supports most popularLinux distributions
- Continuous integration tests
Below are several ways to use Kubespray to deploy a Kubernetes cluster.
Install Ansible according toAnsible 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 Python 3 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, asforexample writing SSL keysin/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 viasudo pip install -r requirements.txt
will go to
a different directory tree (e.g./usr/local/lib/ Python 2.7/dist-packages
on
Ubuntu) from Ansible's (e.g./usr/lib/ Python 2.7/dist-packages/ansible
still on
Ubuntu). As a consequence, theansible-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 inrequirements.txt
.
One way of addressing this is to uninstall the system Ansible package then
reinstall Ansible viapip
,but this not always possible and one must
take care regarding package versions.
A workaround consists of setting theANSIBLE_LIBRARY
andANSIBLE_MODULE_UTILS
environment variables respectively to
theansible/modules
andansible/module_utils
subdirectories of thepip
installation location, which is theLocation
shown by running
pip show [package]
before executingansible-playbook
.
A simple way to ensure you get all the correct version of Ansible is to use thepre-built docker image from Quay. You will then need to usebind mounts to access the inventory and SSH key in the container, like this:
git checkout v2.20.0
docker pull quay.io/kubespray/kubespray:v2.20.0
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.20.0 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
For Vagrant we need to install Python dependencies for provisioning tasks.
Check thatPython
andpip
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 herehttps:// Python.org/downloads/source/
Install Ansible according toAnsible installation guide then run the following step:
vagrant up
- Requirements
- Kubespray vs...
- Getting started
- Setting up your first cluster
- Ansible inventory and tags
- Integration with existing ansible repo
- Deployment data variables
- DNS stack
- HA mode
- Network plugins
- Vagrant install
- Flatcar Container Linux bootstrap
- Fedora CoreOS bootstrap
- Debian Jessie setup
- openSUSE setup
- Downloaded artifacts
- Cloud providers
- OpenStack
- AWS
- Azure
- vSphere
- Equinix Metal
- Large deployments
- Adding/replacing a node
- Upgrades basics
- Air-Gap installation
- NTP
- Hardening
- Mirror
- Roadmap
- Flatcar Container Linux by Kinvolk
- DebianBullseye, Buster, Jessie, Stretch
- Ubuntu16.04, 18.04, 20.04, 22.04
- CentOS/RHEL7,8, 9
- Fedora35, 36
- Fedora CoreOS(seefcos Note)
- openSUSELeap 15.x/Tumbleweed
- Oracle Linux7,8, 9
- Alma Linux8, 9
- Rocky Linux8, 9
- Kylin Linux Advanced Server V10(experimental: seekylin linux notes)
- Amazon Linux 2(experimental: seeamazon linux notes)
- UOS Linux(experimental: seeuos linux notes)
- openEuler(experimental: seeopenEuler notes)
Note: Upstart/SysV init based OS types are not supported.
- Core
- kubernetesv1.26.1
- etcdv3.5.6
- dockerv20.10 (see note)
- containerdv1.6.16
- cri-ov1.24 (experimental: seeCRI-O Note.Only on fedora, ubuntu and centos based OS)
- Network Plugin
- cni-pluginsv1.2.0
- calicov3.24.5
- canal(given calico/flannel versions)
- ciliumv1.12.1
- flannelv0.20.2
- kube-ovnv1.10.7
- kube-routerv1.5.1
- multusv3.8
- weavev2.8.1
- kube-vipv0.5.8
- Application
- cert-managerv1.11.0
- corednsv1.9.3
- ingress-nginxv1.5.1
- krewv0.4.3
- argocdv2.5.10
- helmv3.10.3
- metallbv0.12.1
- registryv2.8.1
- Storage Plugin
- cephfs-provisionerv2.1.0-k8s1.11
- rbd-provisionerv2.1.1-k8s1.11
- aws-ebs-csi-pluginv0.5.0
- azure-csi-pluginv1.10.0
- cinder-csi-pluginv1.22.0
- gcp-pd-csi-pluginv1.4.0
- local-path-provisionerv0.0.22
- local-volume-provisionerv2.5.0
- Supported Docker versions are 18.09, 19.03 and 20.10. TherecommendedDocker version is 20.10.
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 YUMversionlock
plugin orapt pin
). - The cri-o version should be aligned with the respective kubernetes version (i.e. kube_version=1.20.x, crio_version=1.20)
- Minimum required version of Kubernetes is v1.24
- Ansible v2.11+, Jinja 2.11+ and Python -netaddr is installed on the machine that will run Ansible commands
- The target servers must haveaccess to the Internetin order to pull docker images. Otherwise, additional configuration is required (SeeOffline Environment)
- The target servers are configured to allowIPv4 forwarding.
- If using IPv6 for pods and services, the target servers are configured to allowIPv6 forwarding.
- Thefirewalls 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 theBuilding Large Clustersguide.
- Master
- Memory: 1500 MB
- Node
- Memory: 1024 MB
You can choose among ten network plugins. (default:calico
,except Vagrant usesflannel
)
-
flannel:gre/vxlan (layer 2) networking.
-
Calicois 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.
-
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 network plugin to use is defined by the variablekube_network_plugin
.There is also an
option to leverage built-in cloud provider networking instead.
See alsoNetwork checker.
- kubernetes.io/docs/setup/production-environment/tools/kubespray/
- kubespray, monitoring and loggingby @gregbkr
- Deploy Kubernetes w/ Ansible & Terraformby @rsmitty
- Deploy a Kubernetes Cluster with Kubespray (video)
CI/end-to-end tests sponsored by:CNCF,Equinix Metal,OVHcloud,ELASTX.
See thetest matrixfor details.