Update internal doc reference according to doc migration result
Change-Id: I248221414c8ad9b3d8f89ca8dc880ebf923995af
This commit is contained in:
parent
75e865e956
commit
b1b6754204
@ -8,7 +8,7 @@ secret store mapping. There are two types of secret stores. One is global
|
|||||||
default secret store which is used for all projects. And then project
|
default secret store which is used for all projects. And then project
|
||||||
`preferred` secret store which is used to store all *new* secrets created in
|
`preferred` secret store which is used to store all *new* secrets created in
|
||||||
that project. For an introduction to multiple store backends support, see
|
that project. For an introduction to multiple store backends support, see
|
||||||
:doc:`Using Multiple Secret Store Plugins </setup/plugin_backends>` . This
|
:doc:`Using Multiple Secret Store Plugins </configuration/plugin_backends>` . This
|
||||||
document will focus on the details of the Barbican `/v1/secret-stores` REST API.
|
document will focus on the details of the Barbican `/v1/secret-stores` REST API.
|
||||||
|
|
||||||
When multiple secret store backends support is not enabled in service
|
When multiple secret store backends support is not enabled in service
|
||||||
|
@ -4,10 +4,7 @@ Setting up Barbican
|
|||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 1
|
:maxdepth: 1
|
||||||
|
|
||||||
dev.rst
|
|
||||||
keystone.rst
|
keystone.rst
|
||||||
devstack.rst
|
|
||||||
certificate.rst
|
|
||||||
troubleshooting.rst
|
troubleshooting.rst
|
||||||
noauth.rst
|
noauth.rst
|
||||||
audit.rst
|
audit.rst
|
||||||
|
@ -104,7 +104,7 @@ a keystone token in the ``X-Auth-Token`` header. For example:
|
|||||||
http://localhost:9311/v1/secrets
|
http://localhost:9311/v1/secrets
|
||||||
|
|
||||||
For more information on configuring Barbican with Keystone auth see the
|
For more information on configuring Barbican with Keystone auth see the
|
||||||
:doc:`Keystone Configuration </setup/keystone>` page.
|
:doc:`Keystone Configuration </configuration/keystone>` page.
|
||||||
|
|
||||||
Building the Documentation
|
Building the Documentation
|
||||||
--------------------------
|
--------------------------
|
||||||
|
@ -8,14 +8,14 @@ This guide describes how to develop a custom cryptographic plugin for use by
|
|||||||
Barbican.
|
Barbican.
|
||||||
|
|
||||||
Barbican supports two storage modes for secrets: a cryptographic mode (detailed
|
Barbican supports two storage modes for secrets: a cryptographic mode (detailed
|
||||||
on this page), and a :doc:`secret store mode </plugin/secret_store>`. The
|
on this page), and a :doc:`secret store mode </contributor/plugin/secret_store>`. The
|
||||||
cryptographic mode stores encrypted secrets in Barbican's data store, utilizing
|
cryptographic mode stores encrypted secrets in Barbican's data store, utilizing
|
||||||
a cryptographic process or appliance (such as a hardware security module (HSM))
|
a cryptographic process or appliance (such as a hardware security module (HSM))
|
||||||
to perform the encryption/decryption. Barbican includes a PKCS11-based
|
to perform the encryption/decryption. Barbican includes a PKCS11-based
|
||||||
interface to SafeNet HSMs.
|
interface to SafeNet HSMs.
|
||||||
|
|
||||||
Note that cryptographic plugins are not invoked directly from Barbican core,
|
Note that cryptographic plugins are not invoked directly from Barbican core,
|
||||||
but rather via a :doc:`secret store mode </plugin/secret_store>` plugin adapter
|
but rather via a :doc:`secret store mode </contributor/plugin/secret_store>` plugin adapter
|
||||||
class, further described in :ref:`plugin-secret-store-crypto-adapter-label`.
|
class, further described in :ref:`plugin-secret-store-crypto-adapter-label`.
|
||||||
|
|
||||||
``crypto`` Module
|
``crypto`` Module
|
||||||
|
@ -8,7 +8,7 @@ This guide describes how to develop a custom secret store plugin for use by
|
|||||||
Barbican.
|
Barbican.
|
||||||
|
|
||||||
Barbican supports two storage modes for secrets: a secret store mode (detailed
|
Barbican supports two storage modes for secrets: a secret store mode (detailed
|
||||||
on this page), and a :doc:`cryptographic mode </plugin/crypto>`. The secret
|
on this page), and a :doc:`cryptographic mode </contributor/plugin/crypto>`. The secret
|
||||||
store mode offloads both encryption/decryption and encrypted secret storage to
|
store mode offloads both encryption/decryption and encrypted secret storage to
|
||||||
the plugin implementation. Barbican includes plugin interfaces to a Red Hat
|
the plugin implementation. Barbican includes plugin interfaces to a Red Hat
|
||||||
Dogtag service and to a Key Management Interoperability Protocol (KMIP)
|
Dogtag service and to a Key Management Interoperability Protocol (KMIP)
|
||||||
@ -16,7 +16,7 @@ compliant security appliance.
|
|||||||
|
|
||||||
Since the secret store mode defers the storage of encrypted secrets to plugins,
|
Since the secret store mode defers the storage of encrypted secrets to plugins,
|
||||||
Barbican core does not need to store encrypted secrets into its data store,
|
Barbican core does not need to store encrypted secrets into its data store,
|
||||||
unlike the :doc:`cryptographic mode </plugin/crypto>`. To accommodate the
|
unlike the :doc:`cryptographic mode </contributor/plugin/crypto>`. To accommodate the
|
||||||
discrepancy between the two secret storage modes, a secret store to
|
discrepancy between the two secret storage modes, a secret store to
|
||||||
cryptographic plugin adapter has been included in Barbican core, as detailed in
|
cryptographic plugin adapter has been included in Barbican core, as detailed in
|
||||||
:ref:`plugin-secret-store-crypto-adapter-label` section below.
|
:ref:`plugin-secret-store-crypto-adapter-label` section below.
|
||||||
@ -132,7 +132,7 @@ The Cryptographic Plugin Adapter
|
|||||||
Barbican core includes a specialized secret store plugin used to adapt to
|
Barbican core includes a specialized secret store plugin used to adapt to
|
||||||
cryptographic plugins, called ``StoreCryptoAdapterPlugin``. This plugin
|
cryptographic plugins, called ``StoreCryptoAdapterPlugin``. This plugin
|
||||||
functions as a secret store plugin, but it directs secret related operations to
|
functions as a secret store plugin, but it directs secret related operations to
|
||||||
:doc:`cryptographic plugins </plugin/crypto>` for
|
:doc:`cryptographic plugins </contributor/plugin/crypto>` for
|
||||||
encryption/decryption/generation operations. Because cryptographic plugins do
|
encryption/decryption/generation operations. Because cryptographic plugins do
|
||||||
not store encrypted secrets, this adapter plugin provides this storage
|
not store encrypted secrets, this adapter plugin provides this storage
|
||||||
capability via Barbican's data store.
|
capability via Barbican's data store.
|
||||||
|
@ -29,7 +29,7 @@ with the following command:
|
|||||||
|
|
||||||
If you do not have the appropriate Python versions available, consider
|
If you do not have the appropriate Python versions available, consider
|
||||||
setting up PyEnv to install multiple versions of Python. See the
|
setting up PyEnv to install multiple versions of Python. See the
|
||||||
documentation regarding :doc:`/setup/dev` for more information.
|
documentation regarding :doc:`/contributor/dev` for more information.
|
||||||
|
|
||||||
.. note::
|
.. note::
|
||||||
|
|
||||||
@ -97,7 +97,7 @@ Functional Tests
|
|||||||
Unlike running unit tests, the functional tests require Barbican and
|
Unlike running unit tests, the functional tests require Barbican and
|
||||||
Keystone services to be running in order to execute. For more
|
Keystone services to be running in order to execute. For more
|
||||||
information on :doc:`setting up a Barbican development environment
|
information on :doc:`setting up a Barbican development environment
|
||||||
</setup/dev>` and using :doc:`Keystone with Barbican </setup/keystone>`,
|
</contributor/dev>` and using :doc:`Keystone with Barbican </configuration/keystone>`,
|
||||||
see our accompanying project documentation.
|
see our accompanying project documentation.
|
||||||
|
|
||||||
Once you have the appropriate services running and configured you can execute
|
Once you have the appropriate services running and configured you can execute
|
||||||
|
@ -8,7 +8,6 @@ such as Symmetric Keys, Asymmetric Keys, Certificates and raw binary data.
|
|||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 2
|
:maxdepth: 2
|
||||||
|
|
||||||
user/index
|
|
||||||
admin/index
|
admin/index
|
||||||
install/index
|
install/index
|
||||||
configuration/index
|
configuration/index
|
||||||
|
Loading…
Reference in New Issue
Block a user