[config-ref] Update heat tables

Change-Id: I968ebd7a8c0522e0d512d49195a03bd1d95590f1
This commit is contained in:
venkatamahesh 2016-09-03 16:23:18 +05:30
parent 44e31bf4f6
commit 072417342a
22 changed files with 533 additions and 41 deletions

View File

@ -8,13 +8,22 @@ Orchestration uses to talk to other services.
.. include:: ../tables/heat-clients.rst
.. include:: ../tables/heat-clients_backends.rst
.. include:: ../tables/heat-clients_aodh.rst
.. include:: ../tables/heat-clients_barbican.rst
.. include:: ../tables/heat-clients_ceilometer.rst
.. include:: ../tables/heat-clients_cinder.rst
.. include:: ../tables/heat-clients_designate.rst
.. include:: ../tables/heat-clients_glance.rst
.. include:: ../tables/heat-clients_heat.rst
.. include:: ../tables/heat-clients_keystone.rst
.. include:: ../tables/heat-clients_magnum.rst
.. include:: ../tables/heat-clients_manila.rst
.. include:: ../tables/heat-clients_mistral.rst
.. include:: ../tables/heat-clients_monasca.rst
.. include:: ../tables/heat-clients_neutron.rst
.. include:: ../tables/heat-clients_nova.rst
.. include:: ../tables/heat-clients_sahara.rst
.. include:: ../tables/heat-clients_senlin.rst
.. include:: ../tables/heat-clients_swift.rst
.. include:: ../tables/heat-clients_trove.rst
.. include:: ../tables/heat-clients_zaqar.rst

View File

@ -25,4 +25,4 @@
* - ``default_publisher_id`` = ``None``
- (String) Default publisher_id for outgoing notifications.
* - ``transport_url`` = ``None``
- (String) A URL representing the messaging driver to use and its full configuration. If not set, we fall back to the rpc_backend option and driver specific configuration.
- (String) A URL representing the messaging driver to use and its full configuration.

View File

@ -39,7 +39,7 @@
* - ``max_json_body_size`` = ``1048576``
- (Integer) Maximum raw byte size of JSON request body. Should be larger than max_template_size.
* - ``num_engine_workers`` = ``None``
- (Integer) Number of heat-engine processes to fork and run.
- (Integer) Number of heat-engine processes to fork and run. Will default to either to 4 or number of CPUs on the host, whichever is greater.
* - ``observe_on_update`` = ``False``
- (Boolean) On update, enables heat to collect existing resource properties from reality and converge to updated template.
* - ``stack_action_timeout`` = ``3600``
@ -49,7 +49,7 @@
* - ``stack_domain_admin_password`` = ``None``
- (String) Keystone password for stack_domain_admin user.
* - ``stack_scheduler_hints`` = ``False``
- (Boolean) When this feature is enabled, scheduler hints identifying the heat stack context of a server or volume resource are passed to the configured schedulers in nova and cinder, for creates done using heat resource types OS::Cinder::Volume, OS::Nova::Server, and AWS::EC2::Instance. heat_root_stack_id will be set to the id of the root stack of the resource, heat_stack_id will be set to the id of the resource's parent stack, heat_stack_name will be set to the name of the resource's parent stack, heat_path_in_stack will be set to a list of tuples, (stackresourcename, stackname) with list[0] being (None, rootstackname), heat_resource_name will be set to the resource's name, and heat_resource_uuid will be set to the resource's orchestration id.
- (Boolean) When this feature is enabled, scheduler hints identifying the heat stack context of a server or volume resource are passed to the configured schedulers in nova and cinder, for creates done using heat resource types OS::Cinder::Volume, OS::Nova::Server, and AWS::EC2::Instance. heat_root_stack_id will be set to the id of the root stack of the resource, heat_stack_id will be set to the id of the resource's parent stack, heat_stack_name will be set to the name of the resource's parent stack, heat_path_in_stack will be set to a list of comma delimited strings of stackresourcename and stackname with list[0] being 'rootstackname', heat_resource_name will be set to the resource's name, and heat_resource_uuid will be set to the resource's orchestration id.
* - ``stack_user_domain_id`` = ``None``
- (String) Keystone domain ID which contains heat template-defined users. If this option is set, stack_user_domain_name option will be ignored.
* - ``stack_user_domain_name`` = ``None``
@ -106,10 +106,12 @@
- (Integer) Number of workers for Heat service. Default value 0 means, that service will start number of workers equal number of cores on server.
* - **[oslo_middleware]**
-
* - ``enable_proxy_headers_parsing`` = ``False``
- (Boolean) Whether the application is behind a proxy or not. This determines if the middleware should parse the headers or not.
* - ``max_request_body_size`` = ``114688``
- (Integer) The maximum body size for each request, in bytes.
* - ``secure_proxy_ssl_header`` = ``X-Forwarded-Proto``
- (String) DEPRECATED: The HTTP Header that will be used to determine what the original request protocol scheme was, even if it was hidden by an SSL termination proxy.
- (String) DEPRECATED: The HTTP Header that will be used to determine what the original request protocol scheme was, even if it was hidden by a SSL termination proxy.
* - **[oslo_versionedobjects]**
-
* - ``fatal_exception_format_errors`` = ``False``

View File

@ -0,0 +1,30 @@
..
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.
.. _heat-clients_aodh:
.. list-table:: Description of aodh clients configuration options
:header-rows: 1
:class: config-ref-table
* - Configuration option = Default value
- Description
* - **[clients_aodh]**
-
* - ``ca_file`` = ``None``
- (String) Optional CA cert file to use in SSL connections.
* - ``cert_file`` = ``None``
- (String) Optional PEM-formatted certificate chain file.
* - ``endpoint_type`` = ``None``
- (String) Type of endpoint in Identity service catalog to use for communication with the OpenStack service.
* - ``insecure`` = ``None``
- (Boolean) If set, then the server's certificate will not be verified.
* - ``key_file`` = ``None``
- (String) Optional PEM-formatted file that contains the private key.

View File

@ -0,0 +1,30 @@
..
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.
.. _heat-clients_barbican:
.. list-table:: Description of barbican clients configuration options
:header-rows: 1
:class: config-ref-table
* - Configuration option = Default value
- Description
* - **[clients_barbican]**
-
* - ``ca_file`` = ``None``
- (String) Optional CA cert file to use in SSL connections.
* - ``cert_file`` = ``None``
- (String) Optional PEM-formatted certificate chain file.
* - ``endpoint_type`` = ``None``
- (String) Type of endpoint in Identity service catalog to use for communication with the OpenStack service.
* - ``insecure`` = ``None``
- (Boolean) If set, then the server's certificate will not be verified.
* - ``key_file`` = ``None``
- (String) Optional PEM-formatted file that contains the private key.

View File

@ -0,0 +1,30 @@
..
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.
.. _heat-clients_designate:
.. list-table:: Description of designate clients configuration options
:header-rows: 1
:class: config-ref-table
* - Configuration option = Default value
- Description
* - **[clients_designate]**
-
* - ``ca_file`` = ``None``
- (String) Optional CA cert file to use in SSL connections.
* - ``cert_file`` = ``None``
- (String) Optional PEM-formatted certificate chain file.
* - ``endpoint_type`` = ``None``
- (String) Type of endpoint in Identity service catalog to use for communication with the OpenStack service.
* - ``insecure`` = ``None``
- (Boolean) If set, then the server's certificate will not be verified.
* - ``key_file`` = ``None``
- (String) Optional PEM-formatted file that contains the private key.

View File

@ -0,0 +1,30 @@
..
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.
.. _heat-clients_magnum:
.. list-table:: Description of magnum clients configuration options
:header-rows: 1
:class: config-ref-table
* - Configuration option = Default value
- Description
* - **[clients_magnum]**
-
* - ``ca_file`` = ``None``
- (String) Optional CA cert file to use in SSL connections.
* - ``cert_file`` = ``None``
- (String) Optional PEM-formatted certificate chain file.
* - ``endpoint_type`` = ``None``
- (String) Type of endpoint in Identity service catalog to use for communication with the OpenStack service.
* - ``insecure`` = ``None``
- (Boolean) If set, then the server's certificate will not be verified.
* - ``key_file`` = ``None``
- (String) Optional PEM-formatted file that contains the private key.

View File

@ -0,0 +1,30 @@
..
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.
.. _heat-clients_manila:
.. list-table:: Description of manila clients configuration options
:header-rows: 1
:class: config-ref-table
* - Configuration option = Default value
- Description
* - **[clients_manila]**
-
* - ``ca_file`` = ``None``
- (String) Optional CA cert file to use in SSL connections.
* - ``cert_file`` = ``None``
- (String) Optional PEM-formatted certificate chain file.
* - ``endpoint_type`` = ``None``
- (String) Type of endpoint in Identity service catalog to use for communication with the OpenStack service.
* - ``insecure`` = ``None``
- (Boolean) If set, then the server's certificate will not be verified.
* - ``key_file`` = ``None``
- (String) Optional PEM-formatted file that contains the private key.

View File

@ -0,0 +1,30 @@
..
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.
.. _heat-clients_mistral:
.. list-table:: Description of mistral clients configuration options
:header-rows: 1
:class: config-ref-table
* - Configuration option = Default value
- Description
* - **[clients_mistral]**
-
* - ``ca_file`` = ``None``
- (String) Optional CA cert file to use in SSL connections.
* - ``cert_file`` = ``None``
- (String) Optional PEM-formatted certificate chain file.
* - ``endpoint_type`` = ``None``
- (String) Type of endpoint in Identity service catalog to use for communication with the OpenStack service.
* - ``insecure`` = ``None``
- (Boolean) If set, then the server's certificate will not be verified.
* - ``key_file`` = ``None``
- (String) Optional PEM-formatted file that contains the private key.

View File

@ -0,0 +1,30 @@
..
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.
.. _heat-clients_monasca:
.. list-table:: Description of monasca clients configuration options
:header-rows: 1
:class: config-ref-table
* - Configuration option = Default value
- Description
* - **[clients_monasca]**
-
* - ``ca_file`` = ``None``
- (String) Optional CA cert file to use in SSL connections.
* - ``cert_file`` = ``None``
- (String) Optional PEM-formatted certificate chain file.
* - ``endpoint_type`` = ``None``
- (String) Type of endpoint in Identity service catalog to use for communication with the OpenStack service.
* - ``insecure`` = ``None``
- (Boolean) If set, then the server's certificate will not be verified.
* - ``key_file`` = ``None``
- (String) Optional PEM-formatted file that contains the private key.

View File

@ -0,0 +1,30 @@
..
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.
.. _heat-clients_senlin:
.. list-table:: Description of senlin clients configuration options
:header-rows: 1
:class: config-ref-table
* - Configuration option = Default value
- Description
* - **[clients_senlin]**
-
* - ``ca_file`` = ``None``
- (String) Optional CA cert file to use in SSL connections.
* - ``cert_file`` = ``None``
- (String) Optional PEM-formatted certificate chain file.
* - ``endpoint_type`` = ``None``
- (String) Type of endpoint in Identity service catalog to use for communication with the OpenStack service.
* - ``insecure`` = ``None``
- (Boolean) If set, then the server's certificate will not be verified.
* - ``key_file`` = ``None``
- (String) Optional PEM-formatted file that contains the private key.

View File

@ -0,0 +1,30 @@
..
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.
.. _heat-clients_zaqar:
.. list-table:: Description of zaqar clients configuration options
:header-rows: 1
:class: config-ref-table
* - Configuration option = Default value
- Description
* - **[clients_zaqar]**
-
* - ``ca_file`` = ``None``
- (String) Optional CA cert file to use in SSL connections.
* - ``cert_file`` = ``None``
- (String) Optional PEM-formatted certificate chain file.
* - ``endpoint_type`` = ``None``
- (String) Type of endpoint in Identity service catalog to use for communication with the OpenStack service.
* - ``insecure`` = ``None``
- (Boolean) If set, then the server's certificate will not be verified.
* - ``key_file`` = ``None``
- (String) Optional PEM-formatted file that contains the private key.

View File

@ -20,7 +20,7 @@
-
* - ``client_retry_limit`` = ``2``
- (Integer) Number of times to retry when a client encounters an expected intermittent error. Set to 0 to disable retries.
* - ``convergence_engine`` = ``False``
* - ``convergence_engine`` = ``True``
- (Boolean) Enables engine with convergence architecture. All stacks with this option will be created using convergence engine.
* - ``default_deployment_signal_transport`` = ``CFN_SIGNAL``
- (String) Template default for how the server should signal to heat with the deployment output values. CFN_SIGNAL will allow an HTTP POST to a CFN keypair signed URL (requires enabled heat-api-cfn). TEMP_URL_SIGNAL will create a Swift TempURL to be signaled via HTTP PUT (requires object-store endpoint which supports TempURL). HEAT_SIGNAL will allow calls to the Heat API resource-signal using the provided keystone credentials. ZAQAR_SIGNAL will create a dedicated zaqar queue to be signaled using the provided keystone credentials.
@ -31,25 +31,25 @@
* - ``environment_dir`` = ``/etc/heat/environment.d``
- (String) The directory to search for environment files.
* - ``error_wait_time`` = ``240``
- (Integer) Error wait time in seconds for stack action (ie. create or update).
- (Integer) The amount of time in seconds after an error has occurred that tasks may continue to run before being cancelled.
* - ``event_purge_batch_size`` = ``10``
- (Integer) Controls how many events will be pruned whenever a stack's events exceed max_events_per_stack. Set this lower to keep more events at the expense of more frequent purges.
* - ``executor_thread_pool_size`` = ``64``
- (Integer) Size of executor thread pool.
* - ``host`` = ``localhost``
- (String) Name of the engine node. This can be an opaque identifier. It is not necessarily a hostname, FQDN, or IP address.
* - ``keystone_backend`` = ``heat.common.heat_keystoneclient.KeystoneClientV3``
* - ``keystone_backend`` = ``heat.engine.clients.os.keystone.heat_keystoneclient.KsClientWrapper``
- (String) Fully qualified class name to use as a keystone backend.
* - ``max_interface_check_attempts`` = ``10``
- (Integer) Number of times to check whether an interface has been attached or detached.
* - ``memcached_servers`` = ``None``
- (List) Memcached servers or None for in process cache.
* - ``periodic_interval`` = ``60``
- (Integer) Seconds between running periodic tasks.
* - ``plugin_dirs`` = ``/usr/lib64/heat, /usr/lib/heat, /usr/local/lib/heat, /usr/local/lib64/heat``
- (List) List of directories to search for plug-ins.
* - ``reauthentication_auth_method`` =
- (String) Allow reauthentication on token expiry, such that long-running tasks may complete. Note this defeats the expiry of any provided user tokens.
* - ``template_dir`` = ``/etc/heat/templates``
- (String) The directory to search for template files.
* - **[constraint_validation_cache]**
-
* - ``caching`` = ``True``
@ -72,3 +72,13 @@
- (Boolean) Toggle to enable/disable caching when Orchestration Engine retrieves extensions from other OpenStack services. Please note that the global toggle for oslo.cache(enabled=True in [cache] group) must be enabled to use this feature.
* - ``expiration_time`` = ``3600``
- (Integer) TTL, in seconds, for any cached item in the dogpile.cache region used for caching of service extensions.
* - **[volumes]**
-
* - ``backups_enabled`` = ``True``
- (Boolean) Indicate if cinder-backup service is enabled. This is a temporary workaround until cinder-backup service becomes discoverable, see LP#1334856.
* - **[yaql]**
-
* - ``limit_iterators`` = ``200``
- (Integer) The maximum number of elements in collection expression can take for its evaluation.
* - ``memory_quota`` = ``10000``
- (Integer) The maximum size of memory in bytes that expression can take for its evaluation.

View File

@ -24,6 +24,8 @@
- (Integer) Maximum depth allowed when using nested stacks.
* - ``max_resources_per_stack`` = ``1000``
- (Integer) Maximum resources allowed per top-level stack. -1 stands for unlimited.
* - ``max_server_name_length`` = ``53``
- (Integer) Maximum length of a server name to be used in nova.
* - ``max_stacks_per_tenant`` = ``100``
- (Integer) Maximum number of stacks any one tenant may have active at one time.
* - ``max_template_size`` = ``524288``

View File

@ -24,8 +24,10 @@
- (Boolean) Use durable queues in AMQP.
* - ``channel_max`` = ``None``
- (Integer) Maximum number of channels to allow
* - ``connection_factory`` = ``single``
- (String) Connection factory implementation
* - ``default_notification_exchange`` = ``${control_exchange}_notification``
- (String) Exchange name for for sending notifications
- (String) Exchange name for sending notifications
* - ``default_notification_retry_attempts`` = ``-1``
- (Integer) Reconnecting retry count in case of connectivity problem during sending notification, -1 means infinite retry.
* - ``default_rpc_exchange`` = ``${control_exchange}_rpc``
@ -36,7 +38,7 @@
- (Boolean) Deprecated, use rpc_backend=kombu+memory or rpc_backend=fake
* - ``frame_max`` = ``None``
- (Integer) The maximum byte size for an AMQP frame
* - ``heartbeat_interval`` = ``1``
* - ``heartbeat_interval`` = ``3``
- (Integer) How often to send heartbeats for consumer's connections
* - ``heartbeat_rate`` = ``2``
- (Integer) How often times during the heartbeat_timeout_threshold we check the heartbeat.
@ -45,7 +47,7 @@
* - ``host_connection_reconnect_delay`` = ``0.25``
- (Floating point) Set delay for reconnection to some host which has connection error
* - ``kombu_compression`` = ``None``
- (String) EXPERIMENTAL: Possible values are: gzip, bz2. If not set compression will not be used. This option may notbe available in future versions.
- (String) EXPERIMENTAL: Possible values are: gzip, bz2. If not set compression will not be used. This option may not be available in future versions.
* - ``kombu_failover_strategy`` = ``round-robin``
- (String) Determines how the next RabbitMQ node is chosen in case the one we are currently connected to becomes unavailable. Takes effect only if more than one RabbitMQ node is provided in config.
* - ``kombu_missing_consumer_retry_timeout`` = ``60``
@ -68,7 +70,7 @@
- (Floating point) Reconnecting retry delay in case of connectivity problem during sending notification message
* - ``pool_max_overflow`` = ``0``
- (Integer) Maximum number of connections to create above `pool_max_size`.
* - ``pool_max_size`` = ``10``
* - ``pool_max_size`` = ``30``
- (Integer) Maximum number of connections to keep queued.
* - ``pool_recycle`` = ``600``
- (Integer) Lifetime of a connection (since creation) in seconds or None for no recycling. Expired connections are closed on acquire.
@ -79,19 +81,19 @@
* - ``rabbit_ha_queues`` = ``False``
- (Boolean) Try to use HA queues in RabbitMQ (x-ha-policy: all). If you change this option, you must wipe the RabbitMQ database. In RabbitMQ 3.0, queue mirroring is no longer controlled by the x-ha-policy argument when declaring a queue. If you just want to make sure that all queues (except those with auto-generated names) are mirrored across all nodes, run: "rabbitmqctl set_policy HA '^(?!amq\.).*' '{"ha-mode": "all"}' "
* - ``rabbit_host`` = ``localhost``
- (String) The RabbitMQ broker address where a single node is used.
- (String) DEPRECATED: The RabbitMQ broker address where a single node is used. Replaced by [DEFAULT]/transport_url
* - ``rabbit_hosts`` = ``$rabbit_host:$rabbit_port``
- (List) RabbitMQ HA cluster host:port pairs.
- (List) DEPRECATED: RabbitMQ HA cluster host:port pairs. Replaced by [DEFAULT]/transport_url
* - ``rabbit_interval_max`` = ``30``
- (Integer) Maximum interval of RabbitMQ connection retries. Default is 30 seconds.
* - ``rabbit_login_method`` = ``AMQPLAIN``
- (String) The RabbitMQ login method.
* - ``rabbit_max_retries`` = ``0``
- (Integer) Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry count).
- (Integer) DEPRECATED: Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry count).
* - ``rabbit_password`` = ``guest``
- (String) The RabbitMQ password.
- (String) DEPRECATED: The RabbitMQ password. Replaced by [DEFAULT]/transport_url
* - ``rabbit_port`` = ``5672``
- (Port number) The RabbitMQ broker port where a single node is used.
- (Port number) DEPRECATED: The RabbitMQ broker port where a single node is used. Replaced by [DEFAULT]/transport_url
* - ``rabbit_qos_prefetch_count`` = ``0``
- (Integer) Specifies the number of messages to prefetch. Setting to zero allows unlimited messages.
* - ``rabbit_retry_backoff`` = ``2``
@ -103,9 +105,9 @@
* - ``rabbit_use_ssl`` = ``False``
- (Boolean) Connect over SSL for RabbitMQ.
* - ``rabbit_userid`` = ``guest``
- (String) The RabbitMQ userid.
- (String) DEPRECATED: The RabbitMQ userid. Replaced by [DEFAULT]/transport_url
* - ``rabbit_virtual_host`` = ``/``
- (String) The RabbitMQ virtual host.
- (String) DEPRECATED: The RabbitMQ virtual host. Replaced by [DEFAULT]/transport_url
* - ``rpc_listener_prefetch_count`` = ``100``
- (Integer) Max number of not acknowledged message which RabbitMQ can send to rpc listener.
* - ``rpc_queue_expiration`` = ``60``

View File

@ -21,16 +21,16 @@
* - ``check_timeout`` = ``20000``
- (Integer) Time in ms to wait before the transaction is killed.
* - ``host`` = ``127.0.0.1``
- (String) Host to locate redis.
- (String) DEPRECATED: Host to locate redis. Replaced by [DEFAULT]/transport_url
* - ``password`` =
- (String) Password for Redis server (optional).
- (String) DEPRECATED: Password for Redis server (optional). Replaced by [DEFAULT]/transport_url
* - ``port`` = ``6379``
- (Port number) Use this port to connect to redis host.
- (Port number) DEPRECATED: Use this port to connect to redis host. Replaced by [DEFAULT]/transport_url
* - ``sentinel_group_name`` = ``oslo-messaging-zeromq``
- (String) Redis replica set name.
* - ``sentinel_hosts`` =
- (List) List of Redis Sentinel hosts (fault tolerance mode) e.g. [host:port, host1:port ... ]
* - ``socket_timeout`` = ``1000``
- (List) DEPRECATED: List of Redis Sentinel hosts (fault tolerance mode) e.g. [host:port, host1:port ... ] Replaced by [DEFAULT]/transport_url
* - ``socket_timeout`` = ``10000``
- (Integer) Timeout in ms on blocking socket operations
* - ``wait_timeout`` = ``500``
* - ``wait_timeout`` = ``2000``
- (Integer) Time in ms to wait between connection attempts.

View File

@ -21,7 +21,7 @@
* - ``engine_life_check_timeout`` = ``2``
- (Integer) RPC timeout for the engine liveness check that is used for stack locking.
* - ``rpc_backend`` = ``rabbit``
- (String) The messaging driver to use, defaults to rabbit. Other drivers include amqp and zmq.
- (String) DEPRECATED: The messaging driver to use, defaults to rabbit. Other drivers include amqp and zmq. Replaced by [DEFAULT]/transport_url
* - ``rpc_cast_timeout`` = ``-1``
- (Integer) Seconds to wait before a cast expires (TTL). The default value of -1 specifies an infinite linger period. The value of 0 specifies no linger period. Pending messages shall be discarded immediately when the socket is closed. Only supported by impl_zmq.
* - ``rpc_conn_pool_size`` = ``30``
@ -38,18 +38,52 @@
- (String) Directory to use for lock files. For security, the specified directory should only be writable by the user running the processes that need locking. Defaults to environment variable OSLO_LOCK_PATH. If external locks are used, a lock path must be set.
* - **[oslo_messaging_amqp]**
-
* - ``addressing_mode`` = ``dynamic``
- (String) Indicates the addressing mode used by the driver. Permitted values: 'legacy' - use legacy non-routable addressing 'routable' - use routable addresses 'dynamic' - use legacy addresses if the message bus does not support routing otherwise use routable addressing
* - ``allow_insecure_clients`` = ``False``
- (Boolean) Accept clients using either SSL or plain TCP
* - ``anycast_address`` = ``anycast``
- (String) Appended to the address prefix when sending to a group of consumers. Used by the message bus to identify messages that should be delivered in a round-robin fashion across consumers.
* - ``broadcast_prefix`` = ``broadcast``
- (String) address prefix used when broadcasting to all servers
* - ``connection_retry_backoff`` = ``2``
- (Integer) Increase the connection_retry_interval by this many seconds after each unsuccessful failover attempt.
* - ``connection_retry_interval`` = ``1``
- (Integer) Seconds to pause before attempting to re-connect.
* - ``connection_retry_interval_max`` = ``30``
- (Integer) Maximum limit for connection_retry_interval + connection_retry_backoff
* - ``container_name`` = ``None``
- (String) Name for the AMQP container
- (String) Name for the AMQP container. must be globally unique. Defaults to a generated UUID
* - ``default_notification_exchange`` = ``None``
- (String) Exchange name used in notification addresses. Exchange name resolution precedence: Target.exchange if set else default_notification_exchange if set else control_exchange if set else 'notify'
* - ``default_notify_timeout`` = ``30``
- (Integer) The deadline for a sent notification message delivery. Only used when caller does not provide a timeout expiry.
* - ``default_reply_timeout`` = ``30``
- (Integer) The deadline for an rpc reply message delivery. Only used when caller does not provide a timeout expiry.
* - ``default_rpc_exchange`` = ``None``
- (String) Exchange name used in RPC addresses. Exchange name resolution precedence: Target.exchange if set else default_rpc_exchange if set else control_exchange if set else 'rpc'
* - ``default_send_timeout`` = ``30``
- (Integer) The deadline for an rpc cast or call message delivery. Only used when caller does not provide a timeout expiry.
* - ``group_request_prefix`` = ``unicast``
- (String) address prefix when sending to any server in group
* - ``idle_timeout`` = ``0``
- (Integer) Timeout for inactive connections (in seconds)
* - ``link_retry_delay`` = ``10``
- (Integer) Time to pause between re-connecting an AMQP 1.0 link that failed due to a recoverable error.
* - ``multicast_address`` = ``multicast``
- (String) Appended to the address prefix when sending a fanout message. Used by the message bus to identify fanout messages.
* - ``notify_address_prefix`` = ``openstack.org/om/notify``
- (String) Address prefix for all generated Notification addresses
* - ``notify_server_credit`` = ``100``
- (Integer) Window size for incoming Notification messages
* - ``password`` =
- (String) Password for message broker authentication
* - ``reply_link_credit`` = ``200``
- (Integer) Window size for incoming RPC Reply messages.
* - ``rpc_address_prefix`` = ``openstack.org/om/rpc``
- (String) Address prefix for all generated RPC addresses
* - ``rpc_server_credit`` = ``100``
- (Integer) Window size for incoming RPC Request messages
* - ``sasl_config_dir`` =
- (String) Path to directory that contains the SASL configuration
* - ``sasl_config_name`` =
@ -68,6 +102,8 @@
- (String) Password for decrypting ssl_key_file (if encrypted)
* - ``trace`` = ``False``
- (Boolean) Debug: dump AMQP frames to stdout
* - ``unicast_address`` = ``unicast``
- (String) Appended to the address prefix when sending to a particular RPC/Notification server. Used by the message bus to identify messages sent to a single destination.
* - ``username`` =
- (String) User name for message broker authentication
* - **[oslo_messaging_notifications]**

View File

@ -18,9 +18,29 @@
- Description
* - **[profiler]**
-
* - ``connection_string`` = ``messaging://``
- (String) Connection string for a notifier backend. Default value is messaging:// which sets the notifier to oslo_messaging.
Examples of possible values:
* messaging://: use oslo_messaging driver for sending notifications.
* - ``enabled`` = ``False``
- (Boolean) Enables the profiling for all services on this node. Default value is False (fully disable the profiling feature). Possible values: * True: Enables the feature * False: Disables the feature. The profiling cannot be started via this project operations. If the profiling is triggered by another project, this project part will be empty.
- (Boolean) Enables the profiling for all services on this node. Default value is False (fully disable the profiling feature).
Possible values:
* True: Enables the feature
* False: Disables the feature. The profiling cannot be started via this project operations. If the profiling is triggered by another project, this project part will be empty.
* - ``hmac_keys`` = ``SECRET_KEY``
- (String) Secret key(s) to use for encrypting context data for performance profiling. This string value should have the following format: <key1>[,<key2>,...<keyn>], where each key is some random string. A user who triggers the profiling via the REST API has to set one of these keys in the headers of the REST API call to include profiling results of this node for this particular project. Both "enabled" flag and "hmac_keys" config options should be set to enable profiling. Also, to generate correct profiling information across all services at least one key needs to be consistent between OpenStack projects. This ensures it can be used from client side to generate the trace, containing information from all possible resources.
- (String) Secret key(s) to use for encrypting context data for performance profiling. This string value should have the following format: <key1>[,<key2>,...<keyn>], where each key is some random string. A user who triggers the profiling via the REST API has to set one of these keys in the headers of the REST API call to include profiling results of this node for this particular project.
Both "enabled" flag and "hmac_keys" config options should be set to enable profiling. Also, to generate correct profiling information across all services at least one key needs to be consistent between OpenStack projects. This ensures it can be used from client side to generate the trace, containing information from all possible resources.
* - ``trace_sqlalchemy`` = ``False``
- (Boolean) Enables SQL requests profiling in services. Default value is False (SQL requests won't be traced). Possible values: * True: Enables SQL requests profiling. Each SQL query will be part of the trace and can the be analyzed by how much time was spent for that. * False: Disables SQL requests profiling. The spent time is only shown on a higher level of operations. Single SQL queries cannot be analyzed this way.
- (Boolean) Enables SQL requests profiling in services. Default value is False (SQL requests won't be traced).
Possible values:
* True: Enables SQL requests profiling. Each SQL query will be part of the trace and can the be analyzed by how much time was spent for that.
* False: Disables SQL requests profiling. The spent time is only shown on a higher level of operations. Single SQL queries cannot be analyzed this way.

View File

@ -18,7 +18,7 @@
- Description
* - **[trustee]**
-
* - ``auth_plugin`` = ``None``
- (String) Name of the plugin to load
* - ``auth_section`` = ``None``
- (String) Config Section from which to load plugin specific options
- (Unknown) Config Section from which to load plugin specific options
* - ``auth_type`` = ``None``
- (Unknown) Authentication type to load

View File

@ -22,8 +22,6 @@
- (String) ZeroMQ bind address. Should be a wildcard (*), an ethernet interface, or IP. The "host" option should point or resolve to this address.
* - ``rpc_zmq_bind_port_retries`` = ``100``
- (Integer) Number of retries to find free port number before fail with ZMQBindError.
* - ``rpc_zmq_concurrency`` = ``eventlet``
- (String) Type of concurrency used. Either "native" or "eventlet"
* - ``rpc_zmq_contexts`` = ``1``
- (Integer) Number of ZeroMQ contexts, defaults to 1.
* - ``rpc_zmq_host`` = ``localhost``
@ -34,11 +32,53 @@
- (String) MatchMaker driver.
* - ``rpc_zmq_max_port`` = ``65536``
- (Integer) Maximal port number for random ports range.
* - ``rpc_zmq_min_port`` = ``49152``
* - ``rpc_zmq_min_port`` = ``49153``
- (Port number) Minimal port number for random ports range.
* - ``rpc_zmq_serialization`` = ``json``
- (String) Default serialization mechanism for serializing/deserializing outgoing/incoming messages
* - ``rpc_zmq_topic_backlog`` = ``None``
- (Integer) Maximum number of ingress messages to locally buffer per topic. Default is unlimited.
* - ``use_pub_sub`` = ``True``
- (Boolean) Use PUB/SUB pattern for fanout methods. PUB/SUB always uses proxy.
* - ``zmq_target_expire`` = ``120``
* - ``zmq_immediate`` = ``False``
- (Boolean) This option configures round-robin mode in zmq socket. True means not keeping a queue when server side disconnects. False means to keep queue and messages even if server is disconnected, when the server appears we send all accumulated messages to it.
* - ``zmq_target_expire`` = ``300``
- (Integer) Expiration timeout in seconds of a name service record about existing target ( < 0 means no timeout).
* - ``zmq_target_update`` = ``180``
- (Integer) Update period in seconds of a name service record about existing target.
* - **[oslo_messaging_zmq]**
-
* - ``rpc_cast_timeout`` = ``-1``
- (Integer) Seconds to wait before a cast expires (TTL). The default value of -1 specifies an infinite linger period. The value of 0 specifies no linger period. Pending messages shall be discarded immediately when the socket is closed. Only supported by impl_zmq.
* - ``rpc_poll_timeout`` = ``1``
- (Integer) The default number of seconds that poll should wait. Poll raises timeout exception when timeout expired.
* - ``rpc_zmq_bind_address`` = ``*``
- (String) ZeroMQ bind address. Should be a wildcard (*), an ethernet interface, or IP. The "host" option should point or resolve to this address.
* - ``rpc_zmq_bind_port_retries`` = ``100``
- (Integer) Number of retries to find free port number before fail with ZMQBindError.
* - ``rpc_zmq_contexts`` = ``1``
- (Integer) Number of ZeroMQ contexts, defaults to 1.
* - ``rpc_zmq_host`` = ``localhost``
- (String) Name of this node. Must be a valid hostname, FQDN, or IP address. Must match "host" option, if running Nova.
* - ``rpc_zmq_ipc_dir`` = ``/var/run/openstack``
- (String) Directory for holding IPC sockets.
* - ``rpc_zmq_matchmaker`` = ``redis``
- (String) MatchMaker driver.
* - ``rpc_zmq_max_port`` = ``65536``
- (Integer) Maximal port number for random ports range.
* - ``rpc_zmq_min_port`` = ``49153``
- (Port number) Minimal port number for random ports range.
* - ``rpc_zmq_serialization`` = ``json``
- (String) Default serialization mechanism for serializing/deserializing outgoing/incoming messages
* - ``rpc_zmq_topic_backlog`` = ``None``
- (Integer) Maximum number of ingress messages to locally buffer per topic. Default is unlimited.
* - ``use_pub_sub`` = ``True``
- (Boolean) Use PUB/SUB pattern for fanout methods. PUB/SUB always uses proxy.
* - ``use_router_proxy`` = ``True``
- (Boolean) Use ROUTER remote proxy.
* - ``zmq_immediate`` = ``False``
- (Boolean) This option configures round-robin mode in zmq socket. True means not keeping a queue when server side disconnects. False means to keep queue and messages even if server is disconnected, when the server appears we send all accumulated messages to it.
* - ``zmq_target_expire`` = ``300``
- (Integer) Expiration timeout in seconds of a name service record about existing target ( < 0 means no timeout).
* - ``zmq_target_update`` = ``180``
- (Integer) Update period in seconds of a name service record about existing target.

View File

@ -2,6 +2,8 @@ action_retry_limit api
auth_encryption_key crypt
client_retry_limit common
cloud_backend clients_backends
conn_pool_min_size disable
conn_pool_ttl disable
control_exchange amqp
convergence_engine common
debug disable
@ -47,9 +49,9 @@ max_interface_check_attempts common
max_json_body_size api
max_nested_stack_depth quota
max_resources_per_stack quota
max_server_name_length quota
max_stacks_per_tenant quota
max_template_size quota
memcached_servers common
num_engine_workers api
observe_on_update api
onready notification
@ -65,13 +67,13 @@ rpc_poll_timeout rpc
rpc_response_timeout rpc
rpc_zmq_bind_address zeromq
rpc_zmq_bind_port_retries zeromq
rpc_zmq_concurrency zeromq
rpc_zmq_contexts zeromq
rpc_zmq_host zeromq
rpc_zmq_ipc_dir zeromq
rpc_zmq_matchmaker zeromq
rpc_zmq_max_port zeromq
rpc_zmq_min_port zeromq
rpc_zmq_serialization zeromq
rpc_zmq_topic_backlog zeromq
stack_action_timeout api
stack_domain_admin api
@ -81,14 +83,18 @@ stack_user_domain_id api
stack_user_domain_name api
stale_token_duration api
syslog_log_facility disable
template_dir common
transport_url amqp
trusts_delegated_roles api
use_pub_sub zeromq
use_router_proxy disable
use_stderr disable
use_syslog disable
verbose disable
watch_log_file disable
zmq_immediate zeromq
zmq_target_expire zeromq
zmq_target_update zeromq
auth_password/allowed_auth_uris api
auth_password/multi_cloud api
cache/backend disable
@ -109,6 +115,16 @@ clients/cert_file clients
clients/endpoint_type clients
clients/insecure clients
clients/key_file clients
clients_aodh/ca_file clients_aodh
clients_aodh/cert_file clients_aodh
clients_aodh/endpoint_type clients_aodh
clients_aodh/insecure clients_aodh
clients_aodh/key_file clients_aodh
clients_barbican/ca_file clients_barbican
clients_barbican/cert_file clients_barbican
clients_barbican/endpoint_type clients_barbican
clients_barbican/insecure clients_barbican
clients_barbican/key_file clients_barbican
clients_ceilometer/ca_file clients_ceilometer
clients_ceilometer/cert_file clients_ceilometer
clients_ceilometer/endpoint_type clients_ceilometer
@ -120,6 +136,11 @@ clients_cinder/endpoint_type clients_cinder
clients_cinder/http_log_debug clients_cinder
clients_cinder/insecure clients_cinder
clients_cinder/key_file clients_cinder
clients_designate/ca_file clients_designate
clients_designate/cert_file clients_designate
clients_designate/endpoint_type clients_designate
clients_designate/insecure clients_designate
clients_designate/key_file clients_designate
clients_glance/ca_file clients_glance
clients_glance/cert_file clients_glance
clients_glance/endpoint_type clients_glance
@ -137,6 +158,26 @@ clients_keystone/cert_file clients_keystone
clients_keystone/endpoint_type clients_keystone
clients_keystone/insecure clients_keystone
clients_keystone/key_file clients_keystone
clients_magnum/ca_file clients_magnum
clients_magnum/cert_file clients_magnum
clients_magnum/endpoint_type clients_magnum
clients_magnum/insecure clients_magnum
clients_magnum/key_file clients_magnum
clients_manila/ca_file clients_manila
clients_manila/cert_file clients_manila
clients_manila/endpoint_type clients_manila
clients_manila/insecure clients_manila
clients_manila/key_file clients_manila
clients_mistral/ca_file clients_mistral
clients_mistral/cert_file clients_mistral
clients_mistral/endpoint_type clients_mistral
clients_mistral/insecure clients_mistral
clients_mistral/key_file clients_mistral
clients_monasca/ca_file clients_monasca
clients_monasca/cert_file clients_monasca
clients_monasca/endpoint_type clients_monasca
clients_monasca/insecure clients_monasca
clients_monasca/key_file clients_monasca
clients_neutron/ca_file clients_neutron
clients_neutron/cert_file clients_neutron
clients_neutron/endpoint_type clients_neutron
@ -153,6 +194,11 @@ clients_sahara/cert_file clients_sahara
clients_sahara/endpoint_type clients_sahara
clients_sahara/insecure clients_sahara
clients_sahara/key_file clients_sahara
clients_senlin/ca_file clients_senlin
clients_senlin/cert_file clients_senlin
clients_senlin/endpoint_type clients_senlin
clients_senlin/insecure clients_senlin
clients_senlin/key_file clients_senlin
clients_swift/ca_file clients_swift
clients_swift/cert_file clients_swift
clients_swift/endpoint_type clients_swift
@ -163,6 +209,11 @@ clients_trove/cert_file clients_trove
clients_trove/endpoint_type clients_trove
clients_trove/insecure clients_trove
clients_trove/key_file clients_trove
clients_zaqar/ca_file clients_zaqar
clients_zaqar/cert_file clients_zaqar
clients_zaqar/endpoint_type clients_zaqar
clients_zaqar/insecure clients_zaqar
clients_zaqar/key_file clients_zaqar
constraint_validation_cache/caching common
constraint_validation_cache/expiration_time common
cors/allow_credentials disable
@ -278,12 +329,29 @@ matchmaker_redis/socket_timeout redis
matchmaker_redis/wait_timeout redis
oslo_concurrency/disable_process_locking rpc
oslo_concurrency/lock_path rpc
oslo_messaging_amqp/addressing_mode rpc
oslo_messaging_amqp/allow_insecure_clients rpc
oslo_messaging_amqp/anycast_address rpc
oslo_messaging_amqp/broadcast_prefix rpc
oslo_messaging_amqp/connection_retry_backoff rpc
oslo_messaging_amqp/connection_retry_interval rpc
oslo_messaging_amqp/connection_retry_interval_max rpc
oslo_messaging_amqp/container_name rpc
oslo_messaging_amqp/default_notification_exchange rpc
oslo_messaging_amqp/default_notify_timeout rpc
oslo_messaging_amqp/default_reply_timeout rpc
oslo_messaging_amqp/default_rpc_exchange rpc
oslo_messaging_amqp/default_send_timeout rpc
oslo_messaging_amqp/group_request_prefix rpc
oslo_messaging_amqp/idle_timeout rpc
oslo_messaging_amqp/link_retry_delay rpc
oslo_messaging_amqp/multicast_address rpc
oslo_messaging_amqp/notify_address_prefix rpc
oslo_messaging_amqp/notify_server_credit rpc
oslo_messaging_amqp/password rpc
oslo_messaging_amqp/reply_link_credit rpc
oslo_messaging_amqp/rpc_address_prefix rpc
oslo_messaging_amqp/rpc_server_credit rpc
oslo_messaging_amqp/sasl_config_dir rpc
oslo_messaging_amqp/sasl_config_name rpc
oslo_messaging_amqp/sasl_mechanisms rpc
@ -293,6 +361,7 @@ oslo_messaging_amqp/ssl_cert_file rpc
oslo_messaging_amqp/ssl_key_file rpc
oslo_messaging_amqp/ssl_key_password rpc
oslo_messaging_amqp/trace rpc
oslo_messaging_amqp/unicast_address rpc
oslo_messaging_amqp/username rpc
oslo_messaging_notifications/driver rpc
oslo_messaging_notifications/topics rpc
@ -300,6 +369,7 @@ oslo_messaging_notifications/transport_url rpc
oslo_messaging_rabbit/amqp_auto_delete rabbitmq
oslo_messaging_rabbit/amqp_durable_queues rabbitmq
oslo_messaging_rabbit/channel_max rabbitmq
oslo_messaging_rabbit/connection_factory rabbitmq
oslo_messaging_rabbit/default_notification_exchange rabbitmq
oslo_messaging_rabbit/default_notification_retry_attempts rabbitmq
oslo_messaging_rabbit/default_rpc_exchange rabbitmq
@ -352,6 +422,24 @@ oslo_messaging_rabbit/socket_timeout rabbitmq
oslo_messaging_rabbit/ssl rabbitmq
oslo_messaging_rabbit/ssl_options rabbitmq
oslo_messaging_rabbit/tcp_user_timeout rabbitmq
oslo_messaging_zmq/rpc_cast_timeout zeromq
oslo_messaging_zmq/rpc_poll_timeout zeromq
oslo_messaging_zmq/rpc_zmq_bind_address zeromq
oslo_messaging_zmq/rpc_zmq_bind_port_retries zeromq
oslo_messaging_zmq/rpc_zmq_contexts zeromq
oslo_messaging_zmq/rpc_zmq_host zeromq
oslo_messaging_zmq/rpc_zmq_ipc_dir zeromq
oslo_messaging_zmq/rpc_zmq_matchmaker zeromq
oslo_messaging_zmq/rpc_zmq_max_port zeromq
oslo_messaging_zmq/rpc_zmq_min_port zeromq
oslo_messaging_zmq/rpc_zmq_serialization zeromq
oslo_messaging_zmq/rpc_zmq_topic_backlog zeromq
oslo_messaging_zmq/use_pub_sub zeromq
oslo_messaging_zmq/use_router_proxy zeromq
oslo_messaging_zmq/zmq_immediate zeromq
oslo_messaging_zmq/zmq_target_expire zeromq
oslo_messaging_zmq/zmq_target_update zeromq
oslo_middleware/enable_proxy_headers_parsing api
oslo_middleware/max_request_body_size api
oslo_middleware/secure_proxy_ssl_header api
oslo_policy/policy_default_rule disable
@ -360,6 +448,7 @@ oslo_policy/policy_file disable
oslo_versionedobjects/fatal_exception_format_errors api
paste_deploy/api_paste_config api
paste_deploy/flavor api
profiler/connection_string testing
profiler/enabled testing
profiler/hmac_keys testing
profiler/trace_sqlalchemy testing
@ -368,5 +457,8 @@ resource_finder_cache/expiration_time common
revision/heat_revision common
service_extension_cache/caching common
service_extension_cache/expiration_time common
trustee/auth_plugin trustee
trustee/auth_section trustee
trustee/auth_type trustee
volumes/backups_enabled common
yaql/limit_iterators common
yaql/memory_quota common

View File

@ -1,15 +1,24 @@
cfn_api Cloudformation-compatible API
clients_aodh aodh clients
clients_backends client backends
clients_barbican barbican clients
clients_ceilometer ceilometer clients
clients_cinder cinder clients
clients_designate designate clients
clients_glance glance clients
clients_heat heat clients
clients_keystone keystone clients
clients_magnum magnum clients
clients_manila manila clients
clients_mistral mistral clients
clients_monasca monasca clients
clients_neutron neutron clients
clients_nova nova clients
clients_sahara sahara clients
clients_senlin senlin clients
clients_swift swift clients
clients_trove trove clients
clients_zaqar zaqar clients
cloudwatch_api CloudWatch API
crypt crypt
loadbalancer load balancer