d840f36cef
Story: 2011399 Task: 52686 Change-Id: I6cbb622fd41382338c76a7eda2f0f8a37b7c4b4a Signed-off-by: Ngairangbam Mili <ngairangbam.mili@windriver.com>
57 lines
1.6 KiB
ReStructuredText
57 lines
1.6 KiB
ReStructuredText
|
||
.. ecl1581955165616
|
||
.. _security-rest-api-access:
|
||
|
||
===============
|
||
REST API Access
|
||
===============
|
||
|
||
The REST APIs provide programmatic access to the |prod|.
|
||
|
||
The StarlingX Platform related public REST API Endpoints can be listed by
|
||
running the following command:
|
||
|
||
.. code-block:: none
|
||
|
||
$ openstack endpoint list | grep public
|
||
|
||
Use these URLs as the prefix for the URL target of StarlingX Platform
|
||
services REST API messages documented here:
|
||
|
||
|
||
.. _security-rest-api-access-d18e40:
|
||
|
||
- Starlingx – `https://docs.starlingx.io/api-ref/index.html
|
||
<https://docs.starlingx.io/api-ref/index.html>`__
|
||
|
||
- Keystone – `https://docs.openstack.org/api-ref/identity/v3/
|
||
<https://docs.openstack.org/api-ref/identity/v3/>`__
|
||
|
||
- Barbican – `https://docs.openstack.org/barbican/stein/api/
|
||
<https://docs.openstack.org/barbican/stein/api/>`__
|
||
|
||
|
||
|
||
.. _security-rest-api-access-d18e67:
|
||
|
||
----------
|
||
Kubernetes
|
||
----------
|
||
|
||
Access the Kubernetes REST API with the URL prefix of
|
||
https://<oam-floating-ip-address>:6443 and using the API syntax described at
|
||
the following site:
|
||
`https://kubernetes.io/docs/concepts/overview/kubernetes-api/
|
||
<https://kubernetes.io/docs/concepts/overview/kubernetes-api/>`__.
|
||
|
||
.. note::
|
||
|
||
The |prod| REST API/GUI and web server certificate is used by the proxy to
|
||
access the |prod| REST APIs and Kubernetes API server. The REST API client
|
||
needs to trust the issuer of this certificate, which is system-local-ca's
|
||
|RCA| certificate. To retrieve this certificate, use the following command:
|
||
|
||
.. code-block:: none
|
||
|
||
~(keystone_admin)]$ kubectl get secret system-local-ca -n cert-manager -o=jsonpath='{.data.ca\.crt}' | base64 --decode
|