452 lines
18 KiB
XML
452 lines
18 KiB
XML
<?xml version='1.0' encoding='UTF-8'?>
|
|
<section xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="sahara-conf-changes-kilo">
|
|
<!-- Warning: Do not edit this file. It is automatically generated and your changes will be overwritten. The tool to do so lives in the openstack-doc-tools repository. -->
|
|
<title>New, updated and deprecated options in Kilo for Data Processing service</title>
|
|
<table>
|
|
<caption>New options</caption>
|
|
<col width="50%"/>
|
|
<col width="50%"/>
|
|
<thead>
|
|
<tr>
|
|
<td>Option = default value</td>
|
|
<td>(Type) Help string</td>
|
|
</tr>
|
|
</thead>
|
|
<tr>
|
|
<td>[DEFAULT] admin_project_domain_name = default</td>
|
|
<td>(StrOpt) The name of the domain for the service project(ex. tenant).</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[DEFAULT] admin_user_domain_name = default</td>
|
|
<td>(StrOpt) The name of the domain to which the admin user belongs.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[DEFAULT] api_workers = 0</td>
|
|
<td>(IntOpt) Number of workers for Sahara API service (0 means all-in-one-thread configuration).</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[DEFAULT] cleanup_time_for_incomplete_clusters = 0</td>
|
|
<td>(IntOpt) Maximal time (in hours) for clusters allowed to be in states other than "Active", "Deleting" or "Error". If a cluster is not in "Active", "Deleting" or "Error" state and last update of it was longer than "cleanup_time_for_incomplete_clusters" hours ago then it will be deleted automatically. (0 value means that automatic clean up is disabled).</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[DEFAULT] disable_event_log = False</td>
|
|
<td>(BoolOpt) Disables event log feature.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[DEFAULT] job_canceling_timeout = 300</td>
|
|
<td>(IntOpt) Timeout for canceling job execution (in seconds). Sahara will try to cancel job execution during this time.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[DEFAULT] log-config-append = None</td>
|
|
<td>(StrOpt) The name of a logging configuration file. This file is appended to any existing logging configuration files. For details about logging configuration files, see the Python logging module documentation.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[DEFAULT] log-date-format = %Y-%m-%d %H:%M:%S</td>
|
|
<td>(StrOpt) Format string for %%(asctime)s in log records. Default: %(default)s .</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[DEFAULT] log-dir = None</td>
|
|
<td>(StrOpt) (Optional) The base directory used for relative --log-file paths.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[DEFAULT] log-file = None</td>
|
|
<td>(StrOpt) (Optional) Name of log file to output to. If no default is set, logging will go to stdout.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[DEFAULT] log-format = None</td>
|
|
<td>(StrOpt) DEPRECATED. A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. This option is deprecated. Please use logging_context_format_string and logging_default_format_string instead.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[DEFAULT] max_header_line = 16384</td>
|
|
<td>(IntOpt) Maximum line size of message headers to be accepted. max_header_line may need to be increased when using large tokens (typically those generated by the Keystone v3 API with big service catalogs).</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[DEFAULT] proxy_command = </td>
|
|
<td>(StrOpt) 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}.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[DEFAULT] rootwrap_command = sudo sahara-rootwrap /etc/sahara/rootwrap.conf</td>
|
|
<td>(StrOpt) Rootwrap command to leverage. Use in conjunction with use_rootwrap=True</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[DEFAULT] syslog-log-facility = LOG_USER</td>
|
|
<td>(StrOpt) Syslog facility to receive log lines.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[DEFAULT] use-syslog = False</td>
|
|
<td>(BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED during I, and will change in J to honor RFC5424.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[DEFAULT] use-syslog-rfc-format = False</td>
|
|
<td>(BoolOpt) (Optional) Enables or disables syslog rfc5424 format for logging. If enabled, prefixes the MSG part of the syslog message with APP-NAME (RFC5424). The format without the APP-NAME is deprecated in I, and will be removed in J.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[DEFAULT] use_external_key_manager = False</td>
|
|
<td>(BoolOpt) Enable Sahara to use an external key manager service provided by the identity service catalog. Sahara will store all keys with the manager service.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[DEFAULT] use_rootwrap = False</td>
|
|
<td>(BoolOpt) 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)</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[cinder] api_insecure = False</td>
|
|
<td>(BoolOpt) Allow to perform insecure SSL requests to cinder.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[cinder] api_version = 2</td>
|
|
<td>(IntOpt) Version of the Cinder API to use.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[cinder] ca_file = None</td>
|
|
<td>(StrOpt) Location of ca certificates file to use for cinder client requests.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[heat] api_insecure = False</td>
|
|
<td>(BoolOpt) Allow to perform insecure SSL requests to heat.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[heat] ca_file = None</td>
|
|
<td>(StrOpt) Location of ca certificates file to use for heat client requests.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[keystone] api_insecure = False</td>
|
|
<td>(BoolOpt) Allow to perform insecure SSL requests to keystone.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[keystone] ca_file = None</td>
|
|
<td>(StrOpt) Location of ca certificates file to use for keystone client requests.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[neutron] api_insecure = False</td>
|
|
<td>(BoolOpt) Allow to perform insecure SSL requests to neutron.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[neutron] ca_file = None</td>
|
|
<td>(StrOpt) Location of ca certificates file to use for neutron client requests.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[nova] api_insecure = False</td>
|
|
<td>(BoolOpt) Allow to perform insecure SSL requests to nova.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[nova] ca_file = None</td>
|
|
<td>(StrOpt) Location of ca certificates file to use for nova client requests.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[oslo_messaging_amqp] allow_insecure_clients = False</td>
|
|
<td>(BoolOpt) Accept clients using either SSL or plain TCP</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[oslo_messaging_amqp] broadcast_prefix = broadcast</td>
|
|
<td>(StrOpt) address prefix used when broadcasting to all servers</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[oslo_messaging_amqp] container_name = None</td>
|
|
<td>(StrOpt) Name for the AMQP container</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[oslo_messaging_amqp] group_request_prefix = unicast</td>
|
|
<td>(StrOpt) address prefix when sending to any server in group</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[oslo_messaging_amqp] idle_timeout = 0</td>
|
|
<td>(IntOpt) Timeout for inactive connections (in seconds)</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[oslo_messaging_amqp] server_request_prefix = exclusive</td>
|
|
<td>(StrOpt) address prefix used when sending to a specific server</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[oslo_messaging_amqp] ssl_ca_file = </td>
|
|
<td>(StrOpt) CA certificate PEM file to verify server certificate</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[oslo_messaging_amqp] ssl_cert_file = </td>
|
|
<td>(StrOpt) Identifying certificate PEM file to present to clients</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[oslo_messaging_amqp] ssl_key_file = </td>
|
|
<td>(StrOpt) Private key PEM file used to sign cert_file certificate</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[oslo_messaging_amqp] ssl_key_password = None</td>
|
|
<td>(StrOpt) Password for decrypting ssl_key_file (if encrypted)</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[oslo_messaging_amqp] trace = False</td>
|
|
<td>(BoolOpt) Debug: dump AMQP frames to stdout</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[oslo_messaging_qpid] amqp_auto_delete = False</td>
|
|
<td>(BoolOpt) Auto-delete queues in AMQP.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[oslo_messaging_qpid] amqp_durable_queues = False</td>
|
|
<td>(BoolOpt) Use durable queues in AMQP.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[oslo_messaging_qpid] qpid_heartbeat = 60</td>
|
|
<td>(IntOpt) Seconds between connection keepalive heartbeats.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[oslo_messaging_qpid] qpid_hostname = localhost</td>
|
|
<td>(StrOpt) Qpid broker hostname.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[oslo_messaging_qpid] qpid_hosts = $qpid_hostname:$qpid_port</td>
|
|
<td>(ListOpt) Qpid HA cluster host:port pairs.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[oslo_messaging_qpid] qpid_password = </td>
|
|
<td>(StrOpt) Password for Qpid connection.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[oslo_messaging_qpid] qpid_port = 5672</td>
|
|
<td>(IntOpt) Qpid broker port.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[oslo_messaging_qpid] qpid_protocol = tcp</td>
|
|
<td>(StrOpt) Transport to use, either 'tcp' or 'ssl'.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[oslo_messaging_qpid] qpid_receiver_capacity = 1</td>
|
|
<td>(IntOpt) The number of prefetched messages held by receiver.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[oslo_messaging_qpid] qpid_sasl_mechanisms = </td>
|
|
<td>(StrOpt) Space separated list of SASL mechanisms to use for auth.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[oslo_messaging_qpid] qpid_tcp_nodelay = True</td>
|
|
<td>(BoolOpt) Whether to disable the Nagle algorithm.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[oslo_messaging_qpid] qpid_topology_version = 1</td>
|
|
<td>(IntOpt) The qpid topology version to use. Version 1 is what was originally used by impl_qpid. Version 2 includes some backwards-incompatible changes that allow broker federation to work. Users should update to version 2 when they are able to take everything down, as it requires a clean break.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[oslo_messaging_qpid] qpid_username = </td>
|
|
<td>(StrOpt) Username for Qpid connection.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[oslo_messaging_qpid] rpc_conn_pool_size = 30</td>
|
|
<td>(IntOpt) Size of RPC connection pool.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[oslo_messaging_rabbit] amqp_auto_delete = False</td>
|
|
<td>(BoolOpt) Auto-delete queues in AMQP.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[oslo_messaging_rabbit] amqp_durable_queues = False</td>
|
|
<td>(BoolOpt) Use durable queues in AMQP.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[oslo_messaging_rabbit] fake_rabbit = False</td>
|
|
<td>(BoolOpt) Deprecated, use rpc_backend=kombu+memory or rpc_backend=fake</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[oslo_messaging_rabbit] heartbeat_rate = 2</td>
|
|
<td>(IntOpt) How often times during the heartbeat_timeout_threshold we check the heartbeat.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[oslo_messaging_rabbit] heartbeat_timeout_threshold = 0</td>
|
|
<td>(IntOpt) Number of seconds after which the Rabbit broker is considered down if heartbeat's keep-alive fails (0 disables the heartbeat, >0 enables it. Enabling heartbeats requires kombu>=3.0.7 and amqp>=1.4.0). EXPERIMENTAL</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[oslo_messaging_rabbit] kombu_reconnect_delay = 1.0</td>
|
|
<td>(FloatOpt) How long to wait before reconnecting in response to an AMQP consumer cancel notification.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[oslo_messaging_rabbit] kombu_ssl_ca_certs = </td>
|
|
<td>(StrOpt) SSL certification authority file (valid only if SSL enabled).</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[oslo_messaging_rabbit] kombu_ssl_certfile = </td>
|
|
<td>(StrOpt) SSL cert file (valid only if SSL enabled).</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[oslo_messaging_rabbit] kombu_ssl_keyfile = </td>
|
|
<td>(StrOpt) SSL key file (valid only if SSL enabled).</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[oslo_messaging_rabbit] kombu_ssl_version = </td>
|
|
<td>(StrOpt) 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.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[oslo_messaging_rabbit] rabbit_ha_queues = False</td>
|
|
<td>(BoolOpt) Use HA queues in RabbitMQ (x-ha-policy: all). If you change this option, you must wipe the RabbitMQ database.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[oslo_messaging_rabbit] rabbit_host = localhost</td>
|
|
<td>(StrOpt) The RabbitMQ broker address where a single node is used.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[oslo_messaging_rabbit] rabbit_hosts = $rabbit_host:$rabbit_port</td>
|
|
<td>(ListOpt) RabbitMQ HA cluster host:port pairs.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[oslo_messaging_rabbit] rabbit_login_method = AMQPLAIN</td>
|
|
<td>(StrOpt) The RabbitMQ login method.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[oslo_messaging_rabbit] rabbit_max_retries = 0</td>
|
|
<td>(IntOpt) Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry count).</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[oslo_messaging_rabbit] rabbit_password = guest</td>
|
|
<td>(StrOpt) The RabbitMQ password.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[oslo_messaging_rabbit] rabbit_port = 5672</td>
|
|
<td>(IntOpt) The RabbitMQ broker port where a single node is used.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[oslo_messaging_rabbit] rabbit_retry_backoff = 2</td>
|
|
<td>(IntOpt) How long to backoff for between retries when connecting to RabbitMQ.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[oslo_messaging_rabbit] rabbit_retry_interval = 1</td>
|
|
<td>(IntOpt) How frequently to retry connecting with RabbitMQ.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[oslo_messaging_rabbit] rabbit_use_ssl = False</td>
|
|
<td>(BoolOpt) Connect over SSL for RabbitMQ.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[oslo_messaging_rabbit] rabbit_userid = guest</td>
|
|
<td>(StrOpt) The RabbitMQ userid.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[oslo_messaging_rabbit] rabbit_virtual_host = /</td>
|
|
<td>(StrOpt) The RabbitMQ virtual host.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[oslo_messaging_rabbit] rpc_conn_pool_size = 30</td>
|
|
<td>(IntOpt) Size of RPC connection pool.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[oslo_middleware] max_request_body_size = 114688</td>
|
|
<td>(IntOpt) The maximum body size for each request, in bytes.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[oslo_policy] policy_default_rule = default</td>
|
|
<td>(StrOpt) Default rule. Enforced when a requested rule is not found.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[oslo_policy] policy_dirs = ['policy.d']</td>
|
|
<td>(MultiStrOpt) Directories where policy configuration files are stored. They can be relative to any directory in the search path defined by the config_dir option, or absolute paths. The file defined by policy_file must exist for these directories to be searched. Missing or empty directories are ignored.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[oslo_policy] policy_file = policy.json</td>
|
|
<td>(StrOpt) The JSON file that defines policies.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[ssl] ca_file = None</td>
|
|
<td>(StrOpt) CA certificate file to use to verify connecting clients.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[ssl] cert_file = None</td>
|
|
<td>(StrOpt) Certificate file to use when starting the server securely.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[ssl] key_file = None</td>
|
|
<td>(StrOpt) Private key file to use when starting the server securely.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[swift] api_insecure = False</td>
|
|
<td>(BoolOpt) Allow to perform insecure SSL requests to swift.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[swift] ca_file = None</td>
|
|
<td>(StrOpt) Location of ca certificates file to use for swift client requests.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[timeouts] await_attach_volumes = 10</td>
|
|
<td>(IntOpt) Wait for attaching volumes to instances, in seconds</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[timeouts] await_for_instances_active = 10800</td>
|
|
<td>(IntOpt) Wait for instances to become active, in seconds</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[timeouts] delete_instances_timeout = 10800</td>
|
|
<td>(IntOpt) Wait for instances to be deleted, in seconds</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[timeouts] detach_volume_timeout = 300</td>
|
|
<td>(IntOpt) Timeout for detaching volumes from instance, in seconds</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[timeouts] ips_assign_timeout = 10800</td>
|
|
<td>(IntOpt) Assign IPs timeout, in seconds</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[timeouts] volume_available_timeout = 10800</td>
|
|
<td>(IntOpt) Wait for volumes to become available, in seconds</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[timeouts] wait_until_accessible = 10800</td>
|
|
<td>(IntOpt) Wait for instance accessibility, in seconds</td>
|
|
</tr>
|
|
</table>
|
|
<table>
|
|
<caption>New default values</caption>
|
|
<col width="33%"/>
|
|
<col width="33%"/>
|
|
<col width="33%"/>
|
|
<thead>
|
|
<tr>
|
|
<td>Option</td>
|
|
<td>Previous default value</td>
|
|
<td>New default value</td>
|
|
</tr>
|
|
</thead>
|
|
<tr>
|
|
<td>[DEFAULT] default_log_levels</td>
|
|
<td>amqplib=WARN, qpid.messaging=INFO, stevedore=INFO, eventlet.wsgi.server=WARN, sqlalchemy=WARN, boto=WARN, suds=INFO, keystone=INFO, paramiko=WARN, requests=WARN, iso8601=WARN</td>
|
|
<td>amqplib=WARN, qpid.messaging=INFO, stevedore=INFO, eventlet.wsgi.server=WARN, sqlalchemy=WARN, boto=WARN, suds=INFO, keystone=INFO, paramiko=WARN, requests=WARN, iso8601=WARN, oslo_messaging=INFO</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[DEFAULT] plugins</td>
|
|
<td>vanilla, hdp, spark</td>
|
|
<td>vanilla, hdp, spark, cdh</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[DEFAULT] rpc_zmq_matchmaker</td>
|
|
<td>oslo.messaging._drivers.matchmaker.MatchMakerLocalhost</td>
|
|
<td>local</td>
|
|
</tr>
|
|
</table>
|
|
<table>
|
|
<caption>Deprecated options</caption>
|
|
<col width="50%"/>
|
|
<col width="50%"/>
|
|
<thead>
|
|
<tr>
|
|
<td>Deprecated option</td>
|
|
<td>New Option</td>
|
|
</tr>
|
|
</thead>
|
|
<tr>
|
|
<td>[DEFAULT] log-format</td>
|
|
<td>None</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[DEFAULT] use-syslog</td>
|
|
<td>None</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[DEFAULT] detach_volume_timeout</td>
|
|
<td>[timeouts] detach_volume_timeout</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[DEFAULT] log_format</td>
|
|
<td>None</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[DEFAULT] use_syslog</td>
|
|
<td>None</td>
|
|
</tr>
|
|
</table>
|
|
</section>
|