2c1f9bde2b
Add details for bay/cluster API of Magnum. Change-Id: Ib3e2fd27a9cf98719e4938ee9f4839dcc6cacb5d Implements: blueprint magnum-doc-rest-api
121 lines
2.2 KiB
ReStructuredText
121 lines
2.2 KiB
ReStructuredText
.. -*- rst -*-
|
|
|
|
=====================================
|
|
Manage certificates for bay/cluster
|
|
=====================================
|
|
|
|
Generates and show CA certificates for bay/cluster.
|
|
|
|
Show details about the CA certificate for a bay/cluster
|
|
=======================================================
|
|
|
|
.. rest_method:: GET /v1/certificates/{bay_uuid/cluster_uuid}
|
|
|
|
Show CA certificate details that are associated with the created bay/cluster.
|
|
|
|
Response Codes
|
|
--------------
|
|
|
|
.. rest_status_code:: success status.yaml
|
|
|
|
- 200
|
|
|
|
.. rest_status_code:: error status.yaml
|
|
|
|
- 401
|
|
- 403
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- bay_uuid: bay_id
|
|
|
|
.. note::
|
|
|
|
After Newton, all terms related bay/baymodel will be renamed to cluster
|
|
and cluster template.
|
|
|
|
Response
|
|
--------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- X-Openstack-Request-Id: request_id
|
|
- pem: pem
|
|
- bay_uuid: bay_id
|
|
- links: links
|
|
|
|
.. note::
|
|
|
|
After Newton, all terms related bay/baymodel will be renamed to cluster
|
|
and cluster template.
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude:: samples/certificates-ca-show-resp.json
|
|
:language: javascript
|
|
|
|
Generate the CA certificate for a bay/cluster
|
|
=============================================
|
|
|
|
.. rest_method:: POST /v1/certificates/
|
|
|
|
Sign client key and generate the CA certificate for a bay/cluster
|
|
|
|
Response Codes
|
|
--------------
|
|
|
|
.. rest_status_code:: success status.yaml
|
|
|
|
- 201
|
|
|
|
.. rest_status_code:: error status.yaml
|
|
|
|
- 400
|
|
- 401
|
|
- 403
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- bay_uuid: bay_id
|
|
- csr: csr
|
|
|
|
.. note::
|
|
|
|
After Newton, all terms related bay/baymodel will be renamed to cluster
|
|
and cluster template.
|
|
|
|
Request Example
|
|
----------------
|
|
|
|
.. literalinclude:: samples/certificates-ca-sign-req.json
|
|
:language: javascript
|
|
|
|
Response
|
|
--------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- X-Openstack-Request-Id: request_id
|
|
- pem: pem
|
|
- bay_uuid: bay_id
|
|
- links: links
|
|
- csr: csr
|
|
|
|
.. note::
|
|
|
|
After Newton, all terms related bay/baymodel will be renamed to cluster
|
|
and cluster template.
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude:: samples/certificates-ca-sign-resp.json
|
|
:language: javascript
|