From 9a29d679f73623fd3f412d29a3b3efcd8ab0be6d Mon Sep 17 00:00:00 2001 From: Masayuki Igawa Date: Wed, 15 Nov 2017 15:08:50 +0900 Subject: [PATCH] Fix controller install document indentation This commit fixes the document of cinder-controller-install*.rst. Otherwise, the html docs are a little weird. Change-Id: I615d5cab95b07f995318266166480a9fd4d713f8 --- .../install/cinder-controller-install-obs.rst | 40 +++--- .../install/cinder-controller-install-rdo.rst | 18 +-- .../cinder-controller-install-ubuntu.rst | 118 +++++++++--------- 3 files changed, 88 insertions(+), 88 deletions(-) diff --git a/doc/source/install/cinder-controller-install-obs.rst b/doc/source/install/cinder-controller-install-obs.rst index f1b92ee7a95..40bd81d14c8 100644 --- a/doc/source/install/cinder-controller-install-obs.rst +++ b/doc/source/install/cinder-controller-install-obs.rst @@ -74,9 +74,9 @@ must create a database, service credentials, and API endpoints. $ openstack role add --project service --user cinder admin - .. note:: + .. note:: - This command provides no output. + This command provides no output. #. Create the ``cinderv2`` and ``cinderv3`` service entities: @@ -265,27 +265,27 @@ Install and configure components Replace ``RABBIT_PASS`` with the password you chose for the ``openstack`` account in ``RabbitMQ``. - #. In the ``[DEFAULT]`` and ``[keystone_authtoken]`` sections, - configure Identity service access: + #. In the ``[DEFAULT]`` and ``[keystone_authtoken]`` sections, + configure Identity service access: - .. path /etc/cinder/cinder.conf - .. code-block:: ini + .. path /etc/cinder/cinder.conf + .. code-block:: ini - [DEFAULT] - # ... - auth_strategy = keystone + [DEFAULT] + # ... + auth_strategy = keystone - [keystone_authtoken] - # ... - auth_uri = http://controller:5000 - auth_url = http://controller:35357 - memcached_servers = controller:11211 - auth_type = password - project_domain_name = default - user_domain_name = default - project_name = service - username = cinder - password = CINDER_PASS + [keystone_authtoken] + # ... + auth_uri = http://controller:5000 + auth_url = http://controller:35357 + memcached_servers = controller:11211 + auth_type = password + project_domain_name = default + user_domain_name = default + project_name = service + username = cinder + password = CINDER_PASS Replace ``CINDER_PASS`` with the password you chose for the ``cinder`` user in the Identity service. diff --git a/doc/source/install/cinder-controller-install-rdo.rst b/doc/source/install/cinder-controller-install-rdo.rst index 2abd63f1805..27997b7e221 100644 --- a/doc/source/install/cinder-controller-install-rdo.rst +++ b/doc/source/install/cinder-controller-install-rdo.rst @@ -110,9 +110,9 @@ must create a database, service credentials, and API endpoints. | type | volumev3 | +-------------+----------------------------------+ - .. note:: + .. note:: - The Block Storage services require two service entities. + The Block Storage services require two service entities. #. Create the Block Storage service API endpoints: @@ -241,15 +241,15 @@ Install and configure components #. In the ``[database]`` section, configure database access: - .. path /etc/cinder/cinder.conf - .. code-block:: ini + .. path /etc/cinder/cinder.conf + .. code-block:: ini - [database] - # ... - connection = mysql+pymysql://cinder:CINDER_DBPASS@controller/cinder + [database] + # ... + connection = mysql+pymysql://cinder:CINDER_DBPASS@controller/cinder - Replace ``CINDER_DBPASS`` with the password you chose for the - Block Storage database. + Replace ``CINDER_DBPASS`` with the password you chose for the + Block Storage database. #. In the ``[DEFAULT]`` section, configure ``RabbitMQ`` message queue access: diff --git a/doc/source/install/cinder-controller-install-ubuntu.rst b/doc/source/install/cinder-controller-install-ubuntu.rst index e6a384842ff..b6ed33af053 100644 --- a/doc/source/install/cinder-controller-install-ubuntu.rst +++ b/doc/source/install/cinder-controller-install-ubuntu.rst @@ -24,20 +24,20 @@ must create a database, service credentials, and API endpoints. #. Create the ``cinder`` database: - .. code-block:: console + .. code-block:: console - MariaDB [(none)]> CREATE DATABASE cinder; + MariaDB [(none)]> CREATE DATABASE cinder; #. Grant proper access to the ``cinder`` database: - .. code-block:: console + .. code-block:: console - MariaDB [(none)]> GRANT ALL PRIVILEGES ON cinder.* TO 'cinder'@'localhost' \ - IDENTIFIED BY 'CINDER_DBPASS'; - MariaDB [(none)]> GRANT ALL PRIVILEGES ON cinder.* TO 'cinder'@'%' \ - IDENTIFIED BY 'CINDER_DBPASS'; + MariaDB [(none)]> GRANT ALL PRIVILEGES ON cinder.* TO 'cinder'@'localhost' \ + IDENTIFIED BY 'CINDER_DBPASS'; + MariaDB [(none)]> GRANT ALL PRIVILEGES ON cinder.* TO 'cinder'@'%' \ + IDENTIFIED BY 'CINDER_DBPASS'; - Replace ``CINDER_DBPASS`` with a suitable password. + Replace ``CINDER_DBPASS`` with a suitable password. #. Exit the database access client. @@ -52,64 +52,64 @@ must create a database, service credentials, and API endpoints. #. Create a ``cinder`` user: - .. code-block:: console + .. code-block:: console - $ openstack user create --domain default --password-prompt cinder + $ openstack user create --domain default --password-prompt cinder - User Password: - Repeat User Password: - +---------------------+----------------------------------+ - | Field | Value | - +---------------------+----------------------------------+ - | domain_id | default | - | enabled | True | - | id | 9d7e33de3e1a498390353819bc7d245d | - | name | cinder | - | options | {} | - | password_expires_at | None | - +---------------------+----------------------------------+ + User Password: + Repeat User Password: + +---------------------+----------------------------------+ + | Field | Value | + +---------------------+----------------------------------+ + | domain_id | default | + | enabled | True | + | id | 9d7e33de3e1a498390353819bc7d245d | + | name | cinder | + | options | {} | + | password_expires_at | None | + +---------------------+----------------------------------+ #. Add the ``admin`` role to the ``cinder`` user: - .. code-block:: console + .. code-block:: console - $ openstack role add --project service --user cinder admin + $ openstack role add --project service --user cinder admin - .. note:: + .. note:: - This command provides no output. + This command provides no output. #. Create the ``cinderv2`` and ``cinderv3`` service entities: - .. code-block:: console + .. code-block:: console - $ openstack service create --name cinderv2 \ - --description "OpenStack Block Storage" volumev2 + $ openstack service create --name cinderv2 \ + --description "OpenStack Block Storage" volumev2 - +-------------+----------------------------------+ - | Field | Value | - +-------------+----------------------------------+ - | description | OpenStack Block Storage | - | enabled | True | - | id | eb9fd245bdbc414695952e93f29fe3ac | - | name | cinderv2 | - | type | volumev2 | - +-------------+----------------------------------+ + +-------------+----------------------------------+ + | Field | Value | + +-------------+----------------------------------+ + | description | OpenStack Block Storage | + | enabled | True | + | id | eb9fd245bdbc414695952e93f29fe3ac | + | name | cinderv2 | + | type | volumev2 | + +-------------+----------------------------------+ - .. code-block:: console + .. code-block:: console - $ openstack service create --name cinderv3 \ - --description "OpenStack Block Storage" volumev3 + $ openstack service create --name cinderv3 \ + --description "OpenStack Block Storage" volumev3 - +-------------+----------------------------------+ - | Field | Value | - +-------------+----------------------------------+ - | description | OpenStack Block Storage | - | enabled | True | - | id | ab3bbbef780845a1a283490d281e7fda | - | name | cinderv3 | - | type | volumev3 | - +-------------+----------------------------------+ + +-------------+----------------------------------+ + | Field | Value | + +-------------+----------------------------------+ + | description | OpenStack Block Storage | + | enabled | True | + | id | ab3bbbef780845a1a283490d281e7fda | + | name | cinderv3 | + | type | volumev3 | + +-------------+----------------------------------+ .. note:: @@ -249,21 +249,21 @@ Install and configure components # ... connection = mysql+pymysql://cinder:CINDER_DBPASS@controller/cinder - Replace ``CINDER_DBPASS`` with the password you chose for the - Block Storage database. + Replace ``CINDER_DBPASS`` with the password you chose for the + Block Storage database. #. In the ``[DEFAULT]`` section, configure ``RabbitMQ`` message queue access: - .. path /etc/cinder/cinder.conf - .. code-block:: ini + .. path /etc/cinder/cinder.conf + .. code-block:: ini - [DEFAULT] - # ... - transport_url = rabbit://openstack:RABBIT_PASS@controller + [DEFAULT] + # ... + transport_url = rabbit://openstack:RABBIT_PASS@controller - Replace ``RABBIT_PASS`` with the password you chose for the - ``openstack`` account in ``RabbitMQ``. + Replace ``RABBIT_PASS`` with the password you chose for the + ``openstack`` account in ``RabbitMQ``. #. In the ``[DEFAULT]`` and ``[keystone_authtoken]`` sections, configure Identity service access: