From bed2dd42bd423711e4ff9561ff82b3a5c83e4f54 Mon Sep 17 00:00:00 2001 From: Alex Kavanagh Date: Wed, 23 Aug 2017 14:22:11 +0100 Subject: [PATCH] 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 --- .gitreview | 4 +++ {deploy-guide => doc}/source/conf.py | 0 .../source/config-openstack.rst | 15 ++++++---- {deploy-guide => doc}/source/index.rst | 0 {deploy-guide => doc}/source/install-juju.rst | 0 {deploy-guide => doc}/source/install-maas.rst | 0 .../source/install-openstack-bundle.rst | 11 ++++++-- .../source/install-openstack.rst | 26 +++++++++++++----- .../source/media/config-openstack_images.png | Bin .../source/media/install-juju_maaskey.png | Bin .../source/media/install-maas_dhcp.png | Bin .../source/media/install-maas_discovery.png | Bin .../source/media/install-maas_images.png | Bin .../source/media/install-maas_imagestatus.png | Bin .../source/media/install-maas_noadmin.png | Bin .../source/media/install-maas_power.png | Bin .../source/media/install-maas_sshkeys.png | Bin .../source/media/install-maas_tags.png | Bin .../source/media/install-maas_welcome.png | Bin .../media/install-openstack_horizon.png | Bin tox.ini | 2 +- 21 files changed, 42 insertions(+), 16 deletions(-) create mode 100644 .gitreview rename {deploy-guide => doc}/source/conf.py (100%) rename {deploy-guide => doc}/source/config-openstack.rst (97%) rename {deploy-guide => doc}/source/index.rst (100%) rename {deploy-guide => doc}/source/install-juju.rst (100%) rename {deploy-guide => doc}/source/install-maas.rst (100%) rename {deploy-guide => doc}/source/install-openstack-bundle.rst (78%) rename {deploy-guide => doc}/source/install-openstack.rst (95%) rename {deploy-guide => doc}/source/media/config-openstack_images.png (100%) rename {deploy-guide => doc}/source/media/install-juju_maaskey.png (100%) rename {deploy-guide => doc}/source/media/install-maas_dhcp.png (100%) rename {deploy-guide => doc}/source/media/install-maas_discovery.png (100%) rename {deploy-guide => doc}/source/media/install-maas_images.png (100%) rename {deploy-guide => doc}/source/media/install-maas_imagestatus.png (100%) rename {deploy-guide => doc}/source/media/install-maas_noadmin.png (100%) rename {deploy-guide => doc}/source/media/install-maas_power.png (100%) rename {deploy-guide => doc}/source/media/install-maas_sshkeys.png (100%) rename {deploy-guide => doc}/source/media/install-maas_tags.png (100%) rename {deploy-guide => doc}/source/media/install-maas_welcome.png (100%) rename {deploy-guide => doc}/source/media/install-openstack_horizon.png (100%) diff --git a/.gitreview b/.gitreview new file mode 100644 index 0000000..c685ae7 --- /dev/null +++ b/.gitreview @@ -0,0 +1,4 @@ +[gerrit] +host=review.openstack.org +port=29418 +project=openstack/charm-deployment-guide.git diff --git a/deploy-guide/source/conf.py b/doc/source/conf.py similarity index 100% rename from deploy-guide/source/conf.py rename to doc/source/conf.py diff --git a/deploy-guide/source/config-openstack.rst b/doc/source/config-openstack.rst similarity index 97% rename from deploy-guide/source/config-openstack.rst rename to doc/source/config-openstack.rst index a19b0d9..4e92504 100644 --- a/deploy-guide/source/config-openstack.rst +++ b/doc/source/config-openstack.rst @@ -70,7 +70,7 @@ apply. 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: .. code:: bash @@ -131,11 +131,14 @@ new subnet's configuration: | use_default_subnet_pool | None | +-------------------------+--------------------------------------+ -!!! Note: OpenStack has -`deprecated `__ -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. +.. Note:: + + OpenStack has `deprecated + `__ + 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 ------------ diff --git a/deploy-guide/source/index.rst b/doc/source/index.rst similarity index 100% rename from deploy-guide/source/index.rst rename to doc/source/index.rst diff --git a/deploy-guide/source/install-juju.rst b/doc/source/install-juju.rst similarity index 100% rename from deploy-guide/source/install-juju.rst rename to doc/source/install-juju.rst diff --git a/deploy-guide/source/install-maas.rst b/doc/source/install-maas.rst similarity index 100% rename from deploy-guide/source/install-maas.rst rename to doc/source/install-maas.rst diff --git a/deploy-guide/source/install-openstack-bundle.rst b/doc/source/install-openstack-bundle.rst similarity index 78% rename from deploy-guide/source/install-openstack-bundle.rst rename to doc/source/install-openstack-bundle.rst index 490daeb..446dbd7 100644 --- a/deploy-guide/source/install-openstack-bundle.rst +++ b/doc/source/install-openstack-bundle.rst @@ -16,11 +16,18 @@ A `bundle `__, as used above, encapsulates the entire deployment process, including all applications, their 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 -store <./install-openstack-bundle.html>`__. +store `__. -For our project, [download the OpenStack][downloadbundle] and deploy OpenStack +For our project, `download +`__ the +`OpenStack `__ and deploy OpenStack 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. Monitor the output of ``juju status`` to see when everything is ready. diff --git a/deploy-guide/source/install-openstack.rst b/doc/source/install-openstack.rst similarity index 95% rename from deploy-guide/source/install-openstack.rst rename to doc/source/install-openstack.rst index a4cff47..44254af 100644 --- a/deploy-guide/source/install-openstack.rst +++ b/doc/source/install-openstack.rst @@ -80,10 +80,10 @@ of the charms as a ``yaml`` file which we include as we deploy them. `Ceph OSD `__ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -We're starting with the Ceph object storage daemon and we want to configure Ceph -to use the second drive of a cloud node, ``/dev/sdb``. Change or ignore this to -match your own configuration. The configuration is held within the following -file we've called ``ceph-osd.yaml``: +We're starting with the Ceph object storage daemon and we want to configure +Ceph to use the second drive of a cloud node, ``/dev/sdb``. Change this to +match your own configuration if the device name on your system is different. +The configuration is held in the file called ``ceph-osd.yaml``: .. code:: yaml @@ -388,7 +388,7 @@ Relations: juju add-relation glance rabbitmq-server `Ceph monitor `__ -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 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 @@ -440,8 +440,20 @@ Relations: `Swift proxy `__ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -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 +Swift also needs a unique identifier, best generated with the ``uuid`` command. + +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: .. code:: yaml diff --git a/deploy-guide/source/media/config-openstack_images.png b/doc/source/media/config-openstack_images.png similarity index 100% rename from deploy-guide/source/media/config-openstack_images.png rename to doc/source/media/config-openstack_images.png diff --git a/deploy-guide/source/media/install-juju_maaskey.png b/doc/source/media/install-juju_maaskey.png similarity index 100% rename from deploy-guide/source/media/install-juju_maaskey.png rename to doc/source/media/install-juju_maaskey.png diff --git a/deploy-guide/source/media/install-maas_dhcp.png b/doc/source/media/install-maas_dhcp.png similarity index 100% rename from deploy-guide/source/media/install-maas_dhcp.png rename to doc/source/media/install-maas_dhcp.png diff --git a/deploy-guide/source/media/install-maas_discovery.png b/doc/source/media/install-maas_discovery.png similarity index 100% rename from deploy-guide/source/media/install-maas_discovery.png rename to doc/source/media/install-maas_discovery.png diff --git a/deploy-guide/source/media/install-maas_images.png b/doc/source/media/install-maas_images.png similarity index 100% rename from deploy-guide/source/media/install-maas_images.png rename to doc/source/media/install-maas_images.png diff --git a/deploy-guide/source/media/install-maas_imagestatus.png b/doc/source/media/install-maas_imagestatus.png similarity index 100% rename from deploy-guide/source/media/install-maas_imagestatus.png rename to doc/source/media/install-maas_imagestatus.png diff --git a/deploy-guide/source/media/install-maas_noadmin.png b/doc/source/media/install-maas_noadmin.png similarity index 100% rename from deploy-guide/source/media/install-maas_noadmin.png rename to doc/source/media/install-maas_noadmin.png diff --git a/deploy-guide/source/media/install-maas_power.png b/doc/source/media/install-maas_power.png similarity index 100% rename from deploy-guide/source/media/install-maas_power.png rename to doc/source/media/install-maas_power.png diff --git a/deploy-guide/source/media/install-maas_sshkeys.png b/doc/source/media/install-maas_sshkeys.png similarity index 100% rename from deploy-guide/source/media/install-maas_sshkeys.png rename to doc/source/media/install-maas_sshkeys.png diff --git a/deploy-guide/source/media/install-maas_tags.png b/doc/source/media/install-maas_tags.png similarity index 100% rename from deploy-guide/source/media/install-maas_tags.png rename to doc/source/media/install-maas_tags.png diff --git a/deploy-guide/source/media/install-maas_welcome.png b/doc/source/media/install-maas_welcome.png similarity index 100% rename from deploy-guide/source/media/install-maas_welcome.png rename to doc/source/media/install-maas_welcome.png diff --git a/deploy-guide/source/media/install-openstack_horizon.png b/doc/source/media/install-openstack_horizon.png similarity index 100% rename from deploy-guide/source/media/install-openstack_horizon.png rename to doc/source/media/install-openstack_horizon.png diff --git a/tox.ini b/tox.ini index 74310da..155d411 100644 --- a/tox.ini +++ b/tox.ini @@ -14,4 +14,4 @@ deps = -r{toxinidir}/requirements.txt commands = {posargs} [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