Priti Desai 953e45e88e Publishing API Guide to OpenStack site

Moving files from doc/source/api/userguide/*.rst
to api-guide/source/*.rst,
also add api-guide/source/conf.py for building api-guide,
add a new tox target named api-guide
Taking a reference from this patch which was used for the
similar migration of Nova api guide:
https://review.openstack.org/#/c/230186

Change-Id: I725e7939f9a88185de6ef32b311159b0924b7183
Partial-Bug: #1540665
Needed-By: I7b7c623e6299c803930e41d72510f1a67d909fa3

2016-03-16 12:44:50 -07:00

1.7 KiB

Raw Blame History

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.

Barbican for Users

If you're trying to learn how to use barbican, you can start by reading about Secrets in the Barbican API Guide.

Once you're comfortable working with secrets you can dig into the rest of the API.

api/index

Barbican for Developers

If you're new to OpenStack development you should start by reading the OpenStack Developer's Guide.

Once you've read the OpenStack guide you'll be ready to set up a local barbican development environment.

setup/dev setup/devstack

When you're ready to dive deeper in to barbican take a look at:

contribute/getting_involved contribute/architecture contribute/structure contribute/dataflow contribute/dependencies contribute/database_migrations plugin/index testing

Barbican for Operators

If you're looking for information for deploying and configuring barbican you will probably want to read:

setup/index admin-guide-cloud/index

This documentation is generated by the Sphinx toolkit and lives in the source tree.

Indices and tables

genindex
modindex
search

1.7 KiB Raw Blame History