You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

118 lines
5.3 KiB

7 years ago
  1. ![Kubernetes Logo](https://s28.postimg.org/lf3q4ocpp/k8s.png)
  2. ## Deploy a production ready kubernetes cluster
  3. If you have questions, join us on the [kubernetes slack](https://slack.k8s.io), channel **#kargo**.
  4. - Can be deployed on **AWS, GCE, Azure, OpenStack or Baremetal**
  5. - **High available** cluster
  6. - **Composable** (Choice of the network plugin for instance)
  7. - Support most popular **Linux distributions**
  8. - **Continuous integration tests**
  9. To deploy the cluster you can use :
  10. [**kargo-cli**](https://github.com/kubespray/kargo-cli) <br>
  11. **Ansible** usual commands and [**inventory builder**](https://github.com/kubernetes-incubator/kargo/blob/master/contrib/inventory_builder/inventory.py) <br>
  12. **vagrant** by simply running `vagrant up` (for tests purposes) <br>
  13. * [Requirements](#requirements)
  14. * [Kargo vs ...](docs/comparisons.md)
  15. * [Getting started](docs/getting-started.md)
  16. * [Ansible inventory and tags](docs/ansible.md)
  17. * [Deployment data variables](docs/vars.md)
  18. * [DNS stack](docs/dns-stack.md)
  19. * [HA mode](docs/ha-mode.md)
  20. * [Network plugins](#network-plugins)
  21. * [Vagrant install](docs/vagrant.md)
  22. * [CoreOS bootstrap](docs/coreos.md)
  23. * [Downloaded artifacts](docs/downloads.md)
  24. * [Cloud providers](docs/cloud.md)
  25. * [OpenStack](docs/openstack.md)
  26. * [AWS](docs/aws.md)
  27. * [Azure](docs/azure.md)
  28. * [Large deployments](docs/large-deployments.md)
  29. * [Upgrades basics](docs/upgrades.md)
  30. * [Roadmap](docs/roadmap.md)
  31. Supported Linux distributions
  32. ===============
  33. * **Container Linux by CoreOS**
  34. * **Debian** Jessie
  35. * **Ubuntu** 16.04
  36. * **CentOS/RHEL** 7
  37. Note: Upstart/SysV init based OS types are not supported.
  38. Versions of supported components
  39. --------------------------------
  40. [kubernetes](https://github.com/kubernetes/kubernetes/releases) v1.6.4 <br>
  41. [etcd](https://github.com/coreos/etcd/releases) v3.0.17 <br>
  42. [flanneld](https://github.com/coreos/flannel/releases) v0.6.2 <br>
  43. [calicoctl](https://github.com/projectcalico/calico-docker/releases) v0.23.0 <br>
  44. [canal](https://github.com/projectcalico/canal) (given calico/flannel versions) <br>
  45. [weave](http://weave.works/) v1.8.2 <br>
  46. [docker](https://www.docker.com/) v1.13.1 (see note)<br>
  47. [rkt](https://coreos.com/rkt/docs/latest/) v1.21.0 (see Note 2)<br>
  48. 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).
  49. Note 2: rkt support as docker alternative is limited to control plane (etcd and
  50. kubelet). Docker is still used for Kubernetes cluster workloads and network
  51. plugins' related OS services. Also note, only one of the supported network
  52. plugins can be deployed for a given single cluster.
  53. Requirements
  54. --------------
  55. * **Ansible v2.3 (or newer) and python-netaddr is installed on the machine
  56. that will run Ansible commands**
  57. * **Jinja 2.9 (or newer) is required to run the Ansible Playbooks**
  58. * The target servers must have **access to the Internet** in order to pull docker images.
  59. * The target servers are configured to allow **IPv4 forwarding**.
  60. * **Your ssh key must be copied** to all the servers part of your inventory.
  61. * The **firewalls are not managed**, you'll need to implement your own rules the way you used to.
  62. in order to avoid any issue during deployment you should disable your firewall.
  63. ## Network plugins
  64. You can choose between 4 network plugins. (default: `calico`)
  65. * [**flannel**](docs/flannel.md): gre/vxlan (layer 2) networking.
  66. * [**calico**](docs/calico.md): bgp (layer 3) networking.
  67. * [**canal**](https://github.com/projectcalico/canal): a composition of calico and flannel plugins.
  68. * **weave**: Weave is a lightweight container overlay network that doesn't require an external K/V database cluster. <br>
  69. (Please refer to `weave` [troubleshooting documentation](http://docs.weave.works/weave/latest_release/troubleshooting.html)).
  70. The choice is defined with the variable `kube_network_plugin`. There is also an
  71. option to leverage built-in cloud provider networking instead.
  72. See also [Network checker](docs/netcheck.md).
  73. ## Community docs and resources
  74. - [kubernetes.io/docs/getting-started-guides/kargo/](https://kubernetes.io/docs/getting-started-guides/kargo/)
  75. - [kargo, monitoring and logging](https://github.com/gregbkr/kubernetes-kargo-logging-monitoring) by @gregbkr
  76. - [Deploy Kubernetes w/ Ansible & Terraform](https://rsmitty.github.io/Terraform-Ansible-Kubernetes/) by @rsmitty
  77. - [Deploy a Kubernets Cluster with Kargo (video)](https://www.youtube.com/watch?v=N9q51JgbWu8)
  78. ## Tools and projects on top of Kargo
  79. - [Digital Rebar](https://github.com/digitalrebar/digitalrebar)
  80. - [Kargo-cli](https://github.com/kubespray/kargo-cli)
  81. - [Fuel-ccp-installer](https://github.com/openstack/fuel-ccp-installer)
  82. - [Terraform Contrib](https://github.com/kubernetes-incubator/kargo/tree/master/contrib/terraform)
  83. ## CI Tests
  84. ![Gitlab Logo](https://s27.postimg.org/wmtaig1wz/gitlabci.png)
  85. [![Build graphs](https://gitlab.com/kargo-ci/kubernetes-incubator__kargo/badges/master/build.svg)](https://gitlab.com/kargo-ci/kubernetes-incubator__kargo/pipelines) </br>
  86. CI/end-to-end tests sponsored by Google (GCE), DigitalOcean, [teuto.net](https://teuto.net/) (openstack).
  87. See the [test matrix](docs/test_cases.md) for details.