6e3127d043
This converts all MD formatted docs that were renamed to RST to
preserve git history into actual RST documentation. Some minor
edits were made but in general the purpose of this patch is to
*only* convert the documentation not rework the documentation.
I do plan on reworking the documentation in further patch sets.
All links were tested and a test rendering is available:
http://github.com/sdake/kolla
Change-Id: I3df430b14df1ede15407c7f4ba7afcbdc6f9d757
118 lines
4.1 KiB
ReStructuredText
118 lines
4.1 KiB
ReStructuredText
Kolla with Ansible!
|
|
===================
|
|
|
|
Kolla supports deploying Openstack using
|
|
`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 specified. 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 in the Ansible
|
|
`inventory introduction <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 in the Ansible
|
|
`playbook documentation <http://docs.ansible.com/playbooks.html>`__.
|