magnum/api-ref/source/certificates.inc
Diogo Guerra 11bcc17568 Drop bay and baymodel from magnum
- Drop bay and baymodel tests
- Drop bay and baymodel from controllers

Depends-On: Ib85e4fda8e4ac467bd49590dc72ba5913bb9a19d

Story: 2009104
Task: 42957
Task: 42959

Signed-off-by: Diogo Guerra <diogo.filipe.tomas.guerra@cern.ch>
Change-Id: Ida2e42c86400438951d9804e3ce122c56a46b94f
2023-05-09 13:59:57 +00:00

129 lines
2.2 KiB
ReStructuredText

.. -*- rst -*-
=====================================
Manage certificates for cluster
=====================================
Generates and show CA certificates for cluster.
Show details about the CA certificate for a cluster
=======================================================
.. rest_method:: GET /v1/certificates/{cluster_ident}?ca_cert_type={ca_cert_type}
Show CA certificate details that are associated with the created cluster based on the
given CA certificate type.
Response Codes
--------------
.. rest_status_code:: success status.yaml
- 200
.. rest_status_code:: error status.yaml
- 401
- 403
Request
-------
.. rest_parameters:: parameters.yaml
- cluster_ident: cluster_ident
- ca_cert_type: ca_cert_type
Response
--------
.. rest_parameters:: parameters.yaml
- X-Openstack-Request-Id: request_id
- cluster_uuid: cluster_id
- pem: pem
- links: links
Response Example
----------------
.. literalinclude:: samples/certificates-ca-show-resp.json
:language: javascript
Generate the CA certificate for a cluster
=============================================
.. rest_method:: POST /v1/certificates/
Sign client key and generate the CA certificate for a cluster
Response Codes
--------------
.. rest_status_code:: success status.yaml
- 201
.. rest_status_code:: error status.yaml
- 400
- 401
- 403
Request
-------
.. rest_parameters:: parameters.yaml
- cluster_uuid: cluster_id
- csr: csr
Request Example
----------------
.. literalinclude:: samples/certificates-ca-sign-req.json
:language: javascript
Response
--------
.. rest_parameters:: parameters.yaml
- X-Openstack-Request-Id: request_id
- pem: pem
- cluster_uuid: cluster_id
- links: links
- csr: csr
Response Example
----------------
.. literalinclude:: samples/certificates-ca-sign-resp.json
:language: javascript
Rotate the CA certificate for a cluster
===========================================
.. rest_method:: PATCH /v1/certificates/
Rotate the CA certificate for a cluster and invalidate all user
certificates.
Response Codes
--------------
.. rest_status_code:: success status.yaml
- 202
.. rest_status_code:: error status.yaml
- 400
Request
-------
.. rest_parameters:: parameters.yaml
- cluster: cluster_id