diff --git a/doc/config-reference/source/common-configurations/cache.rst b/doc/config-reference/source/common-configurations/cache.rst index de928c4001..ef876bc040 100644 --- a/doc/config-reference/source/common-configurations/cache.rst +++ b/doc/config-reference/source/common-configurations/cache.rst @@ -10,6 +10,9 @@ These options are supported by: * Compute service * Identity service * Message service +* Networking service * Orchestration service -.. include:: ../tables/common-cache.rst +For a complete list of all available cache configuration options, +see `olso.cache configuration options +`_. diff --git a/doc/config-reference/source/message.rst b/doc/config-reference/source/message.rst index a73ad11e4b..0634b3db58 100644 --- a/doc/config-reference/source/message.rst +++ b/doc/config-reference/source/message.rst @@ -14,7 +14,6 @@ Message service message/zaqar-authentication.rst message/zaqar-pooling.rst message/logs.rst - message/zaqar-cache.rst tables/conf-changes/zaqar.rst The Message service is multi-tenant, fast, reliable, and scalable. It allows diff --git a/doc/config-reference/source/message/zaqar-cache.rst b/doc/config-reference/source/message/zaqar-cache.rst deleted file mode 100644 index 4c3a08d6f9..0000000000 --- a/doc/config-reference/source/message/zaqar-cache.rst +++ /dev/null @@ -1,7 +0,0 @@ -=============== -Caching options -=============== - -The caching used in the Message service is determined by the following options: - -.. include:: ../tables/zaqar-cache.rst diff --git a/doc/config-reference/source/networking/lbaas.rst b/doc/config-reference/source/networking/lbaas.rst index e0edc1f1db..24a4189648 100644 --- a/doc/config-reference/source/networking/lbaas.rst +++ b/doc/config-reference/source/networking/lbaas.rst @@ -25,7 +25,6 @@ Use the following options in the ``/etc/octavia/octavia.conf`` file to configure the octavia service. .. include:: ../tables/octavia-auth_token.rst -.. include:: ../tables/octavia-cache.rst .. include:: ../tables/octavia-common.rst .. include:: ../tables/octavia-rabbitmq.rst .. include:: ../tables/octavia-redis.rst diff --git a/doc/config-reference/source/networking/networking_options_reference.rst b/doc/config-reference/source/networking/networking_options_reference.rst index c4a96c3fc8..cd56ad15ea 100644 --- a/doc/config-reference/source/networking/networking_options_reference.rst +++ b/doc/config-reference/source/networking/networking_options_reference.rst @@ -264,6 +264,5 @@ change security group settings. Misc ~~~~ -.. include:: ../tables/neutron-cache.rst .. include:: ../tables/neutron-fdb_agent.rst .. include:: ../tables/neutron-qos.rst diff --git a/doc/config-reference/source/tables/common-cache.rst b/doc/config-reference/source/tables/common-cache.rst deleted file mode 100644 index 633f5ab55c..0000000000 --- a/doc/config-reference/source/tables/common-cache.rst +++ /dev/null @@ -1,46 +0,0 @@ -.. - Warning: Do not edit this file. It is automatically generated from the - software project's code and your changes will be overwritten. - - The tool to generate this file lives in openstack-doc-tools repository. - - Please make any changes needed in the code, then run the - autogenerate-config-doc tool from the openstack-doc-tools repository, or - ask for help on the documentation mailing list, IRC channel or meeting. - -.. _common-cache: - -.. list-table:: Description of cache configuration options - :header-rows: 1 - :class: config-ref-table - - * - 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. diff --git a/doc/config-reference/source/tables/neutron-cache.rst b/doc/config-reference/source/tables/neutron-cache.rst deleted file mode 100644 index 5c13d7a2c9..0000000000 --- a/doc/config-reference/source/tables/neutron-cache.rst +++ /dev/null @@ -1,50 +0,0 @@ -.. - Warning: Do not edit this file. It is automatically generated from the - software project's code and your changes will be overwritten. - - The tool to generate this file lives in openstack-doc-tools repository. - - Please make any changes needed in the code, then run the - autogenerate-config-doc tool from the openstack-doc-tools repository, or - ask for help on the documentation mailing list, IRC channel or meeting. - -.. _neutron-cache: - -.. list-table:: Description of cache configuration options - :header-rows: 1 - :class: config-ref-table - - * - Configuration option = Default value - - Description - * - **[DEFAULT]** - - - * - ``cache_url`` = - - (String) DEPRECATED: URL to connect to the cache back end. This option is deprecated in the Newton release and will be removed. Please add a [cache] group for oslo.cache in your neutron.conf and add "enable" and "backend" options in this section. - * - **[cache]** - - - * - ``backend`` = ``dogpile.cache.null`` - - (String) Dogpile.cache backend module. It is recommended that Memcache or Redis (dogpile.cache.redis) be used in production deployments. For eventlet-based or highly threaded servers, Memcache with pooling (oslo_cache.memcache_pool) is recommended. For low thread servers, dogpile.cache.memcached is recommended. Test environments with a single instance of the server 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/doc/config-reference/source/tables/neutron-common.rst b/doc/config-reference/source/tables/neutron-common.rst index 7d651d6015..42a508c04e 100644 --- a/doc/config-reference/source/tables/neutron-common.rst +++ b/doc/config-reference/source/tables/neutron-common.rst @@ -36,6 +36,8 @@ - (String) The host IP to bind to * - ``bind_port`` = ``9696`` - (Port number) The port to bind to + * - ``cache_url`` = + - (String) DEPRECATED: URL to connect to the cache back end. This option is deprecated in the Newton release and will be removed. Please add a [cache] group for oslo.cache in your neutron.conf and add "enable" and "backend" options in this section. * - ``core_plugin`` = ``None`` - (String) The core plugin Neutron will use * - ``default_availability_zones`` = diff --git a/doc/config-reference/source/tables/octavia-cache.rst b/doc/config-reference/source/tables/octavia-cache.rst deleted file mode 100644 index 053f241596..0000000000 --- a/doc/config-reference/source/tables/octavia-cache.rst +++ /dev/null @@ -1,22 +0,0 @@ -.. - Warning: Do not edit this file. It is automatically generated from the - software project's code and your changes will be overwritten. - - The tool to generate this file lives in openstack-doc-tools repository. - - Please make any changes needed in the code, then run the - autogenerate-config-doc tool from the openstack-doc-tools repository, or - ask for help on the documentation mailing list, IRC channel or meeting. - -.. _octavia-cache: - -.. list-table:: Description of cache configuration options - :header-rows: 1 - :class: config-ref-table - - * - Configuration option = Default value - - Description - * - **[DEFAULT]** - - - * - ``memcached_servers`` = ``None`` - - (List) Memcached servers or None for in process cache. diff --git a/doc/config-reference/source/tables/zaqar-cache.rst b/doc/config-reference/source/tables/zaqar-cache.rst deleted file mode 100644 index fdd0653ae6..0000000000 --- a/doc/config-reference/source/tables/zaqar-cache.rst +++ /dev/null @@ -1,22 +0,0 @@ -.. - Warning: Do not edit this file. It is automatically generated from the - software project's code and your changes will be overwritten. - - The tool to generate this file lives in openstack-doc-tools repository. - - Please make any changes needed in the code, then run the - autogenerate-config-doc tool from the openstack-doc-tools repository, or - ask for help on the documentation mailing list, IRC channel or meeting. - -.. _zaqar-cache: - -.. list-table:: Description of cache configuration options - :header-rows: 1 - :class: config-ref-table - - * - Configuration option = Default value - - Description - * - **[DEFAULT]** - - - * - ``memcached_servers`` = ``None`` - - (List) Memcached servers or None for in process cache. diff --git a/tools/autogenerate-config-flagmappings/neutron.flagmappings b/tools/autogenerate-config-flagmappings/neutron.flagmappings index 438441825f..ec7d90e530 100644 --- a/tools/autogenerate-config-flagmappings/neutron.flagmappings +++ b/tools/autogenerate-config-flagmappings/neutron.flagmappings @@ -15,7 +15,7 @@ backlog api base_mac common bind_host common bind_port common -cache_url cache +cache_url common client_socket_timeout api conn_pool_min_size disable conn_pool_ttl disable