From c8e9a57954dcebcc4c1a11fc7f2cdb48ee4c9961 Mon Sep 17 00:00:00 2001 From: KATO Tomoyuki Date: Sat, 30 Jul 2016 16:01:38 +0900 Subject: [PATCH] [config-ref] consolidate cache configurations into commons Change-Id: I03b1e1277950c5648cc4f4bd4ceec2af143bedd4 Implements: blueprint config-ref-common-sections --- .../source/common-configurations.rst | 1 + .../source/common-configurations/cache.rst | 15 ++++++++++ .../source/compute/config-options.rst | 1 - .../{nova-cache.rst => common-cache.rst} | 4 +-- .../source/tables/heat-common.rst | 28 ------------------- .../source/tables/keystone-cache.rst | 28 ------------------- .../source/tables/zaqar-cache.rst | 28 ------------------- .../heat.flagmappings | 26 ++++++++--------- .../keystone.flagmappings | 26 ++++++++--------- .../keystone.headers | 1 - .../nova.flagmappings | 26 ++++++++--------- .../nova.headers | 1 - .../zaqar.flagmappings | 26 ++++++++--------- .../zaqar.headers | 1 - 14 files changed, 70 insertions(+), 142 deletions(-) create mode 100644 doc/config-reference/source/common-configurations/cache.rst rename doc/config-reference/source/tables/{nova-cache.rst => common-cache.rst} (97%) diff --git a/doc/config-reference/source/common-configurations.rst b/doc/config-reference/source/common-configurations.rst index 3aa893c022..9cdb7c907b 100644 --- a/doc/config-reference/source/common-configurations.rst +++ b/doc/config-reference/source/common-configurations.rst @@ -13,6 +13,7 @@ for shared service and libraries. :maxdepth: 1 common-configurations/auth.rst + common-configurations/cache.rst common-configurations/database.rst common-configurations/logging.rst common-configurations/rpc.rst diff --git a/doc/config-reference/source/common-configurations/cache.rst b/doc/config-reference/source/common-configurations/cache.rst new file mode 100644 index 0000000000..de928c4001 --- /dev/null +++ b/doc/config-reference/source/common-configurations/cache.rst @@ -0,0 +1,15 @@ +==================== +Cache configurations +==================== + +The cache configuration options allow the deployer to control +how an application uses this library. + +These options are supported by: + +* Compute service +* Identity service +* Message service +* Orchestration service + +.. include:: ../tables/common-cache.rst diff --git a/doc/config-reference/source/compute/config-options.rst b/doc/config-reference/source/compute/config-options.rst index 1378fdde6f..ae6e4d00e3 100644 --- a/doc/config-reference/source/compute/config-options.rst +++ b/doc/config-reference/source/compute/config-options.rst @@ -14,7 +14,6 @@ OpenStack Compute service, run .. include:: ../tables/nova-availabilityzones.rst .. include:: ../tables/nova-barbican.rst .. include:: ../tables/nova-ca.rst -.. include:: ../tables/nova-cache.rst .. include:: ../tables/nova-cells.rst .. include:: ../tables/nova-common.rst .. include:: ../tables/nova-compute.rst diff --git a/doc/config-reference/source/tables/nova-cache.rst b/doc/config-reference/source/tables/common-cache.rst similarity index 97% rename from doc/config-reference/source/tables/nova-cache.rst rename to doc/config-reference/source/tables/common-cache.rst index d2c90e68ea..633f5ab55c 100644 --- a/doc/config-reference/source/tables/nova-cache.rst +++ b/doc/config-reference/source/tables/common-cache.rst @@ -8,9 +8,9 @@ autogenerate-config-doc tool from the openstack-doc-tools repository, or ask for help on the documentation mailing list, IRC channel or meeting. -.. _nova-cache: +.. _common-cache: -.. list-table:: Description of Cache configuration options +.. list-table:: Description of cache configuration options :header-rows: 1 :class: config-ref-table diff --git a/doc/config-reference/source/tables/heat-common.rst b/doc/config-reference/source/tables/heat-common.rst index fdff44d659..e287e80edd 100644 --- a/doc/config-reference/source/tables/heat-common.rst +++ b/doc/config-reference/source/tables/heat-common.rst @@ -52,34 +52,6 @@ - (String) Allow reauthentication on token expiry, such that long-running tasks may complete. Note this defeats the expiry of any provided user tokens. * - ``watch_log_file`` = ``False`` - (Boolean) Uses logging handler designed to watch file system. When log file is moved or removed this handler will open a new log file with specified path instantaneously. It makes sense only if log_file option is specified and Linux platform is used. This option is ignored if log_config_append is set. - * - **[cache]** - - - * - ``backend`` = ``dogpile.cache.null`` - - (String) Dogpile.cache backend module. It is recommended that Memcache with pooling (oslo_cache.memcache_pool) or Redis (dogpile.cache.redis) be used in production deployments. Small workloads (single process) like devstack can use the dogpile.cache.memory backend. - * - ``backend_argument`` = ``[]`` - - (Multi-valued) Arguments supplied to the backend module. Specify this option once per argument to be passed to the dogpile.cache backend. Example format: ":". - * - ``config_prefix`` = ``cache.oslo`` - - (String) Prefix for building the configuration dictionary for the cache region. This should not need to be changed unless there is another dogpile.cache region with the same configuration name. - * - ``debug_cache_backend`` = ``False`` - - (Boolean) Extra debugging from the cache backend (cache keys, get/set/delete/etc calls). This is only really useful if you need to see the specific cache-backend get/set/delete calls with the keys/values. Typically this should be left set to false. - * - ``enabled`` = ``False`` - - (Boolean) Global toggle for caching. - * - ``expiration_time`` = ``600`` - - (Integer) Default TTL, in seconds, for any cached item in the dogpile.cache region. This applies to any cached method that doesn't have an explicit cache expiration time defined for it. - * - ``memcache_dead_retry`` = ``300`` - - (Integer) Number of seconds memcached server is considered dead before it is tried again. (dogpile.cache.memcache and oslo_cache.memcache_pool backends only). - * - ``memcache_pool_connection_get_timeout`` = ``10`` - - (Integer) Number of seconds that an operation will wait to get a memcache client connection. - * - ``memcache_pool_maxsize`` = ``10`` - - (Integer) Max total number of open connections to every memcached server. (oslo_cache.memcache_pool backend only). - * - ``memcache_pool_unused_timeout`` = ``60`` - - (Integer) Number of seconds a connection to memcached is held unused in the pool before it is closed. (oslo_cache.memcache_pool backend only). - * - ``memcache_servers`` = ``localhost:11211`` - - (List) Memcache servers in the format of "host:port". (dogpile.cache.memcache and oslo_cache.memcache_pool backends only). - * - ``memcache_socket_timeout`` = ``3`` - - (Integer) Timeout in seconds for every call to a server. (dogpile.cache.memcache and oslo_cache.memcache_pool backends only). - * - ``proxies`` = - - (List) Proxy classes to import that will affect the way the dogpile.cache backend functions. See the dogpile.cache documentation on changing-backend-behavior. * - **[constraint_validation_cache]** - * - ``caching`` = ``True`` diff --git a/doc/config-reference/source/tables/keystone-cache.rst b/doc/config-reference/source/tables/keystone-cache.rst index d1cba0c3a8..241e0c8f59 100644 --- a/doc/config-reference/source/tables/keystone-cache.rst +++ b/doc/config-reference/source/tables/keystone-cache.rst @@ -16,34 +16,6 @@ * - Configuration option = Default value - Description - * - **[cache]** - - - * - ``backend`` = ``dogpile.cache.null`` - - (String) Dogpile.cache backend module. It is recommended that Memcache with pooling (oslo_cache.memcache_pool) or Redis (dogpile.cache.redis) be used in production deployments. Small workloads (single process) like devstack can use the dogpile.cache.memory backend. - * - ``backend_argument`` = ``[]`` - - (Multi-valued) Arguments supplied to the backend module. Specify this option once per argument to be passed to the dogpile.cache backend. Example format: ":". - * - ``config_prefix`` = ``cache.oslo`` - - (String) Prefix for building the configuration dictionary for the cache region. This should not need to be changed unless there is another dogpile.cache region with the same configuration name. - * - ``debug_cache_backend`` = ``False`` - - (Boolean) Extra debugging from the cache backend (cache keys, get/set/delete/etc calls). This is only really useful if you need to see the specific cache-backend get/set/delete calls with the keys/values. Typically this should be left set to false. - * - ``enabled`` = ``False`` - - (Boolean) Global toggle for caching. - * - ``expiration_time`` = ``600`` - - (Integer) Default TTL, in seconds, for any cached item in the dogpile.cache region. This applies to any cached method that doesn't have an explicit cache expiration time defined for it. - * - ``memcache_dead_retry`` = ``300`` - - (Integer) Number of seconds memcached server is considered dead before it is tried again. (dogpile.cache.memcache and oslo_cache.memcache_pool backends only). - * - ``memcache_pool_connection_get_timeout`` = ``10`` - - (Integer) Number of seconds that an operation will wait to get a memcache client connection. - * - ``memcache_pool_maxsize`` = ``10`` - - (Integer) Max total number of open connections to every memcached server. (oslo_cache.memcache_pool backend only). - * - ``memcache_pool_unused_timeout`` = ``60`` - - (Integer) Number of seconds a connection to memcached is held unused in the pool before it is closed. (oslo_cache.memcache_pool backend only). - * - ``memcache_servers`` = ``localhost:11211`` - - (List) Memcache servers in the format of "host:port". (dogpile.cache.memcache and oslo_cache.memcache_pool backends only). - * - ``memcache_socket_timeout`` = ``3`` - - (Integer) Timeout in seconds for every call to a server. (dogpile.cache.memcache and oslo_cache.memcache_pool backends only). - * - ``proxies`` = - - (List) Proxy classes to import that will affect the way the dogpile.cache backend functions. See the dogpile.cache documentation on changing-backend-behavior. * - **[memcache]** - * - ``dead_retry`` = ``300`` diff --git a/doc/config-reference/source/tables/zaqar-cache.rst b/doc/config-reference/source/tables/zaqar-cache.rst index 7087f2e206..fdd0653ae6 100644 --- a/doc/config-reference/source/tables/zaqar-cache.rst +++ b/doc/config-reference/source/tables/zaqar-cache.rst @@ -20,31 +20,3 @@ - * - ``memcached_servers`` = ``None`` - (List) Memcached servers or None for in process cache. - * - **[cache]** - - - * - ``backend`` = ``dogpile.cache.null`` - - (String) Dogpile.cache backend module. It is recommended that Memcache with pooling (oslo_cache.memcache_pool) or Redis (dogpile.cache.redis) be used in production deployments. Small workloads (single process) like devstack can use the dogpile.cache.memory backend. - * - ``backend_argument`` = ``[]`` - - (Multi-valued) Arguments supplied to the backend module. Specify this option once per argument to be passed to the dogpile.cache backend. Example format: ":". - * - ``config_prefix`` = ``cache.oslo`` - - (String) Prefix for building the configuration dictionary for the cache region. This should not need to be changed unless there is another dogpile.cache region with the same configuration name. - * - ``debug_cache_backend`` = ``False`` - - (Boolean) Extra debugging from the cache backend (cache keys, get/set/delete/etc calls). This is only really useful if you need to see the specific cache-backend get/set/delete calls with the keys/values. Typically this should be left set to false. - * - ``enabled`` = ``False`` - - (Boolean) Global toggle for caching. - * - ``expiration_time`` = ``600`` - - (Integer) Default TTL, in seconds, for any cached item in the dogpile.cache region. This applies to any cached method that doesn't have an explicit cache expiration time defined for it. - * - ``memcache_dead_retry`` = ``300`` - - (Integer) Number of seconds memcached server is considered dead before it is tried again. (dogpile.cache.memcache and oslo_cache.memcache_pool backends only). - * - ``memcache_pool_connection_get_timeout`` = ``10`` - - (Integer) Number of seconds that an operation will wait to get a memcache client connection. - * - ``memcache_pool_maxsize`` = ``10`` - - (Integer) Max total number of open connections to every memcached server. (oslo_cache.memcache_pool backend only). - * - ``memcache_pool_unused_timeout`` = ``60`` - - (Integer) Number of seconds a connection to memcached is held unused in the pool before it is closed. (oslo_cache.memcache_pool backend only). - * - ``memcache_servers`` = ``localhost:11211`` - - (List) Memcache servers in the format of "host:port". (dogpile.cache.memcache and oslo_cache.memcache_pool backends only). - * - ``memcache_socket_timeout`` = ``3`` - - (Integer) Timeout in seconds for every call to a server. (dogpile.cache.memcache and oslo_cache.memcache_pool backends only). - * - ``proxies`` = - - (List) Proxy classes to import that will affect the way the dogpile.cache backend functions. See the dogpile.cache documentation on changing-backend-behavior. diff --git a/tools/autogenerate-config-flagmappings/heat.flagmappings b/tools/autogenerate-config-flagmappings/heat.flagmappings index 0a6cb21148..79d7bdfe6f 100644 --- a/tools/autogenerate-config-flagmappings/heat.flagmappings +++ b/tools/autogenerate-config-flagmappings/heat.flagmappings @@ -91,19 +91,19 @@ watch_log_file common zmq_target_expire zeromq auth_password/allowed_auth_uris api auth_password/multi_cloud api -cache/backend common -cache/backend_argument common -cache/config_prefix common -cache/debug_cache_backend common -cache/enabled common -cache/expiration_time common -cache/memcache_dead_retry common -cache/memcache_pool_connection_get_timeout common -cache/memcache_pool_maxsize common -cache/memcache_pool_unused_timeout common -cache/memcache_servers common -cache/memcache_socket_timeout common -cache/proxies common +cache/backend disable +cache/backend_argument disable +cache/config_prefix disable +cache/debug_cache_backend disable +cache/enabled disable +cache/expiration_time disable +cache/memcache_dead_retry disable +cache/memcache_pool_connection_get_timeout disable +cache/memcache_pool_maxsize disable +cache/memcache_pool_unused_timeout disable +cache/memcache_servers disable +cache/memcache_socket_timeout disable +cache/proxies disable clients/ca_file clients clients/cert_file clients clients/endpoint_type clients diff --git a/tools/autogenerate-config-flagmappings/keystone.flagmappings b/tools/autogenerate-config-flagmappings/keystone.flagmappings index 6654b92d67..8ec97e3ab0 100644 --- a/tools/autogenerate-config-flagmappings/keystone.flagmappings +++ b/tools/autogenerate-config-flagmappings/keystone.flagmappings @@ -67,19 +67,19 @@ auth/methods auth auth/oauth1 auth auth/password auth auth/token auth -cache/backend cache -cache/backend_argument cache -cache/config_prefix cache -cache/debug_cache_backend cache -cache/enabled cache -cache/expiration_time cache -cache/memcache_dead_retry cache -cache/memcache_pool_connection_get_timeout cache -cache/memcache_pool_maxsize cache -cache/memcache_pool_unused_timeout cache -cache/memcache_servers cache -cache/memcache_socket_timeout cache -cache/proxies cache +cache/backend disable +cache/backend_argument disable +cache/config_prefix disable +cache/debug_cache_backend disable +cache/enabled disable +cache/expiration_time disable +cache/memcache_dead_retry disable +cache/memcache_pool_connection_get_timeout disable +cache/memcache_pool_maxsize disable +cache/memcache_pool_unused_timeout disable +cache/memcache_servers disable +cache/memcache_socket_timeout disable +cache/proxies disable catalog/cache_time catalog catalog/caching catalog catalog/driver catalog diff --git a/tools/autogenerate-config-flagmappings/keystone.headers b/tools/autogenerate-config-flagmappings/keystone.headers index 6011a7658c..a8abf76c49 100644 --- a/tools/autogenerate-config-flagmappings/keystone.headers +++ b/tools/autogenerate-config-flagmappings/keystone.headers @@ -1,5 +1,4 @@ assignment assignment -cache cache catalog catalog credential credential domain domain diff --git a/tools/autogenerate-config-flagmappings/nova.flagmappings b/tools/autogenerate-config-flagmappings/nova.flagmappings index a69b2fbce9..cbe9edcb2d 100644 --- a/tools/autogenerate-config-flagmappings/nova.flagmappings +++ b/tools/autogenerate-config-flagmappings/nova.flagmappings @@ -356,19 +356,19 @@ barbican/insecure barbican barbican/keyfile barbican barbican/os_region_name barbican barbican/timeout barbican -cache/backend cache -cache/backend_argument cache -cache/config_prefix cache -cache/debug_cache_backend cache -cache/enabled cache -cache/expiration_time cache -cache/memcache_dead_retry cache -cache/memcache_pool_connection_get_timeout cache -cache/memcache_pool_maxsize cache -cache/memcache_pool_unused_timeout cache -cache/memcache_servers cache -cache/memcache_socket_timeout cache -cache/proxies cache +cache/backend disable +cache/backend_argument disable +cache/config_prefix disable +cache/debug_cache_backend disable +cache/enabled disable +cache/expiration_time disable +cache/memcache_dead_retry disable +cache/memcache_pool_connection_get_timeout disable +cache/memcache_pool_maxsize disable +cache/memcache_pool_unused_timeout disable +cache/memcache_servers disable +cache/memcache_socket_timeout disable +cache/proxies disable cells/bandwidth_update_interval quota cells/call_timeout cells cells/capabilities cells diff --git a/tools/autogenerate-config-flagmappings/nova.headers b/tools/autogenerate-config-flagmappings/nova.headers index e6ba40bb8d..cc443b3b68 100644 --- a/tools/autogenerate-config-flagmappings/nova.headers +++ b/tools/autogenerate-config-flagmappings/nova.headers @@ -2,7 +2,6 @@ apiv21 API v2.1 authentication authentication availabilityzones availability zones barbican Barbican -cache Cache cells cell configdrive config drive ephemeral_storage_encryption ephemeral storage encryption diff --git a/tools/autogenerate-config-flagmappings/zaqar.flagmappings b/tools/autogenerate-config-flagmappings/zaqar.flagmappings index e1695d426a..8466937b17 100644 --- a/tools/autogenerate-config-flagmappings/zaqar.flagmappings +++ b/tools/autogenerate-config-flagmappings/zaqar.flagmappings @@ -24,19 +24,19 @@ use_stderr logging use_syslog logging verbose logging watch_log_file logging -cache/backend cache -cache/backend_argument cache -cache/config_prefix cache -cache/debug_cache_backend cache -cache/enabled cache -cache/expiration_time cache -cache/memcache_dead_retry cache -cache/memcache_pool_connection_get_timeout cache -cache/memcache_pool_maxsize cache -cache/memcache_pool_unused_timeout cache -cache/memcache_servers cache -cache/memcache_socket_timeout cache -cache/proxies cache +cache/backend disable +cache/backend_argument disable +cache/config_prefix disable +cache/debug_cache_backend disable +cache/enabled disable +cache/expiration_time disable +cache/memcache_dead_retry disable +cache/memcache_pool_connection_get_timeout disable +cache/memcache_pool_maxsize disable +cache/memcache_pool_unused_timeout disable +cache/memcache_servers disable +cache/memcache_socket_timeout disable +cache/proxies disable certificates/barbican_auth api certificates/cert_manager_type api drivers/management_store drivers diff --git a/tools/autogenerate-config-flagmappings/zaqar.headers b/tools/autogenerate-config-flagmappings/zaqar.headers index 796001dc05..1132329921 100644 --- a/tools/autogenerate-config-flagmappings/zaqar.headers +++ b/tools/autogenerate-config-flagmappings/zaqar.headers @@ -1,5 +1,4 @@ authentication authentication -cache cache drivers drivers mongodb MongoDB pooling pooling