Add proxy docs and empty user guides
In order to review the proxy docs, I wanted to have the proxy docs added. I created some place holder user guides so we'd have the framework for everything. Change-Id: I0d790847b2f47f00e7aba0fb1303603e653e0c7b
This commit is contained in:
@@ -24,7 +24,18 @@ approach, this is where you'll want to begin.
|
||||
:maxdepth: 1
|
||||
|
||||
Connecting to an OpenStack Cloud <userguides/usage>
|
||||
Working with data in the Object Store <userguides/object_store>
|
||||
CDN <userguides/cdn>
|
||||
Compute <userguides/compute>
|
||||
Database <userguides/database>
|
||||
Identity <userguides/identity>
|
||||
Image <userguides/image>
|
||||
Keystore <userguides/keystore>
|
||||
Metric <userguides/metric>
|
||||
Network <userguides/network>
|
||||
Object Store <userguides/object_store>
|
||||
Orchestration <userguides/orchestration>
|
||||
Telemetry <userguides/telemetry>
|
||||
Volume <userguides/volume>
|
||||
|
||||
API Documentation
|
||||
-----------------
|
||||
@@ -55,7 +66,18 @@ but listed below are the ones provided by this SDK by default.
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
CDN <proxies/cdn>
|
||||
Compute <proxies/compute>
|
||||
Database <proxies/database>
|
||||
Identity <proxies/identity>
|
||||
Image <proxies/image>
|
||||
Keystore <proxies/keystore>
|
||||
Metric <proxies/metric>
|
||||
Network <proxies/network>
|
||||
Object Store <proxies/object_store>
|
||||
Orchestration <proxies/orchestration>
|
||||
Telemetry <proxies/telemetry>
|
||||
Volume <proxies/volume>
|
||||
|
||||
Resource Interface
|
||||
******************
|
||||
|
16
doc/source/users/proxies/cdn.rst
Normal file
16
doc/source/users/proxies/cdn.rst
Normal file
@@ -0,0 +1,16 @@
|
||||
CDN API
|
||||
=======
|
||||
|
||||
For details on how to use CDN, see :doc:`/users/userguides/cdn`
|
||||
|
||||
.. automodule:: openstack.cdn.v1._proxy
|
||||
|
||||
The CDN Class
|
||||
-------------
|
||||
|
||||
The CDN high-level interface is available through the ``cdn`` member of a
|
||||
:class:`~openstack.connection.Connection` object. The ``cdn`` member will
|
||||
only be added if the service is detected.
|
||||
|
||||
.. autoclass:: openstack.cdn.v1._proxy.Proxy
|
||||
:members:
|
16
doc/source/users/proxies/compute.rst
Normal file
16
doc/source/users/proxies/compute.rst
Normal file
@@ -0,0 +1,16 @@
|
||||
Compute API
|
||||
===========
|
||||
|
||||
For details on how to use compute, see :doc:`/users/userguides/compute`
|
||||
|
||||
.. automodule:: openstack.compute.v2._proxy
|
||||
|
||||
The Compute Class
|
||||
-----------------
|
||||
|
||||
The compute high-level interface is available through the ``compute``
|
||||
member of a :class:`~openstack.connection.Connection` object. The
|
||||
``compute`` member will only be added if the service is detected.
|
||||
|
||||
.. autoclass:: openstack.compute.v2._proxy.Proxy
|
||||
:members:
|
16
doc/source/users/proxies/database.rst
Normal file
16
doc/source/users/proxies/database.rst
Normal file
@@ -0,0 +1,16 @@
|
||||
Database API
|
||||
============
|
||||
|
||||
For details on how to use database, see :doc:`/users/userguides/database`
|
||||
|
||||
.. automodule:: openstack.database.v1._proxy
|
||||
|
||||
The Database Class
|
||||
------------------
|
||||
|
||||
The database high-level interface is available through the ``database``
|
||||
member of a :class:`~openstack.connection.Connection` object. The
|
||||
``database`` member will only be added if the service is detected.
|
||||
|
||||
.. autoclass:: openstack.database.v1._proxy.Proxy
|
||||
:members:
|
33
doc/source/users/proxies/identity.rst
Normal file
33
doc/source/users/proxies/identity.rst
Normal file
@@ -0,0 +1,33 @@
|
||||
Identity API v2
|
||||
===============
|
||||
|
||||
For details on how to use identity, see :doc:`/users/userguides/identity`
|
||||
|
||||
.. automodule:: openstack.identity.v2._proxy
|
||||
|
||||
The Identity v2 Class
|
||||
---------------------
|
||||
|
||||
The identity high-level interface is available through the ``identity``
|
||||
member of a :class:`~openstack.connection.Connection` object. The
|
||||
``identity`` member will only be added if the service is detected.
|
||||
|
||||
.. autoclass:: openstack.identity.v2._proxy.Proxy
|
||||
:members:
|
||||
|
||||
Identity API v3
|
||||
===============
|
||||
|
||||
For details on how to use identity, see :doc:`/users/userguides/identity`
|
||||
|
||||
.. automodule:: openstack.identity.v3._proxy
|
||||
|
||||
The Identity v3 Class
|
||||
---------------------
|
||||
|
||||
The identity high-level interface is available through the ``identity``
|
||||
member of a :class:`~openstack.connection.Connection` object. The
|
||||
``identity`` member will only be added if the service is detected.
|
||||
|
||||
.. autoclass:: openstack.identity.v3._proxy.Proxy
|
||||
:members:
|
33
doc/source/users/proxies/image.rst
Normal file
33
doc/source/users/proxies/image.rst
Normal file
@@ -0,0 +1,33 @@
|
||||
Image API v1
|
||||
============
|
||||
|
||||
For details on how to use image, see :doc:`/users/userguides/image`
|
||||
|
||||
.. automodule:: openstack.image.v1._proxy
|
||||
|
||||
The Image v1 Class
|
||||
------------------
|
||||
|
||||
The image high-level interface is available through the ``image`` member of a
|
||||
:class:`~openstack.connection.Connection` object. The ``image`` member will
|
||||
only be added if the service is detected.
|
||||
|
||||
.. autoclass:: openstack.image.v1._proxy.Proxy
|
||||
:members:
|
||||
|
||||
Image API v2
|
||||
============
|
||||
|
||||
For details on how to use image, see :doc:`/users/userguides/image`
|
||||
|
||||
.. automodule:: openstack.image.v2._proxy
|
||||
|
||||
The Image v2 Class
|
||||
------------------
|
||||
|
||||
The image high-level interface is available through the ``image`` member of a
|
||||
:class:`~openstack.connection.Connection` object. The ``image`` member will
|
||||
only be added if the service is detected.
|
||||
|
||||
.. autoclass:: openstack.image.v2._proxy.Proxy
|
||||
:members:
|
16
doc/source/users/proxies/keystore.rst
Normal file
16
doc/source/users/proxies/keystore.rst
Normal file
@@ -0,0 +1,16 @@
|
||||
Keystore API
|
||||
============
|
||||
|
||||
For details on how to use keystore, see :doc:`/users/userguides/keystore`
|
||||
|
||||
.. automodule:: openstack.keystore.v1._proxy
|
||||
|
||||
The Keystore Class
|
||||
-------------
|
||||
|
||||
The keystore high-level interface is available through the ``keystore``
|
||||
member of a :class:`~openstack.connection.Connection` object. The
|
||||
``keystore`` member will only be added if the service is detected.
|
||||
|
||||
.. autoclass:: openstack.keystore.v1._proxy.Proxy
|
||||
:members:
|
16
doc/source/users/proxies/metric.rst
Normal file
16
doc/source/users/proxies/metric.rst
Normal file
@@ -0,0 +1,16 @@
|
||||
Metric API
|
||||
==========
|
||||
|
||||
For details on how to use metric, see :doc:`/users/userguides/metric`
|
||||
|
||||
.. automodule:: openstack.metric.v1._proxy
|
||||
|
||||
The Metric Class
|
||||
----------------
|
||||
|
||||
The metric high-level interface is available through the ``metric`` member of a
|
||||
:class:`~openstack.connection.Connection` object. The ``metric`` member will
|
||||
only be added if the service is detected.
|
||||
|
||||
.. autoclass:: openstack.metric.v1._proxy.Proxy
|
||||
:members:
|
16
doc/source/users/proxies/network.rst
Normal file
16
doc/source/users/proxies/network.rst
Normal file
@@ -0,0 +1,16 @@
|
||||
Network API
|
||||
===========
|
||||
|
||||
For details on how to use network, see :doc:`/users/userguides/network`
|
||||
|
||||
.. automodule:: openstack.network.v2._proxy
|
||||
|
||||
The Network Class
|
||||
-----------------
|
||||
|
||||
The network high-level interface is available through the ``network``
|
||||
member of a :class:`~openstack.connection.Connection` object. The
|
||||
``network`` member will only be added if the service is detected.
|
||||
|
||||
.. autoclass:: openstack.network.v2._proxy.Proxy
|
||||
:members:
|
17
doc/source/users/proxies/orchestration.rst
Normal file
17
doc/source/users/proxies/orchestration.rst
Normal file
@@ -0,0 +1,17 @@
|
||||
Orchestration API
|
||||
=================
|
||||
|
||||
For details on how to use orchestration, see :doc:`/users/userguides/orchestration`
|
||||
|
||||
.. automodule:: openstack.orchestration.v1._proxy
|
||||
|
||||
The Orchestration Class
|
||||
-----------------------
|
||||
|
||||
The orchestration high-level interface is available through the
|
||||
``orchestration`` member of a :class:`~openstack.connection.Connection`
|
||||
object. The ``orchestration`` member will only be added if the service
|
||||
is detected.
|
||||
|
||||
.. autoclass:: openstack.orchestration.v1._proxy.Proxy
|
||||
:members:
|
16
doc/source/users/proxies/telemetry.rst
Normal file
16
doc/source/users/proxies/telemetry.rst
Normal file
@@ -0,0 +1,16 @@
|
||||
Telemetry API
|
||||
=============
|
||||
|
||||
For details on how to use telemetry, see :doc:`/users/userguides/telemetry`
|
||||
|
||||
.. automodule:: openstack.telemetry.v2._proxy
|
||||
|
||||
The Telemetry Class
|
||||
-------------------
|
||||
|
||||
The telemetry high-level interface is available through the ``telemetry``
|
||||
member of a :class:`~openstack.connection.Connection` object. The
|
||||
``telemetry`` member will only be added if the service is detected.
|
||||
|
||||
.. autoclass:: openstack.telemetry.v2._proxy.Proxy
|
||||
:members:
|
16
doc/source/users/proxies/volume.rst
Normal file
16
doc/source/users/proxies/volume.rst
Normal file
@@ -0,0 +1,16 @@
|
||||
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:
|
9
doc/source/users/userguides/cdn.rst
Normal file
9
doc/source/users/userguides/cdn.rst
Normal file
@@ -0,0 +1,9 @@
|
||||
Using OpenStack CDN
|
||||
===================
|
||||
|
||||
Before working with ``cdn``, you'll need to obtain a
|
||||
:class:`~openstack.connection.Connection` object like so.
|
||||
|
||||
.. literalinclude:: /code/connection.py
|
||||
|
||||
.. TODO(thowe): Implement this guide
|
9
doc/source/users/userguides/compute.rst
Normal file
9
doc/source/users/userguides/compute.rst
Normal file
@@ -0,0 +1,9 @@
|
||||
Using OpenStack Compute
|
||||
=======================
|
||||
|
||||
Before working with ``compute``, you'll need to obtain a
|
||||
:class:`~openstack.connection.Connection` object like so.
|
||||
|
||||
.. literalinclude:: /code/connection.py
|
||||
|
||||
.. TODO(thowe): Implement this guide
|
9
doc/source/users/userguides/database.rst
Normal file
9
doc/source/users/userguides/database.rst
Normal file
@@ -0,0 +1,9 @@
|
||||
Using OpenStack Database
|
||||
========================
|
||||
|
||||
Before working with ``database``, you'll need to obtain a
|
||||
:class:`~openstack.connection.Connection` object like so.
|
||||
|
||||
.. literalinclude:: /code/connection.py
|
||||
|
||||
.. TODO(thowe): Implement this guide
|
9
doc/source/users/userguides/identity.rst
Normal file
9
doc/source/users/userguides/identity.rst
Normal file
@@ -0,0 +1,9 @@
|
||||
Using OpenStack Identity
|
||||
========================
|
||||
|
||||
Before working with ``identity``, you'll need to obtain a
|
||||
:class:`~openstack.connection.Connection` object like so.
|
||||
|
||||
.. literalinclude:: /code/connection.py
|
||||
|
||||
.. TODO(thowe): Implement this guide
|
9
doc/source/users/userguides/image.rst
Normal file
9
doc/source/users/userguides/image.rst
Normal file
@@ -0,0 +1,9 @@
|
||||
Using OpenStack Image
|
||||
=====================
|
||||
|
||||
Before working with ``image``, you'll need to obtain a
|
||||
:class:`~openstack.connection.Connection` object like so.
|
||||
|
||||
.. literalinclude:: /code/connection.py
|
||||
|
||||
.. TODO(thowe): Implement this guide
|
9
doc/source/users/userguides/keystore.rst
Normal file
9
doc/source/users/userguides/keystore.rst
Normal file
@@ -0,0 +1,9 @@
|
||||
Using OpenStack Keystore
|
||||
========================
|
||||
|
||||
Before working with ``keystore``, you'll need to obtain a
|
||||
:class:`~openstack.connection.Connection` object like so.
|
||||
|
||||
.. literalinclude:: /code/connection.py
|
||||
|
||||
.. TODO(thowe): Implement this guide
|
9
doc/source/users/userguides/metric.rst
Normal file
9
doc/source/users/userguides/metric.rst
Normal file
@@ -0,0 +1,9 @@
|
||||
Using OpenStack Metric
|
||||
======================
|
||||
|
||||
Before working with ``metric``, you'll need to obtain a
|
||||
:class:`~openstack.connection.Connection` object like so.
|
||||
|
||||
.. literalinclude:: /code/connection.py
|
||||
|
||||
.. TODO(thowe): Implement this guide
|
9
doc/source/users/userguides/network.rst
Normal file
9
doc/source/users/userguides/network.rst
Normal file
@@ -0,0 +1,9 @@
|
||||
Using OpenStack Network
|
||||
===================
|
||||
|
||||
Before working with ``network``, you'll need to obtain a
|
||||
:class:`~openstack.connection.Connection` object like so.
|
||||
|
||||
.. literalinclude:: /code/connection.py
|
||||
|
||||
.. TODO(thowe): Implement this guide
|
@@ -1,9 +1,9 @@
|
||||
Using the OpenStack Object Store API
|
||||
====================================
|
||||
Using OpenStack Object Store
|
||||
============================
|
||||
|
||||
The Object Store API operates on two things: containers and objects.
|
||||
|
||||
Before working with the ``object_store`` API, you'll need to obtain a
|
||||
Before working with ``object_store``, you'll need to obtain a
|
||||
:class:`~openstack.connection.Connection` object like so.
|
||||
|
||||
.. literalinclude:: /code/connection.py
|
||||
|
9
doc/source/users/userguides/orchestration.rst
Normal file
9
doc/source/users/userguides/orchestration.rst
Normal file
@@ -0,0 +1,9 @@
|
||||
Using OpenStack Orchestration
|
||||
=============================
|
||||
|
||||
Before working with ``orchestration``, you'll need to obtain a
|
||||
:class:`~openstack.connection.Connection` object like so.
|
||||
|
||||
.. literalinclude:: /code/connection.py
|
||||
|
||||
.. TODO(thowe): Implement this guide
|
9
doc/source/users/userguides/telemetry.rst
Normal file
9
doc/source/users/userguides/telemetry.rst
Normal file
@@ -0,0 +1,9 @@
|
||||
Using OpenStack Telemetry
|
||||
=========================
|
||||
|
||||
Before working with ``telemetry``, you'll need to obtain a
|
||||
:class:`~openstack.connection.Connection` object like so.
|
||||
|
||||
.. literalinclude:: /code/connection.py
|
||||
|
||||
.. TODO(thowe): Implement this guide
|
9
doc/source/users/userguides/volume.rst
Normal file
9
doc/source/users/userguides/volume.rst
Normal file
@@ -0,0 +1,9 @@
|
||||
Using OpenStack Volume
|
||||
======================
|
||||
|
||||
Before working with ``volume``, you'll need to obtain a
|
||||
:class:`~openstack.connection.Connection` object like so.
|
||||
|
||||
.. literalinclude:: /code/connection.py
|
||||
|
||||
.. TODO(thowe): Implement this guide
|
Reference in New Issue
Block a user