[config-ref] update zaqar config options for Ocata

Change-Id: I4bf9fcbe780d7fe329b2c7a5e9ff592ccb2c8363
This commit is contained in:
KATO Tomoyuki 2017-02-13 17:46:11 +09:00
parent bde00b78aa
commit a307e6a3c6
7 changed files with 324 additions and 0 deletions

View File

@ -56,4 +56,5 @@ The following tables detail the available options:
.. include:: ../tables/zaqar-mongodb.rst
.. include:: ../tables/zaqar-redis.rst
.. include:: ../tables/zaqar-sqlalchemy.rst
.. include:: ../tables/zaqar-swift.rst

View File

@ -0,0 +1,66 @@
..
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-profiler:
.. list-table:: Description of profiler configuration options
:header-rows: 1
:class: config-ref-table
* - Configuration option = Default value
- 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.
* mongodb://127.0.0.1:27017 : use mongodb driver for sending notifications.
* elasticsearch://127.0.0.1:9200 : use elasticsearch 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.
* - ``es_doc_type`` = ``notification``
- (String) Document type for notification indexing in elasticsearch.
* - ``es_scroll_size`` = ``10000``
- (Integer) Elasticsearch splits large requests in batches. This parameter defines maximum size of each batch (for example: es_scroll_size=10000).
* - ``es_scroll_time`` = ``2m``
- (String) This parameter is a time value parameter (for example: es_scroll_time=2m), indicating for how long the nodes that participate in the search will maintain relevant resources in order to continue and support it.
* - ``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.
* - ``sentinel_service_name`` = ``mymaster``
- (String) Redissentinel uses a service name to identify a master redis service. This parameter defines the name (for example: sentinal_service_name=mymaster).
* - ``socket_timeout`` = ``0.1``
- (Floating point) Redissentinel provides a timeout option on the connections. This parameter defines that timeout (for example: socket_timeout=0.1).
* - ``trace_management_store`` = ``False``
- (Boolean) If False doesn't trace any management store requests.
* - ``trace_message_store`` = ``False``
- (Boolean) If False doesn't trace any message store requests.
* - ``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.
* - ``trace_wsgi_transport`` = ``False``
- (Boolean) If False doesn't trace any transport requests.Please note that it doesn't work for websocket now.

View File

@ -32,3 +32,21 @@
- (Floating point) Base sleep interval between attempts to reconnect after a redis node failover.
* - ``uri`` = ``redis://127.0.0.1:6379``
- (String) Redis connection URI, taking one of three forms. For a direct connection to a Redis server, use the form "redis://host[:port][?options]", where port defaults to 6379 if not specified. For an HA master-slave Redis cluster using Redis Sentinel, use the form "redis://host1[:port1][,host2[:port2],...,hostN[:portN]][?options]", where each host specified corresponds to an instance of redis-sentinel. In this form, the name of the Redis master used in the Sentinel configuration must be included in the query string as "master=<name>". Finally, to connect to a local instance of Redis over a unix socket, you may use the form "redis:/path/to/redis.sock[?options]". In all forms, the "socket_timeout" option may be specified in the query string. Its value is given in seconds. If not provided, "socket_timeout" defaults to 0.1 seconds.
* - **[matchmaker_redis]**
-
* - ``check_timeout`` = ``20000``
- (Integer) Time in ms to wait before the transaction is killed.
* - ``host`` = ``127.0.0.1``
- (String) DEPRECATED: Host to locate redis. Replaced by [DEFAULT]/transport_url
* - ``password`` =
- (String) DEPRECATED: Password for Redis server (optional). Replaced by [DEFAULT]/transport_url
* - ``port`` = ``6379``
- (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) 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`` = ``2000``
- (Integer) Time in ms to wait between connection attempts.

View File

@ -0,0 +1,26 @@
..
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-swift:
.. list-table:: Description of swift configuration options
:header-rows: 1
:class: config-ref-table
* - Configuration option = Default value
- Description
* - **[drivers:message_store:swift]**
-
* - ``auth_url`` = ``http://127.0.0.1:5000/v3/``
- (String) URI of Keystone endpoint to discover Swift
* - ``insecure`` = ``False``
- (String) Don't check SSL certificate
* - ``uri`` = ``swift://demo:nomoresecrete@/demo``
- (String) Custom URI describing the swift connection.

View File

@ -30,6 +30,8 @@
- (Integer) Defines the maximum message grace period in seconds.
* - ``max_claim_ttl`` = ``43200``
- (Integer) Maximum length of a message in claimed state.
* - ``max_flavors_per_page`` = ``20``
- (Integer) Defines the maximum number of flavors per page.
* - ``max_message_ttl`` = ``1209600``
- (Integer) Maximum amount of time a message will be available.
* - ``max_messages_per_claim_or_pop`` = ``20``
@ -38,6 +40,8 @@
- (Integer) Defines the maximum number of messages per page.
* - ``max_messages_post_size`` = ``262144``
- (Integer) Defines the maximum size of message posts.
* - ``max_pools_per_page`` = ``20``
- (Integer) Defines the maximum number of pools per page.
* - ``max_queue_metadata`` = ``65536``
- (Integer) Defines the maximum amount of metadata in a queue.
* - ``max_queues_per_page`` = ``20``

View File

@ -1,8 +1,12 @@
admin_mode api
auth_strategy authentication
conn_pool_min_size disable
conn_pool_ttl disable
control_exchange disable
debug disable
default_log_levels disable
enable_deprecated_api_versions api
executor_thread_pool_size disable
fatal_deprecations disable
instance_format disable
instance_uuid_format disable
@ -17,12 +21,49 @@ logging_exception_prefix disable
logging_user_identity_format disable
pooling pooling
publish_errors disable
rate_limit_burst disable
rate_limit_except_level disable
rate_limit_interval disable
rpc_ack_timeout_base disable
rpc_ack_timeout_multiplier disable
rpc_backend disable
rpc_conn_pool_size disable
rpc_message_ttl disable
rpc_poll_timeout disable
rpc_response_timeout disable
rpc_retry_attempts disable
rpc_thread_pool_size disable
rpc_use_acks disable
rpc_zmq_bind_address disable
rpc_zmq_bind_port_retries disable
rpc_zmq_contexts disable
rpc_zmq_host disable
rpc_zmq_ipc_dir disable
rpc_zmq_matchmaker disable
rpc_zmq_max_port disable
rpc_zmq_min_port disable
rpc_zmq_serialization disable
rpc_zmq_topic_backlog disable
subscribe_on disable
syslog_log_facility disable
transport_url disable
unreliable api
use_dynamic_connections disable
use_pub_sub disable
use_router_proxy disable
use_stderr disable
use_syslog disable
verbose disable
watch_log_file disable
zmq_failover_connections disable
zmq_immediate disable
zmq_linger disable
zmq_target_expire disable
zmq_target_update disable
zmq_tcp_keepalive disable
zmq_tcp_keepalive_cnt disable
zmq_tcp_keepalive_idle disable
zmq_tcp_keepalive_intvl disable
cache/backend disable
cache/backend_argument disable
cache/config_prefix disable
@ -69,6 +110,9 @@ drivers:message_store:mongodb/uri mongodb
drivers:message_store:redis/max_reconnect_attempts redis
drivers:message_store:redis/reconnect_sleep redis
drivers:message_store:redis/uri redis
drivers:message_store:swift/auth_url swift
drivers:message_store:swift/insecure swift
drivers:message_store:swift/uri swift
drivers:transport:websocket/bind websocket
drivers:transport:websocket/external_port websocket
drivers:transport:websocket/port websocket
@ -110,15 +154,176 @@ keystone_authtoken/memcache_use_advanced_pool disable
keystone_authtoken/memcached_servers disable
keystone_authtoken/region_name disable
keystone_authtoken/revocation_cache_time disable
keystone_authtoken/service_token_roles disable
keystone_authtoken/service_token_roles_required disable
keystone_authtoken/signing_dir disable
keystone_authtoken/token_cache_time disable
matchmaker_redis/check_timeout redis
matchmaker_redis/host redis
matchmaker_redis/password redis
matchmaker_redis/port redis
matchmaker_redis/sentinel_group_name redis
matchmaker_redis/sentinel_hosts redis
matchmaker_redis/socket_timeout redis
matchmaker_redis/wait_timeout redis
notification/max_notifier_workers api
notification/require_confirmation api
notification/smtp_command api
oslo_concurrency/disable_process_locking disable
oslo_concurrency/lock_path disable
oslo_messaging_amqp/addressing_mode disable
oslo_messaging_amqp/allow_insecure_clients disable
oslo_messaging_amqp/anycast_address disable
oslo_messaging_amqp/broadcast_prefix disable
oslo_messaging_amqp/connection_retry_backoff disable
oslo_messaging_amqp/connection_retry_interval disable
oslo_messaging_amqp/connection_retry_interval_max disable
oslo_messaging_amqp/container_name disable
oslo_messaging_amqp/default_notification_exchange disable
oslo_messaging_amqp/default_notify_timeout disable
oslo_messaging_amqp/default_reply_retry disable
oslo_messaging_amqp/default_reply_timeout disable
oslo_messaging_amqp/default_rpc_exchange disable
oslo_messaging_amqp/default_send_timeout disable
oslo_messaging_amqp/default_sender_link_timeout disable
oslo_messaging_amqp/group_request_prefix disable
oslo_messaging_amqp/idle_timeout disable
oslo_messaging_amqp/link_retry_delay disable
oslo_messaging_amqp/multicast_address disable
oslo_messaging_amqp/notify_address_prefix disable
oslo_messaging_amqp/notify_server_credit disable
oslo_messaging_amqp/password disable
oslo_messaging_amqp/pre_settled disable
oslo_messaging_amqp/reply_link_credit disable
oslo_messaging_amqp/rpc_address_prefix disable
oslo_messaging_amqp/rpc_server_credit disable
oslo_messaging_amqp/sasl_config_dir disable
oslo_messaging_amqp/sasl_config_name disable
oslo_messaging_amqp/sasl_mechanisms disable
oslo_messaging_amqp/server_request_prefix disable
oslo_messaging_amqp/ssl_ca_file disable
oslo_messaging_amqp/ssl_cert_file disable
oslo_messaging_amqp/ssl_key_file disable
oslo_messaging_amqp/ssl_key_password disable
oslo_messaging_amqp/trace disable
oslo_messaging_amqp/unicast_address disable
oslo_messaging_amqp/username disable
oslo_messaging_kafka/conn_pool_min_size disable
oslo_messaging_kafka/conn_pool_ttl disable
oslo_messaging_kafka/consumer_group disable
oslo_messaging_kafka/kafka_consumer_timeout disable
oslo_messaging_kafka/kafka_default_host disable
oslo_messaging_kafka/kafka_default_port disable
oslo_messaging_kafka/kafka_max_fetch_bytes disable
oslo_messaging_kafka/pool_size disable
oslo_messaging_kafka/producer_batch_size disable
oslo_messaging_kafka/producer_batch_timeout disable
oslo_messaging_notifications/driver disable
oslo_messaging_notifications/topics disable
oslo_messaging_notifications/transport_url disable
oslo_messaging_rabbit/amqp_auto_delete disable
oslo_messaging_rabbit/amqp_durable_queues disable
oslo_messaging_rabbit/channel_max disable
oslo_messaging_rabbit/connection_factory disable
oslo_messaging_rabbit/default_notification_exchange disable
oslo_messaging_rabbit/default_notification_retry_attempts disable
oslo_messaging_rabbit/default_rpc_exchange disable
oslo_messaging_rabbit/default_rpc_retry_attempts disable
oslo_messaging_rabbit/default_serializer_type disable
oslo_messaging_rabbit/fake_rabbit disable
oslo_messaging_rabbit/frame_max disable
oslo_messaging_rabbit/heartbeat_interval disable
oslo_messaging_rabbit/heartbeat_rate disable
oslo_messaging_rabbit/heartbeat_timeout_threshold disable
oslo_messaging_rabbit/host_connection_reconnect_delay disable
oslo_messaging_rabbit/kombu_compression disable
oslo_messaging_rabbit/kombu_failover_strategy disable
oslo_messaging_rabbit/kombu_missing_consumer_retry_timeout disable
oslo_messaging_rabbit/kombu_reconnect_delay disable
oslo_messaging_rabbit/kombu_ssl_ca_certs disable
oslo_messaging_rabbit/kombu_ssl_certfile disable
oslo_messaging_rabbit/kombu_ssl_keyfile disable
oslo_messaging_rabbit/kombu_ssl_version disable
oslo_messaging_rabbit/notification_listener_prefetch_count disable
oslo_messaging_rabbit/notification_persistence disable
oslo_messaging_rabbit/notification_retry_delay disable
oslo_messaging_rabbit/pool_max_overflow disable
oslo_messaging_rabbit/pool_max_size disable
oslo_messaging_rabbit/pool_recycle disable
oslo_messaging_rabbit/pool_stale disable
oslo_messaging_rabbit/pool_timeout disable
oslo_messaging_rabbit/rabbit_ha_queues disable
oslo_messaging_rabbit/rabbit_host disable
oslo_messaging_rabbit/rabbit_hosts disable
oslo_messaging_rabbit/rabbit_interval_max disable
oslo_messaging_rabbit/rabbit_login_method disable
oslo_messaging_rabbit/rabbit_max_retries disable
oslo_messaging_rabbit/rabbit_password disable
oslo_messaging_rabbit/rabbit_port disable
oslo_messaging_rabbit/rabbit_qos_prefetch_count disable
oslo_messaging_rabbit/rabbit_retry_backoff disable
oslo_messaging_rabbit/rabbit_retry_interval disable
oslo_messaging_rabbit/rabbit_transient_queues_ttl disable
oslo_messaging_rabbit/rabbit_use_ssl disable
oslo_messaging_rabbit/rabbit_userid disable
oslo_messaging_rabbit/rabbit_virtual_host disable
oslo_messaging_rabbit/rpc_listener_prefetch_count disable
oslo_messaging_rabbit/rpc_queue_expiration disable
oslo_messaging_rabbit/rpc_reply_exchange disable
oslo_messaging_rabbit/rpc_reply_listener_prefetch_count disable
oslo_messaging_rabbit/rpc_reply_retry_attempts disable
oslo_messaging_rabbit/rpc_reply_retry_delay disable
oslo_messaging_rabbit/rpc_retry_delay disable
oslo_messaging_rabbit/socket_timeout disable
oslo_messaging_rabbit/ssl disable
oslo_messaging_rabbit/ssl_options disable
oslo_messaging_rabbit/tcp_user_timeout disable
oslo_messaging_zmq/rpc_ack_timeout_base disable
oslo_messaging_zmq/rpc_ack_timeout_multiplier disable
oslo_messaging_zmq/rpc_message_ttl disable
oslo_messaging_zmq/rpc_poll_timeout disable
oslo_messaging_zmq/rpc_retry_attempts disable
oslo_messaging_zmq/rpc_thread_pool_size disable
oslo_messaging_zmq/rpc_use_acks disable
oslo_messaging_zmq/rpc_zmq_bind_address disable
oslo_messaging_zmq/rpc_zmq_bind_port_retries disable
oslo_messaging_zmq/rpc_zmq_contexts disable
oslo_messaging_zmq/rpc_zmq_host disable
oslo_messaging_zmq/rpc_zmq_ipc_dir disable
oslo_messaging_zmq/rpc_zmq_matchmaker disable
oslo_messaging_zmq/rpc_zmq_max_port disable
oslo_messaging_zmq/rpc_zmq_min_port disable
oslo_messaging_zmq/rpc_zmq_serialization disable
oslo_messaging_zmq/rpc_zmq_topic_backlog disable
oslo_messaging_zmq/subscribe_on disable
oslo_messaging_zmq/use_dynamic_connections disable
oslo_messaging_zmq/use_pub_sub disable
oslo_messaging_zmq/use_router_proxy disable
oslo_messaging_zmq/zmq_failover_connections disable
oslo_messaging_zmq/zmq_immediate disable
oslo_messaging_zmq/zmq_linger disable
oslo_messaging_zmq/zmq_target_expire disable
oslo_messaging_zmq/zmq_target_update disable
oslo_messaging_zmq/zmq_tcp_keepalive disable
oslo_messaging_zmq/zmq_tcp_keepalive_cnt disable
oslo_messaging_zmq/zmq_tcp_keepalive_idle disable
oslo_messaging_zmq/zmq_tcp_keepalive_intvl disable
oslo_policy/policy_default_rule disable
oslo_policy/policy_dirs disable
oslo_policy/policy_file disable
pooling:catalog/enable_virtual_pool pooling
profiler/connection_string profiler
profiler/enabled profiler
profiler/es_doc_type profiler
profiler/es_scroll_size profiler
profiler/es_scroll_time profiler
profiler/hmac_keys profiler
profiler/sentinel_service_name profiler
profiler/socket_timeout profiler
profiler/trace_management_store profiler
profiler/trace_message_store profiler
profiler/trace_sqlalchemy profiler
profiler/trace_wsgi_transport profiler
signed_url/secret_key api
storage/claim_pipeline storage
storage/message_pipeline storage
@ -130,10 +335,12 @@ transport/default_message_ttl transport
transport/default_subscription_ttl transport
transport/max_claim_grace transport
transport/max_claim_ttl transport
transport/max_flavors_per_page transport
transport/max_message_ttl transport
transport/max_messages_per_claim_or_pop transport
transport/max_messages_per_page transport
transport/max_messages_post_size transport
transport/max_pools_per_page transport
transport/max_queue_metadata transport
transport/max_queues_per_page transport
transport/max_subscriptions_per_page transport

View File

@ -2,9 +2,11 @@ authentication authentication
drivers drivers
mongodb MongoDB
pooling pooling
profiler profiler
redis Redis
sqlalchemy SQLAlchemy
storage storage
swift swift
transport transport
trustee trustee
websocket Websocket