Correct sphinx source code syntax

Change-Id: Ia986e279081b7939eb2cecdcc6050bcb04afe210
This commit is contained in:
Rui Yuan Dou 2017-05-17 16:00:51 +08:00
parent ffe7d919d8
commit 13ed743925
2 changed files with 24 additions and 11 deletions

View File

@ -27,14 +27,17 @@ Attach/Detach Operations are multi-part commands
There are three things that happen in the workflow for an attach or detach call.
1. Update the status of the volume in the DB (ie attaching/detaching)
- For Attach, this is the cinder.volume.api.reserve method
- For Detach, the analogous call is cinder.volume.api.begin_detaching
2. Handle the connection operations that need to be done on the Volume
- For Attach, this is the cinder.volume.api.initialize_connection method
- For Detach, the analogous calls is cinder.volume.api.terminate_connection
3. Finalize the status of the volume and release the resource
- For attach, this is the cinder.volume.api.attach method
- For detach, the analogous call is cinder.volume.api.detach
@ -66,17 +69,23 @@ things like CHAP credential, iqn and lun information. An example response is
shown here:
::
{driver_volume_type': iscsi, data': {auth_password': YZ2Hceyh7VySh5HY,
target_discovered': False,
encrypted': False,
qos_specs': None,
target_iqn': iqn.2010-10.org.openstack:volume-8b1ec3fe-8c5
target_portal': 11.0.0.8:3260,
volume_id': 8b1ec3fe-8c57-45ca-a1cf-a481bfc8fce2,
target_lun': 1,
access_mode': rw,
auth_username': nE9PY8juynmmZ95F7Xb7,
auth_method': CHAP}}``
{
'driver_volume_type': 'iscsi',
'data': {
'auth_password': 'YZ2Hceyh7VySh5HY',
'target_discovered': False,
'encrypted': False,
'qos_specs': None,
'target_iqn': 'iqn.2010-10.org.openstack:volume-8b1ec3fe-8c57-45ca-a1cf-a481bfc8fce2',
'target_portal': '11.0.0.8:3260',
'volume_id': '8b1ec3fe-8c57-45ca-a1cf-a481bfc8fce2',
'target_lun': 1,
'access_mode': 'rw',
'auth_username': 'nE9PY8juynmmZ95F7Xb7',
'auth_method': 'CHAP'
}
}
In the process of building this data structure, the Cinder Volume Manager makes a number of
calls to the backend driver, and builds a volume_attachment entry in the database to store

View File

@ -98,6 +98,7 @@ backend that supports replication, the extra-specs entry would be::
{replication: enabled}
Additionally you could provide additional details using scoped keys::
{replication: enabled, replication_type: async, replication_count: 2,
replication_targets: [fake_id1, fake_id2]}
@ -128,6 +129,7 @@ The number of API methods associated with replication is intentionally very limi
Admin only methods.
They include::
replication_failover(self, context, volumes)
Additionally we have freeze/thaw methods that will act on the scheduler
@ -157,10 +159,12 @@ backend is lost, and we're just providing a DR mechanism to preserve user data
for volumes that were specified as such via type settings.
**freeze_backend**
Puts a backend host/service into a R/O state for the control plane. For
example if a failover is issued, it is likely desirable that while data access
to existing volumes is maintained, it likely would not be wise to continue
doing things like creates, deletes, extends etc.
**thaw_backend**
Clear frozen control plane on a backend.