diff --git a/doc/source/user/index.rst b/doc/source/user/index.rst index a08f00416..b13a63bf4 100644 --- a/doc/source/user/index.rst +++ b/doc/source/user/index.rst @@ -99,7 +99,8 @@ control which services can be used. Accelerator Baremetal Baremetal Introspection - Block Storage + Block Storage v2 + Block Storage v3 Clustering Compute Database diff --git a/doc/source/user/proxies/block_storage.rst b/doc/source/user/proxies/block_storage_v2.rst similarity index 100% rename from doc/source/user/proxies/block_storage.rst rename to doc/source/user/proxies/block_storage_v2.rst diff --git a/doc/source/user/proxies/block_storage_v3.rst b/doc/source/user/proxies/block_storage_v3.rst new file mode 100644 index 000000000..bfbbed2fb --- /dev/null +++ b/doc/source/user/proxies/block_storage_v3.rst @@ -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 diff --git a/doc/source/user/resources/block_storage/index.rst b/doc/source/user/resources/block_storage/index.rst index 923162185..fdcf654f1 100644 --- a/doc/source/user/resources/block_storage/index.rst +++ b/doc/source/user/resources/block_storage/index.rst @@ -8,3 +8,8 @@ Block Storage Resources v2/snapshot v2/type v2/volume + + v3/backup + v3/snapshot + v3/type + v3/volume diff --git a/doc/source/user/resources/block_storage/v3/backup.rst b/doc/source/user/resources/block_storage/v3/backup.rst new file mode 100644 index 000000000..2382ca978 --- /dev/null +++ b/doc/source/user/resources/block_storage/v3/backup.rst @@ -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: diff --git a/doc/source/user/resources/block_storage/v3/snapshot.rst b/doc/source/user/resources/block_storage/v3/snapshot.rst new file mode 100644 index 000000000..2185f58ba --- /dev/null +++ b/doc/source/user/resources/block_storage/v3/snapshot.rst @@ -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: diff --git a/doc/source/user/resources/block_storage/v3/type.rst b/doc/source/user/resources/block_storage/v3/type.rst new file mode 100644 index 000000000..8cb7650c2 --- /dev/null +++ b/doc/source/user/resources/block_storage/v3/type.rst @@ -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: + diff --git a/doc/source/user/resources/block_storage/v3/volume.rst b/doc/source/user/resources/block_storage/v3/volume.rst new file mode 100644 index 000000000..edb734f2a --- /dev/null +++ b/doc/source/user/resources/block_storage/v3/volume.rst @@ -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: