openstack/senlin
Code Issues Proposed changes

Revised cluster actions API doc

Browse Source 
The implementation of cluster actions has diverted from the original
design. This patch tries to bring the doc back to its right track.
This commit is contained in:
tengqm
2015-03-04 15:53:34 +08:00
parent 6b9761df9c
commit d1858d57ab
8 changed files with 147 additions and 98 deletions
Download Patch File Download Diff File Expand all files Collapse all files

201
doc/api-site/api-ref/src/wadls/clustering-api/src/v1/clustering-api.wadl
View File

@@ -28,11 +28,11 @@
</param>
<resource id="profile_types" path="profile_types">
<method href="#profile_type_list"/>
<resource path="{profile_type}" id="profile_type_schema">
<resource id="profile_schema" path="{profile_type}" >
<param name="profile_type" style="template" required="true"
xmlns="http://wadl.dev.java.net/2009/02">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The name of a profile type.</para>
<para role="shortdesc">The name of a profile type.</para>
</wadl:doc>
</param>
<method href="#profile_type_schema"/>
@@ -40,11 +40,11 @@
</resource>
<resource id="policy_types" path="policy_types">
<method href="#policy_type_list"/>
<resource path="{policy_type}" id="policy_type_schema">
<resource id="policy_schema" path="{policy_type}">
<param name="policy_type" style="template" required="true"
xmlns="http://wadl.dev.java.net/2009/02">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The name of a policy type.</para>
<para role="shortdesc">The name of a policy type.</para>
</wadl:doc>
</param>
<method href="#policy_type_schema"/>
@@ -90,29 +90,18 @@
<method href="#cluster_get"/>
<method href="#cluster_update"/>
<method href="#cluster_delete"/>
<resource path="nodes" id="cluster_nodes">
<method href="#cluster_add_node"/>
<resource path="{node_id}" id="cluster_node_id">
<param name="node_id" style="template" required="true">
<wadl:doc xlmns="http://docbook.org/ns/docbook" xml:lang="EN">
The ID of a cluster node.
</wadl:doc>
</param>
<method href="#cluster_get_node"/>
<method href="#cluster_del_node"/>
</resource>
<resource path="action" id="cluster_action">
<method href="#cluster_action"/>
</resource>
<resource path="policies" id="cluster_policies">
<method href="#cluster_list_policies"/>
<method href="#cluster_attach_policy"/>
<method href="#cluster_policy_list"/>
<resource path="{policy_id}" id="cluster_policy_id">
<param name="policy_id" style="template" required="true">
<wadl:doc xlmns="http://docbook.org/ns/docbook" xml:lang="EN">
The ID of a policy.
</wadl:doc>
</param>
<method href="#cluster_get_policy"/>
<method href="#cluster_detach_policy"/>
<method href="#cluster_policy_get"/>
</resource>
</resource>
</resource>
@@ -172,7 +161,7 @@
</response>
</method>
<method name="GET" id="cluster_list">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="List clusters.">
<wadl:doc xml:lang="EN" title="List clusters." xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Lists clusters.</para>
</wadl:doc>
<request>
@@ -284,7 +273,7 @@
</response>
</method>
<method name="POST" id="cluster_create">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Create cluster">
<wadl:doc xml:lang="EN" title="Create Cluster" xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Creates a cluster.</para>
</wadl:doc>
<request>
@@ -351,7 +340,7 @@
</response>
</method>
<method name="GET" id="cluster_get">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Show cluster details">
<wadl:doc xml:lang="EN" title="Show Cluster Details" xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Shows details for a specified cluster.</para>
</wadl:doc>
<response status="200">
@@ -363,7 +352,7 @@
</response>
</method>
<method name="PATCH" id="cluster_update">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Update cluster">
<wadl:doc xml:lang="EN" title="Update Cluster" xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Updates a specified cluster.</para>
</wadl:doc>
<request>
@@ -414,47 +403,77 @@
</request>
<response status="202"/>
</method>
<method name="DELETE" id="cluster_delete">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Delete cluster">
<para role="shortdesc">Deletes a specified cluster.</para>
</wadl:doc>
<response status="204"/>
</method>
<method name="POST" id="cluster_add_node">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Add node">
<para role="shortdesc">Add specified node to a cluster.</para>
<method name="PUT" id="cluster_action">
<wadl:doc xml:lang="EN" title="Cluster Action" xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Trigger an action on the specified cluster.</para>
</wadl:doc>
<request>
<representation mediaType="application/json">
<param name="node_id" style="plain" required="true">
<param name="action" style="plain" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The ID of the node to be added.</para>
<para>This is the name of the action to be triggered. Supported action names
include:</para>
<itemizedlist>
<listitem>
<para>
<code>add_nodes</code> Add specified nodes to the cluster where nodes
are provided as a list. For example:
<xsdxt:code href="samples/cluster_add_nodes.json"/>
</para>
</listitem>
<listitem>
<para>
<code>del_nodes</code> Delete specified nodes from the cluster where
nodes are provided as a list.
<xsdxt:code href="samples/cluster_del_nodes.json"/>
</para>
</listitem>
<listitem>
<para>
<code>scale_out</code> Scale out the cluster by number of nodes specified
by the <code>count</code> parameter.
<xsdxt:code href="samples/cluster_scale_out.json"/>
</para>
</listitem>
<listitem>
<para>
<code>scale_in</code> Scale in the cluster by number of nodes specified
by the <code>count</code> parameters.
<xsdxt:code href="samples/cluster_scale_in.json"/>
</para>
</listitem>
<listitem>
<para>
<code>policy_attach</code> Attach the specified policy to the cluster where
the request body contains parameters for the policy attachment.
<xsdxt:code href="samples/cluster_policy_attach.json"/>
</para>
</listitem>
<listitem>
<para>
<code>policy_detach</code> Detach the specified policy from the cluster
where the request body contains the ID of the policy.
<xsdxt:code href="samples/cluster_policy_attach.json"/>
</para>
</listitem>
<listitem>
<para>
<code>policy_update</code> Update the policy attachment where the policy ID
and the new property settings are provided in the request body.
<xsdxt:code href="samples/cluster_policy_update.json"/>
</para>
</listitem>
</itemizedlist>
Note that each action takes a different set of parameters.
</wadl:doc>
</param>
</representation>
</request>
<response status="202"/>
</method>
<method name="GET" id="cluster_get_node">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Get node">
<para role="shortdesc">Show details of a node attached to a cluster.</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="samples/cluster_get_node.json"/>
</wadl:doc>
</representation>
</response>
</method>
<method name="DELETE" id="cluster_del_node">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Delete node">
<para role="shortdesc">Delete node from a cluster.</para>
</wadl:doc>
<response status="204"/>
</method>
<method name="GET" id="cluster_list_policies">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="List policies">
<!-- TODO: revise this -->
<method name="GET" id="cluster_policy_list">
<wadl:doc xml:lang="EN" title="List Policies" xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">List the policies attahed to a cluster.</para>
</wadl:doc>
<response status="200">
@@ -465,8 +484,9 @@
</representation>
</response>
</method>
<method name="GET" id="cluster_get_policy">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Get policy">
<!-- TODO: revise this -->
<method name="GET" id="cluster_policy_get">
<wadl:doc xml:lang="EN" title="Get policy" xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Show details of a policy attached to a cluster.</para>
</wadl:doc>
<response status="200">
@@ -477,29 +497,14 @@
</representation>
</response>
</method>
<method name="POST" id="cluster_attach_policy">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Attach policy">
<para role="shortdesc">Add policy to a cluster.</para>
</wadl:doc>
<request>
<representation mediaType="application/json">
<param name="policy_id" style="plain" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The ID of the policy to be attached.</para>
</wadl:doc>
</param>
</representation>
</request>
<response status="202"/>
</method>
<method name="DELETE" id="cluster_detach_policy">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Detach policy">
<para role="shortdesc">Detach a policy from a cluster.</para>
<method name="DELETE" id="cluster_delete">
<wadl:doc xml:lang="EN" title="Delete Cluster" xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Deletes a specified cluster.</para>
</wadl:doc>
<response status="204"/>
</method>
<method name="GET" id="profile_type_list">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="List profile types">
<wadl:doc xml:lang="EN" title="List Profile Types" xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Lists the supported profile types.</para>
</wadl:doc>
<response status="200">
@@ -512,7 +517,7 @@
</response>
</method>
<method name="GET" id="profile_type_schema">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Show profile spec">
<wadl:doc xml:lang="EN" title="Show Profile Schema" xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Shows the interface schema for a specified profile type.</para>
</wadl:doc>
<response status="200">
@@ -524,7 +529,7 @@
</response>
</method>
<method name="GET" id="policy_type_list">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="List policy types">
<wadl:doc xml:lang="EN" title="List Policy Types" xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Lists the supported policy types.</para>
</wadl:doc>
<response status="200">
@@ -537,7 +542,7 @@
</response>
</method>
<method name="GET" id="policy_type_schema">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Show policy schema">
<wadl:doc xml:lang="EN" title="Show Policy Schema" xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Shows the interface schema for a specified policy type.</para>
</wadl:doc>
<response status="200">
@@ -549,7 +554,7 @@
</response>
</method>
<method name="GET" id="profile_list">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="List profiles">
<wadl:doc xml:lang="EN" title="List Profiles" xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">List profiles.</para>
</wadl:doc>
<request>
@@ -634,7 +639,7 @@
</response>
</method>
<method name="POST" id="profile_create">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Create profile">
<wadl:doc xml:lang="EN" title="Create Profile" xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Creates a new profile.</para>
</wadl:doc>
<request>
@@ -739,7 +744,7 @@
</response>
</method>
<method name="GET" id="profile_get">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Show profile data">
<wadl:doc xml:lang="EN" title="Show Profile Data" xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Show detailed data for a specified profile.</para>
</wadl:doc>
<response status="200">
@@ -755,7 +760,7 @@
</response>
</method>
<method name="PATCH" id="profile_update">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Update profile">
<wadl:doc xml:lang="EN" title="Update Profile" xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Update the specified profile.</para>
</wadl:doc>
<request>
@@ -799,13 +804,13 @@
</response>
</method>
<method name="DELETE" id="profile_delete">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Delete a profile">
<wadl:doc xml:lang="EN" title="Delete Profile" xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Deletes a specified profile.</para>
</wadl:doc>
<response status="204"/>
</method>
<method name="GET" id="policy_list">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="List policies">
<wadl:doc xml:lang="EN" title="List Policies" xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">List policies.</para>
</wadl:doc>
<request>
@@ -889,7 +894,7 @@
</response>
</method>
<method name="POST" id="policy_create">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Create policy">
<wadl:doc xml:lang="EN" title="Create Policy" xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Create a new policy.</para>
</wadl:doc>
<request>
@@ -996,7 +1001,7 @@
</response>
</method>
<method name="GET" id="policy_get">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Show policy data">
<wadl:doc xml:lang="EN" title="Show Policy Data" xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Show detailed data for a specified policy.</para>
</wadl:doc>
<response status="200">
@@ -1013,7 +1018,7 @@
</response>
</method>
<method name="PATCH" id="policy_update">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Update policy">
<wadl:doc xml:lang="EN" title="Update Policy" xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Update the specified policy.</para>
</wadl:doc>
<request>
@@ -1061,13 +1066,13 @@
</response>
</method>
<method name="DELETE" id="policy_delete">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Delete policy">
<wadl:doc xml:lang="EN" title="Delete Policy" xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Deletes a specified policy.</para>
</wadl:doc>
<response status="204"/>
</method>
<method name="GET" id="node_list">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="List nodes">
<wadl:doc xml:lang="EN" title="List Nodes" xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Lists nodes.</para>
</wadl:doc>
<request>
@@ -1130,7 +1135,7 @@
</response>
</method>
<method name="POST" id="node_create">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Create node">
<wadl:doc xml:lang="EN" title="Create Node" xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Creates a new node.</para>
</wadl:doc>
<request>
@@ -1179,7 +1184,7 @@
</response>
</method>
<method name="POST" id="node_update">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Update node">
<wadl:doc xml:lang="EN" title="Update Node" xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Update the specified node.</para>
</wadl:doc>
<request>
@@ -1212,13 +1217,13 @@
<response status="202"/>
</method>
<method name="DELETE" id="node_delete">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Delete node">
<wadl:doc title="Delete Node" xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para role="shortdesc">Deletes a specified node.</para>
</wadl:doc>
<response status="204"/>
</method>
<method name="GET" id="node_get">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Show node data">
<wadl:doc xml:lang="EN" title="Show Node Data" xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Shows data for a specified node.</para>
</wadl:doc>
<response status="200">
@@ -1234,7 +1239,7 @@
</response>
</method>
<method name="GET" id="event_list">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="List events">
<wadl:doc xml:lang="EN" title="List Events" xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Lists events.</para>
</wadl:doc>
<request>
@@ -1305,7 +1310,7 @@
</response>
</method>
<method name="GET" id="event_get">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Show event details">
<wadl:doc xml:lang="EN" title="Show Event Data" xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Shows details for a specified event.</para>
</wadl:doc>
<response status="200">
@@ -1317,7 +1322,7 @@
</response>
</method>
<method name="GET" id="action_list">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="List actions">
<wadl:doc xml:lang="EN" title="List Actions" xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Lists actions.</para>
</wadl:doc>
<request>
@@ -1377,7 +1382,7 @@
</response>
</method>
<method name="GET" id="action_get">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Show action details">
<wadl:doc xml:lang="EN" title="Show Action Data" xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Shows details for a specified action.</para>
</wadl:doc>
<response status="200">
@@ -1390,7 +1395,7 @@
</response>
</method>
<method name="GET" id="build_info_get">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Show build information">
<wadl:doc xml:lang="EN" title="Show Build Information" xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Shows build information for a senlin deployment.</para>
</wadl:doc>
<response status="200">

7
doc/api-site/api-ref/src/wadls/clustering-api/src/v1/samples/cluster_add_nodes.json Normal file
View File

@@ -0,0 +1,7 @@
{
"add_nodes": {
"nodes": [
"node1"
]
}
}

7
doc/api-site/api-ref/src/wadls/clustering-api/src/v1/samples/cluster_del_nodes.json Normal file
View File

@@ -0,0 +1,7 @@
{
"del_nodes": {
"nodes": [
"node1"
]
}
}

9
doc/api-site/api-ref/src/wadls/clustering-api/src/v1/samples/cluster_policy_attach.json Normal file
View File

@@ -0,0 +1,9 @@
{
"policy_attach": {
"cooldown": "60",
"enabled": true,
"level": "30",
"policy_id": "lb001",
"priority": "60"
}
}

5
doc/api-site/api-ref/src/wadls/clustering-api/src/v1/samples/cluster_policy_detach.json Normal file
View File

@@ -0,0 +1,5 @@
{
"policy_detach": {
"policy_id": "lb001",
}
}

6
doc/api-site/api-ref/src/wadls/clustering-api/src/v1/samples/cluster_policy_update.json Normal file
View File

@@ -0,0 +1,6 @@
{
"policy_update": {
"enabled": false,
"policy_id": "lb001",
}
}

5
doc/api-site/api-ref/src/wadls/clustering-api/src/v1/samples/cluster_scale_in.json Normal file
View File

@@ -0,0 +1,5 @@
{
"scale_in": {
"count": "2"
}
}

5
doc/api-site/api-ref/src/wadls/clustering-api/src/v1/samples/cluster_scale_out.json Normal file
View File

@@ -0,0 +1,5 @@
{
"scale_out": {
"count": "1"
}
}