Update docs
Link docs to README, update README with recent info. Update comparsions, add kubeadm vs kargo. Better describe variables precedence UX impact. Signed-off-by: Bogdan Dobrelya <bogdando@mail.ru>pull/862/head
Bogdan Dobrelya
parent
a4dbee3e38
commit
e9518072a8
69
README.md
69
README.md
|
|
@ -1,4 +1,4 @@
|
||||||
|
|
||||||
|
|
||||||
##Deploy a production ready kubernetes cluster
|
##Deploy a production ready kubernetes cluster
|
||||||
|
|
||||||
|
|
@ -14,75 +14,88 @@ If you have questions, join us on the [kubernetes slack](https://slack.k8s.io),
|
||||||
To deploy the cluster you can use :
|
To deploy the cluster you can use :
|
||||||
|
|
||||||
[**kargo-cli**](https://github.com/kubespray/kargo-cli) <br>
|
[**kargo-cli**](https://github.com/kubespray/kargo-cli) <br>
|
||||||
**Ansible** usual commands <br>
|
**Ansible** usual commands and [**inventory builder**](https://github.com/kubernetes-incubator/kargo/blob/master/contrib/inventory_builder/inventory.py) <br>
|
||||||
**vagrant** by simply running `vagrant up` (for tests purposes) <br>
|
**vagrant** by simply running `vagrant up` (for tests purposes) <br>
|
||||||
|
|
||||||
|
|
||||||
* [Requirements](#requirements)
|
* [Requirements](#requirements)
|
||||||
|
* [Kargo vs ...](docs/comparisons.md)
|
||||||
* [Getting started](docs/getting-started.md)
|
* [Getting started](docs/getting-started.md)
|
||||||
|
* [Ansible inventory and tags](docs/ansible.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)
|
* [Vagrant install](docs/vagrant.md)
|
||||||
* [CoreOS bootstrap](docs/coreos.md)
|
* [CoreOS bootstrap](docs/coreos.md)
|
||||||
* [Ansible variables](docs/ansible.md)
|
* [Downloaded artifacts](docs/downloads.md)
|
||||||
* [Cloud providers](docs/cloud.md)
|
* [Cloud providers](docs/cloud.md)
|
||||||
* [OpenStack](docs/openstack.md)
|
* [OpenStack](docs/openstack.md)
|
||||||
* [AWS](docs/aws.md)
|
* [AWS](docs/aws.md)
|
||||||
* [Azure](docs/azure.md)
|
* [Azure](docs/azure.md)
|
||||||
* [Network plugins](#network-plugins)
|
* [Large deployments](docs/large-deployments.md)
|
||||||
|
* [Upgrades basics](docs/upgrades.md)
|
||||||
* [Roadmap](docs/roadmap.md)
|
* [Roadmap](docs/roadmap.md)
|
||||||
|
|
||||||
Supported Linux distributions
|
Supported Linux distributions
|
||||||
===============
|
===============
|
||||||
|
|
||||||
* **CoreOS**
|
* **Container Linux by CoreOS**
|
||||||
* **Debian** Wheezy, Jessie
|
* **Debian** Jessie
|
||||||
* **Ubuntu** 14.10, 15.04, 15.10, 16.04
|
* **Ubuntu** 16.04
|
||||||
* **Fedora** 23
|
|
||||||
* **CentOS/RHEL** 7
|
* **CentOS/RHEL** 7
|
||||||
|
|
||||||
Versions
|
Note: Upstart/SysV init based OS types are not supported.
|
||||||
--------------
|
|
||||||
|
|
||||||
[kubernetes](https://github.com/kubernetes/kubernetes/releases) v1.4.6 <br>
|
Versions of supported components
|
||||||
|
--------------------------------
|
||||||
|
|
||||||
|
[kubernetes](https://github.com/kubernetes/kubernetes/releases) v1.5.1 <br>
|
||||||
[etcd](https://github.com/coreos/etcd/releases) v3.0.6 <br>
|
[etcd](https://github.com/coreos/etcd/releases) v3.0.6 <br>
|
||||||
[flanneld](https://github.com/coreos/flannel/releases) v0.6.2 <br>
|
[flanneld](https://github.com/coreos/flannel/releases) v0.6.2 <br>
|
||||||
[calicoctl](https://github.com/projectcalico/calico-docker/releases) v0.22.0 <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/) v1.6.1 <br>
|
[weave](http://weave.works/) v1.6.1 <br>
|
||||||
[docker](https://www.docker.com/) v1.10.3 <br>
|
[docker](https://www.docker.com/) v1.12.5 <br>
|
||||||
|
[rkt](https://coreos.com/rkt/docs/latest/) v1.21.0 <br>
|
||||||
|
|
||||||
|
Note: 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
|
Requirements
|
||||||
--------------
|
--------------
|
||||||
|
|
||||||
* The target servers must have **access to the Internet** in order to pull docker images.
|
* The target servers must have **access to the Internet** in order to pull docker images.
|
||||||
* The **firewalls are not managed**, you'll need to implement your own rules the way you used to.
|
* 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
|
in order to avoid any issue during deployment you should disable your firewall.
|
||||||
|
* The target servers are configured to allow **IPv4 forwarding**.
|
||||||
* **Copy your ssh keys** to all the servers part of your inventory.
|
* **Copy your ssh keys** to all the servers part of your inventory.
|
||||||
* **Ansible v2.1 (or newer) and python-netaddr**
|
* **Ansible v2.2 (or newer) and python-netaddr**
|
||||||
|
|
||||||
|
|
||||||
## Network plugins
|
## Network plugins
|
||||||
You can choose between 3 network plugins. (default: `flannel` with vxlan backend)
|
You can choose between 4 network plugins. (default: `flannel` with vxlan backend)
|
||||||
|
|
||||||
* [**flannel**](docs/flannel.md): gre/vxlan (layer 2) networking.
|
* [**flannel**](docs/flannel.md): gre/vxlan (layer 2) networking.
|
||||||
|
|
||||||
* [**calico**](docs/calico.md): bgp (layer 3) networking.
|
* [**calico**](docs/calico.md): bgp (layer 3) networking.
|
||||||
|
|
||||||
|
* [**canal**](https://github.com/projectcalico/canal): a composition of calico and flannel plugins.
|
||||||
|
|
||||||
* **weave**: Weave is a lightweight container overlay network that doesn't require an external K/V database cluster. <br>
|
* **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))
|
(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`
|
|
||||||
|
|
||||||
|
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).
|
||||||
|
|
||||||
## CI Tests
|
## CI Tests
|
||||||
|
|
||||||
[](https://travis-ci.org/kubernetes-incubator/kargo) </br>
|
|
||||||
|
|
||||||
### Google Compute Engine
|
[](https://gitlab.com/kargo-ci/kubernetes-incubator__kargo/pipelines) </br>
|
||||||
|
|
||||||
| Calico | Flannel | Weave |
|
CI/end-to-end tests sponsored by Google (GCE), and [teuto.net](https://teuto.net/) for OpenStack.
|
||||||
------------- | ------------- | ------------- | ------------- |
|
See the [test matrix](docs/test_cases.md) for details.
|
||||||
Ubuntu Xenial |[](https://ci.kubespray.io/job/kargo-gce-xenial-calico/)|[](https://ci.kubespray.io/job/kargo-gce-xenial-flannel/)|[](https://ci.kubespray.io/job/kargo-gce-xenial-weave)|
|
|
||||||
CentOS 7 |[](https://ci.kubespray.io/job/kargo-gce-centos7-calico/)|[](https://ci.kubespray.io/job/kargo-gce-centos7-flannel/)|[](https://ci.kubespray.io/job/kargo-gce-centos7-weave/)|
|
|
||||||
CoreOS (stable) |[](https://ci.kubespray.io/job/kargo-gce-coreos-calico/)|[](https://ci.kubespray.io/job/kargo-gce-coreos-flannel/)|[](https://ci.kubespray.io/job/kargo-gce-coreos-weave/)|
|
|
||||||
|
|
||||||
CI tests sponsored by Google (GCE), and [teuto.net](https://teuto.net/) for OpenStack.
|
|
||||||
|
|
|
||||||
|
|
@ -45,9 +45,38 @@ kube-master
|
||||||
etcd
|
etcd
|
||||||
```
|
```
|
||||||
|
|
||||||
Group vars
|
Group vars and overriding variables precedence
|
||||||
--------------
|
----------------------------------------------
|
||||||
The main variables to change are located in the directory ```inventory/group_vars/all.yml```.
|
|
||||||
|
The group variables to control main deployment options are located in the directory
|
||||||
|
```inventory/group_vars```.
|
||||||
|
|
||||||
|
There are also role vars for docker, rkt, kubernetes preinstall and master roles.
|
||||||
|
According to the [ansible docs](http://docs.ansible.com/ansible/playbooks_variables.html#variable-precedence-where-should-i-put-a-variable),
|
||||||
|
those cannot be overriden from the group vars. In order to override, one should use
|
||||||
|
the `-e ` runtime flags (most simple way) or other layers described in the docs.
|
||||||
|
|
||||||
|
Kargo uses only a few layers to override things (or expect them to
|
||||||
|
be overriden for roles):
|
||||||
|
|
||||||
|
Layer | Comment
|
||||||
|
------|--------
|
||||||
|
**role defaults** | provides best UX to override things for Kargo deployments
|
||||||
|
inventory vars | Unused
|
||||||
|
**inventory group_vars** | Expects users to use ``all.yml``,``k8s-cluster.yml`` etc. to override things
|
||||||
|
inventory host_vars | Unused
|
||||||
|
playbook group_vars | Unuses
|
||||||
|
playbook host_vars | Unused
|
||||||
|
**host facts** | Kargo overrides for internal roles' logic, like state flags
|
||||||
|
play vars | Unused
|
||||||
|
play vars_prompt | Unused
|
||||||
|
play vars_files | Unused
|
||||||
|
registered vars | Unused
|
||||||
|
set_facts | Kargo overrides those, for some places
|
||||||
|
**role and include vars** | Provides bad UX to override things! Use extra vars to enforce
|
||||||
|
block vars (only for tasks in block) | Kargo overrides for internal roles' logic
|
||||||
|
task vars (only for the task) | Unused for roles, but only for helper scripts
|
||||||
|
**extra vars** (always win precedence) | override with ``ansible-playbook -e @foo.yml``
|
||||||
|
|
||||||
Ansible tags
|
Ansible tags
|
||||||
------------
|
------------
|
||||||
|
|
|
||||||
|
|
@ -1,3 +1,25 @@
|
||||||
Kargo vs [Kops](https://github.com/kubernetes/kops)
|
Kargo vs [Kops](https://github.com/kubernetes/kops)
|
||||||
---------------
|
---------------
|
||||||
Kargo runs on bare metal and most clouds, using Ansible as its substrate for provisioning and orchestration. Kops performs the provisioning and orchestration itself, and as such is less flexible in deployment platforms. For people with familiarity with Ansible, existing Ansible deployments or the desire to run a Kubernetes cluster across multiple platforms, Kargo is a good choice. Kops, however, iss more tightly integrated with the unique features of the clouds it supports so it could be a better choice if you know that you will only be using one platform for the foreseeable future.
|
|
||||||
|
Kargo runs on bare metal and most clouds, using Ansible as its substrate for
|
||||||
|
provisioning and orchestration. Kops performs the provisioning and orchestration
|
||||||
|
itself, and as such is less flexible in deployment platforms. For people with
|
||||||
|
familiarity with Ansible, existing Ansible deployments or the desire to run a
|
||||||
|
Kubernetes cluster across multiple platforms, Kargo is a good choice. Kops,
|
||||||
|
however, is more tightly integrated with the unique features of the clouds it
|
||||||
|
supports so it could be a better choice if you know that you will only be using
|
||||||
|
one platform for the foreseeable future.
|
||||||
|
|
||||||
|
Kargo vs [Kubeadm](https://github.com/kubernetes/kubeadm)
|
||||||
|
------------------
|
||||||
|
|
||||||
|
Kubeadm provides domain Knowledge of Kubernetes clusters' life cycle
|
||||||
|
management, including self-hosted layouts, dynamic discovery services and so
|
||||||
|
on. Had it belong to the new [operators world](https://coreos.com/blog/introducing-operators.html),
|
||||||
|
it would've likely been named a "Kubernetes cluster operator". Kargo however,
|
||||||
|
does generic configuration management tasks from the "OS operators" ansible
|
||||||
|
world, plus some initial K8s clustering (with networking plugins included) and
|
||||||
|
control plane bootstrapping. Kargo [strives](https://github.com/kubernetes-incubator/kargo/issues/553)
|
||||||
|
to adopt kubeadm as a tool in order to consume life cycle management domain
|
||||||
|
knowledge from it and offload generic OS configuration things from it, which
|
||||||
|
hopefully benefits both sides.
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue