barbican/doc/source/index.rst
Moisés Guimarães de Medeiros 5df6c0cf84 Fixes index.rst titles and add mascot
Change based on other services docs like Nova and Cinder.

Change-Id: If96ad0bedf469934c8e4c7fcbe8c880514ae9489
2020-06-08 16:14:18 -03:00

55 lines
1.0 KiB
ReStructuredText

OpenStack Key Manager (barbican)
================================
.. figure:: images/mascot.png
:alt: Barbican logo
:width: 210
What is Barbican?
-----------------
Barbican is the OpenStack Key Manager service. It provides secure storage,
provisioning and management of secret data. This includes keying material
such as Symmetric Keys, Asymmetric Keys, Certificates and raw binary data.
API Guide
---------
If you're trying to learn how to use barbican, you can start by reading about
`Secrets in the Barbican API Guide <https://docs.openstack.org/api-guide/key-manager/secrets.html>`__.
Once you're comfortable working with secrets you can dig into the rest of the
API.
.. toctree::
:maxdepth: 2
admin/index
cli/index
install/index
configuration/index
contributor/index
.. toctree::
:maxdepth: 2
api/index.rst
Sample Files
------------
.. toctree::
:maxdepth: 2
sample_config
sample_policy
Indices and tables
------------------
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`