aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorPaul Bourke <paul.bourke@oracle.com>2015-06-11 09:31:09 +0000
committerPaul Bourke <paul.bourke@oracle.com>2015-06-22 14:06:16 +0000
commit6d3be05e5bd49c2142db94c2e80cd8de60e3e8d1 (patch)
tree5831867d2b146e894ba90724cde9495ef9613bed /docs
parentcee4555eb82284b37349d7e3cd7ced082513f3c5 (diff)
downloadkolla-6d3be05e5bd49c2142db94c2e80cd8de60e3e8d1.tar.gz
kolla-6d3be05e5bd49c2142db94c2e80cd8de60e3e8d1.zip
Move ansible/README.md under docs/
Move the Ansible README under the docs/ dir to make it more visible to people browsing the docs. Change-Id: Ibe38ac24ad5c328486f7a9dd13fbe825d77d26e0
Diffstat (limited to 'docs')
-rw-r--r--docs/ansible-deployment.md50
1 files changed, 50 insertions, 0 deletions
diff --git a/docs/ansible-deployment.md b/docs/ansible-deployment.md
new file mode 100644
index 000000000..8bee0e895
--- /dev/null
+++ b/docs/ansible-deployment.md
@@ -0,0 +1,50 @@
+Koalla - Kolla with ansible!
+============================
+
+Koalla extends the Kolla project past [TripleO][] into its own bonified
+deployment system using [Ansible][] and [docker-compose][].
+
+[TripleO]: https://wiki.openstack.org/wiki/TripleO
+[Ansible]: https://docs.ansible.com
+[docker-compose]: http://docs.docker.com/compose
+
+
+Getting Started
+---------------
+
+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
+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][].
+
+[here]: https://docs.ansible.com/intro_inventory.html
+
+
+Deploying
+---------
+
+You can adjust variables for your environment in the file:
+"./kolla/ansible/group_vars/all.yml"
+
+For All-In-One deploys, you can run the following commands. These will setup all
+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.
+Multiple tags may be specified, and order is still determined by the playbooks.
+
+ cd ./kolla/ansible
+ ansible-playbook -i inventory/all-in-one site.yml --tags message-broker
+ ansible-playbook -i inventory/all-in-one site.yml --tags message-broker,database
+
+
+Further Reading
+---------------
+
+Ansible playbook documentation can be found [here][].
+
+[here]: http://docs.ansible.com/playbooks.html