Need help with kubespray?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

kubernetes-sigs
9.7K Stars 4.1K Forks Apache License 2.0 5.5K Commits 191 Opened issues

Description

Deploy a Production Ready Kubernetes Cluster

Services available

!
?

Need anything else?

Contributors list

No Data

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, 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

  • Flatcar Container Linux by Kinvolk
  • Debian Buster, Jessie, Stretch, Wheezy
  • Ubuntu 16.04, 18.04, 20.04
  • CentOS/RHEL 7, 8 (experimental: see centos 8 notes)
  • Fedora 31, 32
  • Fedora CoreOS (experimental: see fcos Note)
  • openSUSE Leap 42.3/Tumbleweed
  • Oracle Linux 7, 8 (experimental: centos 8 notes apply)

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

Supported Components

Note: The list of validated docker versions is 1.13.1, 17.03, 17.06, 17.09, 18.06, 18.09 and 19.03. The recommended docker version is 19.03. 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.17
  • Ansible v2.9+, 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.
  • 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.

  • ovn4nfv: ovn4nfv-k8s-plugins is the network controller, OVS agent and CNI server to offer basic SFC and OVN overlay networking.

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

Ingress Plugins

  • ambassador: the Ambassador Ingress Controller and API gateway.

  • nginx: the NGINX Ingress Controller.

Community docs and resources

Tools and projects on top of Kubespray

CI Tests

Build graphs

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

See the test matrix for details.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.