openstack-manuals/doc/common/tables/cinder-auth_token.xml

<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
  <!-- Warning: Do not edit this file. It is automatically
     generated and your changes will be overwritten.
     The tool to do so lives in openstack-doc-tools repository. -->
  <table rules="all" xml:id="config_table_cinder_auth_token">
    <caption>Description of authorization token configuration options</caption>
    <col width="50%"/>
    <col width="50%"/>
    <thead>
      <tr>
        <th>Configuration option = Default value</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <th colspan="2">[keystone_authtoken]</th>
      </tr>
      <tr>
        <td><option>admin_password</option> = <replaceable>None</replaceable></td>
        <td>(StrOpt) Service user password.</td>
      </tr>
      <tr>
        <td><option>admin_tenant_name</option> = <replaceable>admin</replaceable></td>
        <td>(StrOpt) Service tenant name.</td>
      </tr>
      <tr>
        <td><option>admin_token</option> = <replaceable>None</replaceable></td>
        <td>(StrOpt) This option is deprecated and may be removed in a future release. Single shared secret with the Keystone configuration used for bootstrapping a Keystone installation, or otherwise bypassing the normal authentication process. This option should not be used, use `admin_user` and `admin_password` instead.</td>
      </tr>
      <tr>
        <td><option>admin_user</option> = <replaceable>None</replaceable></td>
        <td>(StrOpt) Service username.</td>
      </tr>
      <tr>
        <td><option>auth_admin_prefix</option> = <replaceable></replaceable></td>
        <td>(StrOpt) Prefix to prepend at the beginning of the path. Deprecated, use identity_uri.</td>
      </tr>
      <tr>
        <td><option>auth_host</option> = <replaceable>127.0.0.1</replaceable></td>
        <td>(StrOpt) Host providing the admin Identity API endpoint. Deprecated, use identity_uri.</td>
      </tr>
      <tr>
        <td><option>auth_plugin</option> = <replaceable>None</replaceable></td>
        <td>(StrOpt) Name of the plugin to load</td>
      </tr>
      <tr>
        <td><option>auth_port</option> = <replaceable>35357</replaceable></td>
        <td>(IntOpt) Port of the admin Identity API endpoint. Deprecated, use identity_uri.</td>
      </tr>
      <tr>
        <td><option>auth_protocol</option> = <replaceable>https</replaceable></td>
        <td>(StrOpt) Protocol of the admin Identity API endpoint (http or https). Deprecated, use identity_uri.</td>
      </tr>
      <tr>
        <td><option>auth_section</option> = <replaceable>None</replaceable></td>
        <td>(StrOpt) Config Section from which to load plugin specific options</td>
      </tr>
      <tr>
        <td><option>auth_uri</option> = <replaceable>None</replaceable></td>
        <td>(StrOpt) Complete public Identity API endpoint.</td>
      </tr>
      <tr>
        <td><option>auth_version</option> = <replaceable>None</replaceable></td>
        <td>(StrOpt) API version of the admin Identity API endpoint.</td>
      </tr>
      <tr>
        <td><option>cache</option> = <replaceable>None</replaceable></td>
        <td>(StrOpt) Env key for the swift cache.</td>
      </tr>
      <tr>
        <td><option>cafile</option> = <replaceable>None</replaceable></td>
        <td>(StrOpt) A PEM encoded Certificate Authority to use when verifying HTTPs connections. Defaults to system CAs.</td>
      </tr>
      <tr>
        <td><option>certfile</option> = <replaceable>None</replaceable></td>
        <td>(StrOpt) Required if identity server requires client certificate</td>
      </tr>
      <tr>
        <td><option>check_revocations_for_cached</option> = <replaceable>False</replaceable></td>
        <td>(BoolOpt) If true, the revocation list will be checked for cached tokens. This requires that PKI tokens are configured on the identity server.</td>
      </tr>
      <tr>
        <td><option>delay_auth_decision</option> = <replaceable>False</replaceable></td>
        <td>(BoolOpt) Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components.</td>
      </tr>
      <tr>
        <td><option>enforce_token_bind</option> = <replaceable>permissive</replaceable></td>
        <td>(StrOpt) Used to control the use and type of token binding. Can be set to: "disabled" to not check token binding. "permissive" (default) to validate binding information if the bind type is of a form known to the server and ignore it if not. "strict" like "permissive" but if the bind type is unknown the token will be rejected. "required" any form of token binding is needed to be allowed. Finally the name of a binding method that must be present in tokens.</td>
      </tr>
      <tr>
        <td><option>hash_algorithms</option> = <replaceable>md5</replaceable></td>
        <td>(ListOpt) Hash algorithms to use for hashing PKI tokens. This may be a single algorithm or multiple. The algorithms are those supported by Python standard hashlib.new(). The hashes will be tried in the order given, so put the preferred one first for performance. The result of the first hash will be stored in the cache. This will typically be set to multiple values only while migrating from a less secure algorithm to a more secure one. Once all the old tokens are expired this option should be set to a single value for better performance.</td>
      </tr>
      <tr>
        <td><option>http_connect_timeout</option> = <replaceable>None</replaceable></td>
        <td>(IntOpt) Request timeout value for communicating with Identity API server.</td>
      </tr>
      <tr>
        <td><option>http_request_max_retries</option> = <replaceable>3</replaceable></td>
        <td>(IntOpt) How many times are we trying to reconnect when communicating with Identity API Server.</td>
      </tr>
      <tr>
        <td><option>identity_uri</option> = <replaceable>None</replaceable></td>
        <td>(StrOpt) Complete admin Identity API endpoint. This should specify the unversioned root endpoint e.g. https://localhost:35357/</td>
      </tr>
      <tr>
        <td><option>include_service_catalog</option> = <replaceable>True</replaceable></td>
        <td>(BoolOpt) (Optional) Indicate whether to set the X-Service-Catalog header. If False, middleware will not ask for service catalog on token validation and will not set the X-Service-Catalog header.</td>
      </tr>
      <tr>
        <td><option>insecure</option> = <replaceable>False</replaceable></td>
        <td>(BoolOpt) Verify HTTPS connections.</td>
      </tr>
      <tr>
        <td><option>keyfile</option> = <replaceable>None</replaceable></td>
        <td>(StrOpt) Required if identity server requires client certificate</td>
      </tr>
      <tr>
        <td><option>memcache_pool_conn_get_timeout</option> = <replaceable>10</replaceable></td>
        <td>(IntOpt) (Optional) Number of seconds that an operation will wait to get a memcached client connection from the pool.</td>
      </tr>
      <tr>
        <td><option>memcache_pool_dead_retry</option> = <replaceable>300</replaceable></td>
        <td>(IntOpt) (Optional) Number of seconds memcached server is considered dead before it is tried again.</td>
      </tr>
      <tr>
        <td><option>memcache_pool_maxsize</option> = <replaceable>10</replaceable></td>
        <td>(IntOpt) (Optional) Maximum total number of open connections to every memcached server.</td>
      </tr>
      <tr>
        <td><option>memcache_pool_socket_timeout</option> = <replaceable>3</replaceable></td>
        <td>(IntOpt) (Optional) Socket timeout in seconds for communicating with a memcached server.</td>
      </tr>
      <tr>
        <td><option>memcache_pool_unused_timeout</option> = <replaceable>60</replaceable></td>
        <td>(IntOpt) (Optional) Number of seconds a connection to memcached is held unused in the pool before it is closed.</td>
      </tr>
      <tr>
        <td><option>memcache_secret_key</option> = <replaceable>None</replaceable></td>
        <td>(StrOpt) (Optional, mandatory if memcache_security_strategy is defined) This string is used for key derivation.</td>
      </tr>
      <tr>
        <td><option>memcache_security_strategy</option> = <replaceable>None</replaceable></td>
        <td>(StrOpt) (Optional) If defined, indicate whether token data should be authenticated or authenticated and encrypted. Acceptable values are MAC or ENCRYPT.  If MAC, token data is authenticated (with HMAC) in the cache. If ENCRYPT, token data is encrypted and authenticated in the cache. If the value is not one of these options or empty, auth_token will raise an exception on initialization.</td>
      </tr>
      <tr>
        <td><option>memcache_use_advanced_pool</option> = <replaceable>False</replaceable></td>
        <td>(BoolOpt) (Optional) Use the advanced (eventlet safe) memcached client pool. The advanced pool will only work under python 2.x.</td>
      </tr>
      <tr>
        <td><option>revocation_cache_time</option> = <replaceable>10</replaceable></td>
        <td>(IntOpt) Determines the frequency at which the list of revoked tokens is retrieved from the Identity service (in seconds). A high number of revocation events combined with a low cache duration may significantly reduce performance.</td>
      </tr>
      <tr>
        <td><option>signing_dir</option> = <replaceable>None</replaceable></td>
        <td>(StrOpt) Directory used to cache files related to PKI tokens.</td>
      </tr>
      <tr>
        <td><option>token_cache_time</option> = <replaceable>300</replaceable></td>
        <td>(IntOpt) In order to prevent excessive effort spent validating tokens, the middleware caches previously-seen tokens for a configurable duration (in seconds). Set to -1 to disable caching completely.</td>
      </tr>
    </tbody>
  </table>
</para>