openstack
/
cinder
Code Issues Proposed changes

[DOC BLD FIX] Fix code block issues 

For json code block, correct format issues of
the content, and for others use 'code-block: default'
to avoid warnings.

Change-Id: I94b4f513900fcb36ec55777a0762eba786ce1d7d
This commit is contained in:
TommyLike 2017-07-18 17:13:38 +08:00
parent 4689591080
commit ab1b029ef7
16 changed files with 100 additions and 88 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
cinder/api/common.py
View File

@ -433,7 +433,7 @@ def get_enabled_resource_filters(resource=None):
.. code-block:: json
{
"resource": ['filter1', 'filter2', 'filter3']
"resource": ["filter1", "filter2", "filter3"]
}
if resource is not specified, all of the configuration will be returned,

5
cinder/api/contrib/snapshot_manage.py
View File

@ -60,8 +60,9 @@ class SnapshotManageController(wsgi.Controller):
{
"snapshot":
{
"volume_id": <Cinder volume already exists in volume backend>,
"ref": <Driver-specific reference to the existing storage object>
"volume_id": "<Cinder volume already exists in volume backend>",
"ref":
"<Driver-specific reference to the existing storage object>"
}
}

9
cinder/api/contrib/volume_manage.py
View File

@ -62,11 +62,10 @@ class VolumeManageController(wsgi.Controller):
.. code-block:: json
{
'volume':
{
'host': <Cinder host on which the existing storage resides>,
'cluster': <Cinder cluster on which the storage resides>,
'ref': <Driver-specific reference to existing storage object>,
"volume": {
"host": "<Cinder host on which the existing storage resides>",
"cluster": "<Cinder cluster on which the storage resides>",
"ref": "<Driver-specific reference to existing storage object>"
}
}

94
cinder/api/openstack/rest_api_version_history.rst
View File

@ -81,16 +81,18 @@ user documentation.
.. code-block:: json
"cluster": {
"created_at": ...,
"disabled_reason": null,
"last_heartbeat": ...,
"name": "cluster_name",
"num_down_hosts": 4,
"num_hosts": 2,
"state": "up",
"status": "enabled",
"updated_at": ...
{
"cluster": {
"created_at": "",
"disabled_reason": null,
"last_heartbeat": "",
"name": "cluster_name",
"num_down_hosts": 4,
"num_hosts": 2,
"state": "up",
"status": "enabled",
"updated_at": ""
}
}
Update endpoint allows enabling and disabling a cluster in a similar way to
@ -100,11 +102,13 @@ user documentation.
.. code-block:: json
"cluster": {
"name": "cluster_name",
"state": "up",
"status": "enabled"
"disabled_reason": null
{
"cluster": {
"name": "cluster_name",
"state": "up",
"status": "enabled",
"disabled_reason": null
}
}
Index and detail accept filtering by `name`, `binary`, `disabled`,
@ -115,37 +119,35 @@ user documentation.
.. code-block:: json
"clusters": [
{
"name": "cluster_name",
"state": "up",
"status": "enabled"
},
{
...
}
]
{
"clusters": [
{
"name": "cluster_name",
"state": "up",
"status": "enabled"
}
]
}
Detail endpoint returns:
.. code-block:: json
"clusters": [
{
"created_at": ...,
"disabled_reason": null,
"last_heartbeat": ...,
"name": "cluster_name",
"num_down_hosts": 4,
"num_hosts": 2,
"state": "up",
"status": "enabled",
"updated_at": ...
},
{
...
}
]
{
"clusters": [
{
"created_at": "",
"disabled_reason": null,
"last_heartbeat": "",
"name": "cluster_name",
"num_down_hosts": 4,
"num_hosts": 2,
"state": "up",
"status": "enabled",
"updated_at": ""
}
]
}
3.8
---
@ -160,10 +162,12 @@ user documentation.
.. code-block:: json
"backup": {
"id": "backup_id",
"name": "backup_name",
"links": "backup_link",
{
"backup": {
"id": "backup_id",
"name": "backup_name",
"links": "backup_link"
}
}
3.10

6
cinder/api/v3/attachments.py
View File

@ -126,7 +126,7 @@ class AttachmentsController(wsgi.Controller):
{
"volume_uuid": "volume-uuid",
"instance_uuid": "nova-server-uuid",
"connector": None|<connector-object>,
"connector": "null|<connector-object>"
}
}
@ -142,9 +142,9 @@ class AttachmentsController(wsgi.Controller):
"platform": "x86_64",
"host": "tempest-1",
"os_type": "linux2",
"multipath": False,
"multipath": false,
"mountpoint": "/dev/vdb",
"mode": None|"rw"|"ro",
"mode": "null|rw|ro"
}
}

4
cinder/api/v3/views/resource_filters.py
View File

@ -24,8 +24,8 @@ class ViewBuilder(object):
{
"resource_filters": [{
"resource": 'resource_1',
"filters": ['filter1', 'filter2', 'filter3']
"resource": "resource_1",
"filters": ["filter1", "filter2", "filter3"]
}]
}
"""

20
cinder/volume/driver.py
View File

@ -2716,16 +2716,16 @@ class ISERDriver(ISCSIDriver):
The format of the driver data is defined in _get_iser_properties.
Example return value:
.. code-block:: json
.. code-block:: default
{
'driver_volume_type': 'iser'
'driver_volume_type': 'iser',
'data': {
'target_discovered': True,
'target_iqn':
'iqn.2010-10.org.iser.openstack:volume-00000001',
'target_portal': '127.0.0.0.1:3260',
'volume_id': 1,
'volume_id': 1
}
}
@ -2764,27 +2764,29 @@ class FibreChannelDriver(VolumeDriver):
correspond to the list of remote wwn(s) that will export the volume.
Example return values:
.. code-block:: json
.. code-block:: default
{
'driver_volume_type': 'fibre_channel'
'driver_volume_type': 'fibre_channel',
'data': {
'target_discovered': True,
'target_lun': 1,
'target_wwn': '1234567890123',
'discard': False,
'discard': False
}
}
or
or
.. code-block:: default
{
'driver_volume_type': 'fibre_channel'
'driver_volume_type': 'fibre_channel',
'data': {
'target_discovered': True,
'target_lun': 1,
'target_wwn': ['1234567890123', '0987654321321'],
'discard': False,
'discard': False
}
}

16
cinder/volume/drivers/dell_emc/vmax/iscsi.py
View File

@ -196,26 +196,30 @@ class VMAXISCSIDriver(driver.ISCSIDriver):
the format of the driver data is defined in smis_get_iscsi_properties.
Example return value:
.. code-block:: json
.. code-block:: default
{
'driver_volume_type': 'iscsi'
'driver_volume_type': 'iscsi',
'data': {
'target_discovered': True,
'target_iqn': 'iqn.2010-10.org.openstack:volume-00000001',
'target_portal': '127.0.0.0.1:3260',
'volume_id': '12345678-1234-4321-1234-123456789012',
'volume_id': '12345678-1234-4321-1234-123456789012'
}
}
Example return value (multipath is enabled)::
Example return value (multipath is enabled):
.. code-block:: default
{
'driver_volume_type': 'iscsi'
'driver_volume_type': 'iscsi',
'data': {
'target_discovered': True,
'target_iqns': ['iqn.2010-10.org.openstack:volume-00001',
'iqn.2010-10.org.openstack:volume-00002'],
'target_portals': ['127.0.0.1:3260', '127.0.1.1:3260'],
'target_luns': [1, 1],
'target_luns': [1, 1]
}
}
:param volume: the cinder volume object

4
cinder/volume/drivers/hitachi/hbsd_common.py
View File

@ -750,7 +750,7 @@ class HBSDCommon(object):
For HUS 100 Family:
.. code-block:: json
.. code-block:: default
{
'ldev': <logical device number on storage>,
@ -759,7 +759,7 @@ class HBSDCommon(object):
For VSP G1000/VSP/HUS VM:
.. code-block:: json
.. code-block:: default
{
'ldev': <logical device number on storage>,

4
cinder/volume/drivers/hpe/hpe_3par_iscsi.py
View File

@ -331,10 +331,10 @@ class HPE3PARISCSIDriver(driver.ManageableVD,
The format of the driver data is defined in _get_iscsi_properties.
Example return value:
.. code-block:: json
.. code-block:: default
{
'driver_volume_type': 'iscsi'
'driver_volume_type': 'iscsi',
'data': {
'encrypted': False,
'target_discovered': True,

2
cinder/volume/drivers/infortrend/infortrend_fc_cli.py
View File

@ -221,7 +221,7 @@ class InfortrendCLIFCDriver(driver.FibreChannelDriver):
volume['name'] which is how drivers traditionally map between a
cinder volume and the associated backend storage object.
.. code-block:: json
.. code-block:: default
existing_ref:{
'id':lun_id

2
cinder/volume/drivers/infortrend/infortrend_iscsi_cli.py
View File

@ -194,7 +194,7 @@ class InfortrendCLIISCSIDriver(driver.ISCSIDriver):
volume['name'] which is how drivers traditionally map between a
cinder volume and the associated backend storage object.
.. code-block:: json
.. code-block:: default
existing_ref:{
'id':lun_id

10
cinder/volume/drivers/netapp/dataontap/block_base.py
View File

@ -891,10 +891,10 @@ class NetAppBlockStorageLibrary(object):
correspond to the list of remote wwn(s) that will export the volume.
Example return values:
.. code-block:: json
.. code-block:: default
{
'driver_volume_type': 'fibre_channel'
'driver_volume_type': 'fibre_channel',
'data': {
'target_discovered': True,
'target_lun': 1,
@ -906,10 +906,12 @@ class NetAppBlockStorageLibrary(object):
}
}
or
Or
.. code-block:: default
{
'driver_volume_type': 'fibre_channel'
'driver_volume_type': 'fibre_channel',
'data': {
'target_discovered': True,
'target_lun': 1,

6
cinder/volume/drivers/vmware/vmdk.py
View File

@ -605,11 +605,11 @@ class VMwareVcVmdkDriver(driver.VolumeDriver):
The implementation returns the following information:
.. code-block:: json
.. code-block:: default
{
'driver_volume_type': 'vmdk'
'data': {'volume': $VOLUME_MOREF_VALUE
'driver_volume_type': 'vmdk',
'data': {'volume': $VOLUME_MOREF_VALUE,
'volume_id': $VOLUME_ID
}
}

2
cinder/volume/volume_types.py
View File

@ -275,7 +275,7 @@ def volume_types_diff(context, vol_type_id1, vol_type_id2):
whether there is any difference, and 'diff' is a dictionary with the
following format:
.. code-block:: json
.. code-block:: default
{
'extra_specs': {'key1': (value_in_1st_vol_type,

2
cinder/zonemanager/drivers/brocade/brcd_fc_san_lookup_service.py
View File

@ -69,7 +69,7 @@ class BrcdFCSanLookupService(fc_service.FCSanLookupService):
:param target_wwn_list: List of target port WWN
:returns: List -- device wwn map in following format
.. code-block:: json
.. code-block:: default
{
<San name>: {