Move volume docs to block_store
These weren't caught during the renaming. Change-Id: Ied530d3e9760385baa7b16068765328dbb6de6eb
This commit is contained in:
Brian Curtin
parent
85872cd604
commit
495b3484d6
@ -24,6 +24,7 @@ approach, this is where you'll want to begin.
|
||||
:maxdepth: 1
|
||||
|
||||
Connecting to an OpenStack Cloud <userguides/usage>
|
||||
Block Store <userguides/block_store>
|
||||
CDN <userguides/cdn>
|
||||
Compute <userguides/compute>
|
||||
Database <userguides/database>
|
||||
@ -35,7 +36,6 @@ approach, this is where you'll want to begin.
|
||||
Object Store <userguides/object_store>
|
||||
Orchestration <userguides/orchestration>
|
||||
Telemetry <userguides/telemetry>
|
||||
Volume <userguides/volume>
|
||||
|
||||
It may also be useful to try out some working code `examples <examples.html>`_.
|
||||
|
||||
@ -68,6 +68,7 @@ but listed below are the ones provided by this SDK by default.
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
Block Store <proxies/block_store>
|
||||
CDN <proxies/cdn>
|
||||
Compute <proxies/compute>
|
||||
Database <proxies/database>
|
||||
@ -79,7 +80,6 @@ but listed below are the ones provided by this SDK by default.
|
||||
Object Store <proxies/object_store>
|
||||
Orchestration <proxies/orchestration>
|
||||
Telemetry <proxies/telemetry>
|
||||
Volume <proxies/volume>
|
||||
|
||||
Resource Interface
|
||||
******************
|
||||
@ -96,6 +96,7 @@ The following services have exposed *Resource* classes.
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
Block Store <resources/block_store/index>
|
||||
Compute <resources/compute/index>
|
||||
Database <resources/database/index>
|
||||
Identity <resources/identity/index>
|
||||
@ -106,7 +107,6 @@ The following services have exposed *Resource* classes.
|
||||
Orchestration <resources/orchestration/index>
|
||||
Object Store <resources/object_store/index>
|
||||
Telemetry <resources/telemetry/index>
|
||||
Volume <resources/volume/index>
|
||||
|
||||
Low-Level Classes
|
||||
*****************
|
||||
|
||||
16
doc/source/users/proxies/block_store.rst
Normal file
16
doc/source/users/proxies/block_store.rst
Normal file
@ -0,0 +1,16 @@
|
||||
Block Store API
|
||||
===============
|
||||
|
||||
For details on how to use block_store, see :doc:`/users/userguides/block_store`
|
||||
|
||||
.. automodule:: openstack.block_store.v2._proxy
|
||||
|
||||
The BlockStore Class
|
||||
--------------------
|
||||
|
||||
The block_store high-level interface is available through the ``block_store``
|
||||
member of a :class:`~openstack.connection.Connection` object.
|
||||
The ``block_store`` member will only be added if the service is detected.
|
||||
|
||||
.. autoclass:: openstack.block_store.v2._proxy.Proxy
|
||||
:members:
|
||||
@ -1,16 +0,0 @@
|
||||
Volume API
|
||||
==========
|
||||
|
||||
For details on how to use volume, see :doc:`/users/userguides/volume`
|
||||
|
||||
.. automodule:: openstack.volume.v2._proxy
|
||||
|
||||
The Volume Class
|
||||
----------------
|
||||
|
||||
The volume high-level interface is available through the ``volume`` member of a
|
||||
:class:`~openstack.connection.Connection` object. The ``volume`` member will
|
||||
only be added if the service is detected.
|
||||
|
||||
.. autoclass:: openstack.volume.v2._proxy.Proxy
|
||||
:members:
|
||||
@ -1,5 +1,5 @@
|
||||
Volume Resources
|
||||
================
|
||||
Block Store Resources
|
||||
=====================
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
21
doc/source/users/resources/block_store/v2/snapshot.rst
Normal file
21
doc/source/users/resources/block_store/v2/snapshot.rst
Normal file
@ -0,0 +1,21 @@
|
||||
openstack.block_store.v2.snapshot
|
||||
=================================
|
||||
|
||||
.. automodule:: openstack.block_store.v2.snapshot
|
||||
|
||||
The Snapshot Class
|
||||
------------------
|
||||
|
||||
The ``Snapshot`` class inherits from :class:`~openstack.resource.Resource`.
|
||||
|
||||
.. autoclass:: openstack.block_store.v2.snapshot.Snapshot
|
||||
:members:
|
||||
|
||||
The SnapshotDetail Class
|
||||
------------------------
|
||||
|
||||
The ``SnapshotDetail`` class inherits from
|
||||
:class:`~openstack.block_store.v2.snapshot.Snapshot`.
|
||||
|
||||
.. autoclass:: openstack.block_store.v2.snapshot.SnapshotDetail
|
||||
:members:
|
||||
13
doc/source/users/resources/block_store/v2/type.rst
Normal file
13
doc/source/users/resources/block_store/v2/type.rst
Normal file
@ -0,0 +1,13 @@
|
||||
openstack.block_store.v2.type
|
||||
=============================
|
||||
|
||||
.. automodule:: openstack.block_store.v2.type
|
||||
|
||||
The Type Class
|
||||
--------------
|
||||
|
||||
The ``Type`` class inherits from :class:`~openstack.resource.Resource`.
|
||||
|
||||
.. autoclass:: openstack.block_store.v2.type.Type
|
||||
:members:
|
||||
|
||||
21
doc/source/users/resources/block_store/v2/volume.rst
Normal file
21
doc/source/users/resources/block_store/v2/volume.rst
Normal file
@ -0,0 +1,21 @@
|
||||
openstack.block_store.v2.volume
|
||||
===============================
|
||||
|
||||
.. automodule:: openstack.block_store.v2.volume
|
||||
|
||||
The Volume Class
|
||||
----------------
|
||||
|
||||
The ``Volume`` class inherits from :class:`~openstack.resource.Resource`.
|
||||
|
||||
.. autoclass:: openstack.block_store.v2.volume.Volume
|
||||
:members:
|
||||
|
||||
The VolumeDetail Class
|
||||
----------------------
|
||||
|
||||
The ``VolumeDetail`` class inherits from
|
||||
:class:`~openstack.block_store.v2.volume.Volume`.
|
||||
|
||||
.. autoclass:: openstack.block_store.v2.volume.VolumeDetail
|
||||
:members:
|
||||
@ -1,21 +0,0 @@
|
||||
openstack.volume.v2.snapshot
|
||||
============================
|
||||
|
||||
.. automodule:: openstack.volume.v2.snapshot
|
||||
|
||||
The Snapshot Class
|
||||
------------------
|
||||
|
||||
The ``Snapshot`` class inherits from :class:`~openstack.resource.Resource`.
|
||||
|
||||
.. autoclass:: openstack.volume.v2.snapshot.Snapshot
|
||||
:members:
|
||||
|
||||
The SnapshotDetail Class
|
||||
------------------------
|
||||
|
||||
The ``SnapshotDetail`` class inherits from
|
||||
:class:`~openstack.volume.v2.snapshot.Snapshot`.
|
||||
|
||||
.. autoclass:: openstack.volume.v2.snapshot.SnapshotDetail
|
||||
:members:
|
||||
@ -1,13 +0,0 @@
|
||||
openstack.volume.v2.type
|
||||
========================
|
||||
|
||||
.. automodule:: openstack.volume.v2.type
|
||||
|
||||
The Type Class
|
||||
--------------
|
||||
|
||||
The ``Type`` class inherits from :class:`~openstack.resource.Resource`.
|
||||
|
||||
.. autoclass:: openstack.volume.v2.type.Type
|
||||
:members:
|
||||
|
||||
@ -1,21 +0,0 @@
|
||||
openstack.volume.v2.volume
|
||||
==========================
|
||||
|
||||
.. automodule:: openstack.volume.v2.volume
|
||||
|
||||
The Volume Class
|
||||
----------------
|
||||
|
||||
The ``Volume`` class inherits from :class:`~openstack.resource.Resource`.
|
||||
|
||||
.. autoclass:: openstack.volume.v2.volume.Volume
|
||||
:members:
|
||||
|
||||
The VolumeDetail Class
|
||||
----------------------
|
||||
|
||||
The ``VolumeDetail`` class inherits from
|
||||
:class:`~openstack.volume.v2.volume.Volume`.
|
||||
|
||||
.. autoclass:: openstack.volume.v2.volume.VolumeDetail
|
||||
:members:
|
||||
@ -1,7 +1,7 @@
|
||||
Using OpenStack Volume
|
||||
======================
|
||||
Using OpenStack Block Store
|
||||
===========================
|
||||
|
||||
Before working with ``volume``, you'll need to obtain a
|
||||
Before working with ``block_store``, you'll need to obtain a
|
||||
:class:`~openstack.connection.Connection` object like so.
|
||||
|
||||
.. literalinclude:: /code/connection.py
|
||||
Loading…
Reference in New Issue
Block a user