openstack/heat
Code Issues Proposed changes
heat/api-ref/source/v1/software-config.inc
tengqm 8ee3e581d3 Fix api-ref doc for software deployment. 
The current api documentation for software deployment is a mess. This
patch is an attempt to fix it.

Change-Id: I41da79865c2836e6750314497e910982bc5462a9
2016-08-08 03:04:43 -04:00

412 lines
8.3 KiB
ReStructuredText
Raw Blame History

.. -*- rst -*-
======================
Software configuration
======================
Create configuration
====================
.. rest_method:: POST /v1/{tenant_id}/software_configs
Creates a software configuration.
Normal response codes: 200
Error response codes:404,401,400,
Request Parameters
------------------
.. rest_parameters:: parameters.yaml
- inputs: inputs
- group: group
- name: config_name
- outputs: outputs
- config: config
- options: options
- tenant_id: tenant_id
Request Example
---------------
.. literalinclude:: samples/config-create-request.json
:language: javascript
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- id: config_id
- inputs: inputs
- group: group
- name: config_name
- outputs: outputs
- creation_time: creation_time
- updated_time: updated_time
- config: config
- options: options
- software_config: software_config
Response Example
----------------
.. literalinclude:: samples/config-create-response.json
:language: javascript
List configs
============
.. rest_method:: GET /v1/{tenant_id}/software_configs
Lists all available software configurations.
Normal response codes: 200
Error response codes: 404,500,401,400
Request Parameters
------------------
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id
- limit: limit
- marker: marker
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- creation_time: creation_time
- group: group
- id: config_id
- name: config_name
- software_configs: software_configs
Response Example
----------------
.. literalinclude:: samples/configs-list-response.json
:language: javascript
Show configuration details
==========================
.. rest_method:: GET /v1/{tenant_id}/software_configs/{config_id}
Shows details for a software configuration.
Normal response codes: 200
Error response codes: 404,401,400
Request Parameters
------------------
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id
- config_id: config_id
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- config: config
- creation_time: creation_time
- group: group
- id: config_id
- inputs: inputs
- name: config_name
- options: options
- outputs: outputs
- software_config: software_config
Response Example
----------------
.. literalinclude:: samples/config-show-response.json
:language: javascript
Delete config
=============
.. rest_method:: DELETE /v1/{tenant_id}/software_configs/{config_id}
Deletes a software configuration.
Normal response codes: 204
Request Parameters
------------------
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id
- config_id: config_id_url
Create deployment
=================
.. rest_method:: POST /v1/{tenant_id}/software_deployments
Creates a software deployment.
Normal response codes: 200
Error response codes:
Request Parameters
------------------
.. rest_parameters:: parameters.yaml
- action: deployment_action
- config_id: deployment_config_id
- input_values: input_values
- server_id: server_id
- stack_user_project_id: stack_user_project_id
- status: deployment_status
- status_reason: deployment_status_reason
- tenant_id: tenant_id
Request Example
---------------
.. literalinclude:: samples/deployment-create-request.json
:language: javascript
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- action: deployment_action
- config_id: deployment_config_id
- creation_time: creation_time
- id: deployment_id
- input_values: input_values
- output_values: deployment_output_values
- server_id: server_id
- software_deployment: software_deployment
- status: deployment_status
- status_reason: status_reason
- updated_time: deployment_updated_time
Response Example
----------------
.. literalinclude:: samples/deployment-create-response.json
:language: javascript
List deployments
================
.. rest_method:: GET /v1/{tenant_id}/software_deployments
Lists all available software deployments.
Normal response codes: 200
Error response codes: 404,500,401,400
Request Parameters
------------------
.. rest_parameters:: parameters.yaml
- server_id: deployment_server_id_query
- tenant_id: tenant_id
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- action: deployment_action
- config_id: deployment_config_id
- creation_time: creation_time
- id: deployment_id
- input_values: input_values
- output_values: deployment_output_values
- server_id: server_id
- software_deployments: software_deployments
- status: deployment_status
- status_reason: status_reason
- updated_time: deployment_updated_time
Response Example
----------------
.. literalinclude:: samples/deployments-list-response.json
:language: javascript
Show deployment details
=======================
.. rest_method:: GET /v1/{tenant_id}/software_deployments/{deployment_id}
Shows details for a software deployment.
Normal response codes: 200
Error response codes:
Request Parameters
------------------
.. rest_parameters:: parameters.yaml
- deployment_id: deployment_id_url
- tenant_id: tenant_id
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- action: deployment_action
- config_id: deployment_config_id
- creation_time: creation_time
- id: deployment_id
- input_values: input_values
- output_values: deployment_output_values
- server_id: server_id
- software_deployment: software_deployment
- status: deployment_status
- status_reason: status_reason
- updated_time: deployment_updated_time
Response Example
----------------
.. literalinclude:: samples/deployment-show-response.json
:language: javascript
Update deployment
=================
.. rest_method:: PUT /v1/{tenant_id}/software_deployments/{deployment_id}
Updates a software deployment.
Normal response codes: 200
Error response codes:
Request Parameters
------------------
.. rest_parameters:: parameters.yaml
- action: deployment_action
- config_id: deployment_config_id
- deployment_id: deployment_id_url
- input_values: input_values
- output_values: deployment_output_values
- status: deployment_status
- status_reason: status_reason
- tenant_id: tenant_id
Request Example
---------------
.. literalinclude:: samples/deployment-update-request.json
:language: javascript
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- action: deployment_action
- config_id: deployment_config_id
- creation_time: creation_time
- id: deployment_id
- input_values: input_values
- output_values: deployment_output_values
- server_id: server_id
- software_deployments: software_deployments
- status: deployment_status
- status_reason: status_reason
- updated_time: deployment_updated_time
Response Example
----------------
.. literalinclude:: samples/deployment-update-response.json
:language: javascript
Delete deployment
=================
.. rest_method:: DELETE /v1/{tenant_id}/software_deployments/{deployment_id}
Deletes a software deployment.
Normal response codes: 204
Request Parameters
------------------
.. rest_parameters:: parameters.yaml
- deployment_id: deployment_id_url
- tenant_id: tenant_id
Show server configuration metadata
==================================
.. rest_method:: GET /v1/{tenant_id}/software_deployments/metadata/{server_id}
Shows the deployment configuration metadata for a server.
Use the ``group`` property to specify the configuration hook to
which the pass the metadata item.
Normal response codes: 200
Error response codes:
Request Parameters
------------------
.. rest_parameters:: parameters.yaml
- server_id: deployment_server_id_url
- tenant_id: tenant_id
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- config: config
- creation_time: creation_time
- group: group
- id: config_id
- inputs: inputs
- metadata: deployment_metadata
- name: config_name
- options: options
- outputs: outputs
- updated_time: updated_time
Response Example
----------------
.. literalinclude:: samples/deployment-metadata-response.json
:language: javascript
View Git Blame Copy Permalink