Skip to content

Commit f5646c0

Browse files
tengqmtengqm
committed
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
1 parent 56b959e commit f5646c0

File tree

15 files changed

+169
-0
lines changed

15 files changed

+169
-0
lines changed

‎doc/source/users/index.rst‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,7 @@ but listed below are the ones provided by this SDK by default.
6969
:maxdepth: 1
7070

7171
Block Store <proxies/block_store>
72+
Cluster <proxies/cluster>
7273
Compute <proxies/compute>
7374
Database <proxies/database>
7475
Identity <proxies/identity>
@@ -95,6 +96,7 @@ The following services have exposed *Resource* classes.
9596
:maxdepth: 1
9697

9798
Block Store <resources/block_store/index>
99+
Cluster <resources/cluster/index>
98100
Compute <resources/compute/index>
99101
Database <resources/database/index>
100102
Identity <resources/identity/index>

‎doc/source/users/proxies/cluster.rst‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
Cluster API
2+
===========
3+
4+
.. automodule:: openstack.cluster.v1._proxy
5+
6+
The Cluster Class
7+
-----------------
8+
9+
The cluster high-level interface is available through the ``cluster``
10+
member of a :class:`~openstack.connection.Connection` object. The
11+
``cluster`` member will only be added if the service is detected.
12+
13+
.. autoclass:: openstack.cluster.v1._proxy.Proxy
14+
:members:

‎doc/source/users/resources/cluster/index.rst‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
Cluster Resources
2+
=================
3+
4+
.. toctree::
5+
:maxdepth: 1
6+
7+
v1/build_info
8+
v1/profile_type
9+
v1/profile
10+
v1/policy_type
11+
v1/policy
12+
v1/cluster
13+
v1/node
14+
v1/cluster_policy
15+
v1/receiver
16+
v1/action
17+
v1/event

‎doc/source/users/resources/cluster/v1/action.rst‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
openstack.cluster.v1.action
2+
===========================
3+
4+
.. automodule:: openstack.cluster.v1.action
5+
6+
The Action Class
7+
----------------
8+
9+
The ``Action`` class inherits from :class:`~openstack.resource.Resource`.
10+
11+
.. autoclass:: openstack.cluster.v1.action.Action
12+
:members:

‎doc/source/users/resources/cluster/v1/build_info.rst‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
openstack.cluster.v1.build_info
2+
===============================
3+
4+
.. automodule:: openstack.cluster.v1.build_info
5+
6+
The BuildInfo Class
7+
-------------------
8+
9+
The ``BuildInfo`` class inherits from :class:`~openstack.resource.Resource`.
10+
11+
.. autoclass:: openstack.cluster.v1.build_info.BuildInfo
12+
:members:

‎doc/source/users/resources/cluster/v1/cluster.rst‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
openstack.cluster.v1.Cluster
2+
============================
3+
4+
.. automodule:: openstack.cluster.v1.cluster
5+
6+
The Cluster Class
7+
-----------------
8+
9+
The ``Cluster`` class inherits from :class:`~openstack.resource.Resource`.
10+
11+
.. autoclass:: openstack.cluster.v1.cluster.Cluster
12+
:members:

‎doc/source/users/resources/cluster/v1/cluster_policy.rst‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
openstack.cluster.v1.cluster_policy
2+
===================================
3+
4+
.. automodule:: openstack.cluster.v1.cluster_policy
5+
6+
The ClusterPolicy Class
7+
-----------------------
8+
9+
The ``ClusterPolicy`` class inherits from
10+
:class:`~openstack.resource.Resource`.
11+
12+
.. autoclass:: openstack.cluster.v1.cluster_policy.ClusterPolicy
13+
:members:

‎doc/source/users/resources/cluster/v1/event.rst‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
openstack.cluster.v1.event
2+
==========================
3+
4+
.. automodule:: openstack.cluster.v1.event
5+
6+
The Event Class
7+
---------------
8+
9+
The ``Event`` class inherits from :class:`~openstack.resource.Resource`.
10+
11+
.. autoclass:: openstack.cluster.v1.event.Event
12+
:members:

‎doc/source/users/resources/cluster/v1/node.rst‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
openstack.cluster.v1.Node
2+
=========================
3+
4+
.. automodule:: openstack.cluster.v1.node
5+
6+
The Node Class
7+
--------------
8+
9+
The ``Node`` class inherits from :class:`~openstack.resource.Resource`.
10+
11+
.. autoclass:: openstack.cluster.v1.node.Node
12+
:members:

‎doc/source/users/resources/cluster/v1/policy.rst‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
openstack.cluster.v1.policy
2+
===========================
3+
4+
.. automodule:: openstack.cluster.v1.policy
5+
6+
The Policy Class
7+
----------------
8+
9+
The ``Policy`` class inherits from :class:`~openstack.resource.Resource`.
10+
11+
.. autoclass:: openstack.cluster.v1.policy.Policy
12+
:members:

0 commit comments

Comments
 (0)