From 12086744e0890a6d2167098df680bafa8fafe3f2 Mon Sep 17 00:00:00 2001 From: Maxime Guyot Date: Sat, 20 Apr 2019 20:09:45 +0200 Subject: [PATCH] Update docs for inventory_builder (#4581) --- README.md | 4 ++-- docs/getting-started.md | 14 ++++++++------ 2 files changed, 10 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 621cf439e..6c61e7730 100644 --- a/README.md +++ b/README.md @@ -29,7 +29,7 @@ To deploy the cluster you can use : # 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[@]} + CONFIG_FILE=inventory/mycluster/hosts.yml python3 contrib/inventory_builder/inventory.py ${IPS[@]} # Review and change parameters under ``inventory/mycluster/group_vars`` cat inventory/mycluster/group_vars/all/all.yml @@ -39,7 +39,7 @@ To deploy the cluster you can use : # The option `-b` is required, as for example writing SSL keys in /etc/, # installing packages and interacting with various systemd daemons. # Without -b the playbook will fail to run! - ansible-playbook -i inventory/mycluster/hosts.ini --become --become-user=root cluster.yml + ansible-playbook -i inventory/mycluster/hosts.yml --become --become-user=root cluster.yml 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: diff --git a/docs/getting-started.md b/docs/getting-started.md index 634d8fe62..710b70002 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -6,7 +6,7 @@ Building your own inventory Ansible inventory can be stored in 3 formats: YAML, JSON, or INI-like. There is an example inventory located -[here](https://github.com/kubernetes-sigs/kubespray/blob/master/inventory/sample/hosts.ini). +[here](https://github.com/kubernetes-sigs/kubespray/blob/master/inventory/sample/inventory.ini). You can use an [inventory generator](https://github.com/kubernetes-sigs/kubespray/blob/master/contrib/inventory_builder/inventory.py) @@ -20,7 +20,9 @@ Example inventory generator usage: cp -r inventory/sample inventory/mycluster 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[@]} + CONFIG_FILE=inventory/mycluster/hosts.yml python3 contrib/inventory_builder/inventory.py ${IPS[@]} + +Then use `inventory/mycluster/hosts.yml` as inventory file. Starting custom deployment -------------------------- @@ -30,7 +32,7 @@ and start the deployment: **IMPORTANT**: Edit my\_inventory/groups\_vars/\*.yaml to override data vars: - ansible-playbook -i inventory/mycluster/hosts.ini cluster.yml -b -v \ + ansible-playbook -i inventory/mycluster/hosts.yml cluster.yml -b -v \ --private-key=~/.ssh/private_key See more details in the [ansible guide](ansible.md). @@ -43,7 +45,7 @@ You may want to add worker, master or etcd nodes to your existing cluster. This - Add the new worker node to your inventory in the appropriate group (or utilize a [dynamic inventory](https://docs.ansible.com/ansible/intro_dynamic_inventory.html)). - Run the ansible-playbook command, substituting `cluster.yml` for `scale.yml`: - ansible-playbook -i inventory/mycluster/hosts.ini scale.yml -b -v \ + ansible-playbook -i inventory/mycluster/hosts.yml scale.yml -b -v \ --private-key=~/.ssh/private_key Remove nodes @@ -53,12 +55,12 @@ You may want to remove **worker** nodes to your existing cluster. This can be do Add worker nodes to the list under kube-node if you want to delete them (or utilize a [dynamic inventory](https://docs.ansible.com/ansible/intro_dynamic_inventory.html)). - ansible-playbook -i inventory/mycluster/hosts.ini remove-node.yml -b -v \ + ansible-playbook -i inventory/mycluster/hosts.yml remove-node.yml -b -v \ --private-key=~/.ssh/private_key Use `--extra-vars "node=,"` to select the node you want to delete. ``` -ansible-playbook -i inventory/mycluster/hosts.ini remove-node.yml -b -v \ +ansible-playbook -i inventory/mycluster/hosts.yml remove-node.yml -b -v \ --private-key=~/.ssh/private_key \ --extra-vars "node=nodename,nodename2" ```