986a6a015f
The Sphinx build was issuing hundreds of warning for duplicate labels. The reason for this was because all of the tables we had were named as .rst files. This would cause Sphinx to process them twice and it would think there were duplicated sections. There were two ways this could be handled: 1) Exclude the tables directory from the docs build. 2) Name the files as they should have always been so they weren't build twice. Given that option 1 just masked the problem, I am implementing this patch using option 2. So, all the tables we are including in our documentation have been named from .rst to .inc and the .. include:: directives that use them have also been updated to use the new file name. Change-Id: If395eb652f7e3b789bcbd5e6d6d05954c23d8d8a
53 lines
1.4 KiB
ReStructuredText
53 lines
1.4 KiB
ReStructuredText
===================
|
|
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.inc
|
|
|
|
To enable the swift backup driver for 1.0, 2.0, or 3.0 authentication version,
|
|
specify ``1``, ``2``, or ``3`` 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_url = http://localhost:5000/v3
|
|
backup_swift_auth = per_user
|
|
backup_swift_auth_version = 1
|
|
backup_swift_user = <None>
|
|
backup_swift_user_domain = <None>
|
|
backup_swift_key = <None>
|
|
backup_swift_container = volumebackups
|
|
backup_swift_object_size = 52428800
|
|
backup_swift_project = <None>
|
|
backup_swift_project_domain = <None>
|
|
backup_swift_retry_attempts = 3
|
|
backup_swift_retry_backoff = 2
|
|
backup_compression_algorithm = zlib
|