diff --git a/docs/ansible.md b/docs/ansible.md index fc74aa707..875cf3766 100644 --- a/docs/ansible.md +++ b/docs/ansible.md @@ -8,7 +8,7 @@ The inventory is composed of 3 groups: * **kube-node** : list of kubernetes nodes where the pods will run. * **kube-master** : list of servers where kubernetes master components (apiserver, scheduler, controller) will run. -* **etcd**: list of server to compose the etcd server. you should have at least 3 servers for failover purposes. +* **etcd**: list of servers to compose the etcd server. You should have at least 3 servers for failover purpose. Note: do not modify the children of _k8s-cluster_, like putting the _etcd_ group into the _k8s-cluster_, unless you are certain diff --git a/docs/getting-started.md b/docs/getting-started.md index 8958d609d..c44ed1d75 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -21,7 +21,7 @@ kargo deploy --aws -u centos -n calico Building your own inventory --------------------------- -Ansible inventory can be stored in 3 formats: YAML, JSON, or inifile. There is +Ansible inventory can be stored in 3 formats: YAML, JSON, or INI-like. There is an example inventory located [here](https://github.com/kubernetes-incubator/kargo/blob/master/inventory/inventory.example). @@ -47,8 +47,9 @@ Starting custom deployment Once you have an inventory, you may want to customize deployment data vars and start the deployment: +**IMPORTANT: Edit my_inventory/groups_vars/*.yaml to override data vars** + ``` -# Edit my_inventory/groups_vars/*.yaml to override data vars ansible-playbook -i my_inventory/inventory.cfg cluster.yaml -b -v \ --private-key=~/.ssh/private_key ``` diff --git a/inventory/group_vars/all.yml b/inventory/group_vars/all.yml index d04b7c95c..63ce419fb 100644 --- a/inventory/group_vars/all.yml +++ b/inventory/group_vars/all.yml @@ -8,7 +8,7 @@ bin_dir: /usr/local/bin # Those are where all the additional config stuff goes # the kubernetes normally puts in /srv/kubernets. # This puts them in a sane location and namespace. -# Editting those values will almost surely break something. +# Editing those values will almost surely break something. kube_config_dir: /etc/kubernetes kube_script_dir: "{{ bin_dir }}/kubernetes-scripts" kube_manifest_dir: "{{ kube_config_dir }}/manifests"