[config-ref] RST conversion: section_backup-drivers.xml

Change-Id: I0978ea26a7f1d1dfae6eda83b6db609809d3c122
Implements: blueprint config-ref-rst

doc/config-ref-rst/source/block-storage/backup-drivers.rst

@@ -1,3 +1,18 @@
 ==============
 Backup drivers
 ==============
+
+.. toctree::
+
+   backup/ceph-backup-driver.rst
+   backup/tsm-backup-driver.rst
+   backup/swift-backup-driver.rst
+   backup/nfs-backup-driver.rst
+
+This section describes how to configure the cinder-backup service and
+its drivers.
+
+The volume drivers are included with the `Block Storage repository
+<https://git.openstack.org/cgit/openstack/cinder/>`_. To set a backup
+driver, use the ``backup_driver`` flag. By default there is no backup
+driver enabled.

doc/config-ref-rst/source/block-storage/backup/ceph-backup-driver.rst

@@ -0,0 +1,56 @@
+==================
+Ceph backup driver
+==================
+
+The Ceph backup driver backs up volumes of any type to a Ceph back-end
+store. The driver can also detect whether the volume to be backed up is
+a Ceph RBD volume, and if so, it tries to perform incremental and
+differential backups.
+
+For source Ceph RBD volumes, you can perform backups within the same
+Ceph pool (not recommended). You can also perform backups between
+different Ceph pools and between different Ceph clusters.
+
+At the time of writing, differential backup support in Ceph/librbd was
+quite new. This driver attempts a differential backup in the first
+instance. If the differential backup fails, the driver falls back to
+full backup/copy.
+
+If incremental backups are used, multiple backups of the same volume are
+stored as snapshots so that minimal space is consumed in the backup
+store. It takes far less time to restore a volume than to take a full
+copy.
+
+.. note::
+
+    Block Storage enables you to:
+
+    -  Restore to a new volume, which is the default and recommended
+       action.
+
+    -  Restore to the original volume from which the backup was taken.
+       The restore action takes a full copy because this is the safest
+       action.
+
+To enable the Ceph backup driver, include the following option in the
+``cinder.conf`` file:
+
+.. code-block:: ini
+
+    backup_driver = cinder.backup.drivers.ceph
+
+The following configuration options are available for the Ceph backup
+driver.
+
+.. include:: ../../tables/cinder-backups_ceph.rst
+
+This example shows the default options for the Ceph backup driver.
+
+.. code-block:: ini
+
+    backup_ceph_conf=/etc/ceph/ceph.conf
+    backup_ceph_user = cinder
+    backup_ceph_chunk_size = 134217728
+    backup_ceph_pool = backups
+    backup_ceph_stripe_unit = 0
+    backup_ceph_stripe_count = 0

doc/config-ref-rst/source/block-storage/backup/nfs-backup-driver.rst

@@ -0,0 +1,18 @@
+=================
+NFS backup driver
+=================
+
+The backup driver for the NFS back end backs up volumes of any type to
+an NFS exported backup repository.
+
+To enable the NFS backup driver, include the following option in the
+``[DEFAULT]`` section of the ``cinder.conf`` file:
+
+.. code-block:: ini
+
+    backup_driver = cinder.backup.drivers.nfs
+
+The following configuration options are available for the NFS back-end
+backup driver.
+
+.. include:: ../../tables/cinder-backups_nfs.rst

doc/config-ref-rst/source/block-storage/backup/swift-backup-driver.rst

@@ -0,0 +1,48 @@
+===================
+Swift backup driver
+===================
+
+The backup driver for the swift back end performs a volume backup to an
+object storage system.
+
+To enable the swift backup driver, include the following option in the
+``cinder.conf`` file:
+
+.. code-block:: ini
+
+    backup_driver = cinder.backup.drivers.swift
+
+The following configuration options are available for the Swift back-end
+backup driver.
+
+.. include:: ../../tables/cinder-backups_swift.rst
+
+To enable the swift backup driver for 1.0 or 2.0 authentication version,
+specify ``1`` or ``2`` correspondingly. For example:
+
+.. code-block:: ini
+
+    backup_swift_auth_version = 2
+
+In addition, the 2.0 authentication system requires the definition of the
+``backup_swift_tenant`` setting:
+
+.. code-block:: ini
+
+    backup_swift_tenant = <None>
+
+This example shows the default options for the Swift back-end backup
+driver.
+
+.. code-block:: ini
+
+    backup_swift_url = http://localhost:8080/v1/AUTH_
+    backup_swift_auth = per_user
+    backup_swift_auth_version = 1
+    backup_swift_user = <None>
+    backup_swift_key = <None>
+    backup_swift_container = volumebackups
+    backup_swift_object_size = 52428800
+    backup_swift_retry_attempts = 3
+    backup_swift_retry_backoff = 2
+    backup_compression_algorithm = zlib

doc/config-ref-rst/source/block-storage/backup/tsm-backup-driver.rst

@@ -0,0 +1,31 @@
+========================================
+IBM Tivoli Storage Manager backup driver
+========================================
+
+The IBM Tivoli Storage Manager (TSM) backup driver enables performing
+volume backups to a TSM server.
+
+The TSM client should be installed and configured on the machine running
+the cinder-backup service. See the IBM Tivoli Storage Manager
+Backup-Archive Client Installation and User's Guide for details on
+installing the TSM client.
+
+To enable the IBM TSM backup driver, include the following option in
+``cinder.conf``:
+
+.. code-block:: ini
+
+    backup_driver = cinder.backup.drivers.tsm
+
+The following configuration options are available for the TSM backup
+driver.
+
+.. include:: ../../tables/cinder-backups_tsm.rst
+
+This example shows the default options for the TSM backup driver.
+
+.. code-block:: ini
+
+    backup_tsm_volume_prefix = backup
+    backup_tsm_password = password
+    backup_tsm_compression = True