Red Hat Training

A Red Hat training course is available for Red Hat OpenStack Platform

11.4. New, updated and deprecated options in Kilo for Orchestration

Table 11.34. New options

Option = default value (Type) Help string
[DEFAULT] convergence_engine = False (BoolOpt) Enables engine with convergence architecture. All stacks with this option will be created using convergence engine .
[DEFAULT] default_deployment_signal_transport = CFN_SIGNAL (StrOpt) 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
[DEFAULT] default_software_config_transport = POLL_SERVER_CFN (StrOpt) Template default for how the server should receive the metadata required for software configuration. POLL_SERVER_CFN will allow calls to the cfn API action DescribeStackResource authenticated with the provided keypair (requires enabled heat-api-cfn). POLL_SERVER_HEAT will allow calls to the Heat API resource-show using the provided keystone credentials (requires keystone v3 API, and configured stack_user_* config options). POLL_TEMP_URL will create and populate a Swift TempURL with metadata for polling (requires object-store endpoint which supports TempURL).
[DEFAULT] error_wait_time = 240 (IntOpt) Error wait time in seconds for stack action (ie. create or update).
[DEFAULT] fatal_exception_format_errors = False (BoolOpt) Make exception message format errors fatal
[DEFAULT] log-config-append = None (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.
[DEFAULT] log-date-format = %Y-%m-%d %H:%M:%S (StrOpt) Format string for %%(asctime)s in log records. Default: %(default)s .
[DEFAULT] log-dir = None (StrOpt) (Optional) The base directory used for relative --log-file paths.
[DEFAULT] log-file = None (StrOpt) (Optional) Name of log file to output to. If no default is set, logging will go to stdout.
[DEFAULT] log-format = None (StrOpt) DEPRECATED. A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. This option is deprecate, use logging_context_format_string and logging_default_format_string instead.
[DEFAULT] policy_dirs = ['policy.d'] (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.
[DEFAULT] stack_scheduler_hints = False (BoolOpt) When this feature is enabled, scheduler hints identifying the heat stack context of a server resource are passed to the configured schedulers in nova, for server creates done using heat resource types 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), and heat_resource_name will be set to the resource's name.
[DEFAULT] syslog-log-facility = LOG_USER (StrOpt) Syslog facility to receive log lines.
[DEFAULT] use-syslog = False (BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED during I, and will change in J to honor RFC5424.
[DEFAULT] use-syslog-rfc-format = False (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.
[clients_sahara] ca_file = None (StrOpt) Optional CA cert file to use in SSL connections.
[clients_sahara] cert_file = None (StrOpt) Optional PEM-formatted certificate chain file.
[clients_sahara] endpoint_type = None (StrOpt) Type of endpoint in Identity service catalog to use for communication with the OpenStack service.
[clients_sahara] insecure = None (BoolOpt) If set, then the server's certificate will not be verified.
[clients_sahara] key_file = None (StrOpt) Optional PEM-formatted file that contains the private key.
[ec2authtoken] ca_file = None (StrOpt) Optional CA cert file to use in SSL connections.
[ec2authtoken] cert_file = None (StrOpt) Optional PEM-formatted certificate chain file.
[ec2authtoken] insecure = False (BoolOpt) If set, then the server's certificate will not be verified.
[ec2authtoken] key_file = None (StrOpt) Optional PEM-formatted file that contains the private key.
[oslo_messaging_amqp] allow_insecure_clients = False (BoolOpt) Accept clients using either SSL or plain TCP
[oslo_messaging_amqp] broadcast_prefix = broadcast (StrOpt) address prefix used when broadcasting to all servers
[oslo_messaging_amqp] container_name = None (StrOpt) Name for the AMQP container
[oslo_messaging_amqp] group_request_prefix = unicast (StrOpt) address prefix when sending to any server in group
[oslo_messaging_amqp] idle_timeout = 0 (IntOpt) Timeout for inactive connections (in seconds)
[oslo_messaging_amqp] server_request_prefix = exclusive (StrOpt) address prefix used when sending to a specific server
[oslo_messaging_amqp] ssl_ca_file = (StrOpt) CA certificate PEM file for verifing server certificate
[oslo_messaging_amqp] ssl_cert_file = (StrOpt) Identifying certificate PEM file to present to clients
[oslo_messaging_amqp] ssl_key_file = (StrOpt) Private key PEM file used to sign cert_file certificate
[oslo_messaging_amqp] ssl_key_password = None (StrOpt) Password for decrypting ssl_key_file (if encrypted)
[oslo_messaging_amqp] trace = False (BoolOpt) Debug: dump AMQP frames to stdout
[oslo_messaging_qpid] amqp_auto_delete = False (BoolOpt) Auto-delete queues in AMQP.
[oslo_messaging_qpid] amqp_durable_queues = False (BoolOpt) Use durable queues in AMQP.
[oslo_messaging_qpid] qpid_heartbeat = 60 (IntOpt) Seconds between connection keepalive heartbeats.
[oslo_messaging_qpid] qpid_hostname = localhost (StrOpt) Qpid broker hostname.
[oslo_messaging_qpid] qpid_hosts = $qpid_hostname:$qpid_port (ListOpt) Qpid HA cluster host:port pairs.
[oslo_messaging_qpid] qpid_password = (StrOpt) Password for Qpid connection.
[oslo_messaging_qpid] qpid_port = 5672 (IntOpt) Qpid broker port.
[oslo_messaging_qpid] qpid_protocol = tcp (StrOpt) Transport to use, either 'tcp' or 'ssl'.
[oslo_messaging_qpid] qpid_receiver_capacity = 1 (IntOpt) The number of prefetched messages held by receiver.
[oslo_messaging_qpid] qpid_sasl_mechanisms = (StrOpt) Space separated list of SASL mechanisms to use for auth.
[oslo_messaging_qpid] qpid_tcp_nodelay = True (BoolOpt) Whether to disable the Nagle algorithm.
[oslo_messaging_qpid] qpid_topology_version = 1 (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.
[oslo_messaging_qpid] qpid_username = (StrOpt) Username for Qpid connection.
[oslo_messaging_qpid] rpc_conn_pool_size = 30 (IntOpt) Size of RPC connection pool.
[oslo_messaging_rabbit] amqp_auto_delete = False (BoolOpt) Auto-delete queues in AMQP.
[oslo_messaging_rabbit] amqp_durable_queues = False (BoolOpt) Use durable queues in AMQP.
[oslo_messaging_rabbit] fake_rabbit = False (BoolOpt) Deprecated, use rpc_backend=kombu+memory or rpc_backend=fake
[oslo_messaging_rabbit] heartbeat_rate = 2 (IntOpt) How often times during the heartbeat_timeout_threshold we check the heartbeat.
[oslo_messaging_rabbit] heartbeat_timeout_threshold = 0 (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
[oslo_messaging_rabbit] kombu_reconnect_delay = 1.0 (FloatOpt) How long to wait before reconnecting in response to an AMQP consumer cancel notification.
[oslo_messaging_rabbit] kombu_ssl_ca_certs = (StrOpt) SSL certification authority file (valid only if SSL enabled).
[oslo_messaging_rabbit] kombu_ssl_certfile = (StrOpt) SSL cert file (valid only if SSL enabled).
[oslo_messaging_rabbit] kombu_ssl_keyfile = (StrOpt) SSL key file (valid only if SSL enabled).
[oslo_messaging_rabbit] kombu_ssl_version = (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.
[oslo_messaging_rabbit] rabbit_ha_queues = False (BoolOpt) Use HA queues in RabbitMQ (x-ha-policy: all). If you change this option, you must wipe the RabbitMQ database.
[oslo_messaging_rabbit] rabbit_host = localhost (StrOpt) The RabbitMQ broker address where a single node is used.
[oslo_messaging_rabbit] rabbit_hosts = $rabbit_host:$rabbit_port (ListOpt) RabbitMQ HA cluster host:port pairs.
[oslo_messaging_rabbit] rabbit_login_method = AMQPLAIN (StrOpt) The RabbitMQ login method.
[oslo_messaging_rabbit] rabbit_max_retries = 0 (IntOpt) Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry count).
[oslo_messaging_rabbit] rabbit_password = guest (StrOpt) The RabbitMQ password.
[oslo_messaging_rabbit] rabbit_port = 5672 (IntOpt) The RabbitMQ broker port where a single node is used.
[oslo_messaging_rabbit] rabbit_retry_backoff = 2 (IntOpt) How long to backoff for between retries when connecting to RabbitMQ.
[oslo_messaging_rabbit] rabbit_retry_interval = 1 (IntOpt) How frequently to retry connecting with RabbitMQ.
[oslo_messaging_rabbit] rabbit_use_ssl = False (BoolOpt) Connect over SSL for RabbitMQ.
[oslo_messaging_rabbit] rabbit_userid = guest (StrOpt) The RabbitMQ userid.
[oslo_messaging_rabbit] rabbit_virtual_host = / (StrOpt) The RabbitMQ virtual host.
[oslo_messaging_rabbit] rpc_conn_pool_size = 30 (IntOpt) Size of RPC connection pool.
[oslo_middleware] max_request_body_size = 114688 (IntOpt) The maximum body size for each request, in bytes.
[profiler] profiler_enabled = False (BoolOpt) If False fully disable profiling feature.
[profiler] trace_sqlalchemy = False (BoolOpt) If False do not trace SQL requests.

Table 11.35. New default values

Option Previous default value New default value
[DEFAULT] auth_encryption_key notgood but just long enough i think notgood but just long enough i t
[DEFAULT] default_log_levels amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, oslo.messaging=INFO, iso8601=WARN, requests.packages.urllib3.connectionpool=WARN amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, oslo.messaging=INFO, iso8601=WARN, requests.packages.urllib3.connectionpool=WARN, urllib3.connectionpool=WARN, websocket=WARN, requests.packages.urllib3.util.retry=WARN, urllib3.util.retry=WARN, keystonemiddleware=WARN, routes.middleware=WARN, stevedore=WARN
[DEFAULT] deferred_auth_method password trusts
[DEFAULT] max_nested_stack_depth 3 5
[DEFAULT] num_engine_workers 1 4
[DEFAULT] plugin_dirs /usr/lib64/heat, /usr/lib/heat /usr/lib64/heat, /usr/lib/heat, /usr/local/lib/heat, /usr/local/lib64/heat
[DEFAULT] rpc_zmq_matchmaker oslo.messaging._drivers.matchmaker.MatchMakerLocalhost local
[DEFAULT] trusts_delegated_roles heat_stack_owner

Table 11.36. Deprecated options

Deprecated option New Option
[DEFAULT] log-format None
[DEFAULT] use-syslog None
[DEFAULT] list_notifier_drivers None