diff options
| author | Steven Dake <stdake@cisco.com> | 2015-08-20 23:00:55 -0700 |
|---|---|---|
| committer | Steven Dake <stdake@cisco.com> | 2015-08-21 02:10:31 -0700 |
| commit | bbcf22cc1298dd0ad4f0826c9e1186298c64569e (patch) | |
| tree | 6131834f0daf42c2ded83809859e9b9bc424aa7f /docs/ansible-deployment.md | |
| parent | 129f1d06a141c75643336399181ea157fb0dd82a (diff) | |
| download | kolla-bbcf22cc1298dd0ad4f0826c9e1186298c64569e.tar.gz kolla-bbcf22cc1298dd0ad4f0826c9e1186298c64569e.zip | |
Prepare for MD to RST conversion
Sphinx and OpenStack documentation standards require the use of
RST formatted documentation. In order to get out docs integrated
into docs.openstack.org, the following steps must be taken:
1. we need to first convert the documentation to RST
2. sphinx support must be added to the repository
3. project-config must be updated with a publish-docs job
The ability to pubish to docs.openstack.org is a privilege only
available to Big Tent projects. As a result, we should be taking
advantage of this to help spread the word on our implementation.
Note the documentation was converted with a tool called pandoc
the syntax of which was:
pandoc -f markdown -t rst file.md > z
mv z file.rst
In order for git to preserve history the files have to be git mv'ed
in one commit followed by the pandoc operation in a separate commit.
Change-Id: Iba2a70b989e8305da03e8204a9b130d457b00cf0
Diffstat (limited to 'docs/ansible-deployment.md')
| -rw-r--r-- | docs/ansible-deployment.md | 102 |
1 files changed, 0 insertions, 102 deletions
diff --git a/docs/ansible-deployment.md b/docs/ansible-deployment.md deleted file mode 100644 index 9f277c2ab..000000000 --- a/docs/ansible-deployment.md +++ /dev/null @@ -1,102 +0,0 @@ -Kolla with Ansible! -============================ - -Kolla supports deploying Openstack using [Ansible][]. - -[Ansible]: https://docs.ansible.com - - -Getting Started ---------------- - -To run the Ansible playbooks, an inventory file which tracks all of the -available nodes in the environment must be speficied. 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. - -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 - -Prerequisites -------------- - -On the deployment host you must have Ansible>=1.8.4 installed. That is the only -requirement for deploying. To build the images locally you must also have the -Python library docker-py>=1.2.0 installed. - -On the target nodes you must have docker>=1.6.0 and docker-py>=1.2.0 installed. - -Deploying ---------- - -Add the etc/kolla directory to /etc/kolla on the deployment host. Inside of -this directory are two files and a minimum number of parameters which are -listed below. - -All variables for the environment can be specified in the files: -"/etc/kolla/globals.yml" and "/etc/kolla/passwords.yml" - -The kolla_*_address variables can both be the same. Please specify an unused IP -address in your network to act as a VIP for kolla_internal_address. The VIP will -be used with keepalived and added to your "api_interface" as specified in the -globals.yml - - kolla_external_address: "openstack.example.com" - kolla_internal_address: "10.10.10.254" - -The "network_interface" variable is the interface that we bind all our services -to. For example, when starting up Mariadb it will bind to the IP on the -interface list in the "network_interface" variable. - - network_interface: "eth0" - -The "neutron_external_interface" variable is the interface that will be used for -your external bridge in Neutron. Without this bridge your instance traffic will -be unable to access the rest of the Internet. In the case of a single interface -on a machine, you may use a veth pair where one end of the veth pair is listed -here and the other end is in a bridge on your system. - - neutron_external_interface: "eth1" - -The docker_pull_policy specifies whether Docker should always pull images from -the repository it is configured for, or only in the case where the image isn't -present locally. If you are building your own images locally without pushing -them to the Docker Registry, or a local registry, you must set this value to -"missing" or when you run the playbooks docker will attempt to fetch the latest -image upstream. - - docker_pull_policy: "always" - -For All-In-One deploys, the following commands can be run. These will setup all -of the containers on the localhost. These commands will be wrapped in the -kolla-script in the future. - - cd ./kolla/ansible - ansible-playbook -i inventory/all-in-one -e @/etc/kolla/globals.yml -e @/etc/kolla/passwords.yml site.yml - -To run the playbooks for only a particular service, Ansible tags can be used. -Multiple tags may be specified, and order is still determined by the playbooks. - - cd ./kolla/ansible - ansible-playbook -i inventory/all-in-one -e @/etc/kolla/globals.yml -e @/etc/kolla/passwords.yml site.yml --tags rabbitmq - ansible-playbook -i inventory/all-in-one -e @/etc/kolla/globals.yml -e @/etc/kolla/passwords.yml site.yml --tags rabbitmq,mariadb - -Finally, you can view ./kolla/tools/openrc-example for an example of an openrc -you can use with your environment. If you wish you may also run the following -command to initiate your environment with an glance image and neutron networks. - - cd ./kolla/tools - ./init-runonce - -Further Reading ---------------- - -Ansible playbook documentation can be found [here][]. - -[here]: http://docs.ansible.com/playbooks.html |
