openstack/openstacksdk
Code Issues Proposed changes

Documentation for cluster API and resources

Browse Source 
This patch adds documentation for cluster service API and resources.
Follow up patch will add a user guide.

Change-Id: I97fe993a1ddbc0817aa02b1cbb568b334ad8f94e
This commit is contained in:
tengqm 2016-01-24 05:00:45 -05:00
parent 56b959ec5d
commit f5646c0413
15 changed files with 169 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/source/users/index.rst
View File

@ -69,6 +69,7 @@ but listed below are the ones provided by this SDK by default.
:maxdepth: 1
Block Store <proxies/block_store>
Cluster <proxies/cluster>
Compute <proxies/compute>
Database <proxies/database>
Identity <proxies/identity>
@ -95,6 +96,7 @@ The following services have exposed *Resource* classes.
:maxdepth: 1
Block Store <resources/block_store/index>
Cluster <resources/cluster/index>
Compute <resources/compute/index>
Database <resources/database/index>
Identity <resources/identity/index>

14
doc/source/users/proxies/cluster.rst Normal file
View File

@ -0,0 +1,14 @@
Cluster API
===========
.. automodule:: openstack.cluster.v1._proxy
The Cluster Class
-----------------
The cluster high-level interface is available through the ``cluster``
member of a :class:`~openstack.connection.Connection` object. The
``cluster`` member will only be added if the service is detected.
.. autoclass:: openstack.cluster.v1._proxy.Proxy
:members:

17
doc/source/users/resources/cluster/index.rst Normal file
View File

@ -0,0 +1,17 @@
Cluster Resources
=================
.. toctree::
:maxdepth: 1
v1/build_info
v1/profile_type
v1/profile
v1/policy_type
v1/policy
v1/cluster
v1/node
v1/cluster_policy
v1/receiver
v1/action
v1/event

12
doc/source/users/resources/cluster/v1/action.rst Normal file
View File

@ -0,0 +1,12 @@
openstack.cluster.v1.action
===========================
.. automodule:: openstack.cluster.v1.action
The Action Class
----------------
The ``Action`` class inherits from :class:`~openstack.resource.Resource`.
.. autoclass:: openstack.cluster.v1.action.Action
:members:

12
doc/source/users/resources/cluster/v1/build_info.rst Normal file
View File

@ -0,0 +1,12 @@
openstack.cluster.v1.build_info
===============================
.. automodule:: openstack.cluster.v1.build_info
The BuildInfo Class
-------------------
The ``BuildInfo`` class inherits from :class:`~openstack.resource.Resource`.
.. autoclass:: openstack.cluster.v1.build_info.BuildInfo
:members:

12
doc/source/users/resources/cluster/v1/cluster.rst Normal file
View File

@ -0,0 +1,12 @@
openstack.cluster.v1.Cluster
============================
.. automodule:: openstack.cluster.v1.cluster
The Cluster Class
-----------------
The ``Cluster`` class inherits from :class:`~openstack.resource.Resource`.
.. autoclass:: openstack.cluster.v1.cluster.Cluster
:members:

13
doc/source/users/resources/cluster/v1/cluster_policy.rst Normal file
View File

@ -0,0 +1,13 @@
openstack.cluster.v1.cluster_policy
===================================
.. automodule:: openstack.cluster.v1.cluster_policy
The ClusterPolicy Class
-----------------------
The ``ClusterPolicy`` class inherits from
:class:`~openstack.resource.Resource`.
.. autoclass:: openstack.cluster.v1.cluster_policy.ClusterPolicy
:members:

12
doc/source/users/resources/cluster/v1/event.rst Normal file
View File

@ -0,0 +1,12 @@
openstack.cluster.v1.event
==========================
.. automodule:: openstack.cluster.v1.event
The Event Class
---------------
The ``Event`` class inherits from :class:`~openstack.resource.Resource`.
.. autoclass:: openstack.cluster.v1.event.Event
:members:

12
doc/source/users/resources/cluster/v1/node.rst Normal file
View File

@ -0,0 +1,12 @@
openstack.cluster.v1.Node
=========================
.. automodule:: openstack.cluster.v1.node
The Node Class
--------------
The ``Node`` class inherits from :class:`~openstack.resource.Resource`.
.. autoclass:: openstack.cluster.v1.node.Node
:members:

12
doc/source/users/resources/cluster/v1/policy.rst Normal file
View File

@ -0,0 +1,12 @@
openstack.cluster.v1.policy
===========================
.. automodule:: openstack.cluster.v1.policy
The Policy Class
----------------
The ``Policy`` class inherits from :class:`~openstack.resource.Resource`.
.. autoclass:: openstack.cluster.v1.policy.Policy
:members:

12
doc/source/users/resources/cluster/v1/policy_type.rst Normal file
View File

@ -0,0 +1,12 @@
openstack.cluster.v1.policy_type
================================
.. automodule:: openstack.cluster.v1.policy_type
The PolicyType Class
--------------------
The ``PolicyType`` class inherits from :class:`~openstack.resource.Resource`.
.. autoclass:: openstack.cluster.v1.policy_type.PolicyType
:members:

12
doc/source/users/resources/cluster/v1/profile.rst Normal file
View File

@ -0,0 +1,12 @@
openstack.cluster.v1.profile
============================
.. automodule:: openstack.cluster.v1.profile
The Profile Class
-----------------
The ``Profile`` class inherits from :class:`~openstack.resource.Resource`.
.. autoclass:: openstack.cluster.v1.profile.Profile
:members:

12
doc/source/users/resources/cluster/v1/profile_type.rst Normal file
View File

@ -0,0 +1,12 @@
openstack.cluster.v1.profile_type
=================================
.. automodule:: openstack.cluster.v1.profile_type
The ProfileType Class
---------------------
The ``ProfileType`` class inherits from :class:`~openstack.resource.Resource`.
.. autoclass:: openstack.cluster.v1.profile_type.ProfileType
:members:

12
doc/source/users/resources/cluster/v1/receiver.rst Normal file
View File

@ -0,0 +1,12 @@
openstack.cluster.v1.receiver
=============================
.. automodule:: openstack.cluster.v1.receiver
The Reciever Class
------------------
The ``Reciever`` class inherits from :class:`~openstack.resource.Resource`.
.. autoclass:: openstack.cluster.v1.receiver.Receiver
:members:

3
openstack/cluster/v1/_proxy.py
View File

@ -134,6 +134,7 @@ class Proxy(proxy.BaseProxy):
:param kwargs \*\*query: Optional query parameters to be sent to
restrict the profiles to be returned. Available parameters include:
* name: The name of a profile.
* type: The type name of a profile.
* metadata: A list of key-value pairs that are associated with a
@ -226,6 +227,7 @@ class Proxy(proxy.BaseProxy):
:param kwargs \*\*query: Optional query parameters to be sent to
restrict the clusters to be returned. Available parameters include:
* name: The name of a cluster.
* status: The current status of a cluster.
* sort: A list of sorting keys separated by commas. Each sorting
@ -524,6 +526,7 @@ class Proxy(proxy.BaseProxy):
:param kwargs \*\*query: Optional query parameters to be sent to
restrict the policies to be returned. Available parameters include:
* name: The name of a policy.
* type: The type name of a policy.
* sort: A list of sorting keys separated by commas. Each sorting