Adds descriptions of options to proxy server config

Adds is_admin and allow_overrides options description
 to the [filter-authtoken] table.
Also adds missing descriptions of other options to
 the same table.

Change-Id: I6dd8ceb18c593ecf327aab928f3e2ae4fff5ed97
Closes-Bug: #1408381
This commit is contained in:
Maria Zlatkova
2015-03-20 14:31:09 +02:00
parent 6dfbc32b34
commit 48144c9781

View File

@@ -18,27 +18,33 @@
<tbody>
<tr>
<td><option>allow_names_in_acls</option> = <replaceable>true</replaceable></td>
<td>No help text available for this option.</td>
<td>The backwards compatible behavior can be disabled by setting this
option to False.</td>
</tr>
<tr>
<td><option>allow_overrides</option> = <replaceable>true</replaceable></td>
<td>No help text available for this option.</td>
<td>This option allows middleware higher in the WSGI pipeline to override auth
processing, useful for middleware such as tempurl and formpost. If you know
you are not going to use such middleware and you want a bit of extra security,
you can set this to False.</td>
</tr>
<tr>
<td><option>default_domain_id</option> = <replaceable>default</replaceable></td>
<td>No help text available for this option.</td>
<td>Name of the default domain. It is identified by its UUID, which by default has the value "default".</td>
</tr>
<tr>
<td><option>is_admin</option> = <replaceable>false</replaceable></td>
<td>No help text available for this option.</td>
<td>If this option is set to True, it allows to give a user whose username is the same as the project name and who has any role in the project access rights elevated to be the same as if the user had one of the <option>operator_roles</option>. Note that the condition compares names rather than
UUIDs. This option is deprecated. It is False by default.</td>
</tr>
<tr>
<td><option>operator_roles</option> = <replaceable>admin, swiftoperator</replaceable></td>
<td>No help text available for this option.</td>
<td>Operator role defines the user which is allowed to manage a tenant and create containers or give ACL to others. This parameter may be prefixed with an appropriate
prefix.</td>
</tr>
<tr>
<td><option>reseller_admin_role</option> = <replaceable>ResellerAdmin</replaceable></td>
<td>No help text available for this option.</td>
<td>The reseller admin role gives the ability to create and delete accounts.</td>
</tr>
<tr>
<td><option>reseller_prefix</option> = <replaceable>AUTH</replaceable></td>
@@ -46,7 +52,8 @@
</tr>
<tr>
<td><option>service_roles</option> = <replaceable></replaceable></td>
<td>No help text available for this option.</td>
<td>When present, this option requires that the X-Service-Token header supplies a token from a user who has a role listed in service_roles. This parameter may be prefixed with an appropriate
prefix.</td>
</tr>
<tr>
<td><option>use</option> = <replaceable>egg:swift#keystoneauth</replaceable></td>