Merge "Update cluster APIs doc"

2017-07-25 01:51:39 +00:00 · 2017-07-25 01:51:39 +00:00 · 9f1f917f6c
parent 7dd10ad0fd 5b5bc05d31
commit 9f1f917f6c
11 changed files with 139 additions and 10 deletions
--- a/api-ref/source/clusters.inc
+++ b/api-ref/source/clusters.inc
@ -40,7 +40,8 @@ Request Parameters
  - name: name_query
  - status: status_query

-The sorting key is ``enabled``.
+The sorting keys include ``name``, ``status``, ``init_at``, ``created_at``,
+and ``updated_at``.

 Response Parameters
 -------------------
@ -50,7 +51,9 @@ Response Parameters
  - X-OpenStack-Request-ID: request_id
  - clusters: clusters
  - created_at: created_at
+  - config: cluster_config
  - data: cluster_data
+  - dependents: dependents
  - desired_capacity: desired_capacity
  - domain: domain
  - id: cluster_id
@ -105,6 +108,7 @@ Request Parameters
 .. rest_parameters:: parameters.yaml

  - OpenStack-API-Version: microversion
+  - config: cluster_config_req
  - cluster: cluster
  - name: cluster_name
  - desired_capacity: desired_capacity
@ -129,8 +133,10 @@ Response Parameters
  - X-OpenStack-Request-ID: request_id
  - Location: location
  - cluster: cluster
+  - config: cluster_config
  - created_at: created_at
  - data: cluster_data
+  - dependents: dependents
  - desired_capacity: desired_capacity
  - domain: domain
  - id: cluster_id
@ -194,8 +200,10 @@ Response Parameters

  - X-OpenStack-Request-ID: request_id
  - cluster: cluster
+  - config: cluster_config
  - created_at: created_at
  - data: cluster_data
+  - dependents: dependents
  - desired_capacity: desired_capacity
  - domain: domain
  - id: cluster_id
@ -252,6 +260,7 @@ Request Parameters
  - OpenStack-API-Version: microversion
  - cluster_id: cluster_id_url
  - cluster: cluster
+  - config: cluster_config_req
  - name: name_req
  - profile_id: profile_identity
  - timeout: timeout_req
@ -273,8 +282,10 @@ Response Parameters
  - X-OpenStack-Request-ID: request_id
  - Location: location
  - cluster: cluster
+  - config: cluster_config
  - created_at: created_at
  - data: cluster_data
+  - dependents: dependents
  - desired_capacity: desired_capacity
  - domain: domain
  - id: cluster_id
@ -397,6 +408,13 @@ Response Parameters

  - X-OpenStack-Request-ID: request_id
  - Location: location
+  - action: action_action
+
+Response Example
+----------------
+
+.. literalinclude:: samples/cluster-action-response.json
+   :language: javascript


 Scale-in a Cluster
@ -447,6 +465,13 @@ Response Parameters

  - X-OpenStack-Request-ID: request_id
  - Location: location
+  - action: action_action
+
+Response Example
+----------------
+
+.. literalinclude:: samples/cluster-action-response.json
+   :language: javascript


 Scale-out a Cluster
@ -497,6 +522,13 @@ Response Parameters

  - X-OpenStack-Request-ID: request_id
  - Location: location
+  - action: action_action
+
+Response Example
+----------------
+
+.. literalinclude:: samples/cluster-action-response.json
+   :language: javascript


 Add nodes to a Cluster
@ -547,6 +579,13 @@ Response Parameters

  - X-OpenStack-Request-ID: request_id
  - Location: location
+  - action: action_action
+
+Response Example
+----------------
+
+.. literalinclude:: samples/cluster-action-response.json
+   :language: javascript


 Remove nodes from a Cluster
@ -598,6 +637,13 @@ Response Parameters

  - X-OpenStack-Request-ID: request_id
  - Location: location
+  - action: action_action
+
+Response Example
+----------------
+
+.. literalinclude:: samples/cluster-action-response.json
+   :language: javascript


 Replace nodes in a Cluster
@ -650,6 +696,13 @@ Response Parameters

  - X-OpenStack-Request-ID: request_id
  - Location: location
+  - action: action_action
+
+Response Example
+----------------
+
+.. literalinclude:: samples/cluster-action-response.json
+   :language: javascript


 Attach a Policy to a Cluster
@ -685,7 +738,7 @@ Request Parameters
  - policy_id: policy_identity
  - enabled: cluster_policy_enabled

-The ``action_name`` in the request body has to be ``attach_policy``.
+The ``action_name`` in the request body has to be ``policy_attach``.

 Request Example
 ---------------
@ -700,6 +753,13 @@ Response Parameters

  - X-OpenStack-Request-ID: request_id
  - Location: location
+  - action: action_action
+
+Response Example
+----------------
+
+.. literalinclude:: samples/cluster-action-response.json
+   :language: javascript


 Detach a Policy from a Cluster
@ -734,7 +794,7 @@ Request Parameters
  - action: action_request
  - policy_id: policy_identity

-The ``action_name`` in the request body has to be ``detach_policy``.
+The ``action_name`` in the request body has to be ``policy_detach``.

 Request Example
 ---------------
@ -749,6 +809,13 @@ Response Parameters

  - X-OpenStack-Request-ID: request_id
  - Location: location
+  - action: action_action
+
+Response Example
+----------------
+
+.. literalinclude:: samples/cluster-action-response.json
+   :language: javascript


 Update a Policy on a Cluster
@ -799,6 +866,13 @@ Response Parameters

  - X-OpenStack-Request-ID: request_id
  - Location: location
+  - action: action_action
+
+Response Example
+----------------
+
+.. literalinclude:: samples/cluster-action-response.json
+   :language: javascript


 Collect Attributes Across a Cluster
@ -891,6 +965,13 @@ Response Parameters

  - X-OpenStack-Request-ID: request_id
  - Location: location
+  - action: action_action
+
+Response Example
+----------------
+
+.. literalinclude:: samples/cluster-action-response.json
+   :language: javascript


 Recover a Cluster to a Healthy Status
@ -953,6 +1034,13 @@ Response Parameters

  - X-OpenStack-Request-ID: request_id
  - Location: location
+  - action: action_action
+
+Response Example
+----------------
+
+.. literalinclude:: samples/cluster-action-response.json
+   :language: javascript


 Perform an Operation on a Cluster
@ -1002,3 +1090,10 @@ Response Parameters

  - X-OpenStack-Request-ID: request_id
  - Location: location
+  - action: action_action
+
+Response Example
+----------------
+
+.. literalinclude:: samples/cluster-action-response.json
+   :language: javascript
--- a/api-ref/source/parameters.yaml
+++ b/api-ref/source/parameters.yaml
@ -511,6 +511,20 @@ cluster_attributes:
    A list of dictionaries each containing the node ID and the corresponding
    attribute value.

+cluster_config:
+  type: object
+  in: body
+  required: True
+  description: |
+    The structured config associated with the cluster.
+
+cluster_config_req:
+  type: object
+  in: body
+  required: False
+  description: |
+    The structured config associated with the cluster.
+
 cluster_data:
  type: object
  in: body
@ -662,6 +676,14 @@ depended_by:
  description: |
    A list of UUIDs of the actions that depend on the current action.

+dependents:
+  type: object
+  in: body
+  required: True
+  description: |
+    A dict contains dependency information between nova server, heat stack
+    cluster and container cluster.
+
 depends_on:
  type: array
  in: body
--- a/api-ref/source/samples/cluster-action-response.json
+++ b/api-ref/source/samples/cluster-action-response.json
@ -0,0 +1,3 @@
+{
+  "action": "2a0ff107-e789-4660-a122-3816c43af703"
+}
--- a/api-ref/source/samples/cluster-attach-policy-request.json
+++ b/api-ref/source/samples/cluster-attach-policy-request.json
@ -1,5 +1,5 @@
 {
-    "attach_policy": {
+    "policy_attach": {
        "policy_id": "dp01",
        "enabled": false
    }
--- a/api-ref/source/samples/cluster-create-request.json
+++ b/api-ref/source/samples/cluster-create-request.json
@ -1,5 +1,6 @@
 {
    "cluster": {
+        "config": {},
        "desired_capacity": 0,
        "max_size": -1,
        "metadata": {},
--- a/api-ref/source/samples/cluster-create-response.json
+++ b/api-ref/source/samples/cluster-create-response.json
@ -1,7 +1,9 @@
 {
    "cluster": {
+        "config": {},
        "created_at": null,
        "data": {},
+        "dependents": {},
        "desired_capacity": 4,
        "domain": null,
        "id": "45edadcb-c73b-4920-87e1-518b2f29f54b",
--- a/api-ref/source/samples/cluster-detach-policy-request.json
+++ b/api-ref/source/samples/cluster-detach-policy-request.json
@ -1,5 +1,5 @@
 {
-    "detach_policy": {
-        "policy_id": "5630fb31",
+    "policy_detach": {
+        "policy_id": "5630fb31"
    }
 }
--- a/api-ref/source/samples/cluster-scale-in-request.json
+++ b/api-ref/source/samples/cluster-scale-in-request.json
@ -1,5 +1,5 @@
 {
-    "scale_out": {
+    "scale_in": {
        "count": 2
    }
 }
--- a/api-ref/source/samples/cluster-show-response.json
+++ b/api-ref/source/samples/cluster-show-response.json
@ -1,7 +1,9 @@
 {
    "cluster": {
-        "created_at": "2015-02-11T15:13:20",
+        "config": {},
+        "created_at": "2015-02-11T15:13:20Z",
        "data": {},
+        "dependents": {},
        "desired_capacity": 0,
        "domain": null,
        "id": "45edadcb-c73b-4920-87e1-518b2f29f54b",
--- a/api-ref/source/samples/cluster-update-response.json
+++ b/api-ref/source/samples/cluster-update-response.json
@ -1,7 +1,9 @@
 {
    "cluster": {
-        "created_at": "2015-02-11T15:13:20",
+        "config": {},
+        "created_at": "2015-02-11T15:13:20Z",
        "data": {},
+        "dependents": {},
        "desired_capacity": 0,
        "domain": null,
        "id": "45edadcb-c73b-4920-87e1-518b2f29f54b",
--- a/api-ref/source/samples/clusters-list-response.json
+++ b/api-ref/source/samples/clusters-list-response.json
@ -1,8 +1,10 @@
 {
    "clusters": [
        {
-            "created_at": "2015-02-10T14:26:14",
+            "config": {},
+            "created_at": "2015-02-10T14:26:14Z",
            "data": {},
+            "dependents": {},
            "desired_capacity": 4,
            "domain": null,
            "id": "7d85f602-a948-4a30-afd4-e84f47471c15",