From b1b6754204b0827c2121a93597858668df40b0f3 Mon Sep 17 00:00:00 2001 From: Jeremy Liu Date: Mon, 17 Jul 2017 11:42:15 +0800 Subject: [PATCH] Update internal doc reference according to doc migration result Change-Id: I248221414c8ad9b3d8f89ca8dc880ebf923995af --- doc/source/api/reference/store_backends.rst | 2 +- doc/source/configuration/index.rst | 3 --- doc/source/contributor/dev.rst | 2 +- doc/source/contributor/plugin/crypto.rst | 4 ++-- doc/source/contributor/plugin/secret_store.rst | 6 +++--- doc/source/contributor/testing.rst | 4 ++-- doc/source/index.rst | 1 - 7 files changed, 9 insertions(+), 13 deletions(-) diff --git a/doc/source/api/reference/store_backends.rst b/doc/source/api/reference/store_backends.rst index 0122250ea..7f1e3f912 100644 --- a/doc/source/api/reference/store_backends.rst +++ b/doc/source/api/reference/store_backends.rst @@ -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 `preferred` secret store which is used to store all *new* secrets created in that project. For an introduction to multiple store backends support, see -:doc:`Using Multiple Secret Store Plugins ` . This +:doc:`Using Multiple Secret Store Plugins ` . This 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 diff --git a/doc/source/configuration/index.rst b/doc/source/configuration/index.rst index 90b8c1b19..6dc1d9705 100644 --- a/doc/source/configuration/index.rst +++ b/doc/source/configuration/index.rst @@ -4,10 +4,7 @@ Setting up Barbican .. toctree:: :maxdepth: 1 - dev.rst keystone.rst - devstack.rst - certificate.rst troubleshooting.rst noauth.rst audit.rst diff --git a/doc/source/contributor/dev.rst b/doc/source/contributor/dev.rst index caecee321..97b73737c 100644 --- a/doc/source/contributor/dev.rst +++ b/doc/source/contributor/dev.rst @@ -104,7 +104,7 @@ a keystone token in the ``X-Auth-Token`` header. For example: http://localhost:9311/v1/secrets For more information on configuring Barbican with Keystone auth see the -:doc:`Keystone Configuration ` page. +:doc:`Keystone Configuration ` page. Building the Documentation -------------------------- diff --git a/doc/source/contributor/plugin/crypto.rst b/doc/source/contributor/plugin/crypto.rst index cc16a8486..fb070a59e 100644 --- a/doc/source/contributor/plugin/crypto.rst +++ b/doc/source/contributor/plugin/crypto.rst @@ -8,14 +8,14 @@ This guide describes how to develop a custom cryptographic plugin for use by Barbican. Barbican supports two storage modes for secrets: a cryptographic mode (detailed -on this page), and a :doc:`secret store mode `. The +on this page), and a :doc:`secret store mode `. The cryptographic mode stores encrypted secrets in Barbican's data store, utilizing a cryptographic process or appliance (such as a hardware security module (HSM)) to perform the encryption/decryption. Barbican includes a PKCS11-based interface to SafeNet HSMs. Note that cryptographic plugins are not invoked directly from Barbican core, -but rather via a :doc:`secret store mode ` plugin adapter +but rather via a :doc:`secret store mode ` plugin adapter class, further described in :ref:`plugin-secret-store-crypto-adapter-label`. ``crypto`` Module diff --git a/doc/source/contributor/plugin/secret_store.rst b/doc/source/contributor/plugin/secret_store.rst index e06dde4e4..71519384b 100644 --- a/doc/source/contributor/plugin/secret_store.rst +++ b/doc/source/contributor/plugin/secret_store.rst @@ -8,7 +8,7 @@ This guide describes how to develop a custom secret store plugin for use by Barbican. Barbican supports two storage modes for secrets: a secret store mode (detailed -on this page), and a :doc:`cryptographic mode `. The secret +on this page), and a :doc:`cryptographic mode `. The secret store mode offloads both encryption/decryption and encrypted secret storage to the plugin implementation. Barbican includes plugin interfaces to a Red Hat 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, Barbican core does not need to store encrypted secrets into its data store, -unlike the :doc:`cryptographic mode `. To accommodate the +unlike the :doc:`cryptographic mode `. To accommodate the discrepancy between the two secret storage modes, a secret store to cryptographic plugin adapter has been included in Barbican core, as detailed in :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 cryptographic plugins, called ``StoreCryptoAdapterPlugin``. This plugin functions as a secret store plugin, but it directs secret related operations to -:doc:`cryptographic plugins ` for +:doc:`cryptographic plugins ` for encryption/decryption/generation operations. Because cryptographic plugins do not store encrypted secrets, this adapter plugin provides this storage capability via Barbican's data store. diff --git a/doc/source/contributor/testing.rst b/doc/source/contributor/testing.rst index 33f531c74..260c57fb2 100644 --- a/doc/source/contributor/testing.rst +++ b/doc/source/contributor/testing.rst @@ -29,7 +29,7 @@ with the following command: If you do not have the appropriate Python versions available, consider 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:: @@ -97,7 +97,7 @@ Functional Tests Unlike running unit tests, the functional tests require Barbican and Keystone services to be running in order to execute. For more information on :doc:`setting up a Barbican development environment -` and using :doc:`Keystone with Barbican `, +` and using :doc:`Keystone with Barbican `, see our accompanying project documentation. Once you have the appropriate services running and configured you can execute diff --git a/doc/source/index.rst b/doc/source/index.rst index 4150b188a..6cea0a183 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -8,7 +8,6 @@ such as Symmetric Keys, Asymmetric Keys, Certificates and raw binary data. .. toctree:: :maxdepth: 2 - user/index admin/index install/index configuration/index