openstack/openstack-manuals
Code Issues Proposed changes

[config-ref] update sahara config options for Newton

Browse Source 
Change-Id: Ibe3355be23c6ae825798e95b4c2303fa9662619b
This commit is contained in:
KATO Tomoyuki 2016-10-01 11:11:58 +09:00
parent c26657a776
commit 39498598f3
16 changed files with 149 additions and 443 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
doc/config-reference/source/data-processing-service.rst
View File

@ -1,32 +0,0 @@
=======================
Data Processing service
=======================
.. toctree::
tables/conf-changes/sahara.rst
The Data Processing service (sahara) provides a scalable data-processing stack
and associated management interfaces.
.. note::
The common configurations for shared service and libraries,
such as database connections and RPC messaging,
are described at :doc:`common-configurations`.
The following tables provide a comprehensive list of the Data Processing
service configuration options:
.. include:: tables/sahara-amqp.rst
.. include:: tables/sahara-api.rst
.. include:: tables/sahara-clients.rst
.. include:: tables/sahara-common.rst
.. include:: tables/sahara-domain.rst
.. include:: tables/sahara-object_store_access.rst
.. include:: tables/sahara-rabbitmq.rst
.. include:: tables/sahara-redis.rst
.. include:: tables/sahara-rpc.rst
.. include:: tables/sahara-timeouts.rst
.. include:: tables/sahara-varmour.rst
.. include:: tables/sahara-zeromq.rst

18
doc/config-reference/source/data-processing.rst Normal file
View File

@ -0,0 +1,18 @@
=======================
Data Processing service
=======================
.. toctree::
data-processing/api.rst
data-processing/config-options.rst
tables/conf-changes/sahara.rst
The Data Processing service (sahara) provides a scalable data-processing stack
and associated management interfaces.
.. note::
The common configurations for shared service and libraries,
such as database connections and RPC messaging,
are described at :doc:`common-configurations`.

8
doc/config-reference/source/data-processing/api.rst Normal file
View File

@ -0,0 +1,8 @@
================================
Data Processing API configuraton
================================
The following options allow configuration of the APIs that
Data Processing service supports.
.. include:: ../tables/sahara-api.rst

13
doc/config-reference/source/data-processing/config-options.rst Normal file
View File

@ -0,0 +1,13 @@
============================================================
Additional configuration options for Data Processing service
============================================================
The following tables provide a comprehensive list of the Data Processing
service configuration options:
.. include:: ../tables/sahara-clients.rst
.. include:: ../tables/sahara-common.rst
.. include:: ../tables/sahara-domain.rst
.. include:: ../tables/sahara-object_store_access.rst
.. include:: ../tables/sahara-redis.rst
.. include:: ../tables/sahara-timeouts.rst

2
doc/config-reference/source/index.rst
View File

@ -25,7 +25,7 @@ Contents
clustering.rst
compute.rst
dashboard.rst
data-processing-service.rst
data-processing.rst
database.rst
identity.rst
image.rst

55
doc/config-reference/source/tables/conf-changes/sahara.rst
View File

@ -1,4 +1,4 @@
New, updated, and deprecated options in Mitaka for Data Processing service
New, updated, and deprecated options in Newton for Data Processing service
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
..
@ -12,30 +12,24 @@ New, updated, and deprecated options in Mitaka for Data Processing service
* - Option = default value
- (Type) Help string
* - ``[DEFAULT] coordinator_heartbeat_interval = 1``
- (IntOpt) Interval size between heartbeat execution in seconds. Heartbeats are executed to make sure that connection to the coordination server is active.
* - ``[DEFAULT] hash_ring_replicas_count = 40``
- (IntOpt) Number of points that belongs to each member on a hash ring. The larger number leads to a better distribution.
* - ``[DEFAULT] periodic_coordinator_backend_url = None``
- (StrOpt) The backend URL to use for distributed periodic tasks coordination.
* - ``[DEFAULT] periodic_workers_number = 1``
- (IntOpt) Number of threads to run periodic tasks.
* - ``[DEFAULT] use_barbican_key_manager = False``
- (BoolOpt) Enable the usage of the OpenStack Key Management service provided by barbican.
* - ``[castellan] barbican_api_endpoint = None``
- (StrOpt) The endpoint to use for connecting to the barbican api controller. By default, castellan will use the URL from the service catalog.
* - ``[castellan] barbican_api_version = v1``
- (StrOpt) Version of the barbican API, for example: "v1"
* - ``[cluster_verifications] verification_enable = True``
- (BoolOpt) Option to enable verifications for all clusters
* - ``[cluster_verifications] verification_periodic_interval = 600``
- (IntOpt) Interval between two consecutive periodic tasks forverifications, in seconds.
* - ``[oslo_messaging_notifications] enable = False``
- (BoolOpt) Enables sending notifications to Ceilometer
* - ``[oslo_messaging_notifications] level = INFO``
- (StrOpt) Notification level for outgoing notifications
* - ``[oslo_messaging_notifications] publisher_id = None``
- (StrOpt) Notification publisher_id for outgoing notifications
* - ``[DEFAULT] edp_internal_db_enabled = True``
- (BoolOpt) Use Sahara internal db to store job binaries.
* - ``[DEFAULT] image = None``
- (StrOpt) The path to an image to modify. This image will be modified in-place: be sure to target a copy if you wish to maintain a clean master image.
* - ``[DEFAULT] nameservers =``
- (ListOpt) IP addresses of Designate nameservers. This is required if 'use_designate' is True
* - ``[DEFAULT] root_fs = None``
- (StrOpt) The filesystem to mount as the root volume on the image. Novalue is required if only one filesystem is detected.
* - ``[DEFAULT] test_only = False``
- (BoolOpt) If this flag is set, no changes will be made to the image; instead, the script will fail if discrepancies are found between the image and the intended state.
* - ``[DEFAULT] use_designate = False``
- (BoolOpt) Use Designate for internal and external hostnames resolution
* - ``[glance] api_insecure = False``
- (BoolOpt) Allow to perform insecure SSL requests to glance.
* - ``[glance] ca_file = None``
- (StrOpt) Location of ca certificates file to use for glance client requests.
* - ``[glance] endpoint_type = internalURL``
- (StrOpt) Endpoint type for glance client requests
.. list-table:: New default values
:header-rows: 1
@ -44,12 +38,9 @@ New, updated, and deprecated options in Mitaka for Data Processing service
* - Option
- Previous default value
- New default value
* - ``[DEFAULT] api_workers``
- ``0``
- ``1``
* - ``[DEFAULT] plugins``
- ``vanilla, hdp, spark, cdh``
- ``vanilla, spark, cdh, ambari``
- ``vanilla, spark, cdh, ambari, storm, mapr``
.. list-table:: Deprecated options
:header-rows: 1
@ -57,12 +48,6 @@ New, updated, and deprecated options in Mitaka for Data Processing service
* - Deprecated option
- New Option
* - ``[DEFAULT] enable_notifications``
- ``[oslo_messaging_notifications] enable``
* - ``[DEFAULT] notification_level``
- ``[oslo_messaging_notifications] level``
* - ``[DEFAULT] notification_publisher_id``
- ``[oslo_messaging_notifications] publisher_id``
* - ``[DEFAULT] use_syslog``
- ``None``

24
doc/config-reference/source/tables/sahara-amqp.rst
View File

@ -1,24 +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.
.. _sahara-amqp:
.. list-table:: Description of AMQP configuration options
:header-rows: 1
:class: config-ref-table
* - Configuration option = Default value
- Description
* - **[DEFAULT]**
-
* - ``control_exchange`` = ``openstack``
- (String) The default exchange under which topics are scoped. May be overridden by an exchange name specified in the transport_url option.
* - ``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.

30
doc/config-reference/source/tables/sahara-api.rst
View File

@ -16,37 +16,21 @@
* - Configuration option = Default value
- Description
* - **[oslo_messaging_rabbit]**
-
* - ``connection_factory`` = ``single``
- (String) Connection factory implementation
* - **[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.
* - **[retries]**
-
* - ``retries_number`` = ``5``
- (Integer) Number of times to retry the request to client before failing
* - ``retry_after`` = ``10``
- (Integer) Time between the retries to client (in seconds).
* - **[service_auth]**
-
* - ``admin_password`` = ``password``
- (String) The service admin password
* - ``admin_project_domain`` = ``admin``
- (String) The admin project domain name
* - ``admin_tenant_name`` = ``admin``
- (String) The service admin tenant name
* - ``admin_user`` = ``admin``
- (String) The service admin user name
* - ``admin_user_domain`` = ``admin``
- (String) The admin user domain name
* - ``auth_url`` = ``http://127.0.0.1:5000/v2.0``
- (String) Authentication endpoint
* - ``auth_version`` = ``2``
- (String) The auth version used to authenticate
* - ``endpoint_type`` = ``public``
- (String) The endpoint_type to be used
* - ``region`` = ``RegionOne``
- (String) The deployment region
* - ``service_name`` = ``lbaas``
- (String) The name of the service

8
doc/config-reference/source/tables/sahara-clients.rst
View File

@ -26,6 +26,14 @@
- (String) Location of ca certificates file to use for cinder client requests.
* - ``endpoint_type`` = ``internalURL``
- (String) Endpoint type for cinder client requests
* - **[glance]**
-
* - ``api_insecure`` = ``False``
- (Boolean) Allow to perform insecure SSL requests to glance.
* - ``ca_file`` = ``None``
- (String) Location of ca certificates file to use for glance client requests.
* - ``endpoint_type`` = ``internalURL``
- (String) Endpoint type for glance client requests
* - **[heat]**
-
* - ``api_insecure`` = ``False``

28
doc/config-reference/source/tables/sahara-common.rst
View File

@ -36,6 +36,8 @@
- (String) Default ntp server for time sync
* - ``disable_event_log`` = ``False``
- (Boolean) Disables event log feature.
* - ``edp_internal_db_enabled`` = ``True``
- (Boolean) Use Sahara internal db to store job binaries.
* - ``enable_data_locality`` = ``False``
- (Boolean) Enables data locality for hadoop cluster. Also enables data locality for Swift used by hadoop. If enabled, 'compute_topology' and 'swift_topology' configuration parameters should point to OpenStack and Swift topology correspondingly.
* - ``enable_hypervisor_awareness`` = ``True``
@ -50,18 +52,18 @@
- (Boolean) Enable wait condition feature to reduce polling during cluster creation
* - ``heat_stack_tags`` = ``data-processing-cluster``
- (List) List of tags to be used during operating with stack.
* - ``infrastructure_engine`` = ``heat``
- (String) DEPRECATED: An engine which will be used to provision infrastructure for Hadoop cluster.
* - ``image`` = ``None``
- (String) The path to an image to modify. This image will be modified in-place: be sure to target a copy if you wish to maintain a clean master image.
* - ``job_binary_max_KB`` = ``5120``
- (Integer) Maximum length of job binary data in kilobytes that may be stored or retrieved in a single operation.
* - ``job_canceling_timeout`` = ``300``
- (Integer) Timeout for canceling job execution (in seconds). Sahara will try to cancel job execution during this time.
* - ``job_workflow_postfix`` =
- (String) Postfix for storing jobs in hdfs. Will be added to '/user/<hdfs user>/' path.
* - ``memcached_servers`` = ``None``
- (List) Memcached servers or None for in process cache.
* - ``min_transient_cluster_active_time`` = ``30``
- (Integer) Minimal "lifetime" in seconds for a transient cluster. Cluster is guaranteed to be "alive" within this time period.
* - ``nameservers`` =
- (List) IP addresses of Designate nameservers. This is required if 'use_designate' is True
* - ``node_domain`` = ``novalocal``
- (String) The suffix of the node's FQDN. In nova-network that is the dhcp_domain config parameter.
* - ``os_region_name`` = ``None``
@ -76,18 +78,24 @@
- (Integer) Max interval size between periodic tasks execution in seconds.
* - ``periodic_workers_number`` = ``1``
- (Integer) Number of threads to run periodic tasks.
* - ``plugins`` = ``vanilla, spark, cdh, ambari``
* - ``plugins`` = ``vanilla, spark, cdh, ambari, storm, mapr``
- (List) List of plugins to be loaded. Sahara preserves the order of the list when returning it.
* - ``proxy_command`` =
- (String) Proxy command used to connect to instances. If set, this command should open a netcat socket, that Sahara will use for SSH and HTTP connections. Use {host} and {port} to describe the destination. Other available keywords: {tenant_id}, {network_id}, {router_id}.
* - ``remote`` = ``ssh``
- (String) A method for Sahara to execute commands on VMs.
* - ``root_fs`` = ``None``
- (String) The filesystem to mount as the root volume on the image. Novalue is required if only one filesystem is detected.
* - ``rootwrap_command`` = ``sudo sahara-rootwrap /etc/sahara/rootwrap.conf``
- (String) Rootwrap command to leverage. Use in conjunction with use_rootwrap=True
* - ``swift_topology_file`` = ``etc/sahara/swift.topology``
- (String) File with Swift topology.It should contain mapping between Swift nodes and racks.
* - ``test_only`` = ``False``
- (Boolean) If this flag is set, no changes will be made to the image; instead, the script will fail if discrepancies are found between the image and the intended state.
* - ``use_barbican_key_manager`` = ``False``
- (Boolean) Enable the usage of the OpenStack Key Management service provided by barbican.
* - ``use_designate`` = ``False``
- (Boolean) Use Designate for internal and external hostnames resolution
* - ``use_floating_ips`` = ``True``
- (Boolean) If set to True, Sahara will use floating IPs to communicate with instances. To make sure that all instances have floating IPs assigned in Nova Network set "auto_assign_floating_ip=True" in nova.conf. If Neutron is used for networking, make sure that all Node Groups have "floating_ip_pool" parameter defined.
* - ``use_identity_api_v3`` = ``True``
@ -97,19 +105,15 @@
* - ``use_neutron`` = ``False``
- (Boolean) Use Neutron Networking (False indicates the use of Nova networking).
* - ``use_rootwrap`` = ``False``
- (Boolean) Use rootwrap facility to allow non-root users to run the sahara-all server instance and access private network IPs (only valid to use in conjunction with use_namespaces=True)
- (Boolean) Use rootwrap facility to allow non-root users to run the sahara services and access private network IPs (only valid to use in conjunction with use_namespaces=True)
* - ``use_router_proxy`` = ``True``
- (Boolean) Use ROUTER remote proxy.
* - **[castellan]**
-
* - ``barbican_api_endpoint`` = ``None``
- (String) The endpoint to use for connecting to the barbican api controller. By default, castellan will use the URL from the service catalog.
* - ``barbican_api_version`` = ``v1``
- (String) Version of the barbican API, for example: "v1"
* - **[certificates]**
-
* - ``barbican_auth`` = ``barbican_acl_auth``
- (String) Name of the Barbican authentication method to use
* - ``cert_manager_type`` = ``barbican``
- (String) Certificate Manager plugin. Defaults to barbican.
* - **[cluster_verifications]**
-
* - ``verification_enable`` = ``True``

130
doc/config-reference/source/tables/sahara-rabbitmq.rst
View File

@ -1,130 +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.
.. _sahara-rabbitmq:
.. list-table:: Description of RabbitMQ configuration options
:header-rows: 1
:class: config-ref-table
* - Configuration option = Default value
- Description
* - **[oslo_messaging_rabbit]**
-
* - ``amqp_auto_delete`` = ``False``
- (Boolean) Auto-delete queues in AMQP.
* - ``amqp_durable_queues`` = ``False``
- (Boolean) Use durable queues in AMQP.
* - ``channel_max`` = ``None``
- (Integer) Maximum number of channels to allow
* - ``default_notification_exchange`` = ``${control_exchange}_notification``
- (String) Exchange name for 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``
- (String) Exchange name for sending RPC messages
* - ``default_rpc_retry_attempts`` = ``-1``
- (Integer) Reconnecting retry count in case of connectivity problem during sending RPC message, -1 means infinite retry. If actual retry attempts in not 0 the rpc request could be processed more then one time
* - ``fake_rabbit`` = ``False``
- (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``
- (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.
* - ``heartbeat_timeout_threshold`` = ``60``
- (Integer) Number of seconds after which the Rabbit broker is considered down if heartbeat's keep-alive fails (0 disable the heartbeat). EXPERIMENTAL
* - ``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.
* - ``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``
- (Integer) How long to wait a missing client before abandoning to send it its replies. This value should not be longer than rpc_response_timeout.
* - ``kombu_reconnect_delay`` = ``1.0``
- (Floating point) How long to wait before reconnecting in response to an AMQP consumer cancel notification.
* - ``kombu_ssl_ca_certs`` =
- (String) SSL certification authority file (valid only if SSL enabled).
* - ``kombu_ssl_certfile`` =
- (String) SSL cert file (valid only if SSL enabled).
* - ``kombu_ssl_keyfile`` =
- (String) SSL key file (valid only if SSL enabled).
* - ``kombu_ssl_version`` =
- (String) SSL version to use (valid only if SSL enabled). Valid values are TLSv1 and SSLv23. SSLv2, SSLv3, TLSv1_1, and TLSv1_2 may be available on some distributions.
* - ``notification_listener_prefetch_count`` = ``100``
- (Integer) Max number of not acknowledged message which RabbitMQ can send to notification listener.
* - ``notification_persistence`` = ``False``
- (Boolean) Persist notification messages.
* - ``notification_retry_delay`` = ``0.25``
- (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``
- (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.
* - ``pool_stale`` = ``60``
- (Integer) Threshold at which inactive (since release) connections are considered stale in seconds or None for no staleness. Stale connections are closed on acquire.
* - ``pool_timeout`` = ``30``
- (Integer) Default number of seconds to wait for a connections to available
* - ``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.
* - ``rabbit_hosts`` = ``$rabbit_host:$rabbit_port``
- (List) RabbitMQ HA cluster host:port pairs.
* - ``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).
* - ``rabbit_password`` = ``guest``
- (String) The RabbitMQ password.
* - ``rabbit_port`` = ``5672``
- (Port number) The RabbitMQ broker port where a single node is used.
* - ``rabbit_qos_prefetch_count`` = ``0``
- (Integer) Specifies the number of messages to prefetch. Setting to zero allows unlimited messages.
* - ``rabbit_retry_backoff`` = ``2``
- (Integer) How long to backoff for between retries when connecting to RabbitMQ.
* - ``rabbit_retry_interval`` = ``1``
- (Integer) How frequently to retry connecting with RabbitMQ.
* - ``rabbit_transient_queues_ttl`` = ``1800``
- (Integer) Positive integer representing duration in seconds for queue TTL (x-expires). Queues which are unused for the duration of the TTL are automatically deleted. The parameter affects only reply and fanout queues.
* - ``rabbit_use_ssl`` = ``False``
- (Boolean) Connect over SSL for RabbitMQ.
* - ``rabbit_userid`` = ``guest``
- (String) The RabbitMQ userid.
* - ``rabbit_virtual_host`` = ``/``
- (String) The RabbitMQ virtual host.
* - ``rpc_listener_prefetch_count`` = ``100``
- (Integer) Max number of not acknowledged message which RabbitMQ can send to rpc listener.
* - ``rpc_queue_expiration`` = ``60``
- (Integer) Time to live for rpc queues without consumers in seconds.
* - ``rpc_reply_exchange`` = ``${control_exchange}_rpc_reply``
- (String) Exchange name for receiving RPC replies
* - ``rpc_reply_listener_prefetch_count`` = ``100``
- (Integer) Max number of not acknowledged message which RabbitMQ can send to rpc reply listener.
* - ``rpc_reply_retry_attempts`` = ``-1``
- (Integer) Reconnecting retry count in case of connectivity problem during sending reply. -1 means infinite retry during rpc_timeout
* - ``rpc_reply_retry_delay`` = ``0.25``
- (Floating point) Reconnecting retry delay in case of connectivity problem during sending reply.
* - ``rpc_retry_delay`` = ``0.25``
- (Floating point) Reconnecting retry delay in case of connectivity problem during sending RPC message
* - ``socket_timeout`` = ``0.25``
- (Floating point) Set socket timeout in seconds for connection's socket
* - ``ssl`` = ``None``
- (Boolean) Enable SSL
* - ``ssl_options`` = ``None``
- (Dict) Arguments passed to ssl.wrap_socket
* - ``tcp_user_timeout`` = ``0.25``
- (Floating point) Set TCP_USER_TIMEOUT in seconds for connection's socket

12
doc/config-reference/source/tables/sahara-redis.rst
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.

88
doc/config-reference/source/tables/sahara-rpc.rst
View File

@ -1,88 +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.
.. _sahara-rpc:
.. list-table:: Description of RPC configuration options
:header-rows: 1
:class: config-ref-table
* - Configuration option = Default value
- Description
* - **[DEFAULT]**
-
* - ``rpc_backend`` = ``rabbit``
- (String) The messaging driver to use, defaults to rabbit. Other drivers include amqp and 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_conn_pool_size`` = ``30``
- (Integer) Size of RPC connection pool.
* - ``rpc_poll_timeout`` = ``1``
- (Integer) The default number of seconds that poll should wait. Poll raises timeout exception when timeout expired.
* - ``rpc_response_timeout`` = ``60``
- (Integer) Seconds to wait for a response from a call.
* - **[oslo_concurrency]**
-
* - ``disable_process_locking`` = ``False``
- (Boolean) Enables or disables inter-process locks.
* - ``lock_path`` = ``None``
- (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]**
-
* - ``event_stream_topic`` = ``neutron_lbaas_event``
- (String) topic name for receiving events from a queue
* - **[oslo_messaging_amqp]**
-
* - ``allow_insecure_clients`` = ``False``
- (Boolean) Accept clients using either SSL or plain TCP
* - ``broadcast_prefix`` = ``broadcast``
- (String) address prefix used when broadcasting to all servers
* - ``container_name`` = ``None``
- (String) Name for the AMQP container
* - ``group_request_prefix`` = ``unicast``
- (String) address prefix when sending to any server in group
* - ``idle_timeout`` = ``0``
- (Integer) Timeout for inactive connections (in seconds)
* - ``password`` =
- (String) Password for message broker authentication
* - ``sasl_config_dir`` =
- (String) Path to directory that contains the SASL configuration
* - ``sasl_config_name`` =
- (String) Name of configuration file (without .conf suffix)
* - ``sasl_mechanisms`` =
- (String) Space separated list of acceptable SASL mechanisms
* - ``server_request_prefix`` = ``exclusive``
- (String) address prefix used when sending to a specific server
* - ``ssl_ca_file`` =
- (String) CA certificate PEM file to verify server certificate
* - ``ssl_cert_file`` =
- (String) Identifying certificate PEM file to present to clients
* - ``ssl_key_file`` =
- (String) Private key PEM file used to sign cert_file certificate
* - ``ssl_key_password`` = ``None``
- (String) Password for decrypting ssl_key_file (if encrypted)
* - ``trace`` = ``False``
- (Boolean) Debug: dump AMQP frames to stdout
* - ``username`` =
- (String) User name for message broker authentication
* - **[oslo_messaging_notifications]**
-
* - ``driver`` = ``[]``
- (Multi-valued) The Drivers(s) to handle sending notifications. Possible values are messaging, messagingv2, routing, log, test, noop
* - ``enable`` = ``False``
- (Boolean) Enables sending notifications to Ceilometer
* - ``level`` = ``INFO``
- (String) Notification level for outgoing notifications
* - ``publisher_id`` = ``None``
- (String) Notification publisher_id for outgoing notifications
* - ``topics`` = ``notifications``
- (List) AMQP topic used for OpenStack notifications.
* - ``transport_url`` = ``None``
- (String) A URL representing the messaging driver to use for notifications. If not set, we fall back to the same configuration used for RPC.

28
doc/config-reference/source/tables/sahara-varmour.rst
View File

@ -1,28 +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.
.. _sahara-varmour:
.. list-table:: Description of vArmour configuration options
:header-rows: 1
:class: config-ref-table
* - Configuration option = Default value
- Description
* - **[vArmour]**
-
* - ``director`` = ``localhost``
- (String) vArmour director ip
* - ``director_port`` = ``443``
- (String) vArmour director port
* - ``password`` = ``varmour``
- (String) vArmour director password
* - ``username`` = ``varmour``
- (String) vArmour director username

44
doc/config-reference/source/tables/sahara-zeromq.rst
View File

@ -1,44 +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.
.. _sahara-zeromq:
.. list-table:: Description of ZeroMQ configuration options
:header-rows: 1
:class: config-ref-table
* - Configuration option = Default value
- Description
* - **[DEFAULT]**
-
* - ``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_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``
- (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`` = ``49152``
- (Port number) Minimal port number for random ports range.
* - ``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``
- (Integer) Expiration timeout in seconds of a name service record about existing target ( < 0 means no timeout).

72
tools/autogenerate-config-flagmappings/sahara.flagmappings
View File

@ -4,6 +4,8 @@ api_workers common
cleanup_time_for_incomplete_clusters common
cluster_remote_threshold common
compute_topology_file common
conn_pool_min_size disable
conn_pool_ttl disable
control_exchange disable
coordinator_heartbeat_interval common
db_driver disable
@ -11,6 +13,7 @@ debug disable
default_log_levels disable
default_ntp_server common
disable_event_log common
edp_internal_db_enabled common
enable_data_locality common
enable_hypervisor_awareness common
executor_thread_pool_size common
@ -19,7 +22,7 @@ global_remote_threshold common
hash_ring_replicas_count common
heat_enable_wait_condition common
heat_stack_tags common
infrastructure_engine common
image common
instance_format disable
instance_uuid_format disable
job_binary_max_KB common
@ -34,8 +37,8 @@ logging_debug_format_suffix disable
logging_default_format_string disable
logging_exception_prefix disable
logging_user_identity_format disable
memcached_servers common
min_transient_cluster_active_time common
nameservers common
node_domain common
os_region_name common
periodic_coordinator_backend_url common
@ -49,6 +52,7 @@ proxy_user_domain_name domain
proxy_user_role_names domain
publish_errors disable
remote common
root_fs common
rootwrap_command common
rpc_backend disable
rpc_cast_timeout disable
@ -57,21 +61,23 @@ rpc_poll_timeout disable
rpc_response_timeout disable
rpc_zmq_bind_address disable
rpc_zmq_bind_port_retries disable
rpc_zmq_concurrency 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
ssh_timeout_common ssh
ssh_timeout_files ssh
ssh_timeout_interactive ssh
swift_topology_file common
syslog_log_facility disable
test_only common
transport_url disable
use_barbican_key_manager common
use_designate common
use_domain_for_proxy_users domain
use_floating_ips common
use_identity_api_v3 common
@ -79,15 +85,16 @@ use_namespaces common
use_neutron common
use_pub_sub disable
use_rootwrap common
use_router_proxy common
use_stderr disable
use_syslog disable
verbose disable
watch_log_file disable
zmq_immediate disable
zmq_target_expire disable
zmq_target_update disable
castellan/barbican_api_endpoint common
castellan/barbican_api_version common
certificates/barbican_auth common
certificates/cert_manager_type common
cinder/api_insecure clients
cinder/api_version clients
cinder/ca_file clients
@ -127,6 +134,9 @@ database/slave_connection disable
database/sqlite_db disable
database/sqlite_synchronous disable
database/use_db_reconnect disable
glance/api_insecure clients
glance/ca_file clients
glance/endpoint_type clients
heat/api_insecure clients
heat/ca_file clients
heat/endpoint_type clients
@ -192,13 +202,29 @@ object_store_access/public_identity_ca_file object_store_access
object_store_access/public_object_store_ca_file object_store_access
oslo_concurrency/disable_process_locking disable
oslo_concurrency/lock_path disable
oslo_messaging/event_stream_topic 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_timeout disable
oslo_messaging_amqp/default_rpc_exchange disable
oslo_messaging_amqp/default_send_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/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
@ -208,6 +234,7 @@ 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_notifications/driver disable
oslo_messaging_notifications/enable disable
@ -218,6 +245,7 @@ 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 api
oslo_messaging_rabbit/default_notification_exchange disable
oslo_messaging_rabbit/default_notification_retry_attempts disable
oslo_messaging_rabbit/default_rpc_exchange disable
@ -270,6 +298,24 @@ 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_cast_timeout disable
oslo_messaging_zmq/rpc_poll_timeout 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/use_pub_sub disable
oslo_messaging_zmq/use_router_proxy disable
oslo_messaging_zmq/zmq_immediate disable
oslo_messaging_zmq/zmq_target_expire disable
oslo_messaging_zmq/zmq_target_update disable
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
@ -277,16 +323,6 @@ oslo_policy/policy_dirs disable
oslo_policy/policy_file disable
retries/retries_number api
retries/retry_after api
service_auth/admin_password api
service_auth/admin_project_domain api
service_auth/admin_tenant_name api
service_auth/admin_user api
service_auth/admin_user_domain api
service_auth/auth_url api
service_auth/auth_version api
service_auth/endpoint_type api
service_auth/region api
service_auth/service_name api
swift/api_insecure clients
swift/ca_file clients
swift/endpoint_type clients
@ -294,7 +330,3 @@ timeouts/delete_instances_timeout timeouts
timeouts/detach_volume_timeout timeouts
timeouts/ips_assign_timeout timeouts
timeouts/wait_until_accessible timeouts
vArmour/director varmour
vArmour/director_port varmour
vArmour/password varmour
vArmour/username varmour