openstack/cinder
Code Issues Proposed changes

Fix installation instructions format

Browse Source 
These instructions have some sections missing which results in non-standard
format in the URLs. In addition, the automatic numbering is wrong. This patch
fixes the pages.

URLs:
https://docs.openstack.org/cinder/pike/install/cinder-storage-install-ubuntu.html
https://docs.openstack.org/cinder/pike/install/cinder-storage-install-obs.html
https://docs.openstack.org/cinder/pike/install/cinder-storage-install-rdo.html

Closes-Bug: #1713492
Change-Id: I8c9b2437d7eda06ebce3cf5a1c71e497d5146ebc
This commit is contained in:
root 2017-08-29 10:45:23 +08:00 committed by Hanxi_Liu
parent 7f69969345
commit da974d646a
3 changed files with 58 additions and 86 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
doc/source/install/cinder-storage-install-obs.rst
View File

@ -15,9 +15,9 @@ storage node, you must prepare the storage device.
#. Install the LVM packages: #. Install the LVM packages:
.. code-block:: console .. code-block:: console
# zypper install lvm2 # zypper install lvm2
#. (Optional) If you intend to use non-raw image types such as QCOW2 #. (Optional) If you intend to use non-raw image types such as QCOW2
and VMDK, install the QEMU package: and VMDK, install the QEMU package:
@ -26,9 +26,11 @@ storage node, you must prepare the storage device.
# zypper install qemu # zypper install qemu
.. note:: .. end
Some distributions include LVM by default. .. note::
Some distributions include LVM by default.
#. Create the LVM physical volume ``/dev/sdb``: #. Create the LVM physical volume ``/dev/sdb``:
@ -192,24 +194,21 @@ Install and configure components
typically 10.0.0.41 for the first node in the typically 10.0.0.41 for the first node in the
:ref:`example architecture <overview-example-architectures>`. :ref:`example architecture <overview-example-architectures>`.
* In the ``[lvm]`` section, configure the LVM back end with the
LVM driver, ``cinder-volumes`` volume group, iSCSI protocol,
and appropriate iSCSI service:
* In the ``[lvm]`` section, configure the LVM back end with the .. path /etc/cinder/cinder.conf
LVM driver, ``cinder-volumes`` volume group, iSCSI protocol, .. code-block:: ini
and appropriate iSCSI service:
.. path /etc/cinder/cinder.conf
.. code-block:: ini
[lvm]
# ...
volume_driver = cinder.volume.drivers.lvm.LVMVolumeDriver
volume_group = cinder-volumes
iscsi_protocol = iscsi
iscsi_helper = tgtadm
.. end
[lvm]
# ...
volume_driver = cinder.volume.drivers.lvm.LVMVolumeDriver
volume_group = cinder-volumes
iscsi_protocol = iscsi
iscsi_helper = tgtadm
.. end
* In the ``[DEFAULT]`` section, enable the LVM back end: * In the ``[DEFAULT]`` section, enable the LVM back end:
@ -251,7 +250,7 @@ Install and configure components
.. end .. end
3. Create the ``/etc/tgt/conf.d/cinder.conf`` file #. Create the ``/etc/tgt/conf.d/cinder.conf`` file
with the following data: with the following data:
.. code-block:: shell .. code-block:: shell

61
doc/source/install/cinder-storage-install-rdo.rst
View File

@ -13,27 +13,23 @@ storage node, you must prepare the storage device.
#. Install the supporting utility packages: #. Install the supporting utility packages:
* Install the LVM packages:
.. code-block:: console
* Install the LVM packages: # yum install lvm2
.. code-block:: console .. end
# yum install lvm2 * Start the LVM metadata service and configure it to start when the
system boots:
.. end .. code-block:: console
* Start the LVM metadata service and configure it to start when the
system boots:
.. code-block:: console
# systemctl enable lvm2-lvmetad.service
# systemctl start lvm2-lvmetad.service
.. end
# systemctl enable lvm2-lvmetad.service
# systemctl start lvm2-lvmetad.service
.. end
.. note:: .. note::
@ -119,8 +115,6 @@ storage node, you must prepare the storage device.
Install and configure components Install and configure components
-------------------------------- --------------------------------
#. Install the packages: #. Install the packages:
.. code-block:: console .. code-block:: console
@ -129,9 +123,7 @@ Install and configure components
.. end .. end
#. Edit the ``/etc/cinder/cinder.conf`` file
2. Edit the ``/etc/cinder/cinder.conf`` file
and complete the following actions: and complete the following actions:
* In the ``[database]`` section, configure database access: * In the ``[database]`` section, configure database access:
@ -211,24 +203,21 @@ Install and configure components
typically 10.0.0.41 for the first node in the typically 10.0.0.41 for the first node in the
:ref:`example architecture <overview-example-architectures>`. :ref:`example architecture <overview-example-architectures>`.
* In the ``[lvm]`` section, configure the LVM back end with the
LVM driver, ``cinder-volumes`` volume group, iSCSI protocol,
and appropriate iSCSI service. If the ``[lvm]`` section does not exist,
create it:
.. path /etc/cinder/cinder.conf
.. code-block:: ini
* In the ``[lvm]`` section, configure the LVM back end with the [lvm]
LVM driver, ``cinder-volumes`` volume group, iSCSI protocol, volume_driver = cinder.volume.drivers.lvm.LVMVolumeDriver
and appropriate iSCSI service. If the ``[lvm]`` section does not exist, volume_group = cinder-volumes
create it: iscsi_protocol = iscsi
iscsi_helper = lioadm
.. path /etc/cinder/cinder.conf
.. code-block:: ini
[lvm]
volume_driver = cinder.volume.drivers.lvm.LVMVolumeDriver
volume_group = cinder-volumes
iscsi_protocol = iscsi
iscsi_helper = lioadm
.. end
.. end
* In the ``[DEFAULT]`` section, enable the LVM back end: * In the ``[DEFAULT]`` section, enable the LVM back end:
@ -273,8 +262,6 @@ Install and configure components
Finalize installation Finalize installation
--------------------- ---------------------
* Start the Block Storage volume service including its dependencies * Start the Block Storage volume service including its dependencies
and configure them to start when the system boots: and configure them to start when the system boots:
@ -284,5 +271,3 @@ Finalize installation
# systemctl start openstack-cinder-volume.service target.service # systemctl start openstack-cinder-volume.service target.service
.. end .. end

44
doc/source/install/cinder-storage-install-ubuntu.rst
View File

@ -13,15 +13,11 @@ storage node, you must prepare the storage device.
#. Install the supporting utility packages: #. Install the supporting utility packages:
.. code-block:: console
# apt install lvm2
.. end
.. code-block:: console
# apt install lvm2
.. end
.. note:: .. note::
@ -107,9 +103,6 @@ storage node, you must prepare the storage device.
Install and configure components Install and configure components
-------------------------------- --------------------------------
#. Install the packages: #. Install the packages:
.. code-block:: console .. code-block:: console
@ -119,7 +112,7 @@ Install and configure components
.. end .. end
2. Edit the ``/etc/cinder/cinder.conf`` file #. Edit the ``/etc/cinder/cinder.conf`` file
and complete the following actions: and complete the following actions:
* In the ``[database]`` section, configure database access: * In the ``[database]`` section, configure database access:
@ -200,23 +193,21 @@ Install and configure components
:ref:`example architecture <overview-example-architectures>`. :ref:`example architecture <overview-example-architectures>`.
* In the ``[lvm]`` section, configure the LVM back end with the * In the ``[lvm]`` section, configure the LVM back end with the
LVM driver, ``cinder-volumes`` volume group, iSCSI protocol, LVM driver, ``cinder-volumes`` volume group, iSCSI protocol,
and appropriate iSCSI service: and appropriate iSCSI service:
.. path /etc/cinder/cinder.conf .. path /etc/cinder/cinder.conf
.. code-block:: ini .. code-block:: ini
[lvm]
# ...
volume_driver = cinder.volume.drivers.lvm.LVMVolumeDriver
volume_group = cinder-volumes
iscsi_protocol = iscsi
iscsi_helper = tgtadm
.. end
[lvm]
# ...
volume_driver = cinder.volume.drivers.lvm.LVMVolumeDriver
volume_group = cinder-volumes
iscsi_protocol = iscsi
iscsi_helper = tgtadm
.. end
* In the ``[DEFAULT]`` section, enable the LVM back end: * In the ``[DEFAULT]`` section, enable the LVM back end:
@ -261,9 +252,6 @@ Install and configure components
Finalize installation Finalize installation
--------------------- ---------------------
#. Restart the Block Storage volume service including its dependencies: #. Restart the Block Storage volume service including its dependencies:
.. code-block:: console .. code-block:: console