barbican/doc/source/index.rst
Jeremy Liu ed0bb3f5fb Add sample config and policy to documentation
Change-Id: Ie21459821dbe654d5e097494efbfbd647c12044e
2018-02-09 08:16:03 +00:00

47 lines
964 B
ReStructuredText

Welcome to Barbican's developer documentation!
==============================================
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.
.. toctree::
:maxdepth: 2
admin/index
install/index
configuration/index
contributor/index
API Reference
=============
If you're trying to learn how to use barbican, you can start by reading about
`Secrets in the Barbican API Guide <https://developer.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: 1
api/index.rst
Sample Files
============
.. toctree::
:maxdepth: 1
sample_config
sample_policy
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`