2014-04-29 23:42:30 -05:00
|
|
|
Welcome to Barbican's developer documentation!
|
2014-07-21 08:24:57 +02:00
|
|
|
==============================================
|
2014-04-29 23:42:30 -05:00
|
|
|
|
2016-02-17 20:05:27 -06:00
|
|
|
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.
|
2014-04-29 23:42:30 -05:00
|
|
|
|
2016-02-17 20:05:27 -06:00
|
|
|
Barbican for Users
|
|
|
|
|
==================
|
2014-04-29 23:42:30 -05:00
|
|
|
|
2016-02-24 11:24:32 -08:00
|
|
|
If you're trying to learn how to use barbican, you can start by reading about
|
|
|
|
|
`Secrets in the Barbican API Guide <http://developer.openstack.org/api-guide/key-manager/secrets.html>`__.
|
2016-02-17 20:05:27 -06:00
|
|
|
|
|
|
|
|
Once you're comfortable working with secrets you can dig into the rest of the
|
|
|
|
|
API.
|
2014-04-29 23:42:30 -05:00
|
|
|
|
|
|
|
|
.. toctree::
|
2014-05-08 01:51:25 -05:00
|
|
|
:maxdepth: 1
|
2014-04-29 23:42:30 -05:00
|
|
|
|
2015-04-01 09:54:11 -05:00
|
|
|
api/index
|
2016-02-17 20:05:27 -06:00
|
|
|
|
|
|
|
|
Barbican for Developers
|
|
|
|
|
=======================
|
|
|
|
|
|
|
|
|
|
If you're new to OpenStack development you should start by reading the
|
|
|
|
|
`OpenStack Developer's Guide`_.
|
|
|
|
|
|
|
|
|
|
.. _`OpenStack Developer's Guide`: http://docs.openstack.org/infra/manual/developers.html
|
|
|
|
|
|
|
|
|
|
Once you've read the OpenStack guide you'll be ready to set up a local barbican
|
|
|
|
|
development environment.
|
|
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 1
|
|
|
|
|
|
|
|
|
|
setup/dev
|
|
|
|
|
setup/devstack
|
|
|
|
|
|
|
|
|
|
When you're ready to dive deeper in to barbican take a look at:
|
|
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 1
|
|
|
|
|
|
2014-10-22 17:31:40 -05:00
|
|
|
contribute/getting_involved
|
2014-10-31 13:03:23 -04:00
|
|
|
contribute/architecture
|
|
|
|
|
contribute/structure
|
2016-02-17 20:05:27 -06:00
|
|
|
contribute/dataflow
|
|
|
|
|
contribute/dependencies
|
2015-02-18 12:42:22 -05:00
|
|
|
contribute/database_migrations
|
2016-02-17 20:05:27 -06:00
|
|
|
plugin/index
|
2014-10-22 15:14:41 -05:00
|
|
|
testing
|
2016-02-17 20:05:27 -06:00
|
|
|
|
|
|
|
|
Barbican for Operators
|
|
|
|
|
======================
|
|
|
|
|
|
|
|
|
|
If you're looking for information for deploying and configuring barbican you
|
|
|
|
|
will probably want to read:
|
|
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 1
|
|
|
|
|
|
2016-02-24 11:24:32 -08:00
|
|
|
setup/index
|
2015-10-05 17:59:53 -05:00
|
|
|
admin-guide-cloud/index
|
2014-04-29 23:42:30 -05:00
|
|
|
|
2016-02-17 20:05:27 -06:00
|
|
|
This documentation is generated by the Sphinx toolkit and lives in the source
|
|
|
|
|
tree.
|
2014-04-29 23:42:30 -05:00
|
|
|
|
2015-04-01 09:54:11 -05:00
|
|
|
|
2014-04-29 23:42:30 -05:00
|
|
|
Indices and tables
|
|
|
|
|
==================
|
|
|
|
|
|
|
|
|
|
* :ref:`genindex`
|
|
|
|
|
* :ref:`modindex`
|
|
|
|
|
* :ref:`search`
|
