Merge "Prepare separate block_storage v3 documentation"
This commit is contained in:
@@ -99,7 +99,8 @@ control which services can be used.
|
||||
Accelerator <proxies/accelerator>
|
||||
Baremetal <proxies/baremetal>
|
||||
Baremetal Introspection <proxies/baremetal_introspection>
|
||||
Block Storage <proxies/block_storage>
|
||||
Block Storage v2 <proxies/block_storage_v2>
|
||||
Block Storage v3 <proxies/block_storage_v3>
|
||||
Clustering <proxies/clustering>
|
||||
Compute <proxies/compute>
|
||||
Database <proxies/database>
|
||||
|
48
doc/source/user/proxies/block_storage_v3.rst
Normal file
48
doc/source/user/proxies/block_storage_v3.rst
Normal file
@@ -0,0 +1,48 @@
|
||||
Block Storage API
|
||||
=================
|
||||
|
||||
For details on how to use block_storage, see :doc:`/user/guides/block_storage`
|
||||
|
||||
.. automodule:: openstack.block_storage.v3._proxy
|
||||
|
||||
The BlockStorage Class
|
||||
----------------------
|
||||
|
||||
The block_storage high-level interface is available through the
|
||||
``block_storage`` member of a :class:`~openstack.connection.Connection` object.
|
||||
The ``block_storage`` member will only be added if the service is detected.
|
||||
|
||||
Volume Operations
|
||||
^^^^^^^^^^^^^^^^^
|
||||
|
||||
.. autoclass:: openstack.block_storage.v3._proxy.Proxy
|
||||
:noindex:
|
||||
:members: create_volume, delete_volume, get_volume, volumes
|
||||
|
||||
Backup Operations
|
||||
^^^^^^^^^^^^^^^^^
|
||||
|
||||
.. autoclass:: openstack.block_storage.v3._proxy.Proxy
|
||||
:noindex:
|
||||
:members: create_backup, delete_backup, get_backup, backups, restore_backup
|
||||
|
||||
Type Operations
|
||||
^^^^^^^^^^^^^^^
|
||||
|
||||
.. autoclass:: openstack.block_storage.v3._proxy.Proxy
|
||||
:noindex:
|
||||
:members: create_type, delete_type, get_type, types
|
||||
|
||||
Snapshot Operations
|
||||
^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
.. autoclass:: openstack.block_storage.v3._proxy.Proxy
|
||||
:noindex:
|
||||
:members: create_snapshot, delete_snapshot, get_snapshot, snapshots
|
||||
|
||||
Stats Operations
|
||||
^^^^^^^^^^^^^^^^
|
||||
|
||||
.. autoclass:: openstack.block_storage.v3._proxy.Proxy
|
||||
:noindex:
|
||||
:members: backend_pools
|
@@ -8,3 +8,8 @@ Block Storage Resources
|
||||
v2/snapshot
|
||||
v2/type
|
||||
v2/volume
|
||||
|
||||
v3/backup
|
||||
v3/snapshot
|
||||
v3/type
|
||||
v3/volume
|
||||
|
12
doc/source/user/resources/block_storage/v3/backup.rst
Normal file
12
doc/source/user/resources/block_storage/v3/backup.rst
Normal file
@@ -0,0 +1,12 @@
|
||||
openstack.block_storage.v3.backup
|
||||
=================================
|
||||
|
||||
.. automodule:: openstack.block_storage.v3.backup
|
||||
|
||||
The Backup Class
|
||||
----------------
|
||||
|
||||
The ``Backup`` class inherits from :class:`~openstack.resource.Resource`.
|
||||
|
||||
.. autoclass:: openstack.block_storage.v3.backup.Backup
|
||||
:members:
|
21
doc/source/user/resources/block_storage/v3/snapshot.rst
Normal file
21
doc/source/user/resources/block_storage/v3/snapshot.rst
Normal file
@@ -0,0 +1,21 @@
|
||||
openstack.block_storage.v3.snapshot
|
||||
===================================
|
||||
|
||||
.. automodule:: openstack.block_storage.v3.snapshot
|
||||
|
||||
The Snapshot Class
|
||||
------------------
|
||||
|
||||
The ``Snapshot`` class inherits from :class:`~openstack.resource.Resource`.
|
||||
|
||||
.. autoclass:: openstack.block_storage.v3.snapshot.Snapshot
|
||||
:members:
|
||||
|
||||
The SnapshotDetail Class
|
||||
------------------------
|
||||
|
||||
The ``SnapshotDetail`` class inherits from
|
||||
:class:`~openstack.block_storage.v3.snapshot.Snapshot`.
|
||||
|
||||
.. autoclass:: openstack.block_storage.v3.snapshot.SnapshotDetail
|
||||
:members:
|
13
doc/source/user/resources/block_storage/v3/type.rst
Normal file
13
doc/source/user/resources/block_storage/v3/type.rst
Normal file
@@ -0,0 +1,13 @@
|
||||
openstack.block_storage.v3.type
|
||||
===============================
|
||||
|
||||
.. automodule:: openstack.block_storage.v3.type
|
||||
|
||||
The Type Class
|
||||
--------------
|
||||
|
||||
The ``Type`` class inherits from :class:`~openstack.resource.Resource`.
|
||||
|
||||
.. autoclass:: openstack.block_storage.v3.type.Type
|
||||
:members:
|
||||
|
12
doc/source/user/resources/block_storage/v3/volume.rst
Normal file
12
doc/source/user/resources/block_storage/v3/volume.rst
Normal file
@@ -0,0 +1,12 @@
|
||||
openstack.block_storage.v3.volume
|
||||
=================================
|
||||
|
||||
.. automodule:: openstack.block_storage.v3.volume
|
||||
|
||||
The Volume Class
|
||||
----------------
|
||||
|
||||
The ``Volume`` class inherits from :class:`~openstack.resource.Resource`.
|
||||
|
||||
.. autoclass:: openstack.block_storage.v3.volume.Volume
|
||||
:members:
|
Reference in New Issue
Block a user