diff --git a/doc/install-guide-debconf/source/cinder-backup-install.rst b/doc/install-guide-debconf/source/cinder-backup-install.rst new file mode 120000 index 0000000000..b159b00ad5 --- /dev/null +++ b/doc/install-guide-debconf/source/cinder-backup-install.rst @@ -0,0 +1 @@ +../../install-guide/source/cinder-backup-install.rst \ No newline at end of file diff --git a/doc/install-guide/source/cinder-backup-install.rst b/doc/install-guide/source/cinder-backup-install.rst new file mode 100644 index 0000000000..a62e014da3 --- /dev/null +++ b/doc/install-guide/source/cinder-backup-install.rst @@ -0,0 +1,82 @@ +.. _cinder-backup-install: + +Install and configure the backup service +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Optionally, install and configure the backup service. For simplicity, +this configuration uses the Block Storage node and the Object Storage +(swift) driver, thus depending on the +`Object Storage service `_. + +.. note:: + + You must :ref:`install and configure a storage node ` prior + to installing and configuring the backup service. + +Install and configure components +-------------------------------- + +.. note:: + + Perform these steps on the Block Storage node. + +.. only:: obs + + #. Install the packages: + + .. code-block:: console + + # zypper install openstack-cinder-backup + +.. only:: rdo + + #. Install the packages: + + .. code-block:: console + + # yum install openstack-cinder + +.. only:: ubuntu or debian + + #. Install the packages: + + .. code-block:: console + + # apt-get install cinder-backup + +2. Edit the ``/etc/cinder/cinder.conf`` file + and complete the following actions: + + * In the ``[DEFAULT]`` section, configure backup options: + + .. code-block:: ini + + [DEFAULT] + ... + backup_driver = cinder.backup.drivers.swift + backup_swift_url = SWIFT_URL + + Replace ``SWIFT_URL`` with the URL of the Object Storage service, typically + ``http://10.0.0.51:8080/v1/AUTH_`` if using the installation guide + architecture. + +Finalize installation +--------------------- + +.. only:: obs or rdo + + Start the Block Storage backup service and configure it to + start when the system boots: + + .. code-block:: console + + # systemctl enable openstack-cinder-backup.service + # systemctl start openstack-cinder-backup.service + +.. only:: ubuntu or debian + + Restart the Block Storage backup service: + + .. code-block:: console + + # service cinder-backup restart diff --git a/doc/install-guide/source/cinder-verify.rst b/doc/install-guide/source/cinder-verify.rst index b0b3801016..781c7946c9 100644 --- a/doc/install-guide/source/cinder-verify.rst +++ b/doc/install-guide/source/cinder-verify.rst @@ -26,4 +26,9 @@ Verify operation of the Block Storage service. +------------------+------------+------+---------+-------+----------------------------+-----------------+ | cinder-scheduler | controller | nova | enabled | up | 2014-10-18T01:30:54.000000 | None | | cinder-volume | block1@lvm | nova | enabled | up | 2014-10-18T01:30:57.000000 | None | + | cinder-backup | block1 | nova | enabled | up | 2014-10-18T01:30:59.000000 | None | +------------------+------------+------+---------+-------+----------------------------+-----------------+ + + .. note:: + + The ``cinder-backup`` service only appears if you :ref:`cinder-backup-install`. diff --git a/doc/install-guide/source/cinder.rst b/doc/install-guide/source/cinder.rst index c80b280ddf..9653361501 100644 --- a/doc/install-guide/source/cinder.rst +++ b/doc/install-guide/source/cinder.rst @@ -9,6 +9,7 @@ Block Storage service common/get_started_block_storage.rst cinder-controller-install.rst cinder-storage-install.rst + cinder-backup-install.rst cinder-verify.rst cinder-next-steps.rst @@ -25,7 +26,3 @@ on controllers, compute nodes, or standalone storage nodes. For more information, see the `Configuration Reference `__. -.. note:: - - This chapter omits the backup manager because it depends on the - Object Storage service.