Merge "Clean up some config docs formatting"

This commit is contained in:
Zuul 2018-12-01 02:11:32 +00:00 committed by Gerrit Code Review
commit e2498acf4e
4 changed files with 146 additions and 147 deletions

View File

@ -58,10 +58,12 @@ Steps
#. Edit ``/etc/barbican/barbican-api-paste.ini``
Replace the /v1 app pipeline from ``barbican_api`` to
``barbican-api-keystone-audit`` pipeline
``barbican-api-keystone-audit`` pipeline:
[pipeline:barbican-api-keystone-audit] pipeline =
authtoken context audit apiapp
.. code-block:: text
[pipeline:barbican-api-keystone-audit]
pipeline = authtoken context audit apiapp
#. Edit ``barbican.conf`` to update *notification_driver* value.

View File

@ -6,7 +6,7 @@ other OpenStack service for identity and access control. Nonetheless, sometimes
it may be useful to run barbican without any authentication service for
development purposes.
To this end, `barbican-api-paste.ini` contains a filter pipeline
To this end, ``barbican-api-paste.ini`` contains a filter pipeline
without any authentication (no auth mode):
.. code-block:: ini

View File

@ -59,9 +59,8 @@ What you might see
.. code-block:: bash
curl -X POST \
-H "Content-type: application/json" -H "X-Auth-Token: $TOKEN" -d \
'{"payload": "my-secret-here", "payload_content_type": "text/plain"}' \
curl -X POST -H "X-Auth-Token: $TOKEN" -H "Content-type: application/json" \
-d '{"payload": "my-secret-here", "payload_content_type": "text/plain"}' \
http://myhostname.com/v1/secrets
# Response:
@ -90,7 +89,9 @@ Barbican's tox tests fail to run on my Mac
What you might see
^^^^^^^^^^^^^^^^^^^
``clang: error: unknown argument: '-mno-fused-madd'``
.. code-block:: text
clang: error: unknown argument: '-mno-fused-madd'
How to avoid
^^^^^^^^^^^^^
@ -211,8 +212,8 @@ logger, call ``from barbican.common import config`` with this to get a logger
to use in your source file: ``LOG = config.getLogger(__name__)``.
Responder raised TypeError: 'NoneType' object has no attribute '__getitem__'
----------------------------------------------------------------------------
Responder raised ``TypeError: 'NoneType' object has no attribute '__getitem__'``
--------------------------------------------------------------------------------
What you might see
^^^^^^^^^^^^^^^^^^
@ -315,8 +316,7 @@ A stack trace that has this in it (for example):
.. code-block:: text
CryptoMimeTypeNotSupportedException: Crypto Mime Type of 'text/plain' not \
supported
CryptoMimeTypeNotSupportedException: Crypto Mime Type of 'text/plain' not supported
Caused by
@ -342,13 +342,11 @@ What you might see
*** has_emperor mode detected (fd: 6) ***
...
!!! UNABLE to load uWSGI plugin: dlopen(./python_plugin.so, 10): image not \
found !!!
!!! UNABLE to load uWSGI plugin: dlopen(./python_plugin.so, 10): image not found !!!
...
File "./site-packages/paste/deploy/loadwsgi.py", line 22, in import_string
return pkg_resources.EntryPoint.parse("x=" + s).load(False)
File "./site-packages/distribute-0.6.35-py2.7.egg/pkg_resources.py", line \
2015, in load
File "./site-packages/distribute-0.6.35-py2.7.egg/pkg_resources.py", line 2015, in load
entry = __import__(self.module_name, globals(),globals(), ['__name__'])
ImportError: No module named barbican.api.app
...
@ -447,8 +445,7 @@ What you might see
.. code-block:: text
Secret retrieval issue seen - accept-encoding of 'gzip,deflate,sdch' not \
supported
Secret retrieval issue seen - accept-encoding of 'gzip,deflate,sdch' not supported
Caused by