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
69 lines
1.5 KiB
ReStructuredText
69 lines
1.5 KiB
ReStructuredText
===================
|
|
Scality SOFS driver
|
|
===================
|
|
|
|
The Scality SOFS volume driver interacts with configured sfused mounts.
|
|
|
|
The Scality SOFS driver manages volumes as sparse files stored on a
|
|
Scality Ring through sfused. Ring connection settings and sfused options
|
|
are defined in the ``cinder.conf`` file and the configuration file
|
|
pointed to by the ``scality_sofs_config`` option, typically
|
|
``/etc/sfused.conf``.
|
|
|
|
Supported operations
|
|
~~~~~~~~~~~~~~~~~~~~
|
|
|
|
The Scality SOFS volume driver provides the following Block Storage
|
|
volume operations:
|
|
|
|
- Create, delete, attach (map), and detach (unmap) volumes.
|
|
|
|
- Create, list, and delete volume snapshots.
|
|
|
|
- Create a volume from a snapshot.
|
|
|
|
- Copy an image to a volume.
|
|
|
|
- Copy a volume to an image.
|
|
|
|
- Clone a volume.
|
|
|
|
- Extend a volume.
|
|
|
|
- Backup a volume.
|
|
|
|
- Restore backup to new or existing volume.
|
|
|
|
Configuration
|
|
~~~~~~~~~~~~~
|
|
|
|
Use the following instructions to update the ``cinder.conf``
|
|
configuration file:
|
|
|
|
.. code-block:: ini
|
|
|
|
[DEFAULT]
|
|
enabled_backends = scality-1
|
|
|
|
[scality-1]
|
|
volume_driver = cinder.volume.drivers.scality.ScalityDriver
|
|
volume_backend_name = scality-1
|
|
|
|
scality_sofs_config = /etc/sfused.conf
|
|
scality_sofs_mount_point = /cinder
|
|
scality_sofs_volume_dir = cinder/volumes
|
|
|
|
Compute configuration
|
|
~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
Use the following instructions to update the ``nova.conf`` configuration
|
|
file:
|
|
|
|
.. code-block:: ini
|
|
|
|
[libvirt]
|
|
scality_sofs_mount_point = /cinder
|
|
scality_sofs_config = /etc/sfused.conf
|
|
|
|
.. include:: ../../tables/cinder-scality.inc
|