120 lines
5.5 KiB
Markdown
120 lines
5.5 KiB
Markdown
|
|
|
|
## Deploy a production ready kubernetes cluster
|
|
|
|
If you have questions, join us on the [kubernetes slack](https://slack.k8s.io), channel **#kubespray**.
|
|
|
|
- Can be deployed on **AWS, GCE, Azure, OpenStack or Baremetal**
|
|
- **High available** cluster
|
|
- **Composable** (Choice of the network plugin for instance)
|
|
- Support most popular **Linux distributions**
|
|
- **Continuous integration tests**
|
|
|
|
|
|
To deploy the cluster you can use :
|
|
|
|
[**kubespray-cli**](https://github.com/kubespray/kubespray-cli) <br>
|
|
**Ansible** usual commands and [**inventory builder**](https://github.com/kubernetes-incubator/kubespray/blob/master/contrib/inventory_builder/inventory.py) <br>
|
|
**vagrant** by simply running `vagrant up` (for tests purposes) <br>
|
|
|
|
|
|
* [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)
|
|
* [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**
|
|
* **Debian** Jessie
|
|
* **Ubuntu** 16.04
|
|
* **CentOS/RHEL** 7
|
|
|
|
Note: Upstart/SysV init based OS types are not supported.
|
|
|
|
Versions of supported components
|
|
--------------------------------
|
|
|
|
|
|
[kubernetes](https://github.com/kubernetes/kubernetes/releases) v1.6.4 <br>
|
|
[etcd](https://github.com/coreos/etcd/releases) v3.0.17 <br>
|
|
[flanneld](https://github.com/coreos/flannel/releases) v0.6.2 <br>
|
|
[calicoctl](https://github.com/projectcalico/calico-docker/releases) v0.23.0 <br>
|
|
[canal](https://github.com/projectcalico/canal) (given calico/flannel versions) <br>
|
|
[weave](http://weave.works/) v2.0.1 <br>
|
|
[docker](https://www.docker.com/) v1.13.1 (see note)<br>
|
|
[rkt](https://coreos.com/rkt/docs/latest/) v1.21.0 (see Note 2)<br>
|
|
|
|
Note: kubernetes doesn't support newer docker versions. 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).
|
|
|
|
Note 2: rkt support as docker alternative is limited to control plane (etcd and
|
|
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.
|
|
|
|
Requirements
|
|
--------------
|
|
|
|
* **Ansible v2.3 (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.
|
|
|
|
|
|
## Network plugins
|
|
You can choose between 4 network plugins. (default: `calico`)
|
|
|
|
* [**flannel**](docs/flannel.md): gre/vxlan (layer 2) networking.
|
|
|
|
* [**calico**](docs/calico.md): bgp (layer 3) networking.
|
|
|
|
* [**canal**](https://github.com/projectcalico/canal): a composition of calico and flannel plugins.
|
|
|
|
* [**weave**](https://github.com/weaveworks/weave): Weave is a lightweight container overlay network that doesn't require an external K/V database cluster. <br>
|
|
(Please refer to `weave` [troubleshooting documentation](http://docs.weave.works/weave/latest_release/troubleshooting.html)).
|
|
|
|
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).
|
|
|
|
## 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
|
|
- [Digital Rebar](https://github.com/digitalrebar/digitalrebar)
|
|
- [Kubespray-cli](https://github.com/kubespray/kubespray-cli)
|
|
- [Fuel-ccp-installer](https://github.com/openstack/fuel-ccp-installer)
|
|
- [Terraform Contrib](https://github.com/kubernetes-incubator/kubespray/tree/master/contrib/terraform)
|
|
|
|
## CI Tests
|
|
|
|
|
|
|
|
[](https://gitlab.com/kubespray-ci/kubernetes-incubator__kubespray/pipelines) </br>
|
|
|
|
CI/end-to-end tests sponsored by Google (GCE), DigitalOcean, [teuto.net](https://teuto.net/) (openstack).
|
|
See the [test matrix](docs/test_cases.md) for details.
|