Add generated keystone documentation to misc.rst.

- Change a bit the formatting of the documention as well.
- Fix WARNING: Title underline too short. in misc.rst.

Change-Id: I2f4e36bcb5e01e984f0af0152bc5b3b9f7e942ce
This commit is contained in:
Chmouel Boudjnah 2013-01-25 14:27:08 +01:00
parent 89d4a51359
commit 1b86380e2e
2 changed files with 15 additions and 6 deletions

View File

@ -44,6 +44,14 @@ TempAuth
.. _acls: .. _acls:
KeystoneAuth
============
.. automodule:: swift.common.middleware.keystoneauth
:members:
:show-inheritance:
ACLs ACLs
==== ====
@ -180,7 +188,7 @@ Bulk Operations (Delete and Archive Auto Extraction)
:show-inheritance: :show-inheritance:
Container Quotas Container Quotas
============= ================
.. automodule:: swift.common.middleware.container_quotas .. automodule:: swift.common.middleware.container_quotas
:members: :members:

View File

@ -40,14 +40,15 @@ class KeystoneAuth(object):
If support is required for unvalidated users (as with anonymous If support is required for unvalidated users (as with anonymous
access) or for tempurl/formpost middleware, authtoken will need access) or for tempurl/formpost middleware, authtoken will need
to be configured with delay_auth_decision set to 1. See the to be configured with ``delay_auth_decision`` set to 1. See the
Keystone documentation for more detail on how to configure the Keystone documentation for more detail on how to configure the
authtoken middleware. authtoken middleware.
In proxy-server.conf you will need to have the setting account In proxy-server.conf you will need to have the setting account
auto creation to true:: auto creation to true::
[app:proxy-server] account_autocreate = true [app:proxy-server]
account_autocreate = true
And add a swift authorization filter section, such as:: And add a swift authorization filter section, such as::
@ -58,18 +59,18 @@ class KeystoneAuth(object):
This maps tenants to account in Swift. This maps tenants to account in Swift.
The user whose able to give ACL / create Containers permissions The user whose able to give ACL / create Containers permissions
will be the one that are inside the operator_roles will be the one that are inside the ``operator_roles``
setting which by default includes the admin and the swiftoperator setting which by default includes the admin and the swiftoperator
roles. roles.
If you need to have a different reseller_prefix to be able to If you need to have a different reseller_prefix to be able to
mix different auth servers you can configure the option mix different auth servers you can configure the option
reseller_prefix in your keystoneauth entry like this : ``reseller_prefix`` in your keystoneauth entry like this::
reseller_prefix = NEWAUTH_ reseller_prefix = NEWAUTH_
Make sure you have a underscore at the end of your new Make sure you have a underscore at the end of your new
reseller_prefix option. ``reseller_prefix`` option.
:param app: The next WSGI app in the pipeline :param app: The next WSGI app in the pipeline
:param conf: The dict of configuration values :param conf: The dict of configuration values