From f5646c0413c02fceccd5dfe1beed03ad53e6864d Mon Sep 17 00:00:00 2001 From: tengqm Date: Sun, 24 Jan 2016 05:00:45 -0500 Subject: [PATCH] Documentation for cluster API and resources This patch adds documentation for cluster service API and resources. Follow up patch will add a user guide. Change-Id: I97fe993a1ddbc0817aa02b1cbb568b334ad8f94e --- doc/source/users/index.rst | 2 ++ doc/source/users/proxies/cluster.rst | 14 ++++++++++++++ doc/source/users/resources/cluster/index.rst | 17 +++++++++++++++++ .../users/resources/cluster/v1/action.rst | 12 ++++++++++++ .../users/resources/cluster/v1/build_info.rst | 12 ++++++++++++ .../users/resources/cluster/v1/cluster.rst | 12 ++++++++++++ .../resources/cluster/v1/cluster_policy.rst | 13 +++++++++++++ doc/source/users/resources/cluster/v1/event.rst | 12 ++++++++++++ doc/source/users/resources/cluster/v1/node.rst | 12 ++++++++++++ .../users/resources/cluster/v1/policy.rst | 12 ++++++++++++ .../users/resources/cluster/v1/policy_type.rst | 12 ++++++++++++ .../users/resources/cluster/v1/profile.rst | 12 ++++++++++++ .../users/resources/cluster/v1/profile_type.rst | 12 ++++++++++++ .../users/resources/cluster/v1/receiver.rst | 12 ++++++++++++ openstack/cluster/v1/_proxy.py | 3 +++ 15 files changed, 169 insertions(+) create mode 100644 doc/source/users/proxies/cluster.rst create mode 100644 doc/source/users/resources/cluster/index.rst create mode 100644 doc/source/users/resources/cluster/v1/action.rst create mode 100644 doc/source/users/resources/cluster/v1/build_info.rst create mode 100644 doc/source/users/resources/cluster/v1/cluster.rst create mode 100644 doc/source/users/resources/cluster/v1/cluster_policy.rst create mode 100644 doc/source/users/resources/cluster/v1/event.rst create mode 100644 doc/source/users/resources/cluster/v1/node.rst create mode 100644 doc/source/users/resources/cluster/v1/policy.rst create mode 100644 doc/source/users/resources/cluster/v1/policy_type.rst create mode 100644 doc/source/users/resources/cluster/v1/profile.rst create mode 100644 doc/source/users/resources/cluster/v1/profile_type.rst create mode 100644 doc/source/users/resources/cluster/v1/receiver.rst diff --git a/doc/source/users/index.rst b/doc/source/users/index.rst index 942475ea3..a7b4a30ea 100644 --- a/doc/source/users/index.rst +++ b/doc/source/users/index.rst @@ -69,6 +69,7 @@ but listed below are the ones provided by this SDK by default. :maxdepth: 1 Block Store + Cluster Compute Database Identity @@ -95,6 +96,7 @@ The following services have exposed *Resource* classes. :maxdepth: 1 Block Store + Cluster Compute Database Identity diff --git a/doc/source/users/proxies/cluster.rst b/doc/source/users/proxies/cluster.rst new file mode 100644 index 000000000..6715fd383 --- /dev/null +++ b/doc/source/users/proxies/cluster.rst @@ -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: diff --git a/doc/source/users/resources/cluster/index.rst b/doc/source/users/resources/cluster/index.rst new file mode 100644 index 000000000..8ec0a4322 --- /dev/null +++ b/doc/source/users/resources/cluster/index.rst @@ -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 diff --git a/doc/source/users/resources/cluster/v1/action.rst b/doc/source/users/resources/cluster/v1/action.rst new file mode 100644 index 000000000..f75deb424 --- /dev/null +++ b/doc/source/users/resources/cluster/v1/action.rst @@ -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: diff --git a/doc/source/users/resources/cluster/v1/build_info.rst b/doc/source/users/resources/cluster/v1/build_info.rst new file mode 100644 index 000000000..8534e1f7a --- /dev/null +++ b/doc/source/users/resources/cluster/v1/build_info.rst @@ -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: diff --git a/doc/source/users/resources/cluster/v1/cluster.rst b/doc/source/users/resources/cluster/v1/cluster.rst new file mode 100644 index 000000000..a54ce6cf5 --- /dev/null +++ b/doc/source/users/resources/cluster/v1/cluster.rst @@ -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: diff --git a/doc/source/users/resources/cluster/v1/cluster_policy.rst b/doc/source/users/resources/cluster/v1/cluster_policy.rst new file mode 100644 index 000000000..d3a55d541 --- /dev/null +++ b/doc/source/users/resources/cluster/v1/cluster_policy.rst @@ -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: diff --git a/doc/source/users/resources/cluster/v1/event.rst b/doc/source/users/resources/cluster/v1/event.rst new file mode 100644 index 000000000..29678062a --- /dev/null +++ b/doc/source/users/resources/cluster/v1/event.rst @@ -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: diff --git a/doc/source/users/resources/cluster/v1/node.rst b/doc/source/users/resources/cluster/v1/node.rst new file mode 100644 index 000000000..74f11f350 --- /dev/null +++ b/doc/source/users/resources/cluster/v1/node.rst @@ -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: diff --git a/doc/source/users/resources/cluster/v1/policy.rst b/doc/source/users/resources/cluster/v1/policy.rst new file mode 100644 index 000000000..0fe59378c --- /dev/null +++ b/doc/source/users/resources/cluster/v1/policy.rst @@ -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: diff --git a/doc/source/users/resources/cluster/v1/policy_type.rst b/doc/source/users/resources/cluster/v1/policy_type.rst new file mode 100644 index 000000000..ee74b3101 --- /dev/null +++ b/doc/source/users/resources/cluster/v1/policy_type.rst @@ -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: diff --git a/doc/source/users/resources/cluster/v1/profile.rst b/doc/source/users/resources/cluster/v1/profile.rst new file mode 100644 index 000000000..bdf782dcb --- /dev/null +++ b/doc/source/users/resources/cluster/v1/profile.rst @@ -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: diff --git a/doc/source/users/resources/cluster/v1/profile_type.rst b/doc/source/users/resources/cluster/v1/profile_type.rst new file mode 100644 index 000000000..48c007f0f --- /dev/null +++ b/doc/source/users/resources/cluster/v1/profile_type.rst @@ -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: diff --git a/doc/source/users/resources/cluster/v1/receiver.rst b/doc/source/users/resources/cluster/v1/receiver.rst new file mode 100644 index 000000000..8d757d55d --- /dev/null +++ b/doc/source/users/resources/cluster/v1/receiver.rst @@ -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: diff --git a/openstack/cluster/v1/_proxy.py b/openstack/cluster/v1/_proxy.py index e2e7d99dd..6dc402234 100644 --- a/openstack/cluster/v1/_proxy.py +++ b/openstack/cluster/v1/_proxy.py @@ -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