341fb3c4f3
In the index.rst file, sometime, we declare that name_of_file.rst,
sometime is name_of_file.
For example. the content of the barbican/doc/source/api/index.rst
is that:
"""
./reference/secrets
./reference/secret_types
./reference/secret_metadata
./reference/store_backends.rst
./reference/containers
./reference/acls
./reference/quotas
./reference/consumers
./reference/orders
"""
That is confusing, it should be like below:
"""
./reference/secrets.rst
./reference/secret_types.rst
./reference/secret_metadata.rst
./reference/store_backends.rst
./reference/containers.rst
./reference/acls.rst
./reference/quotas.rst
./reference/consumers.rst
./reference/orders.rst
"""
Change-Id: I54ca41bb27f59caaaddab977ef4a3cf7f66bb5f3
Closes-Bug: #1694180
1.8 KiB
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.rst
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.rst setup/devstack.rst
When you're ready to dive deeper in to barbican take a look at:
contribute/getting_involved.rst contribute/architecture.rst contribute/structure.rst contribute/dataflow.rst contribute/dependencies.rst contribute/database_migrations.rst plugin/index.rst testing.rst
Barbican for Operators
If you're looking for information for deploying and configuring barbican you will probably want to read:
setup/index.rst admin-guide-cloud/index.rst upgrade/index.rst
This documentation is generated by the Sphinx toolkit and lives in the source tree.
Indices and tables
genindexmodindexsearch