2018-04-16 22:33:24 +08:00
2016-07-06 23:34:16 +08:00
2018-02-01 14:42:34 +08:00
Deploy a Production Ready Kubernetes Cluster
============================================
2016-07-06 23:34:16 +08:00
2018-02-01 14:42:34 +08:00
If you have questions, join us on the [kubernetes slack ](https://kubernetes.slack.com ), channel ** \#kubespray**.
2018-09-04 17:33:55 +08:00
You can get your invite [here ](http://slack.k8s.io/ )
2016-07-06 23:34:16 +08:00
2018-07-20 22:56:38 +08:00
- Can be deployed on **AWS, GCE, Azure, OpenStack, vSphere, Oracle Cloud Infrastructure (Experimental), or Baremetal**
2018-07-03 17:39:51 +08:00
- **Highly available** cluster
2018-06-07 16:05:48 +08:00
- **Composable** (Choice of the network plugin for instance)
2018-07-03 17:39:51 +08:00
- Supports most popular **Linux distributions**
2018-06-07 16:05:48 +08:00
- **Continuous integration tests**
2016-07-06 23:34:16 +08:00
2018-02-01 14:42:34 +08:00
Quick Start
-----------
2016-07-06 23:34:16 +08:00
To deploy the cluster you can use :
2018-02-01 14:42:34 +08:00
### Ansible
2018-06-07 16:05:48 +08:00
2018-05-15 02:11:57 +08:00
# Install dependencies from ``requirements.txt``
sudo pip install -r requirements.txt
2018-02-01 14:42:34 +08:00
# Copy ``inventory/sample`` as ``inventory/mycluster``
2018-07-03 22:02:44 +08:00
cp -rfp inventory/sample/* inventory/mycluster
2018-02-01 14:42:34 +08:00
# 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.ini python3 contrib/inventory_builder/inventory.py ${IPS[@]}
# Review and change parameters under ``inventory/mycluster/group_vars``
cat inventory/mycluster/group_vars/all.yml
cat inventory/mycluster/group_vars/k8s-cluster.yml
# Deploy Kubespray with Ansible Playbook
ansible-playbook -i inventory/mycluster/hosts.ini cluster.yml
2018-09-07 23:26:55 +08:00
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` .
2018-02-01 14:42:34 +08:00
### Vagrant
2018-06-07 16:05:48 +08:00
For Vagrant we need to install python dependencies for provisioning tasks.
Check if Python and pip are installed:
2018-06-15 07:01:13 +08:00
python -V & & pip -V
2018-06-07 16:05:48 +08:00
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
2018-02-01 14:42:34 +08:00
Documents
---------
- [Requirements ](#requirements )
- [Kubespray vs ... ](docs/comparisons.md )
- [Getting started ](docs/getting-started.md )
- [Ansible inventory and tags ](docs/ansible.md )
- [Integration with existing ansible repo ](docs/integration.md )
- [Deployment data variables ](docs/vars.md )
- [DNS stack ](docs/dns-stack.md )
- [HA mode ](docs/ha-mode.md )
- [Network plugins ](#network-plugins )
- [Vagrant install ](docs/vagrant.md )
- [CoreOS bootstrap ](docs/coreos.md )
- [Debian Jessie setup ](docs/debian.md )
2018-04-26 17:52:06 +08:00
- [openSUSE setup ](docs/opensuse.md )
2018-02-01 14:42:34 +08:00
- [Downloaded artifacts ](docs/downloads.md )
- [Cloud providers ](docs/cloud.md )
- [OpenStack ](docs/openstack.md )
- [AWS ](docs/aws.md )
- [Azure ](docs/azure.md )
- [vSphere ](docs/vsphere.md )
- [Large deployments ](docs/large-deployments.md )
- [Upgrades basics ](docs/upgrades.md )
- [Roadmap ](docs/roadmap.md )
Supported Linux Distributions
-----------------------------
- **Container Linux by CoreOS**
2018-04-06 17:28:33 +08:00
- **Debian** Jessie, Stretch, Wheezy
2018-08-31 14:12:16 +08:00
- **Ubuntu** 16.04, 18.04
2018-02-01 14:42:34 +08:00
- **CentOS/RHEL** 7
2018-03-07 19:39:03 +08:00
- **Fedora/CentOS** Atomic
2018-04-26 17:52:06 +08:00
- **openSUSE** Leap 42.3/Tumbleweed
2016-07-06 23:34:16 +08:00
2017-01-05 21:52:51 +08:00
Note: Upstart/SysV init based OS types are not supported.
2018-06-07 16:58:31 +08:00
Supported Components
--------------------
- Core
2018-09-10 15:50:12 +08:00
- [kubernetes ](https://github.com/kubernetes/kubernetes ) v1.11.3
2018-06-07 16:58:31 +08:00
- [etcd ](https://github.com/coreos/etcd ) v3.2.18
- [docker ](https://www.docker.com/ ) v17.03 (see note)
- [rkt ](https://github.com/rkt/rkt ) v1.21.0 (see Note 2)
- Network Plugin
2018-08-23 22:17:18 +08:00
- [calico ](https://github.com/projectcalico/calico ) v3.1.3
2018-06-07 16:58:31 +08:00
- [canal ](https://github.com/projectcalico/canal ) (given calico/flannel versions)
2018-08-22 15:29:42 +08:00
- [cilium ](https://github.com/cilium/cilium ) v1.2.0
2018-06-07 16:58:31 +08:00
- [contiv ](https://github.com/contiv/install ) v1.1.7
- [flanneld ](https://github.com/coreos/flannel ) v0.10.0
2018-09-17 17:09:19 +08:00
- [weave ](https://github.com/weaveworks/weave ) v2.4.1
2018-06-07 16:58:31 +08:00
- Application
2018-09-02 11:51:28 +08:00
- [cephfs-provisioner ](https://github.com/kubernetes-incubator/external-storage ) v2.1.0-k8s1.11
2018-08-15 11:33:08 +08:00
- [cert-manager ](https://github.com/jetstack/cert-manager ) v0.4.1
2018-09-02 11:37:21 +08:00
- [coredns ](https://github.com/coredns/coredns ) v1.2.2
2018-09-02 12:19:38 +08:00
- [ingress-nginx ](https://github.com/kubernetes/ingress-nginx ) v0.19.0
2016-07-06 23:34:16 +08:00
2018-09-04 20:34:04 +08:00
Note: kubernetes doesn't support newer docker versions ("Version 17.03 is recommended... Versions 17.06+ might work, but have not yet been tested and verified by the Kubernetes node team" cf. [Bootstrapping Clusters with kubeadm ](https://kubernetes.io/docs/setup/independent/install-kubeadm/#installing-docker )). Among other things kubelet currently breaks 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).
2017-05-29 02:55:44 +08:00
Note 2: rkt support as docker alternative is limited to control plane (etcd and
2017-01-05 21:52:51 +08:00
kubelet). Docker is still used for Kubernetes cluster workloads and network
plugins' related OS services. Also note, only one of the supported network
plugins can be deployed for a given single cluster.
2016-07-06 23:34:16 +08:00
Requirements
2018-02-01 14:42:34 +08:00
------------
2016-07-06 23:34:16 +08:00
2018-02-01 14:42:34 +08:00
- **Ansible v2.4 (or newer) 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.
- 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.
2018-04-09 06:45:55 +08:00
- 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.
2016-07-06 23:34:16 +08:00
2018-02-01 14:42:34 +08:00
Network Plugins
---------------
2017-08-10 03:28:33 +08:00
2018-02-17 11:37:47 +08:00
You can choose between 6 network plugins. (default: `calico` , except Vagrant uses `flannel` )
2016-07-06 23:34:16 +08:00
2018-02-01 14:42:34 +08:00
- [flannel ](docs/flannel.md ): gre/vxlan (layer 2) networking.
2016-07-06 23:34:16 +08:00
2018-02-01 14:42:34 +08:00
- [calico ](docs/calico.md ): bgp (layer 3) networking.
2016-07-06 23:34:16 +08:00
2018-02-01 14:42:34 +08:00
- [canal ](https://github.com/projectcalico/canal ): a composition of calico and flannel plugins.
2016-07-06 23:34:16 +08:00
2018-06-07 16:05:48 +08:00
- [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.
2018-02-17 11:37:47 +08:00
2018-02-01 14:42:34 +08:00
- [contiv ](docs/contiv.md ): 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.
contiv network support (#1914)
* Add Contiv support
Contiv is a network plugin for Kubernetes and Docker. It supports
vlan/vxlan/BGP/Cisco ACI technologies. It support firewall policies,
multiple networks and bridging pods onto physical networks.
* Update contiv version to 1.1.4
Update contiv version to 1.1.4 and added SVC_SUBNET in contiv-config.
* Load openvswitch module to workaround on CentOS7.4
* Set contiv cni version to 0.1.0
Correct contiv CNI version to 0.1.0.
* Use kube_apiserver_endpoint for K8S_API_SERVER
Use kube_apiserver_endpoint as K8S_API_SERVER to make contiv talks
to a available endpoint no matter if there's a loadbalancer or not.
* Make contiv use its own etcd
Before this commit, contiv is using a etcd proxy mode to k8s etcd,
this work fine when the etcd hosts are co-located with contiv etcd
proxy, however the k8s peering certs are only in etcd group, as a
result the etcd-proxy is not able to peering with the k8s etcd on
etcd group, plus the netplugin is always trying to find the etcd
endpoint on localhost, this will cause problem for all netplugins
not runnign on etcd group nodes.
This commit make contiv uses its own etcd, separate from k8s one.
on kube-master nodes (where net-master runs), it will run as leader
mode and on all rest nodes it will run as proxy mode.
* Use cp instead of rsync to copy cni binaries
Since rsync has been removed from hyperkube, this commit changes it
to use cp instead.
* Make contiv-etcd able to run on master nodes
* Add rbac_enabled flag for contiv pods
* Add contiv into CNI network plugin lists
* migrate contiv test to tests/files
Signed-off-by: Cristian Staretu <cristian.staretu@gmail.com>
* Add required rules for contiv netplugin
* Better handling json return of fwdMode
* Make contiv etcd port configurable
* Use default var instead of templating
* roles/download/defaults/main.yml: use contiv 1.1.7
Signed-off-by: Cristian Staretu <cristian.staretu@gmail.com>
2017-11-29 22:24:16 +08:00
2018-02-01 14:42:34 +08:00
- [weave ](docs/weave.md ): Weave is a lightweight container overlay network that doesn't require an external K/V database cluster.
(Please refer to `weave` [troubleshooting documentation ](http://docs.weave.works/weave/latest_release/troubleshooting.html )).
2016-07-06 23:34:16 +08:00
2017-01-05 21:52:51 +08:00
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 ](docs/netcheck.md ).
2016-07-06 23:34:16 +08:00
2018-02-01 14:42:34 +08:00
Community docs and resources
----------------------------
- [kubernetes.io/docs/getting-started-guides/kubespray/ ](https://kubernetes.io/docs/getting-started-guides/kubespray/ )
- [kubespray, monitoring and logging ](https://github.com/gregbkr/kubernetes-kargo-logging-monitoring ) by @gregbkr
- [Deploy Kubernetes w/ Ansible & Terraform ](https://rsmitty.github.io/Terraform-Ansible-Kubernetes/ ) by @rsmitty
- [Deploy a Kubernetes Cluster with Kubespray (video) ](https://www.youtube.com/watch?v=N9q51JgbWu8 )
Tools and projects on top of Kubespray
--------------------------------------
2017-03-06 19:24:02 +08:00
2018-02-01 14:42:34 +08:00
- [Digital Rebar Provision ](https://github.com/digitalrebar/provision/blob/master/doc/integrations/ansible.rst )
- [Fuel-ccp-installer ](https://github.com/openstack/fuel-ccp-installer )
- [Terraform Contrib ](https://github.com/kubernetes-incubator/kubespray/tree/master/contrib/terraform )
2017-03-06 19:24:02 +08:00
2018-02-01 14:42:34 +08:00
CI Tests
--------
2016-07-06 23:34:16 +08:00
2018-02-01 14:42:34 +08:00
[](https://gitlab.com/kubespray-ci/kubernetes-incubator__kubespray/pipelines)
2016-07-06 23:34:16 +08:00
2018-03-07 20:37:07 +08:00
CI/end-to-end tests sponsored by Google (GCE)
2017-01-05 21:52:51 +08:00
See the [test matrix ](docs/test_cases.md ) for details.
