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.

68 lines
2.4 KiB

7 years ago
  1. Getting started
  2. ===============
  3. The easiest way to run the deployement is to use the **kubespray-cli** tool.
  4. A complete documentation can be found in its [github repository](https://github.com/kubespray/kubespray-cli).
  5. Here is a simple example on AWS:
  6. * Create instances and generate the inventory
  7. ```
  8. kubespray aws --instances 3
  9. ```
  10. * Run the deployment
  11. ```
  12. kubespray deploy --aws -u centos -n calico
  13. ```
  14. Building your own inventory
  15. ---------------------------
  16. Ansible inventory can be stored in 3 formats: YAML, JSON, or INI-like. There is
  17. an example inventory located
  18. [here](https://github.com/kubernetes-incubator/kubespray/blob/master/inventory/inventory.example).
  19. You can use an
  20. [inventory generator](https://github.com/kubernetes-incubator/kubespray/blob/master/contrib/inventory_builder/inventory.py)
  21. to create or modify an Ansible inventory. Currently, it is limited in
  22. functionality and is only use for making a basic Kubespray cluster, but it does
  23. support creating large clusters. It now supports
  24. separated ETCD and Kubernetes master roles from node role if the size exceeds a
  25. certain threshold. Run inventory.py help for more information.
  26. Example inventory generator usage:
  27. ```
  28. cp -r inventory my_inventory
  29. declare -a IPS=(10.10.1.3 10.10.1.4 10.10.1.5)
  30. CONFIG_FILE=my_inventory/inventory.cfg python3 contrib/inventory_builder/inventory.py ${IPS[@]}
  31. ```
  32. Starting custom deployment
  33. --------------------------
  34. Once you have an inventory, you may want to customize deployment data vars
  35. and start the deployment:
  36. **IMPORTANT: Edit my_inventory/groups_vars/*.yaml to override data vars**
  37. ```
  38. ansible-playbook -i my_inventory/inventory.cfg cluster.yml -b -v \
  39. --private-key=~/.ssh/private_key
  40. ```
  41. See more details in the [ansible guide](ansible.md).
  42. Adding nodes
  43. --------------------------
  44. You may want to add worker nodes to your existing cluster. This can be done by re-running the `cluster.yml` playbook, or you can target the bare minimum needed to get kubelet installed on the worker and talking to your masters. This is especially helpful when doing something like autoscaling your clusters.
  45. - Add the new worker node to your inventory under kube-node (or utilize a [dynamic inventory](https://docs.ansible.com/ansible/intro_dynamic_inventory.html)).
  46. - Run the ansible-playbook command, substituting `scale.yml` for `cluster.yml`:
  47. ```
  48. ansible-playbook -i my_inventory/inventory.cfg scale.yml -b -v \
  49. --private-key=~/.ssh/private_key
  50. ```