docs/doc/source/security/kubernetes/security-rest-api-access.rst
Keane Lim 3c5fa979a4 Security guide update
Re-organized topic hierarchy

Tiny edit to restart review workflow.

Squashed with Resolved index.rst conflict commit

Change-Id: I13472792cb19d1e9975ac76c6954d38054d606c5
Signed-off-by: Keane Lim <keane.lim@windriver.com>
Signed-off-by: MCamp859 <maryx.camp@intel.com>
2021-03-12 15:10:40 -05:00

47 lines
1.2 KiB
ReStructuredText
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

.. 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/>`__.