aboutsummaryrefslogtreecommitdiff
path: root/doc/multinode.rst
diff options
context:
space:
mode:
authorMauricio Lima <mauriciolimab@gmail.com>2016-05-27 08:09:56 -0400
committerMauricio Lima <mauriciolimab@gmail.com>2016-05-27 08:10:43 -0400
commitbe2724a655185faae9abd57c8d07c12e48fd4aba (patch)
tree7d20aec01bdcab76acfeb130e319a091efa5bb4e /doc/multinode.rst
parentc51e315523fe37f28dc9b0968191b7e07125c24b (diff)
downloadkolla-be2724a655185faae9abd57c8d07c12e48fd4aba.tar.gz
kolla-be2724a655185faae9abd57c8d07c12e48fd4aba.zip
Update Documentation
Applying RST formatting conventions [1],[2] and [3] [1] http://docs.openstack.org/contributor-guide/rst-conv/gen-guidelines.html [2] http://docs.openstack.org/contributor-guide/rst-conv/inline-markups.html [3] http://docs.openstack.org/contributor-guide/rst-conv/lists.html Change-Id: I38b77a45d30ca0542058675dd1e8aba790c68567 Partially-implements: blueprint documentation-rework
Diffstat (limited to 'doc/multinode.rst')
-rw-r--r--doc/multinode.rst51
1 files changed, 24 insertions, 27 deletions
diff --git a/doc/multinode.rst b/doc/multinode.rst
index e7b6c1f87..f2a4abd27 100644
--- a/doc/multinode.rst
+++ b/doc/multinode.rst
@@ -7,31 +7,29 @@ Multinode Deployment of Kolla
Deploy a registry (required for multinode)
==========================================
-A Docker registry is a locally hosted registry that replaces the need
-to pull from the Docker Hub to get images. Kolla can function with
-or without a local registry, however for a multinode deployment a registry
-is required.
-
-The Docker registry prior to version 2.3 has extremely bad performance
-because all container data is pushed for every image rather than taking
-advantage of Docker layering to optimize push operations. For more
-information reference
+A Docker registry is a locally hosted registry that replaces the need to pull
+from the Docker Hub to get images. Kolla can function with or without a local
+registry, however for a multinode deployment a registry is required.
+
+The Docker registry prior to version 2.3 has extremely bad performance because
+all container data is pushed for every image rather than taking advantage of
+Docker layering to optimize push operations. For more information reference
`pokey registry <https://github.com/docker/docker/issues/14018>`__.
-The Kolla community recommends using registry 2.3 or later. To deploy
-registry 2.3 do the following:
+The Kolla community recommends using registry 2.3 or later. To deploy registry
+2.3 do the following:
::
docker run -d -p 4000:5000 --restart=always --name registry registry:2
-Note: Kolla looks for the Docker registry to use port 4000. (Docker default
-is port 5000)
+Note: Kolla looks for the Docker registry to use port 4000. (Docker default is
+port 5000)
After starting the registry, it is necessary to instruct Docker that it will
-be communicating with an insecure registry. To enable insecure registry
-communication on CentOS, modify the "/etc/sysconfig/docker" file to contain
+be communicating with an insecure registry. To enable insecure registry
+communication on CentOS, modify the ``/etc/sysconfig/docker`` file to contain
the following where 192.168.1.100 is the IP address of the machine where the
registry is currently running:
@@ -40,18 +38,17 @@ registry is currently running:
# CentOS
other_args="--insecure-registry 192.168.1.100:4000"
-For Ubuntu, edit /etc/default/docker and add:
+For Ubuntu, edit ``/etc/default/docker`` and add:
::
# Ubuntu
DOCKER_OPTS="--insecure-registry 192.168.1.100:4000"
-Docker Inc's packaged version of docker-engine for CentOS is defective and
-does not read the other_args configuration options from
-"/etc/sysconfig/docker". To rectify this problem, ensure the
-following lines appear in the drop-in unit file at
-"/etc/systemd/system/docker.service.d/kolla.conf":
+Docker Inc's packaged version of docker-engine for CentOS is defective and does
+not read the other_args configuration options from ``/etc/sysconfig/docker``.
+To rectify this problem, ensure the following lines appear in the drop-in unit
+file at ``/etc/systemd/system/docker.service.d/kolla.conf``:
::
@@ -78,9 +75,9 @@ Edit the Inventory File
=======================
The ansible inventory file contains all the information needed to determine
-what services will land on which hosts. Edit the inventory file in the kolla
-directory ansible/inventory/multinode or if kolla was installed with pip, it
-can be found in /usr/share/kolla.
+what services will land on which hosts. Edit the inventory file in the kolla
+directory ``ansible/inventory/multinode`` or if kolla was installed with pip,
+it can be found in ``/usr/share/kolla``.
Add the ip addresses or hostnames to a group and the services associated with
that group will land on that host:
@@ -95,9 +92,9 @@ that group will land on that host:
192.168.122.24
-For more advanced roles, the operator can edit which services will be associated
-in with each group. Keep in mind that some services have to be grouped together
-and changing these around can break your deployment:
+For more advanced roles, the operator can edit which services will be
+associated in with each group. Keep in mind that some services have to be
+grouped together and changing these around can break your deployment:
::