[DOC BLD FIX] Fix docstring issues in ibm_storage
There were a number of issues with dosctring issues in the ibm_storage driver. The issues were causing Sphinx to produce WARNINGs. This patch correct those issues. Change-Id: I0a616ff1f5ce2b26a450f0336be59dacf1f2515f
This commit is contained in:
parent
903d8e653c
commit
65b7ef35fc
|
@ -18,42 +18,46 @@ This is the driver that allows openstack to talk to DS8K.
|
|||
|
||||
All volumes are thin provisioned by default, if the machine is licensed for it.
|
||||
This can be overridden by creating a volume type and specifying a key like so:
|
||||
#> cinder type-create my_type
|
||||
#> cinder type-key my_type set drivers:thin_provision=False
|
||||
#> cinder create --volume-type my_type 123
|
||||
|
||||
.. code:: console
|
||||
|
||||
#> cinder type-create my_type
|
||||
#> cinder type-key my_type set drivers:thin_provision=False
|
||||
#> cinder create --volume-type my_type 123
|
||||
|
||||
|
||||
Sample settings for cinder.conf:
|
||||
--->
|
||||
enabled_backends = ibm_ds8k_1, ibm_ds8k_2
|
||||
[ibm_ds8k_1]
|
||||
proxy = cinder.volume.drivers.ibm.ibm_storage.ds8k_proxy.DS8KProxy
|
||||
volume_backend_name = ibm_ds8k_1
|
||||
san_clustername = P2,P3
|
||||
san_password = actual_password
|
||||
san_login = actual_username
|
||||
san_ip = foo.com
|
||||
volume_driver =
|
||||
cinder.volume.drivers.ibm.ibm_storage.ibm_storage.IBMStorageDriver
|
||||
chap = disabled
|
||||
connection_type = fibre_channel
|
||||
replication_device = connection_type: fibre_channel, backend_id: bar,
|
||||
san_ip: bar.com, san_login: actual_username,
|
||||
san_password: actual_password, san_clustername: P4,
|
||||
port_pairs: I0236-I0306; I0237-I0307
|
||||
|
||||
[ibm_ds8k_2]
|
||||
proxy = cinder.volume.drivers.ibm.ibm_storage.ds8k_proxy.DS8KProxy
|
||||
volume_backend_name = ibm_ds8k_2
|
||||
san_clustername = P4,P5
|
||||
san_password = actual_password
|
||||
san_login = actual_username
|
||||
san_ip = bar.com
|
||||
volume_driver =
|
||||
cinder.volume.drivers.ibm.ibm_storage.ibm_storage.IBMStorageDriver
|
||||
chap = disabled
|
||||
connection_type = fibre_channel
|
||||
<---
|
||||
.. code:: ini
|
||||
|
||||
enabled_backends = ibm_ds8k_1, ibm_ds8k_2
|
||||
[ibm_ds8k_1]
|
||||
proxy = cinder.volume.drivers.ibm.ibm_storage.ds8k_proxy.DS8KProxy
|
||||
volume_backend_name = ibm_ds8k_1
|
||||
san_clustername = P2,P3
|
||||
san_password = actual_password
|
||||
san_login = actual_username
|
||||
san_ip = foo.com
|
||||
volume_driver =
|
||||
cinder.volume.drivers.ibm.ibm_storage.ibm_storage.IBMStorageDriver
|
||||
chap = disabled
|
||||
connection_type = fibre_channel
|
||||
replication_device = connection_type: fibre_channel, backend_id: bar,
|
||||
san_ip: bar.com, san_login: actual_username,
|
||||
san_password: actual_password, san_clustername: P4,
|
||||
port_pairs: I0236-I0306; I0237-I0307
|
||||
|
||||
[ibm_ds8k_2]
|
||||
proxy = cinder.volume.drivers.ibm.ibm_storage.ds8k_proxy.DS8KProxy
|
||||
volume_backend_name = ibm_ds8k_2
|
||||
san_clustername = P4,P5
|
||||
san_password = actual_password
|
||||
san_login = actual_username
|
||||
san_ip = bar.com
|
||||
volume_driver =
|
||||
cinder.volume.drivers.ibm.ibm_storage.ibm_storage.IBMStorageDriver
|
||||
chap = disabled
|
||||
connection_type = fibre_channel
|
||||
|
||||
"""
|
||||
import ast
|
||||
|
|
|
@ -111,17 +111,27 @@ class AbstractRESTConnector(object):
|
|||
|
||||
Input: see above
|
||||
Output:
|
||||
|
||||
if we reached the server and read an HTTP response:
|
||||
(INTEGER__HTTP_RESPONSE_STATUS_CODE,
|
||||
STRING__BODY_OF_RESPONSE_EVEN_IF_STATUS_NOT_200)
|
||||
|
||||
.. code:: text
|
||||
|
||||
(INTEGER__HTTP_RESPONSE_STATUS_CODE,
|
||||
STRING__BODY_OF_RESPONSE_EVEN_IF_STATUS_NOT_200)
|
||||
|
||||
if we were not able to reach the server or response
|
||||
was invalid HTTP(like certificate error, or could not
|
||||
resolve domain etc):
|
||||
(False, STRING__SHORT_EXPLANATION_OF_REASON_FOR_NOT_
|
||||
REACHING_SERVER_OR_GETTING_INVALID_RESPONSE)
|
||||
|
||||
.. code:: text
|
||||
|
||||
(False, STRING__SHORT_EXPLANATION_OF_REASON_FOR_NOT_
|
||||
REACHING_SERVER_OR_GETTING_INVALID_RESPONSE)
|
||||
|
||||
Exception: should not raise any exceptions itself as all
|
||||
the expected scenarios are covered above. Unexpected
|
||||
exceptions are permitted.
|
||||
|
||||
"""
|
||||
pass
|
||||
|
||||
|
|
|
@ -103,10 +103,12 @@ class XIVProxy(proxy.IBMStorageProxy):
|
|||
Version: 2.1.0
|
||||
Required pyxcli version: 1.1.4
|
||||
|
||||
2.0 - First open source driver version
|
||||
2.1.0 - Support Consistency groups through Generic volume groups
|
||||
- Support XIV/A9000 Volume independent QoS
|
||||
- Support groups replication
|
||||
.. code:: text
|
||||
|
||||
2.0 - First open source driver version
|
||||
2.1.0 - Support Consistency groups through Generic volume groups
|
||||
- Support XIV/A9000 Volume independent QoS
|
||||
- Support groups replication
|
||||
|
||||
"""
|
||||
|
||||
|
|
Loading…
Reference in New Issue