openstack/openstack-manuals
Code Issues Proposed changes

Update Config reference for keystone

Browse Source 
flagmappings are only one line add/delete
but it has huge difference after docbook.

Change-Id: I77cda2ff0aae7bd86dc6a140339fffd9f9d9ad1e
Partial-Bug: #1407581
This commit is contained in:
Atsushi SAKAI 2015-09-03 15:57:43 +09:00
parent d6d10a5fb7
commit 065905d3a0
17 changed files with 27 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/common/tables/keystone-api.xml
View File

@ -161,7 +161,7 @@
</tr>
<tr>
<td><option>driver</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Entrypoint for the resource backend driver in the keystone.resource namespace. If a resource driver is not specified, the assignment driver will choose the resource driver.</td>
<td>(StrOpt) Entrypoint for the resource backend driver in the keystone.resource namespace. Supplied drivers are ldap and sql. If a resource driver is not specified, the assignment driver will choose the resource driver.</td>
</tr>
<tr>
<td><option>list_limit</option> = <replaceable>None</replaceable></td>

2
doc/common/tables/keystone-assignment.xml
View File

@ -19,7 +19,7 @@
</tr>
<tr>
<td><option>driver</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Entrypoint for the assignment backend driver in the keystone.assignment namespace.</td>
<td>(StrOpt) Entrypoint for the assignment backend driver in the keystone.assignment namespace. Supplied drivers are ldap and sql. If an assignment driver is not specified, the identity driver will choose the assignment driver.</td>
</tr>
</tbody>
</table>

2
doc/common/tables/keystone-auth.xml
View File

@ -19,7 +19,7 @@
</tr>
<tr>
<td><option>external</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Entrypoint for the external (REMOTE_USER) auth plugin module in the keystone.auth.external namespace.</td>
<td>(StrOpt) Entrypoint for the external (REMOTE_USER) auth plugin module in the keystone.auth.external namespace. Supplied drivers are DefaultDomain and Domain. The default driver is DefaultDomain.</td>
</tr>
<tr>
<td><option>methods</option> = <replaceable>external, password, token, oauth1</replaceable></td>

2
doc/common/tables/keystone-catalog.xml
View File

@ -27,7 +27,7 @@
</tr>
<tr>
<td><option>driver</option> = <replaceable>sql</replaceable></td>
<td>(StrOpt) Entrypoint for the catalog backend driver in the keystone.catalog namespace.</td>
<td>(StrOpt) Entrypoint for the catalog backend driver in the keystone.catalog namespace. Supplied drivers are kvs, sql, templated, and endpoint_filter.sql</td>
</tr>
<tr>
<td><option>list_limit</option> = <replaceable>None</replaceable></td>

4
doc/common/tables/keystone-common.xml
View File

@ -17,6 +17,10 @@
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td><option>executor_thread_pool_size</option> = <replaceable>64</replaceable></td>
<td>(IntOpt) Size of executor thread pool.</td>
</tr>
<tr>
<td><option>memcached_servers</option> = <replaceable>None</replaceable></td>
<td>(ListOpt) Memcached servers or None for in process cache.</td>

2
doc/common/tables/keystone-federation.xml
View File

@ -27,7 +27,7 @@
</tr>
<tr>
<td><option>federated_domain_name</option> = <replaceable>Federated</replaceable></td>
<td>(StrOpt) A domain name that is reserved to allow federated ephemeral users to have a domain concept. Note that an admin will not be able to create a domain with this name or update an existing domain to this name. You are not advised to change this value unless you really have to. Changing this option to empty string or None will not have any impact and default name will be used.</td>
<td>(StrOpt) A domain name that is reserved to allow federated ephemeral users to have a domain concept. Note that an admin will not be able to create a domain with this name or update an existing domain to this name. You are not advised to change this value unless you really have to.</td>
</tr>
<tr>
<td><option>remote_id_attribute</option> = <replaceable>None</replaceable></td>

2
doc/common/tables/keystone-identity.xml
View File

@ -43,7 +43,7 @@
</tr>
<tr>
<td><option>driver</option> = <replaceable>sql</replaceable></td>
<td>(StrOpt) Entrypoint for the identity backend driver in the keystone.identity namespace.</td>
<td>(StrOpt) Entrypoint for the identity backend driver in the keystone.identity namespace. Supplied drivers are ldap and sql.</td>
</tr>
<tr>
<td><option>list_limit</option> = <replaceable>None</replaceable></td>

10
doc/common/tables/keystone-ldap.xml
View File

@ -91,7 +91,7 @@
</tr>
<tr>
<td><option>group_tree_dn</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Search base for groups.</td>
<td>(StrOpt) Search base for groups. Defaults to the suffix value.</td>
</tr>
<tr>
<td><option>page_size</option> = <replaceable>0</replaceable></td>
@ -183,7 +183,7 @@
</tr>
<tr>
<td><option>project_tree_dn</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Search base for projects</td>
<td>(StrOpt) Search base for projects. Defaults to the suffix value.</td>
</tr>
<tr>
<td><option>query_scope</option> = <replaceable>one</replaceable></td>
@ -231,7 +231,7 @@
</tr>
<tr>
<td><option>role_tree_dn</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Search base for roles.</td>
<td>(StrOpt) Search base for roles. Defaults to the suffix value.</td>
</tr>
<tr>
<td><option>suffix</option> = <replaceable>cn=example,cn=com</replaceable></td>
@ -290,7 +290,7 @@
<td>(BoolOpt) Allow user updates in LDAP backend.</td>
</tr>
<tr>
<td><option>user_attribute_ignore</option> = <replaceable>default_project_id, tenants</replaceable></td>
<td><option>user_attribute_ignore</option> = <replaceable>default_project_id</replaceable></td>
<td>(ListOpt) List of attributes stripped off the user on update.</td>
</tr>
<tr>
@ -347,7 +347,7 @@
</tr>
<tr>
<td><option>user_tree_dn</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Search base for users.</td>
<td>(StrOpt) Search base for users. Defaults to the suffix value.</td>
</tr>
</tbody>
</table>

10
doc/common/tables/keystone-logging.xml
View File

@ -19,10 +19,10 @@
</tr>
<tr>
<td><option>debug</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Print debugging output (set logging level to DEBUG instead of default WARNING level).</td>
<td>(BoolOpt) Print debugging output (set logging level to DEBUG instead of default INFO level).</td>
</tr>
<tr>
<td><option>default_log_levels</option> = <replaceable>amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, oslo.messaging=INFO, iso8601=WARN, requests.packages.urllib3.connectionpool=WARN, urllib3.connectionpool=WARN, websocket=WARN, requests.packages.urllib3.util.retry=WARN, urllib3.util.retry=WARN, keystonemiddleware=WARN, routes.middleware=WARN, stevedore=WARN</replaceable></td>
<td><option>default_log_levels</option> = <replaceable>amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, oslo.messaging=INFO, iso8601=WARN, requests.packages.urllib3.connectionpool=WARN, urllib3.connectionpool=WARN, websocket=WARN, requests.packages.urllib3.util.retry=WARN, urllib3.util.retry=WARN, keystonemiddleware=WARN, routes.middleware=WARN, stevedore=WARN, taskflow=WARN</replaceable></td>
<td>(ListOpt) List of logger=LEVEL pairs.</td>
</tr>
<tr>
@ -91,11 +91,11 @@
</tr>
<tr>
<td><option>use_syslog_rfc_format</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) (Optional) Enables or disables syslog rfc5424 format for logging. If enabled, prefixes the MSG part of the syslog message with APP-NAME (RFC5424). The format without the APP-NAME is deprecated in K, and will be removed in M, along with this option.</td>
<td>(BoolOpt) (Optional) Enables or disables syslog rfc5424 format for logging. If enabled, prefixes the MSG part of the syslog message with APP-NAME (RFC5424). The format without the APP-NAME is deprecated in Kilo, and will be removed in Mitaka, along with this option.</td>
</tr>
<tr>
<td><option>verbose</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Print more verbose output (set logging level to INFO instead of default WARNING level).</td>
<td><option>verbose</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) If set to false, will disable INFO logging level, making WARNING the default.</td>
</tr>
</tbody>
</table>

2
doc/common/tables/keystone-policy.xml
View File

@ -34,7 +34,7 @@
</tr>
<tr>
<td><option>driver</option> = <replaceable>sql</replaceable></td>
<td>(StrOpt) Entrypoint for the policy backend driver in the keystone.policy namespace.</td>
<td>(StrOpt) Entrypoint for the policy backend driver in the keystone.policy namespace. Supplied drivers are rules and sql.</td>
</tr>
<tr>
<td><option>list_limit</option> = <replaceable>None</replaceable></td>

2
doc/common/tables/keystone-qpid.xml
View File

@ -71,7 +71,7 @@
</tr>
<tr>
<td><option>send_single_reply</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Send a single AMQP reply to call message. The current behaviour since oslo-incubator is to send two AMQP replies - first one with the payload, a second one to ensure the other have finish to send the payload. We are going to remove it in the N release, but we must keep backward compatible at the same time. This option provides such compatibility - it defaults to False in Liberty and can be turned on for early adopters with a new installations or for testing. Please note, that this option will be removed in M release.</td>
<td>(BoolOpt) Send a single AMQP reply to call message. The current behaviour since oslo-incubator is to send two AMQP replies - first one with the payload, a second one to ensure the other have finish to send the payload. We are going to remove it in the N release, but we must keep backward compatible at the same time. This option provides such compatibility - it defaults to False in Liberty and can be turned on for early adopters with a new installations or for testing. Please note, that this option will be removed in the Mitaka release.</td>
</tr>
</tbody>
</table>

2
doc/common/tables/keystone-rabbitmq.xml
View File

@ -111,7 +111,7 @@
</tr>
<tr>
<td><option>send_single_reply</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Send a single AMQP reply to call message. The current behaviour since oslo-incubator is to send two AMQP replies - first one with the payload, a second one to ensure the other have finish to send the payload. We are going to remove it in the N release, but we must keep backward compatible at the same time. This option provides such compatibility - it defaults to False in Liberty and can be turned on for early adopters with a new installations or for testing. Please note, that this option will be removed in M release.</td>
<td>(BoolOpt) Send a single AMQP reply to call message. The current behaviour since oslo-incubator is to send two AMQP replies - first one with the payload, a second one to ensure the other have finish to send the payload. We are going to remove it in the N release, but we must keep backward compatible at the same time. This option provides such compatibility - it defaults to False in Liberty and can be turned on for early adopters with a new installations or for testing. Please note, that this option will be removed in the Mitaka release.</td>
</tr>
</tbody>
</table>

2
doc/common/tables/keystone-revoke.xml
View File

@ -27,7 +27,7 @@
</tr>
<tr>
<td><option>driver</option> = <replaceable>sql</replaceable></td>
<td>(StrOpt) Entrypoint for an implementation of the backend for persisting revocation events in the keystone.revoke namespace.</td>
<td>(StrOpt) Entrypoint for an implementation of the backend for persisting revocation events in the keystone.revoke namespace. Supplied drivers are kvs and sql.</td>
</tr>
<tr>
<td><option>expiration_buffer</option> = <replaceable>1800</replaceable></td>

2
doc/common/tables/keystone-role.xml
View File

@ -27,7 +27,7 @@
</tr>
<tr>
<td><option>driver</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Entrypoint for the role backend driver in the keystone.role namespace.</td>
<td>(StrOpt) Entrypoint for the role backend driver in the keystone.role namespace. Supplied drivers are ldap and sql.</td>
</tr>
<tr>
<td><option>list_limit</option> = <replaceable>None</replaceable></td>

4
doc/common/tables/keystone-rpc.xml
View File

@ -41,10 +41,6 @@
<td><option>rpc_response_timeout</option> = <replaceable>60</replaceable></td>
<td>(IntOpt) Seconds to wait for a response from a call.</td>
</tr>
<tr>
<td><option>rpc_thread_pool_size</option> = <replaceable>64</replaceable></td>
<td>(IntOpt) Size of RPC thread pool.</td>
</tr>
<tr>
<th colspan="2">[oslo_messaging_amqp]</th>
</tr>

2
doc/common/tables/keystone-token.xml
View File

@ -35,7 +35,7 @@
</tr>
<tr>
<td><option>driver</option> = <replaceable>sql</replaceable></td>
<td>(StrOpt) Entrypoint for the token persistence backend driver in the keystone.token.persistence namespace.</td>
<td>(StrOpt) Entrypoint for the token persistence backend driver in the keystone.token.persistence namespace. Supplied drivers are kvs, memcache, memcache_pool, and sql.</td>
</tr>
<tr>
<td><option>enforce_token_bind</option> = <replaceable>permissive</replaceable></td>

2
tools/autogenerate-config-flagmappings/keystone.flagmappings
View File

@ -6,6 +6,7 @@ debug logging
default_log_levels logging
default_publisher_id amqp
domain_id_immutable api
executor_thread_pool_size common
fatal_deprecations logging
instance_format logging
instance_uuid_format logging
@ -38,7 +39,6 @@ rpc_backend rpc
rpc_cast_timeout rpc
rpc_conn_pool_size rpc
rpc_response_timeout rpc
rpc_thread_pool_size rpc
rpc_zmq_bind_address zeromq
rpc_zmq_contexts zeromq
rpc_zmq_host zeromq