Fix some documentation issues
- Fixed odd wording in install-openstack.rst. - Fixed up uuid command usage. - Added missing links and added note about editting bundles. - Fixed up the note to be an RST note rather than just regular text. Also add .gitreview as the project is managed on review.openstack.org Change-Id: Id96104928bd95d9d82dfe2a1e90fbbc60c661c28 Closes-Bug: #1712583
|
@ -0,0 +1,4 @@
|
||||||
|
[gerrit]
|
||||||
|
host=review.openstack.org
|
||||||
|
port=29418
|
||||||
|
project=openstack/charm-deployment-guide.git
|
|
@ -70,7 +70,7 @@ apply.
|
||||||
Define an external network
|
Define an external network
|
||||||
--------------------------
|
--------------------------
|
||||||
|
|
||||||
We'll start by defining a network called ``Pub_Net`` that will use a subnet with
|
We'll start by defining a network called ``Pub_Net`` that will use a subnet
|
||||||
within the range of addresses we put aside in MAAS and Juju:
|
within the range of addresses we put aside in MAAS and Juju:
|
||||||
|
|
||||||
.. code:: bash
|
.. code:: bash
|
||||||
|
@ -131,11 +131,14 @@ new subnet's configuration:
|
||||||
| use_default_subnet_pool | None |
|
| use_default_subnet_pool | None |
|
||||||
+-------------------------+--------------------------------------+
|
+-------------------------+--------------------------------------+
|
||||||
|
|
||||||
!!! Note: OpenStack has
|
.. Note::
|
||||||
`deprecated <https://docs.openstack.org/developer/python-neutronclient/devref/transition_to_osc.html>`__
|
|
||||||
the use of the ``neutron`` command for network configuration, migrating most of
|
OpenStack has `deprecated
|
||||||
its functionality into the Python OpenStack client. Version 2.4.0 or later of
|
<https://docs.openstack.org/developer/python-neutronclient/devref/transition_to_osc.html>`__
|
||||||
this client is needed for the ``subnet create`` command.
|
the use of the ``neutron`` command for network configuration, migrating
|
||||||
|
most of its functionality into the Python OpenStack client. Version
|
||||||
|
2.4.0 or later of this client is needed for the ``subnet create``
|
||||||
|
command.
|
||||||
|
|
||||||
Cloud images
|
Cloud images
|
||||||
------------
|
------------
|
|
@ -16,11 +16,18 @@ A `bundle <https://jujucharms.com/docs/stable/charms-bundles>`__, as used above,
|
||||||
encapsulates the entire deployment process, including all applications, their
|
encapsulates the entire deployment process, including all applications, their
|
||||||
configuration parameters and any relations that need to be made. Generally, you
|
configuration parameters and any relations that need to be made. Generally, you
|
||||||
can use a local file, as above, or deploy a curated bundle from the `charm
|
can use a local file, as above, or deploy a curated bundle from the `charm
|
||||||
store <./install-openstack-bundle.html>`__.
|
store <https://jujucharms.com/store>`__.
|
||||||
|
|
||||||
For our project, [download the OpenStack][downloadbundle] and deploy OpenStack
|
For our project, `download
|
||||||
|
<https://api.jujucharms.com/charmstore/v5/openstack-base/archive>`__ the
|
||||||
|
`OpenStack <https://jujucharms.com/openstack-base/>`__ and deploy OpenStack
|
||||||
using the above command.
|
using the above command.
|
||||||
|
|
||||||
|
.. note::
|
||||||
|
|
||||||
|
You will probably need to edit the bundle information to match the actual
|
||||||
|
hardware that you have.
|
||||||
|
|
||||||
The speed of the deployment depends on your hardware, but may take some time.
|
The speed of the deployment depends on your hardware, but may take some time.
|
||||||
Monitor the output of ``juju status`` to see when everything is ready.
|
Monitor the output of ``juju status`` to see when everything is ready.
|
||||||
|
|
|
@ -80,10 +80,10 @@ of the charms as a ``yaml`` file which we include as we deploy them.
|
||||||
`Ceph OSD <https://jujucharms.com/ceph-osd>`__
|
`Ceph OSD <https://jujucharms.com/ceph-osd>`__
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
We're starting with the Ceph object storage daemon and we want to configure Ceph
|
We're starting with the Ceph object storage daemon and we want to configure
|
||||||
to use the second drive of a cloud node, ``/dev/sdb``. Change or ignore this to
|
Ceph to use the second drive of a cloud node, ``/dev/sdb``. Change this to
|
||||||
match your own configuration. The configuration is held within the following
|
match your own configuration if the device name on your system is different.
|
||||||
file we've called ``ceph-osd.yaml``:
|
The configuration is held in the file called ``ceph-osd.yaml``:
|
||||||
|
|
||||||
.. code:: yaml
|
.. code:: yaml
|
||||||
|
|
||||||
|
@ -388,7 +388,7 @@ Relations:
|
||||||
juju add-relation glance rabbitmq-server
|
juju add-relation glance rabbitmq-server
|
||||||
|
|
||||||
`Ceph monitor <https://jujucharms.com/ceph-mon/>`__
|
`Ceph monitor <https://jujucharms.com/ceph-mon/>`__
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
For Ceph monitors (which monitor the topology of the Ceph deployment and
|
For Ceph monitors (which monitor the topology of the Ceph deployment and
|
||||||
manage the CRUSH map which is used by clients to read and write data) no
|
manage the CRUSH map which is used by clients to read and write data) no
|
||||||
|
@ -440,8 +440,20 @@ Relations:
|
||||||
`Swift proxy <https://jujucharms.com/swift-proxy/>`__
|
`Swift proxy <https://jujucharms.com/swift-proxy/>`__
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
Swift also needs a unique identifier, best generated with the ``uuid`` command
|
Swift also needs a unique identifier, best generated with the ``uuid`` command.
|
||||||
used previously. The output UUID is used for the ``swift-hash`` value in the
|
|
||||||
|
The ``uuid`` command on Ubuntu is in the ``uuid`` package (``sudo apt-get
|
||||||
|
install uuid``) and it is best to produce a version 4 uuid, which is based on
|
||||||
|
random numbers, rather than a version 1 which is based on the MAC address of a
|
||||||
|
network card and a timer.
|
||||||
|
|
||||||
|
Generate the uuid by running:
|
||||||
|
|
||||||
|
.. code:: bash
|
||||||
|
|
||||||
|
uuid -v 4
|
||||||
|
|
||||||
|
The output UUID is used for the ``swift-hash`` value in the
|
||||||
``swift-proxy.yaml`` configuration file:
|
``swift-proxy.yaml`` configuration file:
|
||||||
|
|
||||||
.. code:: yaml
|
.. code:: yaml
|
Before Width: | Height: | Size: 164 KiB After Width: | Height: | Size: 164 KiB |
Before Width: | Height: | Size: 15 KiB After Width: | Height: | Size: 15 KiB |
Before Width: | Height: | Size: 22 KiB After Width: | Height: | Size: 22 KiB |
Before Width: | Height: | Size: 40 KiB After Width: | Height: | Size: 40 KiB |
Before Width: | Height: | Size: 30 KiB After Width: | Height: | Size: 30 KiB |
Before Width: | Height: | Size: 14 KiB After Width: | Height: | Size: 14 KiB |
Before Width: | Height: | Size: 18 KiB After Width: | Height: | Size: 18 KiB |
Before Width: | Height: | Size: 50 KiB After Width: | Height: | Size: 50 KiB |
Before Width: | Height: | Size: 39 KiB After Width: | Height: | Size: 39 KiB |
Before Width: | Height: | Size: 32 KiB After Width: | Height: | Size: 32 KiB |
Before Width: | Height: | Size: 11 KiB After Width: | Height: | Size: 11 KiB |
Before Width: | Height: | Size: 46 KiB After Width: | Height: | Size: 46 KiB |
2
tox.ini
|
@ -14,4 +14,4 @@ deps = -r{toxinidir}/requirements.txt
|
||||||
commands = {posargs}
|
commands = {posargs}
|
||||||
|
|
||||||
[testenv:deploy-guide]
|
[testenv:deploy-guide]
|
||||||
commands = sphinx-build -a -d deploy-guide/build/doctrees -b html deploy-guide/source deploy-guide/build/html
|
commands = sphinx-build -a -d doc/build/doctrees -b html doc/source deploy-guide/build/html
|
||||||
|
|