openstack/openstack-manuals
Code Issues Proposed changes

Configuration reference docs for Cinder backup.

Browse Source 
Documentation for configuration cinder-backup service
including documentation for the drivers in Havana:
Ceph, IBM TSM and Swift.
Driver documentation is based on the driver's code and comments.

Closes-Bug: 1205359

Change-Id: I4a38b779193db35ae95332744ed52f931a4ecee4
This commit is contained in:
Ronen Kat 2013-09-18 11:54:07 +02:00
parent 55c3982c1d
commit e56cfaf5d7
5 changed files with 148 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

60
doc/config-reference/block-storage/backup/ceph-backup-driver.xml Normal file
View File

@ -0,0 +1,60 @@
<section xml:id="ceph-backup-driver"
xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink"
version="5.0">
<title>Ceph Backup Driver</title>
<para>The Ceph backup driver supports backing up volumes of any type
to a Ceph backend store. It is also capable of detecting whether
the volume to be backed up is a Ceph RBD volume and if so,
attempts to perform incremental/differential backups.
</para>
<para>Support is also included for the following in the case of source
volume being a Ceph RBD volume:
</para>
<itemizedlist>
<listitem><para>backing up within the same Ceph pool
(not recommended)</para>
</listitem>
<listitem><para>backing up between different Ceph pools</para>
</listitem>
<listitem><para>backing up between different Ceph clusters</para>
</listitem>
</itemizedlist>
<para>At the time of writing, differential backup support in
Ceph/librbd was quite new so this driver accounts for this
by first attempting differential backup and falling back to
full backup/copy if the former fails.
</para>
<para>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 and restoring the volume takes
a far reduced amount of time compared to a full copy.
</para>
<para>Note that Cinder supports restoring to a new volume or the
original volume the backup was taken from. For the latter
case, a full copy is enforced since this was deemed the safest
action to take. It is therefore recommended to always
restore to a new volume (default).
</para>
<para>To enable the Ceph backup driver, include the following option
in cinder.conf:</para>
<programlisting>
backup_driver=cinder.backup.driver.ceph
</programlisting>
<para>The following configuration options are available for the
Ceph backup driver.
</para>
<xi:include href="../../../common/tables/cinder-backups_ceph.xml" />
<para>Here is an example of the default options for the Ceph backup
driver.
</para>
<programlisting>
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
</programlisting>
</section>

34
doc/config-reference/block-storage/backup/swift-backup-driver.xml Normal file
View File

@ -0,0 +1,34 @@
<section xml:id="swift-backup-driver"
xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink"
version="5.0">
<title>Swift Backup Driver</title>
<para>The backup driver for Swift backend performs a volume backup to a
Swift object storage system.
</para>
<para>To enable the Swift backup driver, include the following option
in cinder.conf:</para>
<programlisting>
backup_driver=cinder.backup.driver.swift
</programlisting>
<para>The following configuration options are available for the
Swift backend backup driver.
</para>
<xi:include href="../../../common/tables/cinder-backups_swift.xml" />
<para>Here is an example of the default options for the Swift backend
backup driver.
</para>
<programlisting>
backup_swift_url=http://localhost:8080/v1/AUTH
backup_swift_auth=per_user
backup_swift_user=&lt;None&gt;
backup_swift_key=&lt;None&gt;
backup_swift_container=volumebackups
backup_swift_object_size=52428800
backup_swift_retry_attempts=3
backup_swift_retry_backoff=2
backup_compression_algorithm=zlib
</programlisting>
</section>

35
doc/config-reference/block-storage/backup/tsm-backup-driver.xml Normal file
View File

@ -0,0 +1,35 @@
<section xml:id="tsm-backup-driver"
xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink"
version="5.0">
<title>IBM Tivoli Storage Manager Backup Driver</title>
<para>The IBM Tivoli Storage Manager (TSM) backup driver enables
performing volume backups to a TSM server.
</para>
<para>The TSM client should be installed and configured on the
machine running the <systemitem class="service">cinder-backup
</systemitem> service.
Please refer to the IBM Tivoli Storage Manager
Backup-Archive Client Installation and User's Guide for
details on installing the TSM client.
</para>
<para>To enable the IBM TSM backup driver, include the following option
in cinder.conf:</para>
<programlisting>
backup_driver=cinder.backup.driver.tsm
</programlisting>
<para>The following configuration options are available for the
TSM backup driver.
</para>
<xi:include href="../../../common/tables/cinder-backups_tsm.xml" />
<para>Here is an example of the default options for the TSM backup
driver.
</para>
<programlisting>
backup_tsm_volume_prefix = backup
backup_tsm_password = password
backup_tsm_compression = True
</programlisting>
</section>

18
doc/config-reference/block-storage/section_backup-drivers.xml Normal file
View File

@ -0,0 +1,18 @@
<?xml version="1.0" encoding="UTF-8"?>
<section xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
xml:id="section_backup-drivers">
<title>Backup Drivers</title>
<para>This section describes how to configure the <systemitem
class="service">cinder-backup</systemitem> service and its
drivers.</para>
<para>The volume drivers are included with the Cinder repository
(<link xlink:href="https://github.com/openstack/cinder"
>https://github.com/openstack/cinder</link>). To set a
backup driver, use the <literal>backup_driver</literal> flag.
By default there is no backup driver enabled.</para>
<xi:include href="backup/ceph-backup-driver.xml"/>
<xi:include href="backup/tsm-backup-driver.xml"/>
<xi:include href="backup/swift-backup-driver.xml"/>
</section>

1
doc/config-reference/ch_blockstorageconfigure.xml
View File

@ -23,5 +23,6 @@
directory with MooseFS instead of NFS.</para>
<xi:include href="../common/section_moosefs.xml"/>
<xi:include href="block-storage/section_volume-drivers.xml"/>
<xi:include href="block-storage/section_backup-drivers.xml"/>
</section>
</chapter>