aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorPaul Bourke <paul.bourke@oracle.com>2015-06-11 09:39:56 +0000
committerPaul Bourke <paul.bourke@oracle.com>2015-06-22 14:06:16 +0000
commit95e9b4de91adcc224fb37406701978f3ce27cba9 (patch)
tree792f10f3d1d16c82d1410b032400b6b585d50387 /docs
parent6d3be05e5bd49c2142db94c2e80cd8de60e3e8d1 (diff)
downloadkolla-95e9b4de91adcc224fb37406701978f3ce27cba9.tar.gz
kolla-95e9b4de91adcc224fb37406701978f3ce27cba9.zip
Minor doc fixups in ansible-deployment.md
* Capitalise all usages of "Ansible", "Kolla", and "OpenStack" * Add note to let users know ssh key setup is not necessary for the aio demo. * Add note to remind users to update the koalla_directory variable. Change-Id: Icb5c1237aa5de049445cb417e565da550dc87daf
Diffstat (limited to 'docs')
-rw-r--r--docs/ansible-deployment.md19
1 files changed, 13 insertions, 6 deletions
diff --git a/docs/ansible-deployment.md b/docs/ansible-deployment.md
index 8bee0e895..8aee3a0a5 100644
--- a/docs/ansible-deployment.md
+++ b/docs/ansible-deployment.md
@@ -1,4 +1,4 @@
-Koalla - Kolla with ansible!
+Koalla - Kolla with Ansible!
============================
Koalla extends the Kolla project past [TripleO][] into its own bonified
@@ -12,12 +12,17 @@ deployment system using [Ansible][] and [docker-compose][].
Getting Started
---------------
-To run the ansible playbooks, you must specify an inventory file which tracks
+To run the Ansible playbooks, you must specify an inventory file which tracks
all of the available nodes in your environment. With this inventory file
-ansible will log into each node via ssh (configurable) and run tasks. Ansible
+Ansible will log into each node via ssh (configurable) and run tasks. Ansible
does not require password less logins via ssh, however it is highly recommended
-to setup ssh-keys. More information on the ansible inventory file can be found
-[here][].
+to setup ssh-keys.
+
+Two sample inventory files are provided, *all-in-one*, and *multinode*. The
+"all-in-one" inventory defaults to use the Ansible "local" connection type,
+which removes the need to setup ssh keys in order to get started quickly.
+
+More information on the Ansible inventory file can be found [here][].
[here]: https://docs.ansible.com/intro_inventory.html
@@ -27,6 +32,8 @@ Deploying
You can adjust variables for your environment in the file:
"./kolla/ansible/group_vars/all.yml"
+Ensure that the *koalla_directory* variable matches where you have Kolla cloned
+on the target machine(s).
For All-In-One deploys, you can run the following commands. These will setup all
of the containers on your localhost.
@@ -34,7 +41,7 @@ of the containers on your localhost.
cd ./kolla/ansible
ansible-playbook -i inventory/all-in-one site.yml
-To run the playbooks for only a particular service, you can us ansible tags.
+To run the playbooks for only a particular service, you can use Ansible tags.
Multiple tags may be specified, and order is still determined by the playbooks.
cd ./kolla/ansible