Configuration Reference
Configuring Red Hat OpenStack Platform environments
OpenStack Documentation Team
rhos-docs@redhat.com
OpenStack Documentation Team
rhos-docs@redhat.com
Abstract
Preface
This document describes the options available in the configuration files for each of the major services in Red Hat OpenStack Platform. The content is automatically generated based on the values in the configuration files themselves, and is provided for reference purposes only.
Manually editing configuration files is not supported. All configuration changes must be made through the Director. Red Hat provides this guide as a technical reference only.
Making open source more inclusive
Red Hat is committed to replacing problematic language in our code, documentation, and web properties. We are beginning with these four terms: master, slave, blacklist, and whitelist. Because of the enormity of this endeavor, these changes will be implemented gradually over several upcoming releases. For more details, see our CTO Chris Wright’s message.
Providing feedback on Red Hat documentation
We appreciate your input on our documentation. Tell us how we can make it better.
Using the Direct Documentation Feedback (DDF) function
Use the Add Feedback DDF function for direct comments on specific sentences, paragraphs, or code blocks.
- View the documentation in the Multi-page HTML format.
- Ensure that you see the Feedback button in the upper right corner of the document.
- Highlight the part of text that you want to comment on.
- Click Add Feedback.
- Complete the Add Feedback field with your comments.
- Optional: Add your email address so that the documentation team can contact you for clarification on your issue.
- Click Submit.
Chapter 1. barbican
The following chapter contains information about the configuration options in the barbican
service.
1.1. barbican.conf
This section contains options for the /etc/barbican/barbican.conf
file.
1.1.1. DEFAULT
The following table outlines the options available under the [DEFAULT]
group in the /etc/barbican/barbican.conf
file.
.
Configuration option = Default value | Type | Description |
---|---|---|
| string value | Role used to identify an authenticated user as administrator. |
| boolean value | Allow unauthenticated users to access the API with read-only privileges. This only applies when using ContextMiddleware. |
| string value | File name for the paste.deploy config for api service |
| string value | Enable eventlet backdoor. Acceptable values are 0, <port>, and <start>:<end>, where 0 results in listening on a random tcp port number; <port> results in listening on the specified port number (and not enabling backdoor if that port is in use); and <start>:<end> results in listening on the smallest unused port number within the specified range of port numbers. The chosen port is displayed in the service’s log file. |
| string value | Enable eventlet backdoor, using the provided path as a unix socket that can receive connections. This option is mutually exclusive with backdoor_port in that only one should be provided. If both are provided then the existence of this option overrides the usage of that option. Inside the path {pid} will be replaced with the PID of the current process. |
| integer value | Timeout for client connections' socket operations. If an incoming connection is idle for this number of seconds it will be closed. A value of 0 means wait forever. |
| integer value | The pool size limit for connections expiration policy |
| integer value | The time-to-live in sec of idle connections in the pool |
| string value | The default exchange under which topics are scoped. May be overridden by an exchange name specified in the transport_url option. |
| boolean value | Create the Barbican database on service startup. |
| boolean value | If set to true, the logging level will be set to DEBUG instead of the default INFO level. |
| integer value | Default page size for the limit paging URL parameter. |
| list value | List of package logging levels in logger=LEVEL pairs. This option is ignored if log_config_append is set. |
| integer value | Size of executor thread pool when executor is threading or eventlet. |
| boolean value | Enables or disables fatal status of deprecations. |
| string value | Host name, for use in HATEOAS-style references Note: Typically this would be the load balanced endpoint that clients would use to communicate back with this service. If a deployment wants to derive host from wsgi request instead then make this blank. Blank is needed to override default config value which is http://localhost:9311 |
`instance_format = [instance: %(uuid)s] ` | string value | The format for an instance that is passed with the log message. |
`instance_uuid_format = [instance: %(uuid)s] ` | string value | The format for an instance UUID that is passed with the log message. |
| string value | 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. Note that when logging configuration files are used then all logging configuration is set in the configuration file and other logging configuration options are ignored (for example, log-date-format). |
| string value | Defines the format string for %%(asctime)s in log records. Default: %(default)s . This option is ignored if log_config_append is set. |
| string value | (Optional) The base directory used for relative log_file paths. This option is ignored if log_config_append is set. |
| string value | (Optional) Name of log file to send logging output to. If no default is set, logging will go to stderr as defined by use_stderr. This option is ignored if log_config_append is set. |
| integer value | The amount of time before the log files are rotated. This option is ignored unless log_rotation_type is setto "interval". |
| string value | Rotation interval type. The time of the last file change (or the time when the service was started) is used when scheduling the next rotation. |
| string value | Log rotation type. |
| string value | Format string to use for log messages with context. Used by oslo_log.formatters.ContextFormatter |
| string value | Additional data to append to log message when logging level for the message is DEBUG. Used by oslo_log.formatters.ContextFormatter |
| string value | Format string to use for log messages when context is undefined. Used by oslo_log.formatters.ContextFormatter |
| string value | Prefix each line of exception output with this format. Used by oslo_log.formatters.ContextFormatter |
| string value | Defines the format string for %(user_identity)s that is used in logging_context_format_string. Used by oslo_log.formatters.ContextFormatter |
| integer value | Maximum allowed http request size against the barbican-api. |
| integer value | Maximum allowed secret size in bytes. |
| integer value | Maximum line size of message headers to be accepted. max_header_line may need to be increased when using large tokens (typically those generated when keystone is configured to use PKI tokens with big service catalogs). |
| integer value | Maximum page size for the limit paging URL parameter. |
| integer value | Maximum number of rotated log files. |
| integer value | Log file maximum size in MB. This option is ignored if "log_rotation_type" is not set to "size". |
| boolean value | Enables or disables publication of error events. |
| integer value | Maximum number of logged messages per rate_limit_interval. |
| string value | Log level name used by rate limiting: CRITICAL, ERROR, INFO, WARNING, DEBUG or empty string. Logs with level greater or equal to rate_limit_except_level are not filtered. An empty string means that all levels are filtered. |
| integer value | Interval, number of seconds, of log rate limiting. |
| integer value | Size of RPC connection pool. |
| integer value | Seconds to wait for a response from a call. |
| boolean value | Some periodic tasks can be run in a separate process. Should we run them here? |
| string value | SQLAlchemy connection string for the reference implementation registry server. Any valid SQLAlchemy connection string is fine. See: http://www.sqlalchemy.org/docs/05/reference/sqlalchemy/connections.html#sqlalchemy.create_engine. Note: For absolute addresses, use //// slashes after sqlite:. |
| integer value |
Period in seconds after which SQLAlchemy should reestablish its connection to the database. MySQL uses a default |
| integer value | Maximum number of database connection retries during startup. Set to -1 to specify an infinite retry count. |
| string value | Accepts a class imported from the sqlalchemy.pool module, and handles the details of building the pool for you. If commented out, SQLAlchemy will select based on the database dialect. Other options are QueuePool (for SQLAlchemy-managed connections) and NullPool (to disabled SQLAlchemy management of connections). See http://docs.sqlalchemy.org/en/latest/core/pooling.html for more details |
| boolean value | Show SQLAlchemy pool-related debugging output in logs (sets DEBUG log level output) if specified. |
| integer value | The maximum overflow size of the pool used by SQLAlchemy. When the number of checked-out connections reaches the size set in sql_pool_size, additional connections will be returned up to this limit. It follows then that the total number of simultaneous connections the pool will allow is sql_pool_size + sql_pool_max_overflow. Can be set to -1 to indicate no overflow limit, so no limit will be placed on the total number of concurrent connections. Comment out to allow SQLAlchemy to select the default. |
| integer value | Size of pool used by SQLAlchemy. This is the largest number of connections that will be kept persistently in the pool. Can be set to 0 to indicate no size limit. To disable pooling, use a NullPool with sql_pool_class instead. Comment out to allow SQLAlchemy to select the default. |
| integer value | Interval between retries of opening a SQL connection. |
| string value | Syslog facility to receive log lines. This option is ignored if log_config_append is set. |
| integer value | Sets the value of TCP_KEEPIDLE in seconds for each server socket. Not supported on OS X. |
| string value | The network address and optional user credentials for connecting to the messaging backend, in URL format. The expected format is: driver://[user:pass@]host:port[,[userN:passN@]hostN:portN]/virtual_host?query Example: rabbit://rabbitmq:password@127.0.0.1:5672// For full details on the fields in the URL see the documentation of oslo_messaging.TransportURL at https://docs.openstack.org/oslo.messaging/latest/reference/transport.html |
| boolean value | Enable journald for logging. If running in a systemd environment you may wish to enable journal support. Doing so will use the journal native protocol which includes structured metadata in addition to log messages.This option is ignored if log_config_append is set. |
| boolean value | Use JSON formatting for logging. This option is ignored if log_config_append is set. |
| boolean value | Use syslog for logging. Existing syslog format is DEPRECATED and will be changed later to honor RFC5424. This option is ignored if log_config_append is set. |
| boolean value | Log output to Windows Event Log. |
| boolean value | Log output to standard error. This option is ignored if log_config_append is set. |
| boolean value | Uses logging handler designed to watch file system. When log file is moved or removed this handler will open a new log file with specified path instantaneously. It makes sense only if log_file option is specified and Linux platform is used. This option is ignored if log_config_append is set. |
| integer value | Size of the pool of greenthreads used by wsgi |
| boolean value | If False, closes the client socket connection explicitly. |
| string value | A python format string that is used as the template to generate log lines. The following values can beformatted into it: client_ip, date_time, request_line, status_code, body_length, wall_seconds. |
1.1.2. certificate
The following table outlines the options available under the [certificate]
group in the /etc/barbican/barbican.conf
file.
Table 1.1. certificate
Configuration option = Default value | Type | Description |
---|---|---|
| multi valued | List of certificate plugins to load. |
| string value | Extension namespace to search for plugins. |
1.1.3. certificate_event
The following table outlines the options available under the [certificate_event]
group in the /etc/barbican/barbican.conf
file.
Table 1.2. certificate_event
Configuration option = Default value | Type | Description |
---|---|---|
| multi valued | List of certificate plugins to load. |
| string value | Extension namespace to search for eventing plugins. |
1.1.4. cors
The following table outlines the options available under the [cors]
group in the /etc/barbican/barbican.conf
file.
Table 1.3. cors
Configuration option = Default value | Type | Description |
---|---|---|
| boolean value | Indicate that the actual request can include user credentials |
| list value | Indicate which header field names may be used during the actual request. |
| list value | Indicate which methods can be used during the actual request. |
| list value | Indicate whether this resource may be shared with the domain received in the requests "origin" header. Format: "<protocol>://<host>[:<port>]", no trailing slash. Example: https://horizon.example.com |
| list value | Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers. |
| integer value | Maximum cache age of CORS preflight requests. |
1.1.5. crypto
The following table outlines the options available under the [crypto]
group in the /etc/barbican/barbican.conf
file.
Table 1.4. crypto
Configuration option = Default value | Type | Description |
---|---|---|
| multi valued | List of crypto plugins to load. |
| string value | Extension namespace to search for plugins. |
1.1.6. dogtag_plugin
The following table outlines the options available under the [dogtag_plugin]
group in the /etc/barbican/barbican.conf
file.
Table 1.5. dogtag_plugin
Configuration option = Default value | Type | Description |
---|---|---|
| string value | List of automatically approved enrollment profiles |
| string value | Time in days for CA entries to expire |
| string value | Hostname for the Dogtag instance |
| port value | Port for the Dogtag instance |
| string value | Path to the NSS certificate database |
| string value | Password for the NSS certificate databases |
| string value | Path to PEM file for authentication |
| string value | User friendly plugin name |
| string value | Working directory for Dogtag plugin |
| integer value | Retries when storing or generating secrets |
| string value | Profile for simple CMC requests |
1.1.7. keystone_authtoken
The following table outlines the options available under the [keystone_authtoken]
group in the /etc/barbican/barbican.conf
file.
Table 1.6. keystone_authtoken
Configuration option = Default value | Type | Description |
---|---|---|
| string value | Config Section from which to load plugin specific options |
| string value | Authentication type to load |
| string value | (DEPRECATED FOR REMOVAL) Complete "public" Identity API endpoint. This endpoint should not be an "admin" endpoint, as it should be accessible by all end users. Unauthenticated clients are redirected to this endpoint to authenticate. Although this endpoint should ideally be unversioned, client support in the wild varies. If you’re using a versioned v2 endpoint here, then this should not be the same endpoint the service user utilizes for validating tokens, because normal end users may not be able to reach that endpoint. This option is deprecated in favor of www_authenticate_uri and will be removed in the S release. |
| string value | API version of the Identity API endpoint. |
| string value |
Request environment key where the Swift cache object is stored. When auth_token middleware is deployed with a Swift cache, use this option to have the middleware share a caching backend with swift. Otherwise, use the |
| string value | A PEM encoded Certificate Authority to use when verifying HTTPs connections. Defaults to system CAs. |
| string value | Required if identity server requires client certificate |
| boolean value | Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components. |
| string value | Used to control the use and type of token binding. Can be set to: "disabled" to not check token binding. "permissive" (default) to validate binding information if the bind type is of a form known to the server and ignore it if not. "strict" like "permissive" but if the bind type is unknown the token will be rejected. "required" any form of token binding is needed to be allowed. Finally the name of a binding method that must be present in tokens. |
| integer value | Request timeout value for communicating with Identity API server. |
| integer value | How many times are we trying to reconnect when communicating with Identity API Server. |
| boolean value | (Optional) Indicate whether to set the X-Service-Catalog header. If False, middleware will not ask for service catalog on token validation and will not set the X-Service-Catalog header. |
| boolean value | Verify HTTPS connections. |
| string value | Interface to use for the Identity API endpoint. Valid values are "public", "internal" or "admin"(default). |
| string value | Required if identity server requires client certificate |
| integer value | (Optional) Number of seconds that an operation will wait to get a memcached client connection from the pool. |
| integer value | (Optional) Number of seconds memcached server is considered dead before it is tried again. |
| integer value | (Optional) Maximum total number of open connections to every memcached server. |
| integer value | (Optional) Socket timeout in seconds for communicating with a memcached server. |
| integer value | (Optional) Number of seconds a connection to memcached is held unused in the pool before it is closed. |
| string value | (Optional, mandatory if memcache_security_strategy is defined) This string is used for key derivation. |
| string value | (Optional) If defined, indicate whether token data should be authenticated or authenticated and encrypted. If MAC, token data is authenticated (with HMAC) in the cache. If ENCRYPT, token data is encrypted and authenticated in the cache. If the value is not one of these options or empty, auth_token will raise an exception on initialization. |
| boolean value | (Optional) Use the advanced (eventlet safe) memcached client pool. The advanced pool will only work under python 2.x. |
| list value | Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process. |
| string value | The region in which the identity server can be found. |
| list value | A choice of roles that must be present in a service token. Service tokens are allowed to request that an expired token can be used and so this check should tightly control that only actual services should be sending this token. Roles here are applied as an ANY check so any role in this list must be present. For backwards compatibility reasons this currently only affects the allow_expired check. |
| boolean value | For backwards compatibility reasons we must let valid service tokens pass that don’t pass the service_token_roles check as valid. Setting this true will become the default in a future release and should be enabled if possible. |
| string value | The name or type of the service as it appears in the service catalog. This is used to validate tokens that have restricted access rules. |
| integer value | In order to prevent excessive effort spent validating tokens, the middleware caches previously-seen tokens for a configurable duration (in seconds). Set to -1 to disable caching completely. |
| string value | Complete "public" Identity API endpoint. This endpoint should not be an "admin" endpoint, as it should be accessible by all end users. Unauthenticated clients are redirected to this endpoint to authenticate. Although this endpoint should ideally be unversioned, client support in the wild varies. If you’re using a versioned v2 endpoint here, then this should not be the same endpoint the service user utilizes for validating tokens, because normal end users may not be able to reach that endpoint. |
1.1.8. keystone_notifications
The following table outlines the options available under the [keystone_notifications]
group in the /etc/barbican/barbican.conf
file.
Table 1.7. keystone_notifications
Configuration option = Default value | Type | Description |
---|---|---|
| boolean value | True enables requeue feature in case of notification processing error. Enable this only when underlying transport supports this feature. |
| string value | The default exchange under which topics are scoped. May be overridden by an exchange name specified in the transport_url option. |
| boolean value | True enables keystone notification listener functionality. |
| integer value | Define the number of max threads to be used for notification server processing functionality. |
| string value | Keystone notification queue topic name. This name needs to match one of values mentioned in Keystone deployment’s notification_topics configuration e.g. notification_topics=notifications, barbican_notificationsMultiple servers may listen on a topic and messages will be dispatched to one of the servers in a round-robin fashion. That’s why Barbican service should have its own dedicated notification queue so that it receives all of Keystone notifications. |
| string value | Version of tasks invoked via notifications |
1.1.9. kmip_plugin
The following table outlines the options available under the [kmip_plugin]
group in the /etc/barbican/barbican.conf
file.
Table 1.8. kmip_plugin
Configuration option = Default value | Type | Description |
---|---|---|
| string value | File path to concatenated "certification authority" certificates |
| string value | File path to local client certificate |
| string value | Address of the KMIP server |
| string value | File path to local client certificate keyfile |
| string value | Password for authenticating with KMIP server |
| boolean value | Only support PKCS#1 encoding of asymmetric keys |
| string value | User friendly plugin name |
| port value | Port for the KMIP server |
| string value | SSL version, maps to the module ssl’s constants |
| string value | Username for authenticating with KMIP server |
1.1.10. oslo_messaging_amqp
The following table outlines the options available under the [oslo_messaging_amqp]
group in the /etc/barbican/barbican.conf
file.
Table 1.9. oslo_messaging_amqp
Configuration option = Default value | Type | Description |
---|---|---|
| string value | 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 |
| string value | 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. |
| string value | address prefix used when broadcasting to all servers |
| integer value | Increase the connection_retry_interval by this many seconds after each unsuccessful failover attempt. |
| integer value | Seconds to pause before attempting to re-connect. |
| integer value | Maximum limit for connection_retry_interval + connection_retry_backoff |
| string value | Name for the AMQP container. must be globally unique. Defaults to a generated UUID |
| string value | 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 |
| integer value | The deadline for a sent notification message delivery. Only used when caller does not provide a timeout expiry. |
| integer value | The maximum number of attempts to re-send a reply message which failed due to a recoverable error. |
| integer value | The deadline for an rpc reply message delivery. |
| string value | 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 |
| integer value | The deadline for an rpc cast or call message delivery. Only used when caller does not provide a timeout expiry. |
| integer value | The duration to schedule a purge of idle sender links. Detach link after expiry. |
| string value | address prefix when sending to any server in group |
| integer value | Timeout for inactive connections (in seconds) |
| integer value | Time to pause between re-connecting an AMQP 1.0 link that failed due to a recoverable error. |
| string value | Appended to the address prefix when sending a fanout message. Used by the message bus to identify fanout messages. |
| string value | Address prefix for all generated Notification addresses |
| integer value | Window size for incoming Notification messages |
| multi valued | Send messages of this type pre-settled. Pre-settled messages will not receive acknowledgement from the peer. Note well: pre-settled messages may be silently discarded if the delivery fails. Permitted values: rpc-call - send RPC Calls pre-settled rpc-reply- send RPC Replies pre-settled rpc-cast - Send RPC Casts pre-settled notify - Send Notifications pre-settled |
| boolean value | Enable virtual host support for those message buses that do not natively support virtual hosting (such as qpidd). When set to true the virtual host name will be added to all message bus addresses, effectively creating a private subnet per virtual host. Set to False if the message bus supports virtual hosting using the hostname field in the AMQP 1.0 Open performative as the name of the virtual host. |
| integer value | Window size for incoming RPC Reply messages. |
| string value | Address prefix for all generated RPC addresses |
| integer value | Window size for incoming RPC Request messages |
`sasl_config_dir = ` | string value | Path to directory that contains the SASL configuration |
`sasl_config_name = ` | string value | Name of configuration file (without .conf suffix) |
`sasl_default_realm = ` | string value | SASL realm to use if no realm present in username |
`sasl_mechanisms = ` | string value | Space separated list of acceptable SASL mechanisms |
| string value | address prefix used when sending to a specific server |
| boolean value | Attempt to connect via SSL. If no other ssl-related parameters are given, it will use the system’s CA-bundle to verify the server’s certificate. |
`ssl_ca_file = ` | string value | CA certificate PEM file used to verify the server’s certificate |
`ssl_cert_file = ` | string value | Self-identifying certificate PEM file for client authentication |
`ssl_key_file = ` | string value | Private key PEM file used to sign ssl_cert_file certificate (optional) |
| string value | Password for decrypting ssl_key_file (if encrypted) |
| boolean value | By default SSL checks that the name in the server’s certificate matches the hostname in the transport_url. In some configurations it may be preferable to use the virtual hostname instead, for example if the server uses the Server Name Indication TLS extension (rfc6066) to provide a certificate per virtual host. Set ssl_verify_vhost to True if the server’s SSL certificate uses the virtual host name instead of the DNS name. |
| boolean value | Debug: dump AMQP frames to stdout |
| string value | 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. |
1.1.11. oslo_messaging_kafka
The following table outlines the options available under the [oslo_messaging_kafka]
group in the /etc/barbican/barbican.conf
file.
Table 1.10. oslo_messaging_kafka
Configuration option = Default value | Type | Description |
---|---|---|
| string value | The compression codec for all data generated by the producer. If not set, compression will not be used. Note that the allowed values of this depend on the kafka version |
| integer value | (DEPRECATED FOR REMOVAL) The pool size limit for connections expiration policy |
| integer value | (DEPRECATED FOR REMOVAL) The time-to-live in sec of idle connections in the pool |
| string value | Group id for Kafka consumer. Consumers in one group will coordinate message consumption |
| boolean value | Enable asynchronous consumer commits |
| floating point value | Default timeout(s) for Kafka consumers |
| integer value | Max fetch bytes of Kafka consumer |
| integer value | The maximum number of records returned in a poll call |
| integer value | (DEPRECATED FOR REMOVAL) Pool Size for Kafka Consumers |
| integer value | Size of batch for the producer async send |
| floating point value | Upper bound on the delay for KafkaProducer batching in seconds |
| string value | Mechanism when security protocol is SASL |
| string value | Protocol used to communicate with brokers |
`ssl_cafile = ` | string value | CA certificate PEM file used to verify the server certificate |
1.1.12. oslo_messaging_notifications
The following table outlines the options available under the [oslo_messaging_notifications]
group in the /etc/barbican/barbican.conf
file.
Table 1.11. oslo_messaging_notifications
Configuration option = Default value | Type | Description |
---|---|---|
| multi valued | The Drivers(s) to handle sending notifications. Possible values are messaging, messagingv2, routing, log, test, noop |
| integer value | The maximum number of attempts to re-send a notification message which failed to be delivered due to a recoverable error. 0 - No retry, -1 - indefinite |
| list value | AMQP topic used for OpenStack notifications. |
| string value | A URL representing the messaging driver to use for notifications. If not set, we fall back to the same configuration used for RPC. |
1.1.13. oslo_messaging_rabbit
The following table outlines the options available under the [oslo_messaging_rabbit]
group in the /etc/barbican/barbican.conf
file.
Table 1.12. oslo_messaging_rabbit
Configuration option = Default value | Type | Description |
---|---|---|
| boolean value | Auto-delete queues in AMQP. |
| boolean value | Use durable queues in AMQP. |
| integer value | Enable/Disable the RabbitMQ mandatory flag for direct send. The direct send is used as reply,so the MessageUndeliverable exception is raised in case the client queue does not exist. |
| boolean value | EXPERIMENTAL: Run the health check heartbeat threadthrough a native python thread. By default if thisoption isn’t provided the health check heartbeat willinherit the execution model from the parent process. Byexample if the parent process have monkey patched thestdlib by using eventlet/greenlet then the heartbeatwill be run through a green thread. |
| integer value | How often times during the heartbeat_timeout_threshold we check the heartbeat. |
| integer value | Number of seconds after which the Rabbit broker is considered down if heartbeat’s keep-alive fails (0 disables heartbeat). |
| string value | EXPERIMENTAL: Possible values are: gzip, bz2. If not set compression will not be used. This option may not be available in future versions. |
| string value | 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. |
| integer value | How long to wait a missing client before abandoning to send it its replies. This value should not be longer than rpc_response_timeout. |
| floating point value | How long to wait before reconnecting in response to an AMQP consumer cancel notification. |
| boolean value | 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"} " |
| integer value | Maximum interval of RabbitMQ connection retries. Default is 30 seconds. |
| string value | The RabbitMQ login method. |
| integer value | Specifies the number of messages to prefetch. Setting to zero allows unlimited messages. |
| integer value | How long to backoff for between retries when connecting to RabbitMQ. |
| integer value | How frequently to retry connecting with RabbitMQ. |
| integer value | 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. |
| boolean value | Connect over SSL. |
`ssl_ca_file = ` | string value | SSL certification authority file (valid only if SSL enabled). |
`ssl_cert_file = ` | string value | SSL cert file (valid only if SSL enabled). |
`ssl_key_file = ` | string value | SSL key file (valid only if SSL enabled). |
`ssl_version = ` | string value | 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. |
1.1.14. oslo_middleware
The following table outlines the options available under the [oslo_middleware]
group in the /etc/barbican/barbican.conf
file.
Table 1.13. oslo_middleware
Configuration option = Default value | Type | Description |
---|---|---|
| boolean value | Whether the application is behind a proxy or not. This determines if the middleware should parse the headers or not. |
1.1.15. oslo_policy
The following table outlines the options available under the [oslo_policy]
group in the /etc/barbican/barbican.conf
file.
Table 1.14. oslo_policy
Configuration option = Default value | Type | Description |
---|---|---|
| boolean value |
This option controls whether or not to enforce scope when evaluating policies. If |
| string value | Default rule. Enforced when a requested rule is not found. |
| multi valued | 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. |
| string value | The relative or absolute path of a file that maps roles to permissions for a given service. Relative paths must be specified in relation to the configuration file setting this option. |
| string value | Content Type to send and receive data for REST based policy check |
| string value | Absolute path to ca cert file for REST based policy check |
| string value | Absolute path to client cert for REST based policy check |
| string value | Absolute path client key file REST based policy check |
| boolean value | server identity verification for REST based policy check |
1.1.16. p11_crypto_plugin
The following table outlines the options available under the [p11_crypto_plugin]
group in the /etc/barbican/barbican.conf
file.
Table 1.15. p11_crypto_plugin
Configuration option = Default value | Type | Description |
---|---|---|
| boolean value | Generate IVs for CKM_AES_GCM mechanism. |
| boolean value | Always set CKA_SENSITIVE=CK_TRUE including CKA_EXTRACTABLE=CK_TRUE keys. |
| string value | Secret encryption mechanism |
| string value | HMAC Key Type |
| string value | HMAC Key Generation Algorithm |
| string value | HMAC key wrap mechanism |
| string value | Master HMAC Key label (as stored in the HSM) |
| string value | Path to vendor PKCS11 library |
| string value | Password to login to PKCS11 session |
| string value | Master KEK label (as stored in the HSM) |
| integer value | Master KEK length in bytes. |
| integer value | Project KEK Cache Item Limit |
| integer value | Project KEK Cache Time To Live, in seconds |
| integer value | Project KEK length in bytes. |
| string value | User friendly plugin name |
| boolean value | Flag for Read/Write Sessions |
`seed_file = ` | string value | File to pull entropy for seeding RNG |
| integer value | Amount of data to read from file for seed |
| integer value | (Optional) HSM Slot ID that contains the token device to be used. |
| string value | Token label used to identify the token to be used. Required when token_serial_number is not specified. |
| string value | Token serial number used to identify the token to be used. Required when the device has multiple tokens with the same label. |
1.1.17. queue
The following table outlines the options available under the [queue]
group in the /etc/barbican/barbican.conf
file.
Table 1.16. queue
Configuration option = Default value | Type | Description |
---|---|---|
| integer value | Number of asynchronous worker processes |
| boolean value | True enables queuing, False invokes workers synchronously |
| string value | Queue namespace |
| string value | Server name for RPC task processing server |
| string value | Queue topic name |
| string value | Version of tasks invoked via queue |
1.1.18. quotas
The following table outlines the options available under the [quotas]
group in the /etc/barbican/barbican.conf
file.
Table 1.17. quotas
Configuration option = Default value | Type | Description |
---|---|---|
| integer value | Number of CAs allowed per project |
| integer value | Number of consumers allowed per project |
| integer value | Number of containers allowed per project |
| integer value | Number of orders allowed per project |
| integer value | Number of secrets allowed per project |
1.1.19. retry_scheduler
The following table outlines the options available under the [retry_scheduler]
group in the /etc/barbican/barbican.conf
file.
Table 1.18. retry_scheduler
Configuration option = Default value | Type | Description |
---|---|---|
| floating point value | Seconds (float) to wait before starting retry scheduler |
| floating point value | Seconds (float) to wait between periodic schedule events |
1.1.20. secretstore
The following table outlines the options available under the [secretstore]
group in the /etc/barbican/barbican.conf
file.
Table 1.19. secretstore
Configuration option = Default value | Type | Description |
---|---|---|
| boolean value | Flag to enable multiple secret store plugin backend support. Default is False |
| multi valued | List of secret store plugins to load. |
| string value | Extension namespace to search for plugins. |
| list value | List of suffix to use for looking up plugins which are supported with multiple backend support. |
1.1.21. simple_crypto_plugin
The following table outlines the options available under the [simple_crypto_plugin]
group in the /etc/barbican/barbican.conf
file.
Table 1.20. simple_crypto_plugin
Configuration option = Default value | Type | Description |
---|---|---|
| string value | Key encryption key to be used by Simple Crypto Plugin |
| string value | User friendly plugin name |
1.1.22. snakeoil_ca_plugin
The following table outlines the options available under the [snakeoil_ca_plugin]
group in the /etc/barbican/barbican.conf
file.
Table 1.21. snakeoil_ca_plugin
Configuration option = Default value | Type | Description |
---|---|---|
| string value | Path to CA certificate chain file |
| string value | Path to CA certificate key file |
| string value | Path to CA certificate file |
| string value | Path to CA chain pkcs7 file |
| string value | Directory in which to store certs/keys for subcas |
1.1.23. ssl
The following table outlines the options available under the [ssl]
group in the /etc/barbican/barbican.conf
file.
Table 1.22. ssl
Configuration option = Default value | Type | Description |
---|---|---|
| string value | CA certificate file to use to verify connecting clients. |
| string value | Certificate file to use when starting the server securely. |
| string value | Sets the list of available ciphers. value should be a string in the OpenSSL cipher list format. |
| string value | Private key file to use when starting the server securely. |
| string value | 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. |
Chapter 2. cinder
The following chapter contains information about the configuration options in the cinder
service.
2.1. cinder.conf
This section contains options for the /etc/cinder/cinder.conf
file.
2.1.1. DEFAULT
The following table outlines the options available under the [DEFAULT]
group in the /etc/cinder/cinder.conf
file.
.
Configuration option = Default value | Type | Description |
---|---|---|
| floating point value | Multiplier used for weighing allocated capacity. Positive numbers mean to stack vs spread. |
| boolean value | If the requested Cinder availability zone is unavailable, fall back to the value of default_availability_zone, then storage_availability_zone, instead of failing. |
| boolean value | The strategy to use for image compression on upload. Default is disallow compression. |
| list value | A list of url schemes that can be downloaded directly via the direct_url. Currently supported schemes: [file, cinder]. |
| string value | File name for the paste.deploy config for api service |
| boolean value | Enables or disables rate limit of the API. |
| list value | The Storage Pools Cinder should use, a comma separated list. |
| string value | The pool which is used as a meta pool when creating a volume, and it should be a replication pool at present. If not set, the driver will choose a replication pool from the value of as13000_ipsan_pools. |
| integer value | The effective time of token validity in seconds. |
| string value | The strategy to use for auth. Supports noauth or keystone. |
| integer value | Cache volume availability zones in memory for the provided duration in seconds |
| string value | Enable eventlet backdoor. Acceptable values are 0, <port>, and <start>:<end>, where 0 results in listening on a random tcp port number; <port> results in listening on the specified port number (and not enabling backdoor if that port is in use); and <start>:<end> results in listening on the smallest unused port number within the specified range of port numbers. The chosen port is displayed in the service’s log file. |
| string value | Enable eventlet backdoor, using the provided path as a unix socket that can receive connections. This option is mutually exclusive with backdoor_port in that only one should be provided. If both are provided then the existence of this option overrides the usage of that option. Inside the path {pid} will be replaced with the PID of the current process. |
| string value | Availability zone for this volume backend. If not set, the storage_availability_zone option value is used as the default for all backends. |
| integer value | Time in seconds between requests for usage statistics from the backend. Be aware that generating usage statistics is expensive for some backends, so setting this value too low may adversely affect performance. |
| string value | The full class name of the volume backup API class |
| integer value | The chunk size, in bytes, that a backup is broken into before transfer to the Ceph object store. |
| string value | Ceph configuration file to use. |
| boolean value | If True, apply JOURNALING and EXCLUSIVE_LOCK feature bits to the backup RBD objects to allow mirroring |
| string value | The Ceph pool where volume backups are stored. |
| integer value | RBD stripe count to use when creating a backup image. |
| integer value | RBD stripe unit to use when creating a backup image. |
| string value | The Ceph user to connect with. Default here is to use the same user as for Cinder volumes. If not using cephx this should be set to None. |
| string value | Compression algorithm ("none" to disable) |
| string value | Custom directory to use for backups. |
| string value | Driver to use for backups. |
| integer value | Time in seconds between checks to see if the backup driver has been successfully initialized, any time the driver is restarted. |
| integer value | Time in seconds between checks of the backup driver status. If does not report as working, it is restarted. |
| boolean value | Enable or Disable the timer to send the periodic progress notifications to Ceilometer when backing up the volume to the backend storage. The default value is True to enable the timer. |
| integer value | The maximum size in bytes of the files used to hold backups. If the volume being backed up exceeds this size, then it will be backed up into multiple files.backup_file_size must be a multiple of backup_sha_block_size_bytes. |
| integer value | The size in bytes that changes are tracked for incremental backups. backup_gcs_object_size has to be multiple of backup_gcs_block_size. |
| string value | The GCS bucket to use. |
| string value | Location of GCS bucket. |
| string value | Absolute path of GCS service account credential file. |
| boolean value | Enable or Disable the timer to send the periodic progress notifications to Ceilometer when backing up the volume to the GCS backend storage. The default value is True to enable the timer. |
| integer value | Number of times to retry. |
| integer value | The size in bytes of GCS backup objects. |
| string value | Owner project id for GCS bucket. |
| uri value | URL for http proxy access. |
| integer value | GCS object will be downloaded in chunks of bytes. |
| list value | List of GCS error codes. |
| string value | Storage class of GCS bucket. |
| string value | Http user-agent string for gcs api. |
| integer value | GCS object will be uploaded in chunks of bytes. Pass in a value of -1 if the file is to be uploaded as a single chunk. |
| string value | Full class name for the Manager for volume backup |
| integer value | Backup metadata version to be used when backing up volume metadata. If this number is bumped, make sure the service doing the restore supports the new version. |
| integer value | The number of attempts to mount NFS shares before raising an error. |
| string value | Mount options passed to the NFS client. See NFS man page for details. |
| string value | Base dir containing mount point for NFS share. |
| string value | Template string to be used to generate backup names |
| integer value | Size of the native threads pool for the backups. Most backup drivers rely heavily on this, it can be decreased for specific drivers that don’t. |
| integer value | The number of chunks or objects, for which one Ceilometer notification will be sent |
| string value | Path specifying where to store backups. |
| boolean value | Offload pending backup delete during backup service startup. If false, the backup service will remain down until all pending backups are deleted. |
| integer value | The size in bytes that changes are tracked for incremental backups. backup_file_size has to be multiple of backup_sha_block_size_bytes. |
| string value | NFS share in hostname:path, ipv4addr:path, or "[ipv6addr]:path" format. |
| string value | Swift authentication mechanism (per_user or single_user). |
| boolean value | Bypass verification of server certificate when making SSL connection to Swift. |
| uri value | The URL of the Keystone endpoint |
| string value | Swift authentication version. Specify "1" for auth 1.0, or "2" for auth 2.0 or "3" for auth 3.0 |
| integer value | The size in bytes that changes are tracked for incremental backups. backup_swift_object_size has to be multiple of backup_swift_block_size. |
| string value | Location of the CA certificate file to use for swift client requests. |
| string value | The default Swift container to use |
| boolean value | Enable or Disable the timer to send the periodic progress notifications to Ceilometer when backing up the volume to the Swift backend storage. The default value is True to enable the timer. |
| string value | Swift key for authentication |
| integer value | The size in bytes of Swift backup objects |
| string value | Swift project/account name. Required when connecting to an auth 3.0 system |
| string value | Swift project domain name. Required when connecting to an auth 3.0 system |
| integer value | The number of retries to make for Swift operations |
| integer value | The backoff time in seconds between Swift retries |
| string value | Swift tenant/account name. Required when connecting to an auth 2.0 system |
| uri value | The URL of the Swift endpoint |
| string value | Swift user name |
| string value | Swift user domain name. Required when connecting to an auth 3.0 system |
| integer value | Interval, in seconds, between two progress notifications reporting the backup status |
| boolean value | Enable or Disable compression for backups |
| string value | TSM password for the running username |
| string value | Volume prefix for the backup id when backing up to TSM |
| boolean value | Backup services use same backend. |
| boolean value | If this is set to True, a temporary snapshot will be created for performing non-disruptive backups. Otherwise a temporary volume will be cloned in order to perform a backup. |
| integer value | Number of backup processes to launch. Improves performance with concurrent backups. |
| floating point value | Multiplier used for weighing free capacity. Negative numbers mean to stack vs spread. |
`chap_password = ` | string value | Password for specified CHAP account name. |
`chap_username = ` | string value | CHAP user name. |
| string value | Chiscsi (CXT) global defaults configuration file |
| string value | ID of the project which will be used as the Cinder internal tenant. |
| string value | ID of the user to be used in volume operations as the Cinder internal tenant. |
| integer value | Timeout for client connections' socket operations. If an incoming connection is idle for this number of seconds it will be closed. A value of 0 means wait forever. |
| integer value | (DEPRECATED FOR REMOVAL) Create clone volume timeout |
| boolean value | Ensure that the new volumes are the same AZ as snapshot or source volume |
| string value | Name of this cluster. Used to group volume hosts that share the same backend configurations to work in HA Active-Active mode. Active-Active is not yet supported. |
| string value | Image compression format on image upload |
| string value | The full class name of the compute API class to use |
| list value |
Path to a config directory to pull |
| unknown value | Path to a config file to use. Multiple config files can be specified, with values in later files taking precedence. Defaults to %(default)s. This option must be set from the command-line. |
| list value | Lists configuration groups that provide more details for accessing configuration settings from locations other than local files. |
| integer value | The pool size limit for connections expiration policy |
| integer value | The time-to-live in sec of idle connections in the pool |
| string value | The full class name of the consistencygroup API class |
| string value | The default exchange under which topics are scoped. May be overridden by an exchange name specified in the transport_url option. |
| integer value | Interval between 503 retries |
| integer value | Timeout for HTTP 503 retry messages |
| string value | (DEPRECATED FOR REMOVAL) Datera API port. |
| string value | (DEPRECATED FOR REMOVAL) Datera API version. |
| boolean value | True to set function arg and return logging |
| boolean value | ONLY FOR DEBUG/TESTING PURPOSES True to set replica_count to 1 |
| boolean value | Set to True to disable sending additional metadata to the Datera backend |
| boolean value | Set to True to disable profiling in the Datera driver |
| boolean value | Set to True to disable automatic template override of the size attribute when creating from a template |
| boolean value | Set to True to enable Datera backend image caching |
| string value | Cinder volume type id to use for cached volumes |
| string value | LDAP authentication server |
| string value | If set to Map -→ OpenStack project ID will be mapped implicitly to Datera tenant ID If set to None -→ Datera tenant ID will not be used during volume provisioning If set to anything else -→ Datera tenant ID will be the provided value |
| dict value | Settings here will be used as volume-type defaults if the volume-type setting is not provided. This can be used, for example, to set a very low total_iops_max value if none is specified in the volume-type to prevent accidental overusage. Options are specified via the following format, WITHOUT ANY DF: PREFIX: datera_volume_type_defaults=iops_per_gb:100,bandwidth_per_gb:200…etc. |
| string value | Driver to use for database access |
| boolean value | If set to true, the logging level will be set to DEBUG instead of the default INFO level. |
| string value | Default availability zone for new volumes. If not set, the storage_availability_zone option value is used as the default for new volumes. |
| string value | Default group type to use |
| list value | List of package logging levels in logger=LEVEL pairs. This option is ignored if log_config_append is set. |
| string value | Default volume type to use |
| string value | The path to the client certificate for verification, if the driver supports it. |
| string value | The path to the client certificate key for verification, if the driver supports it. |
| string value | Namespace for driver private data values to be saved in. |
| string value | Can be used to specify a non default path to a CA_BUNDLE file or directory with certificates of trusted CAs, which will be used to validate the backend |
| boolean value | If set to True the http client will validate the SSL certificate of the backend endpoint. |
| boolean value | Tell driver to use SSL for connection to backend storage if the driver supports it. |
| boolean value | (DEPRECATED FOR REMOVAL) The flag of thin storage allocation. |
`dsware_manager = ` | string value | (DEPRECATED FOR REMOVAL) Fusionstorage manager ip addr for cinder-volume. |
`dsware_rest_url = ` | string value | The address of FusionStorage array. For example, "dsware_rest_url=xxx" |
`dsware_storage_pools = ` | string value | The list of pools on the FusionStorage array, the semicolon(;) was used to split the storage pools, "dsware_storage_pools = xxx1; xxx2; xxx3" |
| boolean value | Enables the Force option on upload_to_image. This enables running upload_volume on in-use volumes for backends that support it. |
| boolean value | Services to be added to the available pool on create |
| boolean value | Set this to True when you want to allow an unsupported driver to start. Drivers that haven’t maintained a working CI system and testing are marked as unsupported until CI is working again. This also marks a driver as deprecated and may be removed in the next release. |
| boolean value | (DEPRECATED FOR REMOVAL) DEPRECATED: Deploy v2 of the Cinder API. |
| boolean value | Deploy v3 of the Cinder API. |
| list value | A list of backend names to use. These backend names should be backed by a unique [CONFIG] group with its options |
| boolean value | If this is set to True, attachment of volumes for image transfer will be aborted when multipathd is not running. Otherwise, it will fallback to single path. |
| integer value | Size of executor thread pool when executor is threading or eventlet. |
| boolean value | Enables or disables fatal status of deprecations. |
| string value | String representation for an equation that will be used to filter hosts. Only used when the driver filter is set to be used by the Cinder scheduler. |
`fusionstorageagent = ` | string value | (DEPRECATED FOR REMOVAL) Fusionstorage agent ip addr range |
| boolean value | Allow to perform insecure SSL (https) requests to glance (https will be used but cert validation will not be performed). |
| list value | A list of the URLs of glance API servers available to cinder ([http[s]://][hostname|ip]:port). If protocol is not specified it defaults to http. |
| boolean value | Enables or disables negotiation of SSL layer compression. In some cases disabling compression can improve data throughput, such as when high network bandwidth is available and you use compressed image formats like qcow2. |
| string value | Location of ca certificates file to use for glance client requests. |
| string value | Info to match when looking for glance in the service catalog. Format is: separated values of the form: <service_type>:<service_name>:<endpoint_type> - Only used if glance_api_servers are not provided. |
| list value | Default core properties of image |
| integer value | Number retries when downloading an image from glance |
| integer value | http/https timeout value for glance operations. If no value (None) is supplied here, the glanceclient default value is used. |
| string value | Base dir containing mount point for gluster share. |
| string value | GlusterFS share in <hostname|ipv4addr|ipv6addr>:<gluster_vol_name> format. Eg: 1.2.3.4:backup_vol |
| string value | String representation for an equation that will be used to determine the goodness of a host. Only used when using the goodness weigher is set to be used by the Cinder scheduler. |
| integer value | Specify a timeout after which a gracefully shutdown server will exit. Zero value means endless wait. |
| string value | The full class name of the group API class |
| host address value | Name of this node. This can be an opaque identifier. It is not necessarily a host name, FQDN, or IP address. |
| string value | IET configuration file |
| boolean value | When possible, compress images uploaded to the image service |
| integer value | Address space limit in gigabytes to convert the image |
| integer value | CPU time limit in seconds to convert the image |
| string value | Directory used for temporary storage during image conversion |
| boolean value | If set to True, upload-to-image in raw format will create a cloned volume and register its location to the image service, instead of uploading the volume content. The cinder backend and locations support must be enabled in the image service. |
| boolean value | If set to True, the image volume created by upload-to-image will be placed in the internal tenant. Otherwise, the image volume is created in the current context’s tenant. |
| boolean value | Enable the image volume cache for this backend. |
| integer value | Max number of entries allowed in the image volume cache. 0 ⇒ unlimited. |
| integer value | Max size of the image volume cache for this backend in GB. 0 ⇒ unlimited. |
| boolean value | The Infortrend CLI cache. While set True, the RAID status report will use cache stored in the CLI. Never enable this unless the RAID is managed only by Openstack and only by one infortrend cinder-volume backend. Otherwise, CLI might report out-dated status to cinder and thus there might be some race condition among all backend/CLIs. |
| integer value | The maximum retry times if a command fails. |
| string value | The Infortrend CLI absolute path. |
| integer value | The timeout for CLI in seconds. |
| string value | Infortrend iqn prefix for iSCSI. |
`infortrend_pools_name = ` | list value | The Infortrend logical volumes name list. It is separated with comma. |
`infortrend_slots_a_channels_id = ` | list value | Infortrend raid channel ID list on Slot A for OpenStack usage. It is separated with comma. |
`infortrend_slots_b_channels_id = ` | list value | Infortrend raid channel ID list on Slot B for OpenStack usage. It is separated with comma. |
| integer value | Max number of volumes and snapshots to be retrieved per batch during volume manager host initialization. Query results will be obtained in batches from the database and not in one shot to avoid extreme memory usage. Set 0 to turn off this functionality. |
`instance_format = [instance: %(uuid)s] ` | string value | The format for an instance that is passed with the log message. |
`instance_uuid_format = [instance: %(uuid)s] ` | string value | The format for an instance UUID that is passed with the log message. |
| boolean value | Allow tenants to specify QOS on create |
| boolean value | Configure CHAP authentication for iSCSI connections (Default: Enabled) |
| integer value | Specifies the InStorage LocalCopy copy rate to be used when creating a full volume copy. The default is rate is 50, and the valid rates are 1-100. |
| integer value | Maximum number of seconds to wait for LocalCopy to be prepared. |
| boolean value | Storage system autoexpand parameter for volumes (True/False) |
| boolean value | Storage system compression option for volumes |
| integer value | Storage system grain size parameter for volumes (32/64/128/256) |
| boolean value | Enable InTier for volumes |
| string value | The I/O group in which to allocate volumes. It can be a comma-separated list in which case the driver will select an io_group based on least number of volumes associated with the io_group. |
| integer value | Storage system space-efficiency parameter for volumes (percentage) |
| integer value | Storage system threshold for volume capacity warnings (percentage) |
| list value | Comma separated list of storage system storage pools for volumes. |
| string value | Specifies secondary management IP or hostname to be used if san_ip is invalid or becomes inaccessible. |
| string value | Sets the behavior of the iSCSI target to either perform blockio or fileio optionally, auto can be set and Cinder will autodetect type of backing device |
| list value | The list of secondary IP addresses of the iSCSI daemon |
`iscsi_target_flags = ` | string value | Sets the target-specific flags for the iSCSI target. Only used for tgtadm to specify backing device flags using bsoflags option. The specified string is passed as is to the underlying tool. |
| string value | Sets the behavior of the iSCSI target to either perform write-back(on) or write-through(off). This parameter is valid if target_helper is set to tgtadm. |
| string value | The name of the iSER target user-land tool to use |
| string value | The IP address that the iSER daemon is listening on |
| port value | The port that the iSER daemon is listening on |
| string value | Prefix for iSER volumes |
| string value | The Java absolute path. |
| string value | Info to match when looking for keystone in the service catalog. Format is: separated values of the form: <service_type>:<service_name>:<endpoint_type> - Only used if backup_swift_auth_url is unset |
| string value | 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. Note that when logging configuration files are used then all logging configuration is set in the configuration file and other logging configuration options are ignored (for example, log-date-format). |
| string value | Defines the format string for %%(asctime)s in log records. Default: %(default)s . This option is ignored if log_config_append is set. |
| string value | (Optional) The base directory used for relative log_file paths. This option is ignored if log_config_append is set. |
| string value | (Optional) Name of log file to send logging output to. If no default is set, logging will go to stderr as defined by use_stderr. This option is ignored if log_config_append is set. |
| boolean value | Enables or disables logging values of all registered options when starting a service (at DEBUG level). |
| integer value | The amount of time before the log files are rotated. This option is ignored unless log_rotation_type is setto "interval". |
| string value | Rotation interval type. The time of the last file change (or the time when the service was started) is used when scheduling the next rotation. |
| string value | Log rotation type. |
| string value | Format string to use for log messages with context. Used by oslo_log.formatters.ContextFormatter |
| string value | Additional data to append to log message when logging level for the message is DEBUG. Used by oslo_log.formatters.ContextFormatter |
| string value | Format string to use for log messages when context is undefined. Used by oslo_log.formatters.ContextFormatter |
| string value | Prefix each line of exception output with this format. Used by oslo_log.formatters.ContextFormatter |
| string value | Defines the format string for %(user_identity)s that is used in logging_context_format_string. Used by oslo_log.formatters.ContextFormatter |
| dict value | This option is to support the FSA to mount across the different nodes. The parameters takes the standard dict config form, manager_ips = host1:ip1, host2:ip2… |
| integer value | Number of seconds between subsequent usage refreshes |
| integer value | Maximum line size of message headers to be accepted. max_header_line may need to be increased when using large tokens (typically those generated when keystone is configured to use PKI tokens with big service catalogs). |
| integer value | Maximum number of rotated log files. |
| integer value | Log file maximum size in MB. This option is ignored if "log_rotation_type" is not set to "size". |
| string value | Representation of the over subscription ratio when thin provisioning is enabled. Default ratio is 20.0, meaning provisioned capacity can be 20 times of the total physical capacity. If the ratio is 10.5, it means provisioned capacity can be 10.5 times of the total physical capacity. A ratio of 1.0 means provisioned capacity cannot exceed the total physical capacity. If ratio is auto, Cinder will automatically calculate the ratio based on the provisioned capacity and the used space. If not set to auto, the ratio has to be a minimum of 1.0. |
| integer value | interval between periodic task runs to clean expired messages in seconds. |
| integer value | message minimum life in seconds. |
| integer value | Timeout for creating the volume to migrate to when performing volume migration (seconds) |
| boolean value | Enable monkey patching |
| list value | List of modules/decorators to monkey patch |
| host address value | IP address of this host |
| boolean value | Whether snapshots count against gigabyte quota |
| integer value | The maximum number of times to rescan iSER target to find volume |
| integer value | Number of times to attempt to run flakey shell commands |
| integer value | The maximum number of times to rescan targets to find volume |
| integer value | The namespace id associated with the subsystem that will be created with the path for the LVM volume. |
| port value | The port that the NVMe target is listening on. |
| integer value | The maximum number of items that a collection resource returns in a single response |
| list value | Specify list of extensions to load when using osapi_volume_extension option with cinder.api.contrib.select_extensions |
| multi valued | osapi volume extension to load |
| string value | IP address on which OpenStack Volume API listens |
| port value | Port on which OpenStack Volume API listens |
| boolean value | Wraps the socket in a SSL context if True is set. A certificate file and key file must be specified. |
| integer value | Number of workers for OpenStack Volume API service. The default is equal to the number of CPUs available. |
| integer value | Max size allowed per volume, in gigabytes |
| integer value | Range, in seconds, to randomly delay when starting the periodic task scheduler to reduce stampeding. (Disable by setting to 0) |
| integer value | Interval, in seconds, between running periodic tasks |
| list value | (DEPRECATED FOR REMOVAL) Pool id permit to use |
| string value | (DEPRECATED FOR REMOVAL) Pool type, like sata-2copy |
| string value | Public url to use for versions endpoint. The default is None, which will use the request’s host_url attribute to populate the URL base. If Cinder is operating behind a proxy, you will want to change this to represent the proxy’s URL. |
| boolean value | Enables or disables publication of error events. |
| integer value | Total amount of storage, in gigabytes, allowed for backups per project |
| integer value | Number of volume backups allowed per project |
| integer value | Number of consistencygroups allowed per project |
| string value | Default driver to use for quota checks |
| integer value | Total amount of storage, in gigabytes, allowed for volumes and snapshots per project |
| integer value | Number of groups allowed per project |
| integer value | Number of volume snapshots allowed per project |
| integer value | Number of volumes allowed per project |
| integer value | Maximum number of logged messages per rate_limit_interval. |
| string value | Log level name used by rate limiting: CRITICAL, ERROR, INFO, WARNING, DEBUG or empty string. Logs with level greater or equal to rate_limit_except_level are not filtered. An empty string means that all levels are filtered. |
| integer value | Interval, number of seconds, of log rate limiting. |
| integer value | Maximum times to reintialize the driver if volume initialization fails. The interval of retry is exponentially backoff, and will be 1s, 2s, 4s etc. |
| dict value | Multi opt of dictionaries to represent a replication target device. This option may be specified multiple times in a single config section to specify multiple replication target devices. Each entry takes the standard dict config form: replication_device = target_device_id:<required>,key1:value1,key2:value2… |
| boolean value | Report to clients of Cinder that the backend supports discard (aka. trim/unmap). This will not actually change the behavior of the backend or the client directly, it will only notify that it can be used. |
| integer value | Interval, in seconds, between nodes reporting state to datastore |
| integer value | Interval between periodic task runs to clean expired reservations in seconds. |
| integer value | Number of seconds until a reservation expires |
| integer value | The percentage of backend capacity is reserved |
| string value | Json file indicating user visible filter parameters for list queries. |
| boolean value | If True, always discard excess bytes when restoring volumes i.e. pad with zeroes. |
| string value | Path to the rootwrap configuration file to use for running commands as root |
| integer value | Size of RPC connection pool. |
| integer value | Seconds to wait for a response from a call. |
| boolean value | Some periodic tasks can be run in a separate process. Should we run them here? |
| list value | Which filter class names to use for filtering hosts when not specified in the request. |
| list value | Which weigher class names to use for weighing hosts. |
| string value | Default scheduler driver to use |
| integer value | Maximum time in seconds to wait for the driver to report as ready |
| string value | The scheduler host manager class to use |
`scheduler_json_config_location = ` | string value | Absolute path to scheduler configuration JSON file. |
| string value | Full class name for the Manager for scheduler |
| integer value | Maximum number of attempts to schedule a volume |
| string value | Which handler to use for selecting the host/pool after weighing |
| string value | SCST target implementation can choose from multiple SCST target drivers. |
| string value | Certain ISCSI targets have predefined target names, SCST target driver uses this name. |
| integer value | Maximum time since last check-in for a service to be considered up |
| string value | Template string to be used to generate snapshot names |
| boolean value | Create volume from snapshot at the host where snapshot resides |
| boolean value | Log requests to multiple loggers. |
| string value | File containing SSH host keys for the systems with which Cinder needs to communicate. OPTIONAL: Default=$state_path/ssh_known_hosts |
| string value | Top-level directory for maintaining cinder’s state |
| string value | Availability zone of this node. Can be overridden per volume backend with the option "backend_availability_zone". |
| string value | Protocol for transferring data between host and storage back-end. |
| integer value | The default StorPool chain replication value. Used when creating a volume with no specified type if storpool_template is not set. Also used for calculating the apparent free space reported in the stats. |
| string value | The StorPool template for volumes with no type. |
| boolean value | Option to enable strict host key checking. When set to "True" Cinder will only connect to systems with a host key present in the configured "ssh_hosts_key_file". When set to "False" the host key will be saved upon first connection and used for subsequent connections. Default=False |
| string value | Info to match when looking for swift in the service catalog. Format is: separated values of the form: <service_type>:<service_name>:<endpoint_type> - Only used if backup_swift_url is unset |
| string value | Syslog facility to receive log lines. This option is ignored if log_config_append is set. |
| string value | Target user-land tool to use. tgtadm is default, use lioadm for LIO iSCSI support, scstadmin for SCST target support, ietadm for iSCSI Enterprise Target, iscsictl for Chelsio iSCSI Target, nvmet for NVMEoF support, spdk-nvmeof for SPDK NVMe-oF, or fake for testing. |
| string value | The IP address that the iSCSI daemon is listening on |
| port value | The port that the iSCSI daemon is listening on |
| string value | Prefix for iSCSI volumes |
| string value | Determines the target protocol for new volumes, created with tgtadm, lioadm and nvmet target helpers. In order to enable RDMA, this parameter should be set with the value "iser". The supported iSCSI protocol values are "iscsi" and "iser", in case of nvmet target set to "nvmet_rdma". |
| boolean value | Sets the value of TCP_KEEPALIVE (True/False) for each server socket. |
| integer value | Sets the value of TCP_KEEPCNT for each server socket. Not supported on OS X. |
| integer value | Sets the value of TCP_KEEPINTVL in seconds for each server socket. Not supported on OS X. |
| integer value | Sets the value of TCP_KEEPIDLE in seconds for each server socket. Not supported on OS X. |
| list value | List of options that control which trace info is written to the DEBUG log level to assist developers. Valid values are method and api. |
| string value | The full class name of the volume transfer API class |
| string value | The network address and optional user credentials for connecting to the messaging backend, in URL format. The expected format is: driver://[user:pass@]host:port[,[userN:passN@]hostN:portN]/virtual_host?query Example: rabbit://rabbitmq:password@127.0.0.1:5672// For full details on the fields in the URL see the documentation of oslo_messaging.TransportURL at https://docs.openstack.org/oslo.messaging/latest/reference/transport.html |
| integer value | Count of reservations until usage is refreshed |
| boolean value | Enable journald for logging. If running in a systemd environment you may wish to enable journal support. Doing so will use the journal native protocol which includes structured metadata in addition to log messages.This option is ignored if log_config_append is set. |
| boolean value | Use JSON formatting for logging. This option is ignored if log_config_append is set. |
| boolean value | Use syslog for logging. Existing syslog format is DEPRECATED and will be changed later to honor RFC5424. This option is ignored if log_config_append is set. |
| boolean value | Option to enable/disable CHAP authentication for targets. |
| boolean value | Enables or disables use of default quota class with default quota. |
| boolean value | Log output to Windows Event Log. |
| boolean value | Treat X-Forwarded-For as the canonical remote address. Only enable this if you have a sanitizing proxy. |
| boolean value | Do we attach/detach volumes in cinder using multipath for volume to image and image to volume transfers? |
| boolean value | Log output to standard error. This option is ignored if log_config_append is set. |
| string value | Enable image signature verification. Cinder uses the image signature metadata from Glance and verifies the signature of a signed image while downloading that image. There are two options here.
If the image signature cannot be verified or if the image signature metadata is incomplete when required, then Cinder will not create the volume and update it into an error state. This provides end users with stronger assurances of the integrity of the image data they are using to create volumes. |
| string value | The full class name of the volume API class to use |
| string value | The backend name for a given driver implementation |
| string value | Method used to wipe old volumes |
| string value | The flag to pass to ionice to alter the i/o priority of the process used to zero a volume after deletion, for example "-c3" for idle only priority. |
| integer value | Size in MiB to wipe at start of old volumes. 1024 MiB at max. 0 ⇒ all |
| string value | The blkio cgroup name to be used to limit bandwidth of volume copy |
| integer value | The upper limit of bandwidth of volume copy. 0 ⇒ unlimited |
| string value | The default block size used when copying/clearing volumes |
| string value | Full class name for the Manager for volume |
| string value | Template string to be used to generate volume names |
| floating point value | Multiplier used for weighing volume number. Negative numbers mean to spread vs stack. |
| boolean value | Offload pending volume delete during volume service startup |
| integer value | The number of characters in the autogenerated auth key. |
| integer value | The number of characters in the salt. |
| string value | Time period for which to generate volume usages. The options are hour, day, month, or year. |
| string value | Volume configuration file storage directory |
| boolean value | Create sparse Lun. |
| string value | VA config file. |
| boolean value | Uses logging handler designed to watch file system. When log file is moved or removed this handler will open a new log file with specified path instantaneously. It makes sense only if log_file option is specified and Linux platform is used. This option is ignored if log_config_append is set. |
| integer value | Size of the pool of greenthreads used by wsgi |
| boolean value | If False, closes the client socket connection explicitly. |
| string value | A python format string that is used as the template to generate log lines. The following values can beformatted into it: client_ip, date_time, request_line, status_code, body_length, wall_seconds. |
| string value | FC Zoning mode configured, only fabric is supported now. |
2.1.2. backend
The following table outlines the options available under the [backend]
group in the /etc/cinder/cinder.conf
file.
Table 2.1. backend
Configuration option = Default value | Type | Description |
---|---|---|
| string value | Backend override of host value. |
2.1.3. backend_defaults
The following table outlines the options available under the [backend_defaults]
group in the /etc/cinder/cinder.conf
file.
Table 2.2. backend_defaults
Configuration option = Default value | Type | Description |
---|---|---|
| boolean value | K2 driver will calculate max_oversubscription_ratio on setting this option as True. |
| string value | Availability zone for this volume backend. If not set, the storage_availability_zone option value is used as the default for all backends. |
| integer value | Size of the native threads pool for the backend. Increase for backends that heavily rely on this, like the RBD driver. |
| string value | CHAP authentication mode, effective only for iscsi (disabled|enabled) |
`chap_password = ` | string value | Password for specified CHAP account name. |
`chap_username = ` | string value | CHAP user name. |
| boolean value | (DEPRECATED FOR REMOVAL) DEPRECATED: Report free_capacity_gb as 0 when the limit to maximum number of pool LUNs is reached. By default, the value is False. |
| string value | Chiscsi (CXT) global defaults configuration file |
| string value | config file for cinder eternus_dx volume driver |
| string value | The configuration file for the Cinder Huawei driver. |
| string value | Connection type to the IBM Storage Array |
| integer value | This defines an optional cycle period that applies to Global Mirror relationships with a cycling mode of multi. A Global Mirror relationship using the multi cycling_mode performs a complete cycle at most once each period. The default is 300 seconds, and the valid seconds are 60-86400. |
| integer value | Default timeout for CLI operations in minutes. For example, LUN migration is a typical long running operation, which depends on the LUN size and the load of the array. An upper bound in the specific deployment can be set to avoid unnecessary long wait. By default, it is 365 days long. |
| integer value | Time delay in seconds before a volume is eligible for permanent removal after being tagged for deferred deletion. |
| integer value | Number of seconds between runs of the periodic task to purge volumes tagged for deletion. |
| integer value | Dell SC API async call default timeout in seconds. |
| integer value | Dell SC API sync call default timeout in seconds. |
| port value | Dell API port |
| string value | Name of the server folder to use on the Storage Center |
| integer value | Storage Center System Serial Number |
| boolean value | Enable HTTPS SC certificate verification |
| string value | Name of the volume folder to use on the Storage Center |
| string value | Server OS type to use when creating a new server on the Storage Center. |
| boolean value | To destroy storage group when the last LUN is removed from it. By default, the value is False. |
| boolean value | Disabling iSCSI discovery (sendtargets) for multipath connections on K2 driver. |
`dpl_pool = ` | string value | DPL pool uuid in which DPL volumes are stored. |
| port value | DPL port number. |
| string value | The path to the client certificate for verification, if the driver supports it. |
| string value | The path to the client certificate key for verification, if the driver supports it. |
| string value | Namespace for driver private data values to be saved in. |
| string value | Can be used to specify a non default path to a CA_BUNDLE file or directory with certificates of trusted CAs, which will be used to validate the backend |
| boolean value | If set to True the http client will validate the SSL certificate of the backend endpoint. |
| boolean value | Tell driver to use SSL for connection to backend storage if the driver supports it. |
`ds8k_devadd_unitadd_mapping = ` | string value | Mapping between IODevice address and unit address. |
| string value | Set to zLinux if your OpenStack version is prior to Liberty and you’re connecting to zLinux systems. Otherwise set to auto. Valid values for this parameter are: auto, AMDLinuxRHEL, AMDLinuxSuse, AppleOSX, Fujitsu, Hp, HpTru64, HpVms, LinuxDT, LinuxRF, LinuxRHEL, LinuxSuse, Novell, SGI, SVC, SanFsAIX, SanFsLinux, Sun, VMWare, Win2000, Win2003, Win2008, Win2012, iLinux, nSeries, pLinux, pSeries, pSeriesPowerswap, zLinux, iSeries. |
| string value | Set the first two digits of SSID. |
| boolean value | Enable deferred deletion. Upon deletion, volumes are tagged for deletion but will only be removed asynchronously at a later time. |
| boolean value | Set this to True when you want to allow an unsupported driver to start. Drivers that haven’t maintained a working CI system and testing are marked as unsupported until CI is working again. This also marks a driver as deprecated and may be removed in the next release. |
| boolean value | If this is set to True, attachment of volumes for image transfer will be aborted when multipathd is not running. Otherwise, it will fallback to single path. |
| integer value | Maximum retry count for reconnection. Default is 5. |
| string value | Group name to use for creating volumes. Defaults to "group-0". |
| string value | Pool in which volumes will be created. Defaults to "default". |
| IP address value | (DEPRECATED FOR REMOVAL) DEPRECATED: Fault Domain IP to be excluded from iSCSI returns. |
| list value | Comma separated Fault Domain IPs to be excluded from iSCSI returns. |
| integer value | This option specifies the threshold for last access time for images in the NFS image cache. When a cache cleaning cycle begins, images in the cache that have not been accessed in the last M minutes, where M is the value of this parameter, will be deleted from the cache to create free space on the NFS share. |
| string value | User defined capabilities, a JSON formatted string specifying key/value pairs. The key/value pairs can be used by the CapabilitiesFilter to select between backends when requests specify volume types. For example, specifying a service level or the geographical location of a backend, then creating a volume type to allow the user to select by these different properties. |
| string value | String representation for an equation that will be used to filter hosts. Only used when the driver filter is set to be used by the Cinder scheduler. |
| string value | Connection protocol should be FC. (Default is FC.) |
| integer value | Default iSCSI Port ID of FlashSystem. (Default port is 0.) |
| boolean value | Allows vdisk to multi host mapping. (Default is True) |
| boolean value | Delete a LUN even if it is in Storage Groups. |
| string value | String representation for an equation that will be used to determine the goodness of a host. Only used when using the goodness weigher is set to be used by the Cinder scheduler. |
| list value | Comma-separated list of IP address or hostnames of GPFS nodes. |
| string value | File containing SSH host keys for the gpfs nodes with which driver needs to communicate. Default=$state_path/ssh_known_hosts |
| string value | Specifies the path of the Image service repository in GPFS. Leave undefined if not storing images in GPFS. |
| string value | Specifies the type of image copy to be used. Set this when the Image service repository also uses GPFS so that image files can be transferred efficiently from the Image service to the Block Storage service. There are two valid values: "copy" specifies that a full copy of the image is made; "copy_on_write" specifies that copy-on-write optimization strategy is used and unmodified blocks of the image file are shared efficiently. |
| integer value | Specifies an upper limit on the number of indirections required to reach a specific block due to snapshots or clones. A lengthy chain of copy-on-write snapshots or clones can have a negative impact on performance, but improves space utilization. 0 indicates unlimited clone depth. |
| string value | Specifies the path of the GPFS directory where Block Storage volume and snapshot files are stored. |
`gpfs_private_key = ` | string value | Filename of private key to use for SSH authentication. |
| boolean value | Specifies that volumes are created as sparse files which initially consume no space. If set to False, the volume is created as a fully allocated file, in which case, creation may take a significantly longer time. |
| port value | SSH port to use. |
| string value | Specifies the storage pool that volumes are assigned to. By default, the system storage pool is used. |
| boolean value | Option to enable strict gpfs host key checking while connecting to gpfs nodes. Default=False |
| string value | Username for GPFS nodes. |
`gpfs_user_password = ` | string value | Password for GPFS node user. |
`hpe3par_api_url = ` | string value | WSAPI Server URL. This setting applies to both 3PAR and Primera. Example 1: for 3PAR, URL is: https://<3par ip>:8080/api/v1 Example 2: for Primera, URL is: https://<primera ip>:443/api/v1 |
| list value | List of the 3PAR / Primera CPG(s) to use for volume creation |
`hpe3par_cpg_snap = ` | string value | The 3PAR / Primera CPG to use for snapshots of volumes. If empty the userCPG will be used. |
| boolean value | Enable HTTP debugging to 3PAR / Primera |
| boolean value | Enable CHAP authentication for iSCSI connections. |
| list value | List of target iSCSI addresses to use. |
`hpe3par_password = ` | string value | 3PAR / Primera password for the user specified in hpe3par_username |
`hpe3par_snapshot_expiration = ` | string value | The time in hours when a snapshot expires and is deleted. This must be larger than expiration |
`hpe3par_snapshot_retention = ` | string value | The time in hours to retain a snapshot. You can’t delete it before this expires. |
`hpe3par_target_nsp = ` | string value | The nsp of 3PAR backend to be used when: (1) multipath is not enabled in cinder.conf. (2) Fiber Channel Zone Manager is not used. (3) the 3PAR backend is prezoned with this specific nsp only. For example if nsp is 2 1 2, the format of the option’s value is 2:1:2 |
`hpe3par_username = ` | string value | 3PAR / Primera username with the edit role |
| uri value | HPE LeftHand WSAPI Server Url like https://<LeftHand ip>:8081/lhos |
| string value | HPE LeftHand cluster name |
| boolean value | Enable HTTP debugging to LeftHand |
| boolean value | Configure CHAP authentication for iSCSI connections (Default: Disabled) |
| string value | HPE LeftHand Super user password |
| port value | Port number of SSH service. |
| string value | HPE LeftHand Super user username |
| string value | (DEPRECATED FOR REMOVAL) HPMSA API interface protocol. |
| list value | List of comma-separated target iSCSI IP addresses. |
| string value | Pool or Vdisk name to use for volume creation. |
| string value | linear (for Vdisk) or virtual (for Pool). |
| boolean value | (DEPRECATED FOR REMOVAL) Whether to verify HPMSA array SSL certificate. |
| string value | (DEPRECATED FOR REMOVAL) HPMSA array SSL certificate path. |
| string value | The remote device hypermetro will use. |
| string value | IET configuration file |
| boolean value | Force LUN creation even if the full threshold of pool is reached. By default, the value is False. |
| boolean value | If set to True, upload-to-image in raw format will create a cloned volume and register its location to the image service, instead of uploading the volume content. The cinder backend and locations support must be enabled in the image service. |
| boolean value | If set to True, the image volume created by upload-to-image will be placed in the internal tenant. Otherwise, the image volume is created in the current context’s tenant. |
| boolean value | Enable the image volume cache for this backend. |
| integer value | Max number of entries allowed in the image volume cache. 0 ⇒ unlimited. |
| integer value | Max size of the image volume cache for this backend in GB. 0 ⇒ unlimited. |
| list value | List of names of network spaces to use for iSCSI connectivity |
| string value | Name of the pool from which volumes are allocated |
| string value | Protocol for transferring data between host and storage back-end. |
| boolean value | Specifies whether to turn on compression for newly created volumes. |
| boolean value | Automatically deregister initiators after the related storage group is destroyed. By default, the value is False. |
| boolean value | Automatically register initiators. By default, the value is False. |
| boolean value | Use this value to enable the initiator_check. |
| integer value | Use this value to specify length of the interval in seconds. |
| list value | Comma separated iSCSI or FC ports to be used in Nova or Cinder. |
| string value | Mapping between hostname and its iSCSI initiator IP addresses. |
| string value | Sets the behavior of the iSCSI target to either perform blockio or fileio optionally, auto can be set and Cinder will autodetect type of backing device |
| list value | The list of secondary IP addresses of the iSCSI daemon |
`iscsi_target_flags = ` | string value | Sets the target-specific flags for the iSCSI target. Only used for tgtadm to specify backing device flags using bsoflags option. The specified string is passed as is to the underlying tool. |
| string value | Sets the behavior of the iSCSI target to either perform write-back(on) or write-through(off). This parameter is valid if target_helper is set to tgtadm. |
| string value | The name of the iSER target user-land tool to use |
| string value | The IP address that the iSER daemon is listening on |
| port value | The port that the iSER daemon is listening on |
| string value | Prefix for iSER volumes |
| string value | (DEPRECATED FOR REMOVAL) Lenovo api interface protocol. |
| list value | List of comma-separated target iSCSI IP addresses. |
| string value | Pool or Vdisk name to use for volume creation. |
| string value | linear (for VDisk) or virtual (for Pool). |
| boolean value | (DEPRECATED FOR REMOVAL) Whether to verify Lenovo array SSL certificate. |
| string value | (DEPRECATED FOR REMOVAL) Lenovo array SSL certificate path. |
| boolean value | True means Cinder node is a diskless LINSTOR node. |
| integer value | Default Block size for Image restoration. When using iSCSI transport, this option specifies the block size |
| string value | Default Storage Pool name for LINSTOR. |
| string value | Default storage URI for LINSTOR. |
| string value | Default Volume Group name for LINSTOR. Not Cinder Volume. |
| floating point value | Default volume downscale size in KiB = 4 MiB. |
`lss_range_for_cg = ` | string value | Reserve LSSs for consistency group. |
| string value | LVM conf file to use for the LVM driver in Cinder; this setting is ignored if the specified file does not exist (You can also specify None to not use a conf file even if one exists). |
| integer value | If >0, create LVs with multiple mirrors. Note that this requires lvm_mirrors + 2 PVs with available space |
| boolean value | Suppress leaked file descriptor warnings in LVM commands. |
| string value | Type of LVM volumes to deploy; (default, thin, or auto). Auto defaults to thin if thin is supported. |
| list value | Macrosan iscsi_clients list. You can configure multiple clients. You can configure it in this format: (host; client_name; sp1_iscsi_port; sp2_iscsi_port), (host; client_name; sp1_iscsi_port; sp2_iscsi_port) Important warning, Client_name has the following requirements: [a-zA-Z0-9.-_:], the maximum number of characters is 31 E.g: (controller1; device1; eth-1:0; eth-2:0), (controller2; device2; eth-1:0/eth-1:1; eth-2:0/eth-2:1), |
| string value | This is the default connection ports' name for iscsi. This default configuration is used when no host related information is obtained.E.g: eth-1:0/eth-1:1; eth-2:0/eth-2:1 |
| boolean value | In the case of an FC connection, the configuration item associated with the port is maintained. |
| integer value | The use_sp_port_nr parameter is the number of online FC ports used by the single-ended memory when the FC connection is established in the switch non-all-pass mode. The maximum is 4 |
| boolean value | Force disconnect while deleting volume |
| boolean value | Whether enable log timing |
| string value | Pool to use for volume creation |
| list value | Slave device |
| list value | MacroSAN replication devices' ip addresses |
| string value | MacroSAN replication devices' password |
| string value | MacroSAN replication devices' username |
| list value | MacroSAN sdas devices' ip addresses |
| string value | MacroSAN sdas devices' password |
| string value | MacroSAN sdas devices' username |
| floating point value | Set snapshot’s resource ratio |
| integer value | Set the thin lun’s extent size |
| integer value | Set the thin lun’s high watermark |
| integer value | Set the thin lun’s low watermark |
`management_ips = ` | string value | List of Management IP addresses (separated by commas) |
| integer value | Default max number of LUNs in a storage group. By default, the value is 255. |
| string value | Representation of the over subscription ratio when thin provisioning is enabled. Default ratio is 20.0, meaning provisioned capacity can be 20 times of the total physical capacity. If the ratio is 10.5, it means provisioned capacity can be 10.5 times of the total physical capacity. A ratio of 1.0 means provisioned capacity cannot exceed the total physical capacity. If ratio is auto, Cinder will automatically calculate the ratio based on the provisioned capacity and the used space. If not set to auto, the ratio has to be a minimum of 1.0. |
| string value | The remote metro device domain name. |
| string value | The remote metro device request url. |
| string value | The remote metro device san password. |
| string value | The remote metro device san user. |
| string value | The remote metro device pool names. |
`nas_host = ` | string value | IP address or Hostname of NAS system. |
| string value | User name to connect to NAS system. |
| string value | Options used to mount the storage backend file system where Cinder volumes are stored. |
`nas_password = ` | string value | Password to connect to NAS system. |
`nas_private_key = ` | string value | Filename of private key to use for SSH authentication. |
| string value | Allow network-attached storage systems to operate in a secure environment where root level access is not permitted. If set to False, access is as the root user and insecure. If set to True, access is not as root. If set to auto, a check is done to determine if this is a new installation: True is used if so, otherwise False. Default is auto. |
| string value | Set more secure file permissions on network-attached storage volume files to restrict broad other/world access. If set to False, volumes are created with open permissions. If set to True, volumes are created with permissions for the cinder user and group (660). If set to auto, a check is done to determine if this is a new installation: True is used if so, otherwise False. Default is auto. |
`nas_share_path = ` | string value | Path to the share to use for storing Cinder volumes. For example: "/srv/export1" for an NFS server export available at 10.0.5.10:/srv/export1 . |
| port value | SSH port to use to connect to NAS system. |
| string value | Provisioning type that will be used when creating volumes. |
| string value | Naviseccli Path. |
| string value |
A regular expression to limit the API tracing. This option is honored only if enabling |
| string value | This option specifies the path of the NetApp copy offload tool binary. Ensure that the binary has execute permissions set which allow the effective user of the cinder-volume process to execute the file. |
| string value | This option defines the type of operating system for all initiators that can access a LUN. This information is used when mapping LUNs to individual hosts or groups of hosts. |
| string value | Administrative user account name used to access the storage system or proxy server. |
| string value | This option defines the type of operating system that will access a LUN exported from Data ONTAP; it is assigned to the LUN at the time it is created. |
| string value | This option determines if storage space is reserved for LUN allocation. If enabled, LUNs are thick provisioned. If space reservation is disabled, storage space is allocated on demand. |
| string value | Password for the administrative user account specified in the netapp_login option. |
| string value | This option is used to restrict provisioning to the specified pools. Specify the value of this option to be a regular expression which will be applied to the names of objects from the storage backend which represent pools in Cinder. This option is only utilized when the storage protocol is configured to use iSCSI or FC. |
| dict value | Multi opt of dictionaries to represent the aggregate mapping between source and destination back ends when using whole back end replication. For every source aggregate associated with a cinder pool (NetApp FlexVol), you would need to specify the destination aggregate on the replication target device. A replication target device is configured with the configuration option replication_device. Specify this option as many times as you have replication devices. Each entry takes the standard dict config form: netapp_replication_aggregate_map = backend_id:<name_of_replication_device_section>,src_aggr_name1:dest_aggr_name1,src_aggr_name2:dest_aggr_name2,… |
| string value | The hostname (or IP address) for the storage system or proxy server. |
| integer value | The TCP port to use for communication with the storage system or proxy server. If not specified, Data ONTAP drivers will use 80 for HTTP and 443 for HTTPS. |
| floating point value | The quantity to be multiplied by the requested volume size to ensure enough space is available on the virtual storage server (Vserver) to fulfill the volume creation request. Note: this option is deprecated and will be removed in favor of "reserved_percentage" in the Mitaka release. |
| integer value | The maximum time in seconds to wait for existing SnapMirror transfers to complete before aborting during a failover. |
| string value | The storage family type used on the storage system; the only valid value is ontap_cluster for using clustered Data ONTAP. |
| string value | The storage protocol to be used on the data path with the storage system. |
| string value | The transport protocol used when communicating with the storage system or proxy server. |
| string value | This option specifies the virtual storage server (Vserver) name on the storage cluster on which provisioning of block storage volumes should occur. |
| integer value | Block size for datasets |
| integer value | NexentaEdge iSCSI LUN object chunk size |
`nexenta_client_address = ` | string value | (DEPRECATED FOR REMOVAL) NexentaEdge iSCSI Gateway client address for non-VIP service |
| string value | Compression value for new ZFS folders. |
| string value | Deduplication value for new ZFS folders. |
`nexenta_dataset_description = ` | string value | Human-readable description for the folder. |
| boolean value | Defines whether NexentaEdge iSCSI LUN object has encryption enabled. |
`nexenta_folder = ` | string value | A folder where cinder created datasets will reside. |
| string value | Template string to generate group snapshot name |
`nexenta_host = ` | string value | IP address of NexentaStor Appliance |
| string value | Prefix for iSCSI host groups on NexentaStor |
| integer value | NexentaEdge iSCSI LUN object IOPS limit |
`nexenta_iscsi_service = ` | string value | NexentaEdge iSCSI service name |
| string value | Group of hosts which are allowed to access volumes |
`nexenta_iscsi_target_portal_groups = ` | string value | NexentaStor target portal groups |
| integer value | Nexenta appliance iSCSI target portal port |
`nexenta_iscsi_target_portals = ` | string value | Comma separated list of portals for NexentaStor5, in format of IP1:port1,IP2:port2. Port is optional, default=3260. Example: 10.10.10.1:3267,10.10.1.2 |
| boolean value | Postponed write to backing store or not |
`nexenta_lun_container = ` | string value | NexentaEdge logical path of bucket for LUNs |
| integer value | Amount of LUNs per iSCSI target |
| string value | Base directory that contains NFS share mount points |
| string value | NexentaEdge logical path of directory to store symbolic links to NBDs |
| boolean value | If set True cache NexentaStor appliance volroot option value. |
| integer value | Block size for datasets |
| string value | Template string to generate origin name of clone |
| string value | (DEPRECATED FOR REMOVAL) Password to connect to NexentaStor management REST API server |
| boolean value | Create volumes as QCOW2 files rather than raw files |
| integer value | NexentaEdge iSCSI LUN object replication count. |
`nexenta_rest_address = ` | string value | (DEPRECATED FOR REMOVAL) IP address of NexentaStor management REST API endpoint |
| floating point value | Specifies the backoff factor to apply between connection attempts to NexentaStor management REST API server |
| floating point value | Specifies the time limit (in seconds), within which the connection to NexentaStor management REST API server must be established |
| string value | Password to connect to NexentaEdge. |
| integer value | (DEPRECATED FOR REMOVAL) HTTP(S) port to connect to NexentaStor management REST API server. If it is equal zero, 8443 for HTTPS and 8080 for HTTP is used |
| string value | Use http or https for NexentaStor management REST API connection (default auto) |
| floating point value | Specifies the time limit (in seconds), within which NexentaStor management REST API server must send a response |
| integer value | Specifies the number of times to repeat NexentaStor management REST API call in case of connection errors and NexentaStor appliance EBUSY or ENOENT errors |
| string value | User name to connect to NexentaEdge. |
| integer value | Enable stream compression, level 1..9. 1 - gives best speed; 9 - gives best compression. |
| integer value | Number of TCP connections. |
| integer value | TCP Buffer size in KiloBytes. |
| string value | File with the list of available nfs shares |
| boolean value | Enables or disables the creation of sparse datasets |
| boolean value | Enables or disables the creation of volumes as sparsed files that take no space. If disabled (False), volume is created as a regular file, which takes a long time. |
| string value | Prefix for iSCSI target groups on NexentaStor |
| string value | iqn prefix for NexentaStor iSCSI targets |
| boolean value | Use HTTP secure protocol for NexentaStor management REST API connections |
| string value | (DEPRECATED FOR REMOVAL) User name to connect to NexentaStor management REST API server |
| string value | NexentaStor pool name that holds all volumes |
| string value | Volume group for NexentaStor5 iSCSI |
| integer value | The number of attempts to mount NFS shares before raising an error. At least one attempt will be made to mount an NFS share, regardless of the value specified. |
| string value | Mount options passed to the NFS client. See section of the NFS man page for details. |
| string value | Base dir containing mount points for NFS shares. |
| boolean value | Create volumes as QCOW2 files rather than raw files. |
| string value | File with the list of available NFS shares. |
| boolean value | Enable support for snapshots on the NFS driver. Platforms using libvirt <1.2.7 will encounter issues with this feature. |
| boolean value | Create volumes as sparsed files which take no space. If set to False volume is created as regular file. In such case volume creation takes a lot of time. |
| string value | Nimble Controller pool name |
| string value | Nimble Subnet Label |
| string value | Path to Nimble Array SSL certificate |
| boolean value | Whether to verify Nimble SSL Certificate |
| integer value | The maximum number of times to rescan iSER target to find volume |
| integer value | Number of times to attempt to run flakey shell commands |
| integer value | The maximum number of times to rescan targets to find volume |
| integer value | The namespace id associated with the subsystem that will be created with the path for the LVM volume. |
| port value | The port that the NVMe target is listening on. |
| boolean value | Allow volume migration during rebuild. |
| boolean value | Allow volumes to be created in Storage Pools when zero padding is disabled. This option should not be enabled if multiple tenants will utilize volumes from a shared Storage Pool. |
| floating point value | max_over_subscription_ratio setting for the driver. Maximum value allowed is 10.0. |
| port value | Gateway REST server port. |
| boolean value | Round volume sizes up to 8GB boundaries. PowerFlex/VxFlex OS requires volumes to be sized in multiples of 8GB. If set to False, volume creation will fail for volumes not sized properly |
| string value | PowerFlex/ScaleIO API version. This value should be left as the default value unless otherwise instructed by technical support. |
| string value | Storage Pools. Comma separated list of storage pools used to provide volumes. Each pool should be specified as a protection_domain_name:storage_pool_name value |
| boolean value | Unmap volumes before deletion. |
| string value | Serial number of the array to connect to. |
| list value | List of user assigned name for storage array. |
| string value | User defined override for port group name. |
| list value | List of port groups containing frontend ports configured prior for server connection. |
| string value | Service level to use for provisioning storage. Setting this as an extra spec in pool_name is preferable. |
| string value | User defined override for short host name. |
| integer value | Use this value to specify the maximum number of unlinks for the temporary snapshots before a clone operation. |
| string value | Storage resource pool on array to use for provisioning. |
| list value | Appliances names. Comma separated list of PowerStore appliances names used to provision volumes. Required. |
| list value | Allowed ports. Comma separated list of PowerStore iSCSI IPs or FC WWNs (ex. 58:cc:f0:98:49:22:07:02) to be used. If option is not set all ports are allowed. |
| string value | Proxy driver that connects to the IBM Storage Array |
| string value | REST API authorization token. |
| boolean value | Automatically determine an oversubscription ratio based on the current total data reduction values. If used this calculated value will override the max_over_subscription_ratio config option. |
| boolean value | When enabled, all Pure volumes, snapshots, and protection groups will be eradicated at the time of deletion in Cinder. Data will NOT be recoverable after a delete with this set to True! When disabled, volumes and snapshots will go into pending eradication state and can be recovered. |
| string value | Determines how the Purity system tunes the protocol used between the array and the initiator. |
| string value | CIDR of FlashArray iSCSI targets hosts are allowed to connect to. Default will allow connection to any IP address. |
| integer value | Snapshot replication interval in seconds. |
| integer value | Retain snapshots per day on target for this time (in days.) |
| integer value | Retain how many snapshots for each day. |
| integer value | Retain all snapshots on target for this time (in seconds.) |
| string value | Pure Protection Group name to use for async replication (will be created if it does not exist). |
| string value | Pure Pod name to use for sync replication (will be created if it does not exist). |
| uri value | The URL to management QNAP Storage. Driver does not support IPv6 address in URL. |
| string value | The pool name in the QNAP Storage |
| string value | Communication protocol to access QNAP storage |
| string value | Path to a Quobyte Client configuration file. |
| string value | Base dir containing the mount point for the Quobyte volume. |
| boolean value | Create new volumes from the volume_from_snapshot_cache by creating overlay files instead of full copies. This speeds up the creation of volumes from this cache. This feature requires the options quobyte_qcow2_volumes and quobyte_volume_from_snapshot_cache to be set to True. If one of these is set to False this option is ignored. |
| boolean value | Create volumes as QCOW2 files rather than raw files. |
| boolean value | Create volumes as sparse files which take no space. If set to False, volume is created as regular file. |
| boolean value | Create a cache of volumes from merged snapshots to speed up creation of multiple volumes from a single snapshot. |
| string value | Quobyte URL to the Quobyte volume using e.g. a DNS SRV record (preferred) or a host list (alternatively) like quobyte://<DIR host1>, <DIR host2>/<volume name> |
| integer value | Timeout value (in seconds) used when connecting to ceph cluster. If value < 0, no timeout is set and default librados value is used. |
| integer value | Interval value (in seconds) between connection retries to ceph cluster. |
| integer value | Number of retries if connection to ceph cluster failed. |
`rbd_ceph_conf = ` | string value | Path to the ceph configuration file |
| string value | The name of ceph cluster |
| boolean value | Set to True if the pool is used exclusively by Cinder. On exclusive use driver won’t query images' provisioned size as they will match the value calculated by the Cinder core code for allocated_capacity_gb. This reduces the load on the Ceph cluster as well as on the volume service. |
| boolean value | Flatten volumes created from snapshots to remove dependency from volume to snapshot |
`rbd_keyring_conf = ` | string value | Path to the ceph keyring file |
| integer value | Maximum number of nested volume clones that are taken before a flatten occurs. Set to 0 to disable cloning. Note: lowering this value will not affect existing volumes whose clone depth exceeds the new value. |
| string value | The RADOS pool where rbd volumes are stored |
| string value | The libvirt uuid of the secret for the rbd_user volumes |
| integer value | Volumes will be chunked into objects of this size (in megabytes). |
| string value | The RADOS client name for accessing rbd volumes - only set when using cephx authentication |
| boolean value | To remove the host from Unity when the last LUN is detached from it. By default, it is False. |
| integer value | Timeout value (in seconds) used when connecting to ceph cluster to do a demotion/promotion of volumes. If value < 0, no timeout is set and default librados value is used. |
| dict value | Multi opt of dictionaries to represent a replication target device. This option may be specified multiple times in a single config section to specify multiple replication target devices. Each entry takes the standard dict config form: replication_device = target_device_id:<required>,key1:value1,key2:value2… |
| boolean value | Report to clients of Cinder that the backend supports discard (aka. trim/unmap). This will not actually change the behavior of the backend or the client directly, it will only notify that it can be used. |
| boolean value | Set to True for driver to report total capacity as a dynamic value (used + current free) and to False to report a static value (quota max bytes if defined and global size of cluster if not). |
| integer value | The percentage of backend capacity is reserved |
| integer value | Use this value to specify number of retries. |
| port value | Port to use to access the SAN API |
`san_clustername = ` | string value | Cluster name to use for creating volumes |
`san_ip = ` | string value | IP address of SAN controller |
| boolean value | Execute commands locally instead of over SSH; use if the volume service is running on the SAN device |
| string value | Username for SAN controller |
`san_password = ` | string value | Password for SAN controller |
`san_private_key = ` | string value | Filename of private key to use for SSH authentication |
| port value | SSH port to use with SAN |
| boolean value | Use thin provisioning for SAN volumes? |
| string value | SCST target implementation can choose from multiple SCST target drivers. |
| string value | Certain ISCSI targets have predefined target names, SCST target driver uses this name. |
| list value | List of comma-separated target iSCSI IP addresses. |
| string value | Pool or vdisk name to use for volume creation. |
| string value | linear (for vdisk) or virtual (for virtual pool). |
`secondary_san_ip = ` | string value | IP address of secondary DSM controller |
| string value | Secondary DSM user name |
`secondary_san_password = ` | string value | Secondary DSM user password name |
| port value | Secondary Dell API port |
| string value | Create SolidFire accounts with this prefix. Any string can be used here, but the string "hostname" is special and will create a prefix using the cinder node hostname (previous default behavior). The default is NO prefix. |
| boolean value | Allow tenants to specify QOS on create |
| port value | SolidFire API port. Useful if the device api is behind a proxy on a different port. |
| boolean value | Set 512 byte emulation on volume creation; |
| boolean value | Utilize volume access groups on a per-tenant basis. |
| string value | Change how SolidFire reports used space and provisioning calculations. If this parameter is set to usedSpace, the driver will report correct values as expected by Cinder thin provisioning. |
| string value | Overrides default cluster SVIP with the one specified. This is required or deployments that have implemented the use of VLANs for iSCSI networks in their cloud. |
| string value | Create SolidFire volumes with this prefix. Volume names are of the form <sf_volume_prefix><cinder-volume-id>. The default is to use a prefix of UUID-. |
| string value | IP address of sheep daemon. |
| port value | Port of sheep daemon. |
| string value | Default format that will be used when creating volumes if no volume format is specified. |
| string value | Base dir containing mount points for smbfs shares. |
| dict value | Mappings between share locations and pool names. If not specified, the share names will be used as pool names. Example: //addr/share:pool_name,//addr/share2:pool_name2 |
| string value | File with the list of available smbfs shares. |
| integer value | Queue depth for rdma transport. |
| string value | The NVMe target remote configuration IP address. |
| string value | The NVMe target remote configuration password. |
| port value | The NVMe target remote configuration port. |
| string value | The NVMe target remote configuration username. |
| integer value | SSH connection timeout in seconds |
| integer value | Maximum ssh connections in the pool |
| integer value | Minimum ssh connections in the pool |
| string value | Protocol for transferring data between host and storage back-end. |
| string value | VNX authentication scope type. By default, the value is global. |
| list value | Comma-separated list of storage pool names to be used. |
| string value | Directory path that contains the VNX security file. Make sure the security file is generated first. |
| string value | Specifies the name of the peer pool for hyperswap volume, the peer pool must exist on the other site. |
| dict value | Specifies the site information for host. One WWPN or multi WWPNs used in the host can be specified. For example: storwize_preferred_host_site=site1:wwpn1,site2:wwpn2&wwpn3 or storwize_preferred_host_site=site1:iqn1,site2:iqn2 |
| string value | Specifies secondary management IP or hostname to be used if san_ip is invalid or becomes inaccessible. |
| boolean value | Allow tenants to specify QOS on create |
| integer value | Specifies the Storwize FlashCopy copy rate to be used when creating a full volume copy. The default is rate is 50, and the valid rates are 1-150. |
| integer value | Maximum number of seconds to wait for FlashCopy to be prepared. |
| boolean value | Configure CHAP authentication for iSCSI connections (Default: Enabled) |
| string value | Specifies the name of the pool in which mirrored copy is stored. Example: "pool2" |
| boolean value | (DEPRECATED FOR REMOVAL) This option no longer has any affect. It is deprecated and will be removed in the next release. |
| boolean value | Connect with multipath (FC only; iSCSI multipath is controlled by Nova) |
| string value | If operating in stretched cluster mode, specify the name of the pool in which mirrored copies are stored.Example: "pool2" |
| boolean value | Storage system autoexpand parameter for volumes (True/False) |
| boolean value | Storage system compression option for volumes |
| boolean value | Enable Easy Tier for volumes |
| integer value | Storage system grain size parameter for volumes (8/32/64/128/256) |
| string value | The I/O group in which to allocate volumes. It can be a comma-separated list in which case the driver will select an io_group based on least number of volumes associated with the io_group. |
| boolean value | Specifies that the volume not be formatted during creation. |
| integer value | Storage system space-efficiency parameter for volumes (percentage) |
| integer value | Storage system threshold for volume capacity warnings (percentage) |
| list value | Comma separated list of storage system storage pools for volumes. |
| boolean value | Suppress requests library SSL certificate warnings. |
| port value | Management port for Synology storage. |
| string value | Device id for skip one time password check for logging in Synology storage if OTP is enabled. |
| string value | One time password of administrator for logging in Synology storage if OTP is enabled. |
`synology_password = ` | string value | Password of administrator for logging in Synology storage. |
`synology_pool_name = ` | string value | Volume on Synology storage to be used for creating lun. |
| boolean value | Do certificate validation or not if $driver_use_ssl is True |
| string value | Administrator of Synology storage. |
| string value | Target user-land tool to use. tgtadm is default, use lioadm for LIO iSCSI support, scstadmin for SCST target support, ietadm for iSCSI Enterprise Target, iscsictl for Chelsio iSCSI Target, nvmet for NVMEoF support, spdk-nvmeof for SPDK NVMe-oF, or fake for testing. |
| string value | The IP address that the iSCSI daemon is listening on |
| port value | The port that the iSCSI daemon is listening on |
| string value | Prefix for iSCSI volumes |
| string value | Determines the target protocol for new volumes, created with tgtadm, lioadm and nvmet target helpers. In order to enable RDMA, this parameter should be set with the value "iser". The supported iSCSI protocol values are "iscsi" and "iser", in case of nvmet target set to "nvmet_rdma". |
| integer value | If the percentage of available space for an NFS share has dropped below the value specified by this option, the NFS image cache will be cleaned. |
| integer value | When the percentage of available space on an NFS share has reached the percentage specified by this option, the driver will stop clearing files from the NFS image cache that have not been accessed in the last M minutes, where M is the value of the expiry_thres_minutes configuration option. |
| list value | List of options that control which trace info is written to the DEBUG log level to assist developers. Valid values are method and api. |
| boolean value | If the driver should automatically failback to the primary instance of Unisphere when a successful connection is re-established. |
| integer value | A backoff factor to apply between attempts after the second try (most errors are resolved immediately by a second try without a delay). Retries will sleep for: {backoff factor} * (2 ^ ({number of total retries} - 1)) seconds. |
| integer value | The maximum number of retries each connection should attempt. Note, this applies only to failed DNS lookups, socket connections and connection timeouts, never to requests where data has made it to the server. |
| dict value | Dictionary of Unisphere failover target info. |
| integer value | How long to wait for the server to send data before giving up. |
| boolean value | Whether or not our private network has unique FQDN on each initiator or not. For example networks with QA systems usually have multiple servers/VMs with the same FQDN. When true this will create host entries on 3PAR using the FQDN, when false it will use the reversed IQN/WWNN. |
| list value | A comma-separated list of iSCSI or FC ports to be used. Each port can be Unix-style glob expressions. |
| list value | A comma-separated list of storage pool names to be used. |
| boolean value | Option to enable/disable CHAP authentication for targets. |
| boolean value | Do we attach/detach volumes in cinder using multipath for volume to image and image to volume transfers? |
| string value | (DEPRECATED FOR REMOVAL) DEPRECATED: vmax_array. |
| list value | (DEPRECATED FOR REMOVAL) DEPRECATED: vmax_port_groups. |
| string value | (DEPRECATED FOR REMOVAL) DEPRECATED: vmax_service_level. |
| integer value | (DEPRECATED FOR REMOVAL) DEPRECATED: vmax_snapvc_unlink_limit. |
| string value | (DEPRECATED FOR REMOVAL) DEPRECATED: vmax_srp. |
| string value | Workload, setting this as an extra spec in pool_name is preferable. |
| string value | Default adapter type to be used for attaching volumes. |
| integer value | Number of times VMware vCenter server API must be retried upon connection related issues. |
| string value | CA bundle file to use in verifying the vCenter server certificate. |
| multi valued | Name of a vCenter compute cluster where volumes should be created. |
| integer value | Maximum number of connections in http connection pool. |
| string value | Regular expression pattern to match the name of datastores where backend volumes are created. |
| string value | IP address for connecting to VMware vCenter server. |
| string value | Password for authenticating with VMware vCenter server. |
| port value | Port number for connecting to VMware vCenter server. |
| string value | Username for authenticating with VMware vCenter server. |
| string value | Optional string specifying the VMware vCenter server version. The driver attempts to retrieve the version from VMware vCenter server. Set this configuration only if you want to override the vCenter server version. |
| integer value | Timeout in seconds for VMDK volume transfer between Cinder and Glance. |
| boolean value | If true, the vCenter server certificate is not verified. If false, then the default CA truststore is used for verification. This option is ignored if "vmware_ca_file" is set. |
| boolean value | If true, the backend volume in vCenter server is created lazily when the volume is created without any source. The backend volume is created when the volume is attached, uploaded to image service or during backup. |
| integer value | Max number of objects to be retrieved per batch. Query results will be obtained in batches from the server and not in one shot. Server may still limit the count to something less than the configured value. |
| string value | Volume snapshot format in vCenter server. |
| multi valued | (DEPRECATED FOR REMOVAL) Names of storage profiles to be monitored. |
| floating point value | The interval (in seconds) for polling remote tasks invoked on VMware vCenter server. |
| string value | Directory where virtual disks are stored during volume backup and restore. |
| string value | Name of the vCenter inventory folder that will contain Cinder volumes. This folder will be created under "OpenStack/<project_folder>", where project_folder is of format "Project (<volume_project_id>)". |
| string value | Optional VIM service WSDL Location e.g http://<server>/vimService.wsdl. Optional over-ride to default location for bug work-arounds. |
| boolean value |
Always use asynchronous migration during volume cloning and creating from snapshot. As described in configuration doc, async migration has some constraints. Besides using metadata, customers could use this option to disable async migration. Be aware that |
| string value | The backend name for a given driver implementation |
| string value | Method used to wipe old volumes |
| string value | The flag to pass to ionice to alter the i/o priority of the process used to zero a volume after deletion, for example "-c3" for idle only priority. |
| integer value | Size in MiB to wipe at start of old volumes. 1024 MiB at max. 0 ⇒ all |
| string value | The blkio cgroup name to be used to limit bandwidth of volume copy |
| integer value | The upper limit of bandwidth of volume copy. 0 ⇒ unlimited |
| string value | The default block size used when copying/clearing volumes |
| string value | Driver to use for volume creation |
| string value | Name for the VG that will contain exported volumes |
| string value | Volume configuration file storage directory |
| boolean value | (DEPRECATED FOR REMOVAL) renamed to powerflex_allow_migration_during_rebuild. |
| boolean value | (DEPRECATED FOR REMOVAL) renamed to powerflex_allow_non_padded_volumes. |
| floating point value | (DEPRECATED FOR REMOVAL) renamed to powerflex_max_over_subscription_ratio. |
| port value | (DEPRECATED FOR REMOVAL) renamed to powerflex_rest_server_port. |
| boolean value | (DEPRECATED FOR REMOVAL) renamed to powerflex_round_volume_capacity. |
| string value | (DEPRECATED FOR REMOVAL) renamed to powerflex_server_api_version. |
| string value | (DEPRECATED FOR REMOVAL) renamed to powerflex_storage_pools. |
| boolean value | (DEPRECATED FOR REMOVAL) renamed to powerflex_round_volume_capacity. |
| string value | Default format that will be used when creating volumes if no volume format is specified. |
| list value | Mount options passed to the vzstorage client. See section of the pstorage-mount man page for details. |
| string value | Base dir containing mount points for vzstorage shares. |
| string value | File with the list of available vzstorage shares. |
| boolean value | Create volumes as sparsed files which take no space rather than regular files when using raw format, in which case volume creation takes lot of time. |
| floating point value | Percent of ACTUAL usage of the underlying volume before no new volumes can be allocated to the volume destination. |
| string value | Path to store VHD backed volumes |
| integer value | Number of retries in case array is busy |
| integer value | Interval between retries in case array is busy |
| boolean value | Should the driver remove initiator groups with no volumes after the last connection was terminated. Since the behavior till now was to leave the IG be, we default to False (not deleting IGs without connected volumes); setting this parameter to True will remove any IG after terminating its connection to the last volume. |
`xtremio_cluster_name = ` | string value | XMS cluster id in multi-cluster environment |
| integer value | Number of volumes created from each cached glance image |
| string value | VPSA access key |
| boolean value | VPSA - Attach snapshot policy for volumes |
| string value | (DEPRECATED FOR REMOVAL) VPSA - Password |
| boolean value | If set to True the http client will validate the SSL certificate of the VPSA endpoint. |
| boolean value | VPSA - Use ISER instead of iSCSI |
| string value | (DEPRECATED FOR REMOVAL) VPSA - Username |
| boolean value | VPSA - Default encryption policy for volumes |
| string value | VPSA - Default template for VPSA volume names |
| string value | VPSA - Management Host name or IP address |
| string value | VPSA - Storage Pool assigned for volumes |
| port value | VPSA - Port number |
| boolean value | VPSA - Use SSL connection |
| string value | Name of directory inside zfssa_nfs_share where cache volumes are stored. |
| string value | Name of ZFSSA project where cache volumes are stored. |
| string value | Data path IP address |
| boolean value | Flag to enable local caching: True, False. |
| string value | HTTPS port number |
`zfssa_initiator = ` | string value | iSCSI initiator IQNs. (comma separated) |
`zfssa_initiator_config = ` | string value | iSCSI initiators configuration. |
`zfssa_initiator_group = ` | string value | iSCSI initiator group. |
`zfssa_initiator_password = ` | string value | Secret of the iSCSI initiator CHAP user. |
`zfssa_initiator_user = ` | string value | iSCSI initiator CHAP user (name). |
| string value | Data compression. |
| string value | Synchronous write bias. |
| boolean value | Flag to enable sparse (thin-provisioned): True, False. |
| string value | Block size. |
| string value | Driver policy for volume manage. |
`zfssa_nfs_mount_options = ` | string value | Options to be passed while mounting share over nfs |
`zfssa_nfs_pool = ` | string value | Storage pool name. |
| string value | Project name. |
| string value | Share name. |
| string value | Data compression. |
| string value | Synchronous write bias-latency, throughput. |
| string value | Storage pool name. |
| string value | Project name. |
`zfssa_replication_ip = ` | string value | IP address used for replication data. (maybe the same as data ip) |
| integer value | REST connection timeout. (seconds) |
| string value | iSCSI target group name. |
| string value | Network interfaces of iSCSI targets. (comma separated) |
`zfssa_target_password = ` | string value | Secret of the iSCSI target CHAP user. |
| string value | iSCSI target portal (Data-IP:Port, w.x.y.z:3260). |
`zfssa_target_user = ` | string value | iSCSI target CHAP user (name). |
2.1.4. barbican
The following table outlines the options available under the [barbican]
group in the /etc/cinder/cinder.conf
file.
Table 2.3. barbican
Configuration option = Default value | Type | Description |
---|---|---|
| string value | Use this endpoint to connect to Keystone |
| string value | Version of the Barbican API, for example: "v1" |
| string value | Use this endpoint to connect to Barbican, for example: "http://localhost:9311/" |
| string value | Specifies the type of endpoint. Allowed values are: public, private, and admin |
| integer value | Number of times to retry poll for key creation completion |
| integer value | Number of seconds to wait before retrying poll for key creation completion |
| boolean value | Specifies if insecure TLS (https) requests. If False, the server’s certificate will not be validated, if True, we can set the verify_ssl_path config meanwhile. |
| string value | A path to a bundle or CA certs to check against, or None for requests to attempt to locate and use certificates which verify_ssh is True. If verify_ssl is False, this is ignored. |
2.1.5. brcd_fabric_example
The following table outlines the options available under the [brcd_fabric_example]
group in the /etc/cinder/cinder.conf
file.
Table 2.4. brcd_fabric_example
Configuration option = Default value | Type | Description |
---|---|---|
`fc_fabric_address = ` | string value | Management IP of fabric. |
`fc_fabric_password = ` | string value | Password for user. |
| port value | Connecting port |
`fc_fabric_ssh_cert_path = ` | string value | Local SSH certificate Path. |
`fc_fabric_user = ` | string value | Fabric user ID. |
| string value | South bound connector for the fabric. |
| string value | Virtual Fabric ID. |
| boolean value | Overridden zoning activation state. |
| string value | Overridden zone name prefix. |
| string value | Overridden zoning policy. |
2.1.6. cisco_fabric_example
The following table outlines the options available under the [cisco_fabric_example]
group in the /etc/cinder/cinder.conf
file.
Table 2.5. cisco_fabric_example
Configuration option = Default value | Type | Description |
---|---|---|
`cisco_fc_fabric_address = ` | string value | Management IP of fabric |
`cisco_fc_fabric_password = ` | string value | Password for user |
| port value | Connecting port |
`cisco_fc_fabric_user = ` | string value | Fabric user ID |
| boolean value | overridden zoning activation state |
| string value | overridden zone name prefix |
| string value | overridden zoning policy |
| string value | VSAN of the Fabric |
2.1.7. coordination
The following table outlines the options available under the [coordination]
group in the /etc/cinder/cinder.conf
file.
Table 2.6. coordination
Configuration option = Default value | Type | Description |
---|---|---|
| string value | The backend URL to use for distributed coordination. |
2.1.8. cors
The following table outlines the options available under the [cors]
group in the /etc/cinder/cinder.conf
file.
Table 2.7. cors
Configuration option = Default value | Type | Description |
---|---|---|
| boolean value | Indicate that the actual request can include user credentials |
| list value | Indicate which header field names may be used during the actual request. |
| list value | Indicate which methods can be used during the actual request. |
| list value | Indicate whether this resource may be shared with the domain received in the requests "origin" header. Format: "<protocol>://<host>[:<port>]", no trailing slash. Example: https://horizon.example.com |
| list value | Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers. |
| integer value | Maximum cache age of CORS preflight requests. |
2.1.9. database
The following table outlines the options available under the [database]
group in the /etc/cinder/cinder.conf
file.
Table 2.8. database
Configuration option = Default value | Type | Description |
---|---|---|
| string value | The back end to use for the database. |
| string value | The SQLAlchemy connection string to use to connect to the database. |
| integer value | Verbosity of SQL debugging information: 0=None, 100=Everything. |
`connection_parameters = ` | string value | Optional URL parameters to append onto the connection URL at connect time; specify as param1=value1¶m2=value2&… |
| integer value | Connections which have been present in the connection pool longer than this number of seconds will be replaced with a new one the next time they are checked out from the pool. |
| boolean value | Add Python stack traces to SQL as comment strings. |
| boolean value | If True, increases the interval between retries of a database operation up to db_max_retry_interval. |
| integer value | Maximum retries in case of connection error or deadlock error before error is raised. Set to -1 to specify an infinite retry count. |
| integer value | If db_inc_retry_interval is set, the maximum seconds between retries of a database operation. |
| integer value | Seconds between retries of a database transaction. |
| integer value | If set, use this value for max_overflow with SQLAlchemy. |
| integer value | Maximum number of SQL connections to keep open in a pool. Setting a value of 0 indicates no limit. |
| integer value | Maximum number of database connection retries during startup. Set to -1 to specify an infinite retry count. |
| boolean value | If True, transparently enables support for handling MySQL Cluster (NDB). |
| string value | The SQL mode to be used for MySQL sessions. This option, including the default, overrides any server-set SQL mode. To use whatever SQL mode is set by the server configuration, set this to no value. Example: mysql_sql_mode= |
| integer value | If set, use this value for pool_timeout with SQLAlchemy. |
| integer value | Interval between retries of opening a SQL connection. |
| string value | The SQLAlchemy connection string to use to connect to the slave database. |
| boolean value | If True, SQLite uses synchronous mode. |
| boolean value | Enable the experimental use of database reconnect on connection lost. |
2.1.10. fc-zone-manager
The following table outlines the options available under the [fc-zone-manager]
group in the /etc/cinder/cinder.conf
file.
Table 2.9. fc-zone-manager
Configuration option = Default value | Type | Description |
---|---|---|
| string value | South bound connector for zoning operation |
| string value | Southbound connector for zoning operation |
| boolean value | Set this to True when you want to allow an unsupported zone manager driver to start. Drivers that haven’t maintained a working CI system and testing are marked as unsupported until CI is working again. This also marks a driver as deprecated and may be removed in the next release. |
| string value | Comma separated list of Fibre Channel fabric names. This list of names is used to retrieve other SAN credentials for connecting to each SAN fabric |
| string value | FC SAN Lookup Service |
| string value | FC Zone Driver responsible for zone management |
| string value | Zoning policy configured by user; valid values include "initiator-target" or "initiator" |
2.1.11. healthcheck
The following table outlines the options available under the [healthcheck]
group in the /etc/cinder/cinder.conf
file.
Table 2.10. healthcheck
Configuration option = Default value | Type | Description |
---|---|---|
| list value | Additional backends that can perform health checks and report that information back as part of a request. |
| boolean value | Show more detailed information as part of the response. Security note: Enabling this option may expose sensitive details about the service being monitored. Be sure to verify that it will not violate your security policies. |
| string value | Check the presence of a file to determine if an application is running on a port. Used by DisableByFileHealthcheck plugin. |
| list value | Check the presence of a file based on a port to determine if an application is running on a port. Expects a "port:path" list of strings. Used by DisableByFilesPortsHealthcheck plugin. |
| string value | (DEPRECATED FOR REMOVAL) The path to respond to healtcheck requests on. |
2.1.12. key_manager
The following table outlines the options available under the [key_manager]
group in the /etc/cinder/cinder.conf
file.
Table 2.11. key_manager
Configuration option = Default value | Type | Description |
---|---|---|
| string value | The type of authentication credential to create. Possible values are token, password, keystone_token, and keystone_password. Required if no context is passed to the credential factory. |
| string value | Use this endpoint to connect to Keystone. |
| string value | Specify the key manager implementation. Options are "barbican" and "vault". Default is "barbican". Will support the values earlier set using [key_manager]/api_class for some time. |
| string value | Domain ID for domain scoping. Optional for keystone_token and keystone_password auth_type. |
| string value | Domain name for domain scoping. Optional for keystone_token and keystone_password auth_type. |
| string value | Fixed key returned by key manager, specified in hex |
| string value | Password for authentication. Required for password and keystone_password auth_type. |
| string value | Project’s domain ID for project. Optional for keystone_token and keystone_password auth_type. |
| string value | Project’s domain name for project. Optional for keystone_token and keystone_password auth_type. |
| string value | Project ID for project scoping. Optional for keystone_token and keystone_password auth_type. |
| string value | Project name for project scoping. Optional for keystone_token and keystone_password auth_type. |
| boolean value | Allow fetching a new token if the current one is going to expire. Optional for keystone_token and keystone_password auth_type. |
| string value | Token for authentication. Required for token and keystone_token auth_type if no context is passed to the credential factory. |
| string value | Trust ID for trust scoping. Optional for keystone_token and keystone_password auth_type. |
| string value | User’s domain ID for authentication. Optional for keystone_token and keystone_password auth_type. |
| string value | User’s domain name for authentication. Optional for keystone_token and keystone_password auth_type. |
| string value | User ID for authentication. Optional for keystone_token and keystone_password auth_type. |
| string value | Username for authentication. Required for password auth_type. Optional for the keystone_password auth_type. |
2.1.13. keystone_authtoken
The following table outlines the options available under the [keystone_authtoken]
group in the /etc/cinder/cinder.conf
file.
Table 2.12. keystone_authtoken
Configuration option = Default value | Type | Description |
---|---|---|
| string value | Config Section from which to load plugin specific options |
| string value | Authentication type to load |
| string value | (DEPRECATED FOR REMOVAL) Complete "public" Identity API endpoint. This endpoint should not be an "admin" endpoint, as it should be accessible by all end users. Unauthenticated clients are redirected to this endpoint to authenticate. Although this endpoint should ideally be unversioned, client support in the wild varies. If you’re using a versioned v2 endpoint here, then this should not be the same endpoint the service user utilizes for validating tokens, because normal end users may not be able to reach that endpoint. This option is deprecated in favor of www_authenticate_uri and will be removed in the S release. |
| string value | API version of the Identity API endpoint. |
| string value |
Request environment key where the Swift cache object is stored. When auth_token middleware is deployed with a Swift cache, use this option to have the middleware share a caching backend with swift. Otherwise, use the |
| string value | A PEM encoded Certificate Authority to use when verifying HTTPs connections. Defaults to system CAs. |
| string value | Required if identity server requires client certificate |
| boolean value | Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components. |
| string value | Used to control the use and type of token binding. Can be set to: "disabled" to not check token binding. "permissive" (default) to validate binding information if the bind type is of a form known to the server and ignore it if not. "strict" like "permissive" but if the bind type is unknown the token will be rejected. "required" any form of token binding is needed to be allowed. Finally the name of a binding method that must be present in tokens. |
| integer value | Request timeout value for communicating with Identity API server. |
| integer value | How many times are we trying to reconnect when communicating with Identity API Server. |
| boolean value | (Optional) Indicate whether to set the X-Service-Catalog header. If False, middleware will not ask for service catalog on token validation and will not set the X-Service-Catalog header. |
| boolean value | Verify HTTPS connections. |
| string value | Interface to use for the Identity API endpoint. Valid values are "public", "internal" or "admin"(default). |
| string value | Required if identity server requires client certificate |
| integer value | (Optional) Number of seconds that an operation will wait to get a memcached client connection from the pool. |
| integer value | (Optional) Number of seconds memcached server is considered dead before it is tried again. |
| integer value | (Optional) Maximum total number of open connections to every memcached server. |
| integer value | (Optional) Socket timeout in seconds for communicating with a memcached server. |
| integer value | (Optional) Number of seconds a connection to memcached is held unused in the pool before it is closed. |
| string value | (Optional, mandatory if memcache_security_strategy is defined) This string is used for key derivation. |
| string value | (Optional) If defined, indicate whether token data should be authenticated or authenticated and encrypted. If MAC, token data is authenticated (with HMAC) in the cache. If ENCRYPT, token data is encrypted and authenticated in the cache. If the value is not one of these options or empty, auth_token will raise an exception on initialization. |
| boolean value | (Optional) Use the advanced (eventlet safe) memcached client pool. The advanced pool will only work under python 2.x. |
| list value | Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process. |
| string value | The region in which the identity server can be found. |
| list value | A choice of roles that must be present in a service token. Service tokens are allowed to request that an expired token can be used and so this check should tightly control that only actual services should be sending this token. Roles here are applied as an ANY check so any role in this list must be present. For backwards compatibility reasons this currently only affects the allow_expired check. |
| boolean value | For backwards compatibility reasons we must let valid service tokens pass that don’t pass the service_token_roles check as valid. Setting this true will become the default in a future release and should be enabled if possible. |
| string value | The name or type of the service as it appears in the service catalog. This is used to validate tokens that have restricted access rules. |
| integer value | In order to prevent excessive effort spent validating tokens, the middleware caches previously-seen tokens for a configurable duration (in seconds). Set to -1 to disable caching completely. |
| string value | Complete "public" Identity API endpoint. This endpoint should not be an "admin" endpoint, as it should be accessible by all end users. Unauthenticated clients are redirected to this endpoint to authenticate. Although this endpoint should ideally be unversioned, client support in the wild varies. If you’re using a versioned v2 endpoint here, then this should not be the same endpoint the service user utilizes for validating tokens, because normal end users may not be able to reach that endpoint. |
2.1.14. nova
The following table outlines the options available under the [nova]
group in the /etc/cinder/cinder.conf
file.
Table 2.13. nova
Configuration option = Default value | Type | Description |
---|---|---|
| string value | Config Section from which to load plugin specific options |
| string value | Authentication type to load |
| string value | PEM encoded Certificate Authority to use when verifying HTTPs connections. |
| string value | PEM encoded client certificate cert file |
| boolean value | Collect per-API call timing information. |
| boolean value | Verify HTTPS connections. |
| string value | Type of the nova endpoint to use. This endpoint will be looked up in the keystone catalog and should be one of public, internal or admin. |
| string value | PEM encoded client certificate key file |
| string value | Name of nova region to use. Useful if keystone manages more than one region. |
| boolean value | Log requests to multiple loggers. |
| integer value | Timeout value for http requests |
| string value | The authentication URL for the nova connection when using the current users token |
2.1.15. oslo_concurrency
The following table outlines the options available under the [oslo_concurrency]
group in the /etc/cinder/cinder.conf
file.
Table 2.14. oslo_concurrency
Configuration option = Default value | Type | Description |
---|---|---|
| boolean value | Enables or disables inter-process locks. |
| string value | 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. |
2.1.16. oslo_messaging_amqp
The following table outlines the options available under the [oslo_messaging_amqp]
group in the /etc/cinder/cinder.conf
file.
Table 2.15. oslo_messaging_amqp
Configuration option = Default value | Type | Description |
---|---|---|
| string value | 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 |
| string value | 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. |
| string value | address prefix used when broadcasting to all servers |
| integer value | Increase the connection_retry_interval by this many seconds after each unsuccessful failover attempt. |
| integer value | Seconds to pause before attempting to re-connect. |
| integer value | Maximum limit for connection_retry_interval + connection_retry_backoff |
| string value | Name for the AMQP container. must be globally unique. Defaults to a generated UUID |
| string value | 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 |
| integer value | The deadline for a sent notification message delivery. Only used when caller does not provide a timeout expiry. |
| integer value | The maximum number of attempts to re-send a reply message which failed due to a recoverable error. |
| integer value | The deadline for an rpc reply message delivery. |
| string value | 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 |
| integer value | The deadline for an rpc cast or call message delivery. Only used when caller does not provide a timeout expiry. |
| integer value | The duration to schedule a purge of idle sender links. Detach link after expiry. |
| string value | address prefix when sending to any server in group |
| integer value | Timeout for inactive connections (in seconds) |
| integer value | Time to pause between re-connecting an AMQP 1.0 link that failed due to a recoverable error. |
| string value | Appended to the address prefix when sending a fanout message. Used by the message bus to identify fanout messages. |
| string value | Address prefix for all generated Notification addresses |
| integer value | Window size for incoming Notification messages |
| multi valued | Send messages of this type pre-settled. Pre-settled messages will not receive acknowledgement from the peer. Note well: pre-settled messages may be silently discarded if the delivery fails. Permitted values: rpc-call - send RPC Calls pre-settled rpc-reply- send RPC Replies pre-settled rpc-cast - Send RPC Casts pre-settled notify - Send Notifications pre-settled |
| boolean value | Enable virtual host support for those message buses that do not natively support virtual hosting (such as qpidd). When set to true the virtual host name will be added to all message bus addresses, effectively creating a private subnet per virtual host. Set to False if the message bus supports virtual hosting using the hostname field in the AMQP 1.0 Open performative as the name of the virtual host. |
| integer value | Window size for incoming RPC Reply messages. |
| string value | Address prefix for all generated RPC addresses |
| integer value | Window size for incoming RPC Request messages |
`sasl_config_dir = ` | string value | Path to directory that contains the SASL configuration |
`sasl_config_name = ` | string value | Name of configuration file (without .conf suffix) |
`sasl_default_realm = ` | string value | SASL realm to use if no realm present in username |
`sasl_mechanisms = ` | string value | Space separated list of acceptable SASL mechanisms |
| string value | address prefix used when sending to a specific server |
| boolean value | Attempt to connect via SSL. If no other ssl-related parameters are given, it will use the system’s CA-bundle to verify the server’s certificate. |
`ssl_ca_file = ` | string value | CA certificate PEM file used to verify the server’s certificate |
`ssl_cert_file = ` | string value | Self-identifying certificate PEM file for client authentication |
`ssl_key_file = ` | string value | Private key PEM file used to sign ssl_cert_file certificate (optional) |
| string value | Password for decrypting ssl_key_file (if encrypted) |
| boolean value | By default SSL checks that the name in the server’s certificate matches the hostname in the transport_url. In some configurations it may be preferable to use the virtual hostname instead, for example if the server uses the Server Name Indication TLS extension (rfc6066) to provide a certificate per virtual host. Set ssl_verify_vhost to True if the server’s SSL certificate uses the virtual host name instead of the DNS name. |
| boolean value | Debug: dump AMQP frames to stdout |
| string value | 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. |
2.1.17. oslo_messaging_kafka
The following table outlines the options available under the [oslo_messaging_kafka]
group in the /etc/cinder/cinder.conf
file.
Table 2.16. oslo_messaging_kafka
Configuration option = Default value | Type | Description |
---|---|---|
| string value | The compression codec for all data generated by the producer. If not set, compression will not be used. Note that the allowed values of this depend on the kafka version |
| integer value | (DEPRECATED FOR REMOVAL) The pool size limit for connections expiration policy |
| integer value | (DEPRECATED FOR REMOVAL) The time-to-live in sec of idle connections in the pool |
| string value | Group id for Kafka consumer. Consumers in one group will coordinate message consumption |
| boolean value | Enable asynchronous consumer commits |
| floating point value | Default timeout(s) for Kafka consumers |
| integer value | Max fetch bytes of Kafka consumer |
| integer value | The maximum number of records returned in a poll call |
| integer value | (DEPRECATED FOR REMOVAL) Pool Size for Kafka Consumers |
| integer value | Size of batch for the producer async send |
| floating point value | Upper bound on the delay for KafkaProducer batching in seconds |
| string value | Mechanism when security protocol is SASL |
| string value | Protocol used to communicate with brokers |
`ssl_cafile = ` | string value | CA certificate PEM file used to verify the server certificate |
2.1.18. oslo_messaging_notifications
The following table outlines the options available under the [oslo_messaging_notifications]
group in the /etc/cinder/cinder.conf
file.
Table 2.17. oslo_messaging_notifications
Configuration option = Default value | Type | Description |
---|---|---|
| multi valued | The Drivers(s) to handle sending notifications. Possible values are messaging, messagingv2, routing, log, test, noop |
| integer value | The maximum number of attempts to re-send a notification message which failed to be delivered due to a recoverable error. 0 - No retry, -1 - indefinite |
| list value | AMQP topic used for OpenStack notifications. |
| string value | A URL representing the messaging driver to use for notifications. If not set, we fall back to the same configuration used for RPC. |
2.1.19. oslo_messaging_rabbit
The following table outlines the options available under the [oslo_messaging_rabbit]
group in the /etc/cinder/cinder.conf
file.
Table 2.18. oslo_messaging_rabbit
Configuration option = Default value | Type | Description |
---|---|---|
| boolean value | Auto-delete queues in AMQP. |
| boolean value | Use durable queues in AMQP. |
| integer value | Enable/Disable the RabbitMQ mandatory flag for direct send. The direct send is used as reply,so the MessageUndeliverable exception is raised in case the client queue does not exist. |
| boolean value | EXPERIMENTAL: Run the health check heartbeat threadthrough a native python thread. By default if thisoption isn’t provided the health check heartbeat willinherit the execution model from the parent process. Byexample if the parent process have monkey patched thestdlib by using eventlet/greenlet then the heartbeatwill be run through a green thread. |
| integer value | How often times during the heartbeat_timeout_threshold we check the heartbeat. |
| integer value | Number of seconds after which the Rabbit broker is considered down if heartbeat’s keep-alive fails (0 disables heartbeat). |
| string value | EXPERIMENTAL: Possible values are: gzip, bz2. If not set compression will not be used. This option may not be available in future versions. |
| string value | 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. |
| integer value | How long to wait a missing client before abandoning to send it its replies. This value should not be longer than rpc_response_timeout. |
| floating point value | How long to wait before reconnecting in response to an AMQP consumer cancel notification. |
| boolean value | 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"} " |
| integer value | Maximum interval of RabbitMQ connection retries. Default is 30 seconds. |
| string value | The RabbitMQ login method. |
| integer value | Specifies the number of messages to prefetch. Setting to zero allows unlimited messages. |
| integer value | How long to backoff for between retries when connecting to RabbitMQ. |
| integer value | How frequently to retry connecting with RabbitMQ. |
| integer value | 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. |
| boolean value | Connect over SSL. |
`ssl_ca_file = ` | string value | SSL certification authority file (valid only if SSL enabled). |
`ssl_cert_file = ` | string value | SSL cert file (valid only if SSL enabled). |
`ssl_key_file = ` | string value | SSL key file (valid only if SSL enabled). |
`ssl_version = ` | string value | 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. |
2.1.20. oslo_middleware
The following table outlines the options available under the [oslo_middleware]
group in the /etc/cinder/cinder.conf
file.
Table 2.19. oslo_middleware
Configuration option = Default value | Type | Description |
---|---|---|
| boolean value | Whether the application is behind a proxy or not. This determines if the middleware should parse the headers or not. |
| integer value | The maximum body size for each request, in bytes. |
| string value | (DEPRECATED FOR REMOVAL) 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. |
2.1.21. oslo_policy
The following table outlines the options available under the [oslo_policy]
group in the /etc/cinder/cinder.conf
file.
Table 2.20. oslo_policy
Configuration option = Default value | Type | Description |
---|---|---|
| boolean value |
This option controls whether or not to enforce scope when evaluating policies. If |
| string value | Default rule. Enforced when a requested rule is not found. |
| multi valued | 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. |
| string value | The relative or absolute path of a file that maps roles to permissions for a given service. Relative paths must be specified in relation to the configuration file setting this option. |
| string value | Content Type to send and receive data for REST based policy check |
| string value | Absolute path to ca cert file for REST based policy check |
| string value | Absolute path to client cert for REST based policy check |
| string value | Absolute path client key file REST based policy check |
| boolean value | server identity verification for REST based policy check |
2.1.22. oslo_reports
The following table outlines the options available under the [oslo_reports]
group in the /etc/cinder/cinder.conf
file.
Table 2.21. oslo_reports
Configuration option = Default value | Type | Description |
---|---|---|
| string value | The path to a file to watch for changes to trigger the reports, instead of signals. Setting this option disables the signal trigger for the reports. If application is running as a WSGI application it is recommended to use this instead of signals. |
| integer value | How many seconds to wait between polls when file_event_handler is set |
| string value | Path to a log directory where to create a file |
2.1.23. oslo_versionedobjects
The following table outlines the options available under the [oslo_versionedobjects]
group in the /etc/cinder/cinder.conf
file.
Table 2.22. oslo_versionedobjects
Configuration option = Default value | Type | Description |
---|---|---|
| boolean value | Make exception message format errors fatal |
2.1.24. privsep
The following table outlines the options available under the [privsep]
group in the /etc/cinder/cinder.conf
file.
Table 2.23. privsep
Configuration option = Default value | Type | Description |
---|---|---|
| list value | List of Linux capabilities retained by the privsep daemon. |
| string value | Group that the privsep daemon should run as. |
| string value | Command to invoke to start the privsep daemon if not using the "fork" method. If not specified, a default is generated using "sudo privsep-helper" and arguments designed to recreate the current configuration. This command must accept suitable --privsep_context and --privsep_sock_path arguments. |
| integer value | The number of threads available for privsep to concurrently run processes. Defaults to the number of CPU cores in the system. |
| string value | User that the privsep daemon should run as. |
2.1.25. profiler
The following table outlines the options available under the [profiler]
group in the /etc/cinder/cinder.conf
file.
Table 2.24. profiler
Configuration option = Default value | Type | Description |
---|---|---|
| string value | Connection string for a notifier backend.
Default value is Examples of possible values:
|
| boolean value | Enable the profiling for all services on this node. Default value is False (fully disable the profiling feature). Possible values:
|
| string value | Document type for notification indexing in elasticsearch. |
| integer value | Elasticsearch splits large requests in batches. This parameter defines maximum size of each batch (for example: es_scroll_size=10000). |
| string value | 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. |
| boolean value | Enable filter traces that contain error/exception to a separated place. Default value is set to False. Possible values:
|
| string value | 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 value |
Redissentinel uses a service name to identify a master redis service. This parameter defines the name (for example: |
| floating point value | Redissentinel provides a timeout option on the connections. This parameter defines that timeout (for example: socket_timeout=0.1). |
| boolean value | Enable SQL requests profiling in services. Default value is False (SQL requests won’t be traced). Possible values:
|
2.1.26. sample_castellan_source
The following table outlines the options available under the [sample_castellan_source]
group in the /etc/cinder/cinder.conf
file.
Table 2.25. sample_castellan_source
Configuration option = Default value | Type | Description |
---|---|---|
| string value | The path to a castellan configuration file. |
| string value | The name of the driver that can load this configuration source. |
| string value | The path to a configuration/castellan_id mapping file. |
2.1.27. sample_remote_file_source
The following table outlines the options available under the [sample_remote_file_source]
group in the /etc/cinder/cinder.conf
file.
Table 2.26. sample_remote_file_source
Configuration option = Default value | Type | Description |
---|---|---|
| string value | The path to a CA_BUNDLE file or directory with certificates of trusted CAs. |
| string value | Client side certificate, as a single file path containing either the certificate only or the private key and the certificate. |
| string value | Client side private key, in case client_cert is specified but does not includes the private key. |
| string value | The name of the driver that can load this configuration source. |
| uri value | Required option with the URI of the extra configuration file’s location. |
2.1.28. service_user
The following table outlines the options available under the [service_user]
group in the /etc/cinder/cinder.conf
file.
Table 2.27. service_user
Configuration option = Default value | Type | Description |
---|---|---|
| string value | Authentication URL |
| string value | PEM encoded Certificate Authority to use when verifying HTTPs connections. |
| string value | PEM encoded client certificate cert file |
| boolean value | Collect per-API call timing information. |
| string value | Domain ID to scope to |
| string value | Domain name to scope to |
| boolean value | Verify HTTPS connections. |
| string value | PEM encoded client certificate key file |
| string value | User’s password |
| string value | Domain ID containing project |
| string value | Domain name containing project |
| string value | Project ID to scope to |
| string value | Project name to scope to |
| boolean value | When True, if sending a user token to an REST API, also send a service token. |
| boolean value | Log requests to multiple loggers. |
| string value | Scope for system operations |
| integer value | Timeout value for http requests |
| string value | Trust ID |
| string value | User’s domain id |
| string value | User’s domain name |
| string value | User ID |
| string value | Username |
2.1.29. ssl
The following table outlines the options available under the [ssl]
group in the /etc/cinder/cinder.conf
file.
Table 2.28. ssl
Configuration option = Default value | Type | Description |
---|---|---|
| string value | CA certificate file to use to verify connecting clients. |
| string value | Certificate file to use when starting the server securely. |
| string value | Sets the list of available ciphers. value should be a string in the OpenSSL cipher list format. |
| string value | Private key file to use when starting the server securely. |
| string value | 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. |
2.1.30. vault
The following table outlines the options available under the [vault]
group in the /etc/cinder/cinder.conf
file.
Table 2.29. vault
Configuration option = Default value | Type | Description |
---|---|---|
| string value | AppRole role_id for authentication with vault |
| string value | AppRole secret_id for authentication with vault |
| string value | Mountpoint of KV store in Vault to use, for example: secret |
| string value | root token for vault |
| string value | Absolute path to ca cert file |
| boolean value | SSL Enabled/Disabled |
| string value | Use this endpoint to connect to Vault, for example: "http://127.0.0.1:8200" |
Chapter 3. glance
The following chapter contains information about the configuration options in the glance
service.
3.1. glance-api.conf
This section contains options for the /etc/glance/glance-api.conf
file.
3.1.1. DEFAULT
The following table outlines the options available under the [DEFAULT]
group in the /etc/glance/glance-api.conf
file.
.
Configuration option = Default value | Type | Description |
---|---|---|
| string value | (DEPRECATED FOR REMOVAL) The administrators password. If "use_user_token" is not in effect, then admin credentials can be specified. |
| string value | Role used to identify an authenticated user as administrator. Provide a string value representing a Keystone role to identify an administrative user. Users with this role will be granted administrative privileges. The default value for this option is admin. Possible values:
Related options:
|
| string value | (DEPRECATED FOR REMOVAL) The tenant name of the administrative user. If "use_user_token" is not in effect, then admin tenant name can be specified. |
| string value | (DEPRECATED FOR REMOVAL) The administrators user name. If "use_user_token" is not in effect, then admin credentials can be specified. |
| boolean value | Allow users to add additional/custom properties to images.
Glance defines a standard set of properties (in its schema) that appear on every image. These properties are also known as
By default, this configuration option is set to Possible values:
Related options:
|
| boolean value | Allow limited access to unauthenticated users. Assign a boolean to determine API access for unathenticated users. When set to False, the API cannot be accessed by unauthenticated users. When set to True, unauthenticated users can access the API with read-only privileges. This however only applies when using ContextMiddleware. Possible values:
Related options:
|
| list value | List of allowed exception modules to handle RPC exceptions.
Provide a comma separated list of modules whose exceptions are permitted to be recreated upon receiving exception data via an RPC call made to Glance. The default list includes The RPC protocol permits interaction with Glance via calls across a network or within the same system. Including a list of exception namespaces with this option enables RPC to propagate the exceptions back to the users. Possible values:
Related options:
|
| integer value | Maximum number of results that could be returned by a request.
As described in the help text of Note Setting this to a very large value may slow down database queries and increase response times. Setting this to a very low value may result in poor user experience. Possible values:
Related options:
|
| string value | (DEPRECATED FOR REMOVAL) The region for the authentication service. If "use_user_token" is not in effect and using keystone auth, then region name can be specified. |
| string value | (DEPRECATED FOR REMOVAL) The strategy to use for authentication. If "use_user_token" is not in effect, then auth strategy can be specified. |
| string value | (DEPRECATED FOR REMOVAL) The URL to the keystone service. If "use_user_token" is not in effect and using keystone auth, then URL of keystone can be specified. |
| integer value | Set the number of incoming connection requests. Provide a positive integer value to limit the number of requests in the backlog queue. The default queue size is 4096. An incoming connection to a TCP listener socket is queued before a connection can be established with the server. Setting the backlog for a TCP socket ensures a limited queue size for incoming traffic. Possible values:
Related options:
|
| host address value | IP address to bind the glance servers to.
Provide an IP address to bind the glance server to. The default value is Edit this option to enable the server to listen on one particular IP address on the network card. This facilitates selection of a particular network interface for the server. Possible values:
Related options:
|
| port value | Port number on which the server will listen. Provide a valid port number to bind the server’s socket to. This port is then set to identify processes and forward network messages that arrive at the server. The default bind_port value for the API server is 9292 and for the registry server is 9191. Possible values:
Related options:
|
| string value | Absolute path to the CA file. Provide a string value representing a valid absolute path to the Certificate Authority file to use for client authentication. A CA file typically contains necessary trusted certificates to use for the client authentication. This is essential to ensure that a secure connection is established to the server via the internet. Possible values:
Related options:
|
| string value | Absolute path to the certificate file. Provide a string value representing a valid absolute path to the certificate file which is required to start the API service securely. A certificate file typically is a public key container and includes the server’s public key, server name, server information and the signature which was a result of the verification process using the CA certificate. This is required for a secure connection establishment. Possible values:
Related options:
|
| integer value | Timeout for client connections' socket operations. Provide a valid integer value representing time in seconds to set the period of wait before an incoming connection can be closed. The default value is 900 seconds. The value zero implies wait forever. Possible values:
Related options:
|
| integer value | The pool size limit for connections expiration policy |
| integer value | The time-to-live in sec of idle connections in the pool |
| string value | The default exchange under which topics are scoped. May be overridden by an exchange name specified in the transport_url option. |
| string value | (DEPRECATED FOR REMOVAL) Python module path of data access API. Specifies the path to the API to use for accessing the data model. This option determines how the image catalog data will be accessed. Possible values:
If this option is set to
Setting this option to Note
In v2 OpenStack Images API, the registry service is optional. In order to use the Registry API in v2, the option
Finally, when this configuration option is set to Related options:
|
| boolean value | If set to true, the logging level will be set to DEBUG instead of the default INFO level. |
| list value | List of package logging levels in logger=LEVEL pairs. This option is ignored if log_config_append is set. |
| string value | Default publisher_id for outgoing Glance notifications. This is the value that the notification driver will use to identify messages for events originating from the Glance service. Typically, this is the hostname of the instance that generated the message. Possible values:
Related options:
|
| boolean value | Turn on/off delayed delete.
Typically when an image is deleted, the Note When delayed delete is turned on, image scrubber MUST be running as a periodic task to prevent the backend storage from filling up with undesired usage. Possible values:
Related options:
|
| string value | Digest algorithm to use for digital signature.
Provide a string value representing the digest algorithm to use for generating digital signatures. By default,
To get a list of the available algorithms supported by the version of OpenSSL on your platform, run the command: Note
Possible values:
Relation options:
|
| list value | List of notifications to be disabled. Specify a list of notifications that should not be emitted. A notification can be given either as a notification type to disable a single event notification, or as a notification group prefix to disable all event notifications within a group. Possible values: A comma-separated list of individual notification types or notification groups to be disabled. Currently supported groups: image image.member task metadef_namespace metadef_object metadef_property metadef_resource_type metadef_tag For a complete listing and description of each event refer to: http://docs.openstack.org/developer/glance/notifications.html The values must be specified as: <group_name>.<event_name> For example: image.create,task.success,metadef_tag Related options:
|
| boolean value | DEPRECATED FOR REMOVAL |
| boolean value | Deploy the v2 OpenStack Images API.
When this option is set to NOTES:
Possible values:
Related options:
|
| boolean value | (DEPRECATED FOR REMOVAL) Deploy the v2 API Registry service.
When this option is set to NOTES:
Possible values:
Related options:
|
| dict value | Key:Value pair of store identifier and store type. In case of multiple backends should be separated using comma. |
| list value | List of enabled Image Import Methods 'glance-direct', 'copy-image' and 'web-download' are enabled by default. Related options: ** [DEFAULT]/node_staging_uri |
| integer value | Size of executor thread pool when executor is threading or eventlet. |
| boolean value | Enables or disables fatal status of deprecations. |
| string value | Secure hashing algorithm used for computing the os_hash_value property. This option configures the Glance "multihash", which consists of two image properties: the os_hash_algo and the os_hash_value. The os_hash_algo will be populated by the value of this configuration option, and the os_hash_value will be populated by the hexdigest computed when the algorithm is applied to the uploaded or imported image data. The value must be a valid secure hash algorithm name recognized by the python hashlib library. You can determine what these are by examining the hashlib.algorithms_available data member of the version of the library being used in your Glance installation. For interoperability purposes, however, we recommend that you use the set of secure hash names supplied by the hashlib.algorithms_guaranteed data member because those algorithms are guaranteed to be supported by the hashlib library on all platforms. Thus, any image consumer using hashlib locally should be able to verify the os_hash_value of the image. The default value of sha512 is a performant secure hash algorithm. If this option is misconfigured, any attempts to store image data will fail. For that reason, we recommend using the default value. Possible values:
Related options:
|
| boolean value | Set keep alive option for HTTP over TCP.
Provide a boolean value to determine sending of keep alive packets. If set to
This option must be set to Possible values:
Related options:
|
| string value | Base directory for image cache.
This is the location where image data is cached and served out of. All cached images are stored directly under this directory. This directory also contains three subdirectories, namely,
The
The Possible values:
Related options:
|
| string value | The driver to use for image cache management. This configuration option provides the flexibility to choose between the different image-cache drivers available. An image-cache driver is responsible for providing the essential functions of image-cache like write images to/read images from cache, track age and usage of cached images, provide a list of cached images, fetch size of the cache, queue images for caching and clean up the cache, etc.
The essential functions of a driver are defined in the base class
Possible values:
Related options:
|
| integer value | The upper limit on cache size, in bytes, after which the cache-pruner cleans up the image cache. Note This is just a threshold for cache-pruner to act upon. It is NOT a hard limit beyond which the image cache would never grow. In fact, depending on how often the cache-pruner runs and how quickly the cache fills, the image cache can far exceed the size specified here very easily. Hence, care must be taken to appropriately schedule the cache-pruner and in setting this limit. Glance caches an image when it is downloaded. Consequently, the size of the image cache grows over time as the number of downloads increases. To keep the cache size from becoming unmanageable, it is recommended to run the cache-pruner as a periodic task. When the cache pruner is kicked off, it compares the current size of image cache and triggers a cleanup if the image cache grew beyond the size specified here. After the cleanup, the size of cache is less than or equal to size specified here. Possible values:
Related options:
|
| string value | The relative path to sqlite file database that will be used for image cache management.
This is a relative path to the sqlite file database that tracks the age and usage statistics of image cache. The path is relative to image cache base directory, specified by the configuration option This is a lightweight database with just one table. Possible values:
Related options:
|
| integer value | The amount of time, in seconds, an incomplete image remains in the cache.
Incomplete images are images for which download is in progress. Please see the description of configuration option It is recommended to run cache-cleaner as a periodic task on the Glance API nodes to keep the incomplete images from occupying disk space. Possible values:
Related options:
|
| integer value | Maximum number of locations allowed on an image. Any negative value is interpreted as unlimited. Related options:
|
| integer value | Maximum number of image members per image. This limits the maximum of users an image can be shared with. Any negative value is interpreted as unlimited. Related options:
|
| integer value | Maximum number of properties allowed on an image. This enforces an upper limit on the number of additional properties an image can have. Any negative value is interpreted as unlimited. Note
This won’t have any impact if additional properties are disabled. Please refer to Related options:
|
| integer value | Maximum size of image a user can upload in bytes. An image upload greater than the size mentioned here would result in an image creation failure. This configuration option defaults to 1099511627776 bytes (1 TiB). NOTES:
Possible values:
|
| integer value | Maximum number of tags allowed on an image. Any negative value is interpreted as unlimited. Related options:
|
`instance_format = [instance: %(uuid)s] ` | string value | The format for an instance that is passed with the log message. |
`instance_uuid_format = [instance: %(uuid)s] ` | string value | The format for an instance UUID that is passed with the log message. |
| string value | Absolute path to a private key file. Provide a string value representing a valid absolute path to a private key file which is required to establish the client-server connection. Possible values:
Related options:
|
| integer value | The default number of results to return for a request.
Responses to certain API requests, like list images, may return multiple items. The number of results returned can be explicitly controlled by specifying the NOTES:
Possible values:
Related options:
|
| string value | Strategy to determine the preference order of image locations. This configuration option indicates the strategy to determine the order in which an image’s locations must be accessed to serve the image’s data. Glance then retrieves the image data from the first responsive active location it finds in this list.
This option takes one of two possible values Possible values:
Related options:
|
| string value | 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. Note that when logging configuration files are used then all logging configuration is set in the configuration file and other logging configuration options are ignored (for example, log-date-format). |
| string value | Defines the format string for %%(asctime)s in log records. Default: %(default)s . This option is ignored if log_config_append is set. |
| string value | (Optional) The base directory used for relative log_file paths. This option is ignored if log_config_append is set. |
| string value | (Optional) Name of log file to send logging output to. If no default is set, logging will go to stderr as defined by use_stderr. This option is ignored if log_config_append is set. |
| integer value | The amount of time before the log files are rotated. This option is ignored unless log_rotation_type is setto "interval". |
| string value | Rotation interval type. The time of the last file change (or the time when the service was started) is used when scheduling the next rotation. |
| string value | Log rotation type. |
| string value | Format string to use for log messages with context. Used by oslo_log.formatters.ContextFormatter |
| string value | Additional data to append to log message when logging level for the message is DEBUG. Used by oslo_log.formatters.ContextFormatter |
| string value | Format string to use for log messages when context is undefined. Used by oslo_log.formatters.ContextFormatter |
| string value | Prefix each line of exception output with this format. Used by oslo_log.formatters.ContextFormatter |
| string value | Defines the format string for %(user_identity)s that is used in logging_context_format_string. Used by oslo_log.formatters.ContextFormatter |
| integer value | Maximum line size of message headers. Provide an integer value representing a length to limit the size of message headers. The default value is 16384. Note
Setting Possible values:
Related options:
|
| integer value | Maximum number of rotated log files. |
| integer value | Log file maximum size in MB. This option is ignored if "log_rotation_type" is not set to "size". |
| integer value | Limit the request ID length. Provide an integer value to limit the length of the request ID to the specified length. The default value is 64. Users can change this to any ineteger value between 0 and 16384 however keeping in mind that a larger value may flood the logs. Possible values:
Related options:
|
| string value | AES key for encrypting store location metadata. Provide a string value representing the AES cipher to use for encrypting Glance store metadata. Note The AES key to use must be set to a random string of length 16, 24 or 32 bytes. Possible values:
Related options:
|
| string value | The URL provides location where the temporary data will be stored This option is for Glance internal use only. Glance will save the image data uploaded by the user to staging endpoint during the image import process. This option does not change the staging API endpoint by any means. Note It is discouraged to use same path as [task]/work_dir Note file://<absolute-directory-path> is the only option api_image_import flow will support for now. Note The staging path must be on shared filesystem available to all Glance API nodes. Possible values:
Related options:
|
| boolean value | (DEPRECATED FOR REMOVAL) Set the image owner to tenant or the authenticated user. Assign a boolean value to determine the owner of an image. When set to True, the owner of the image is the tenant. When set to False, the owner of the image will be the authenticated user issuing the request. Setting it to False makes the image private to the associated user and sharing with other users within the same tenant (or "project") requires explicit image sharing via image membership. Possible values:
Related options:
|
| string value | The location of the property protection file. Provide a valid path to the property protection file which contains the rules for property protections and the roles/policies associated with them. A property protection file, when set, restricts the Glance image properties to be created, read, updated and/or deleted by a specific set of users that are identified by either roles or policies. If this configuration option is not set, by default, property protections won’t be enforced. If a value is specified and the file is not found, the glance-api service will fail to start. More information on property protections can be found at: https://docs.openstack.org/glance/latest/admin/property-protections.html Possible values:
Related options:
|
| string value | Rule format for property protection.
Provide the desired way to set property protection on Glance image properties. The two permissible values are
If the value is Possible values:
Related options:
|
| string value | Public url endpoint to use for Glance versions response. This is the public url endpoint that will appear in the Glance "versions" response. If no value is specified, the endpoint that is displayed in the version’s response is that of the host running the API service. Change the endpoint to represent the proxy URL if the API service is running behind a proxy. If the service is running behind a load balancer, add the load balancer’s URL for this value. Possible values:
Related options:
|
| boolean value | Enables or disables publication of error events. |
| host address value | Host address of the pydev server. Provide a string value representing the hostname or IP of the pydev server to use for debugging. The pydev server listens for debug connections on this address, facilitating remote debugging in Glance. Possible values:
Related options:
|
| port value | Port number that the pydev server will listen on. Provide a port number to bind the pydev server to. The pydev process accepts debug connections on this port and facilitates remote debugging in Glance. Possible values:
Related options:
|
| integer value | Maximum number of logged messages per rate_limit_interval. |
| string value | Log level name used by rate limiting: CRITICAL, ERROR, INFO, WARNING, DEBUG or empty string. Logs with level greater or equal to rate_limit_except_level are not filtered. An empty string means that all levels are filtered. |
| integer value | Interval, number of seconds, of log rate limiting. |
| string value | (DEPRECATED FOR REMOVAL) Absolute path to the Certificate Authority file. Provide a string value representing a valid absolute path to the certificate authority file to use for establishing a secure connection to the registry server. Note
This option must be set if Possible values:
Related options:
|
| string value | (DEPRECATED FOR REMOVAL) Absolute path to the certificate file. Provide a string value representing a valid absolute path to the certificate file to use for establishing a secure connection to the registry server. Note
This option must be set if Possible values:
Related options:
|
| boolean value | (DEPRECATED FOR REMOVAL) Set verification of the registry server certificate.
Provide a boolean value to determine whether or not to validate SSL connections to the registry server. By default, this option is set to
If set to Possible values:
Related options:
|
| string value | (DEPRECATED FOR REMOVAL) Absolute path to the private key file. Provide a string value representing a valid absolute path to the private key file to use for establishing a secure connection to the registry server. Note
This option must be set if Possible values:
Related options:
|
| string value | (DEPRECATED FOR REMOVAL) Protocol to use for communication with the registry server.
Provide a string value representing the protocol to use for communication with the registry server. By default, this option is set to
This option can be set to Possible values:
Related options:
|
| integer value | (DEPRECATED FOR REMOVAL) Timeout value for registry requests. Provide an integer value representing the period of time in seconds that the API server will wait for a registry request to complete. The default value is 600 seconds. A value of 0 implies that a request will never timeout. Possible values:
Related options:
|
| host address value | (DEPRECATED FOR REMOVAL) Address the registry server is hosted on. Possible values:
Related options:
|
| port value | (DEPRECATED FOR REMOVAL) Port the registry server is listening on. Possible values:
Related options:
|
| integer value | Size of RPC connection pool. |
| integer value | Seconds to wait for a response from a call. |
| integer value | The size of thread pool to be used for scrubbing images. When there are a large number of images to scrub, it is beneficial to scrub images in parallel so that the scrub queue stays in control and the backend storage is reclaimed in a timely fashion. This configuration option denotes the maximum number of images to be scrubbed in parallel. The default value is one, which signifies serial scrubbing. Any value above one indicates parallel scrubbing. Possible values:
Related options:
|
| integer value | The amount of time, in seconds, to delay image scrubbing.
When delayed delete is turned on, an image is put into
It is important to realize that this has storage implications. The larger the Possible values:
Related options:
|
| string value | (DEPRECATED FOR REMOVAL) The HTTP header used to determine the scheme for the original request, even if it was removed by an SSL terminating proxy. Typical value is "HTTP_X_FORWARDED_PROTO". |
| boolean value | Send headers received from identity when making requests to registry.
Typically, Glance registry can be deployed in multiple flavors, which may or may not include authentication. For example,
Provide a boolean value to determine whether to send the identity headers to provide tenant and user information along with the requests to registry service. By default, this option is set to Possible values:
Related options:
|
| boolean value | Show direct image location when returning an image.
This configuration option indicates whether to show the direct image location when returning image details to the user. The direct image location is where the image data is stored in backend storage. This image location is shown under the image property
When multiple image locations exist for an image, the best location is displayed based on the location strategy indicated by the configuration option NOTES:
Possible values:
Related options:
|
| boolean value | (DEPRECATED FOR REMOVAL) Show all image locations when returning an image.
This configuration option indicates whether to show all the image locations when returning image details to the user. When multiple image locations exist for an image, the locations are ordered based on the location strategy indicated by the configuration opt NOTES:
Possible values:
Related options:
|
| string value | Syslog facility to receive log lines. This option is ignored if log_config_append is set. |
| integer value | Set the wait time before a connection recheck. Provide a positive integer value representing time in seconds which is set as the idle wait time before a TCP keep alive packet can be sent to the host. The default value is 600 seconds.
Setting Possible values:
Related options:
|
| string value | The network address and optional user credentials for connecting to the messaging backend, in URL format. The expected format is: driver://[user:pass@]host:port[,[userN:passN@]hostN:portN]/virtual_host?query Example: rabbit://rabbitmq:password@127.0.0.1:5672// For full details on the fields in the URL see the documentation of oslo_messaging.TransportURL at https://docs.openstack.org/oslo.messaging/latest/reference/transport.html |
| boolean value | Enable journald for logging. If running in a systemd environment you may wish to enable journal support. Doing so will use the journal native protocol which includes structured metadata in addition to log messages.This option is ignored if log_config_append is set. |
| boolean value | Use JSON formatting for logging. This option is ignored if log_config_append is set. |
| boolean value | Use syslog for logging. Existing syslog format is DEPRECATED and will be changed later to honor RFC5424. This option is ignored if log_config_append is set. |
| boolean value | Log output to Windows Event Log. |
| boolean value | Log output to standard error. This option is ignored if log_config_append is set. |
| boolean value | (DEPRECATED FOR REMOVAL) Whether to pass through the user token when making requests to the registry. To prevent failures with token expiration during big files upload, it is recommended to set this parameter to False.If "use_user_token" is not in effect, then admin credentials can be specified. |
| string value | Maximum amount of image storage per tenant. This enforces an upper limit on the cumulative storage consumed by all images of a tenant across all stores. This is a per-tenant limit.
The default unit for this configuration option is Bytes. However, storage units can be specified using case-sensitive literals Possible values:
Related options:
|
| boolean value | Uses logging handler designed to watch file system. When log file is moved or removed this handler will open a new log file with specified path instantaneously. It makes sense only if log_file option is specified and Linux platform is used. This option is ignored if log_config_append is set. |
| integer value | Number of Glance worker processes to start.
Provide a non-negative integer value to set the number of child process workers to service requests. By default, the number of CPUs available is set as the value for Each worker process is made to listen on the port set in the configuration file and contains a greenthread pool of size 1000. Note Setting the number of workers to zero, triggers the creation of a single API process with a greenthread pool of size 1000. Possible values:
Related options:
|
3.1.2. cinder
The following table outlines the options available under the [cinder]
group in the /etc/glance/glance-api.conf
file.
Table 3.1. cinder
Configuration option = Default value | Type | Description |
---|---|---|
| boolean value | Allow to perform insecure SSL requests to cinder.
If this option is set to True, HTTPS endpoint connection is verified using the CA certificates file specified by Possible values:
Related options:
|
| string value | Location of a CA certificates file used for cinder client requests.
The specified CA certificates file, if set, is used to verify cinder connections via HTTPS endpoint. If the endpoint is HTTP, this value is ignored. Possible values:
Related options:
|
| string value | Information to match when looking for cinder in the service catalog.
When the
The service catalog can be listed by the Possible values:
Related options:
|
| string value | Override service catalog lookup with template for cinder endpoint.
When this option is set, this value is used to generate cinder endpoint, instead of looking up from the service catalog. This value is ignored if
If this configuration option is set, Possible values:
Related options:
|
| boolean value | If this is set to True, attachment of volumes for image transfer will be aborted when multipathd is not running. Otherwise, it will fallback to single path. Possible values:
Related options:
|
| integer value | Number of cinderclient retries on failed http calls. When a call failed by any errors, cinderclient will retry the call up to the specified times after sleeping a few seconds. Possible values:
Related options:
|
| string value | Directory where the NFS volume is mounted on the glance node. Possible values:
|
| string value | Region name to lookup cinder service from the service catalog.
This is used only when Possible values:
Related options:
|
| integer value | Time period, in seconds, to wait for a cinder volume transition to complete.
When the cinder volume is created, deleted, or attached to the glance node to read/write the volume data, the volume’s state is changed. For example, the newly created volume status changes from Possible values:
Related options:
|
| string value | The address where the cinder authentication service is listening.
When all of If either of these options are not set, the cinder endpoint is looked up from the service catalog, and current context’s user and project are used. Possible values:
Related options:
|
| string value | Password for the user authenticating against cinder. This must be used with all the following related options. If any of these are not specified, the user of the current context is used. Possible values:
Related options:
|
| string value | Project name where the image volume is stored in cinder. If this configuration option is not set, the project in current context is used. This must be used with all the following related options. If any of these are not specified, the project of the current context is used. Possible values:
Related options:
|
| string value | User name to authenticate against cinder. This must be used with all the following related options. If any of these are not specified, the user of the current context is used. Possible values:
Related options:
|
| boolean value | Flag to identify mutipath is supported or not in the deployment. Set it to False if multipath is not supported. Possible values:
Related options:
|
| string value | Volume type that will be used for volume creation in cinder. Some cinder backends can have several volume types to optimize storage usage. Adding this option allows an operator to choose a specific volume type in cinder that can be optimized for images. If this is not set, then the default volume type specified in the cinder configuration will be used for volume creation. Possible values:
Related options:
|
| string value | Path to the rootwrap configuration file to use for running commands as root. The cinder store requires root privileges to operate the image volumes (for connecting to iSCSI/FC volumes and reading/writing the volume data, etc.). The configuration file should allow the required commands by cinder store and os-brick library. Possible values:
Related options:
|
3.1.3. cors
The following table outlines the options available under the [cors]
group in the /etc/glance/glance-api.conf
file.
Table 3.2. cors
Configuration option = Default value | Type | Description |
---|---|---|
| boolean value | Indicate that the actual request can include user credentials |
| list value | Indicate which header field names may be used during the actual request. |
| list value | Indicate which methods can be used during the actual request. |
| list value | Indicate whether this resource may be shared with the domain received in the requests "origin" header. Format: "<protocol>://<host>[:<port>]", no trailing slash. Example: https://horizon.example.com |
| list value | Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers. |
| integer value | Maximum cache age of CORS preflight requests. |
3.1.4. database
The following table outlines the options available under the [database]
group in the /etc/glance/glance-api.conf
file.
Table 3.3. database
Configuration option = Default value | Type | Description |
---|---|---|
| string value | The back end to use for the database. |
| string value | The SQLAlchemy connection string to use to connect to the database. |
| integer value | Verbosity of SQL debugging information: 0=None, 100=Everything. |
`connection_parameters = ` | string value | Optional URL parameters to append onto the connection URL at connect time; specify as param1=value1¶m2=value2&… |
| integer value | Connections which have been present in the connection pool longer than this number of seconds will be replaced with a new one the next time they are checked out from the pool. |
| boolean value | Add Python stack traces to SQL as comment strings. |
| boolean value | If True, increases the interval between retries of a database operation up to db_max_retry_interval. |
| integer value | Maximum retries in case of connection error or deadlock error before error is raised. Set to -1 to specify an infinite retry count. |
| integer value | If db_inc_retry_interval is set, the maximum seconds between retries of a database operation. |
| integer value | Seconds between retries of a database transaction. |
| integer value | If set, use this value for max_overflow with SQLAlchemy. |
| integer value | Maximum number of SQL connections to keep open in a pool. Setting a value of 0 indicates no limit. |
| integer value | Maximum number of database connection retries during startup. Set to -1 to specify an infinite retry count. |
| boolean value | If True, transparently enables support for handling MySQL Cluster (NDB). |
| string value | The SQL mode to be used for MySQL sessions. This option, including the default, overrides any server-set SQL mode. To use whatever SQL mode is set by the server configuration, set this to no value. Example: mysql_sql_mode= |
| integer value | If set, use this value for pool_timeout with SQLAlchemy. |
| integer value | Interval between retries of opening a SQL connection. |
| string value | The SQLAlchemy connection string to use to connect to the slave database. |
| boolean value | If True, SQLite uses synchronous mode. |
| boolean value | Enable the experimental use of database reconnect on connection lost. |
| boolean value | Enable the experimental use of thread pooling for all DB API calls |
3.1.5. file
The following table outlines the options available under the [file]
group in the /etc/glance/glance-api.conf
file.
Table 3.4. file
Configuration option = Default value | Type | Description |
---|---|---|
| integer value | Chunk size, in bytes. The chunk size used when reading or writing image files. Raising this value may improve the throughput but it may also slightly increase the memory usage when handling a large number of requests. Possible Values:
Related options:
|
| string value | Directory to which the filesystem backend store writes images.
Upon start up, Glance creates the directory if it doesn’t already exist and verifies write access to the user under which Note
This directory is used only when filesystem store is used as a storage backend. Either Possible values:
Related options:
|
| multi valued | List of directories and their priorities to which the filesystem backend store writes images.
The filesystem store can be configured to store images in multiple directories as opposed to using a single directory specified by the More information on configuring filesystem store with multiple store directories can be found at https://docs.openstack.org/glance/latest/configuration/configuring.html Note
This directory is used only when filesystem store is used as a storage backend. Either Possible values:
Related options:
|
| integer value | File access permissions for the image files. Set the intended file access permissions for image data. This provides a way to enable other services, e.g. Nova, to consume images directly from the filesystem store. The users running the services that are intended to be given access to could be made a member of the group that owns the files created. Assigning a value less then or equal to zero for this configuration option signifies that no changes be made to the default permissions. This value will be decoded as an octal digit. For more information, please refer the documentation at https://docs.openstack.org/glance/latest/configuration/configuring.html Possible values:
Related options:
|
| string value | Filesystem store metadata file.
The path to a file which contains the metadata to be returned with any location associated with the filesystem store. The file must contain a valid JSON object. The object should contain the keys Possible values:
Related options:
|
3.1.6. glance.store.http.store
The following table outlines the options available under the [glance.store.http.store]
group in the /etc/glance/glance-api.conf
file.
Table 3.5. glance.store.http.store
Configuration option = Default value | Type | Description |
---|---|---|
| dict value | The http/https proxy information to be used to connect to the remote server. This configuration option specifies the http/https proxy information that should be used to connect to the remote server. The proxy information should be a key value pair of the scheme and proxy, for example, http:10.0.0.1:3128. You can also specify proxies for multiple schemes by separating the key value pairs with a comma, for example, http:10.0.0.1:3128, https:10.0.0.1:1080. Possible values:
Related options:
|
| string value | Path to the CA bundle file.
This configuration option enables the operator to use a custom Certificate Authority file to verify the remote server certificate. If this option is set, the Possible values:
Related options:
|
| boolean value | Set verification of the remote server certificate. This configuration option takes in a boolean value to determine whether or not to verify the remote server certificate. If set to True, the remote server certificate is not verified. If the option is set to False, then the default CA truststore is used for verification.
This option is ignored if Possible values:
Related options:
|
3.1.7. glance.store.rbd.store
The following table outlines the options available under the [glance.store.rbd.store]
group in the /etc/glance/glance-api.conf
file.
Table 3.6. glance.store.rbd.store
Configuration option = Default value | Type | Description |
---|---|---|
| integer value | Timeout value for connecting to Ceph cluster. This configuration option takes in the timeout value in seconds used when connecting to the Ceph cluster i.e. it sets the time to wait for glance-api before closing the connection. This prevents glance-api hangups during the connection to RBD. If the value for this option is set to less than or equal to 0, no timeout is set and the default librados value is used. Possible Values:
Related options:
|
`rbd_store_ceph_conf = ` | string value | Ceph configuration file path. This configuration option specifies the path to the Ceph configuration file to be used. If the value for this option is not set by the user or is set to the empty string, librados will read the standard ceph.conf file by searching the default Ceph configuration file locations in sequential order. See the Ceph documentation for details. Note If using Cephx authentication, this file should include a reference to the right keyring in a client.<USER> section NOTE 2: If you leave this option empty (the default), the actual Ceph configuration file used may change depending on what version of librados is being used. If it is important for you to know exactly which configuration file is in effect, you may specify that file here using this option. Possible Values:
Related options:
|
| integer value | Size, in megabytes, to chunk RADOS images into. Provide an integer value representing the size in megabytes to chunk Glance images into. The default chunk size is 8 megabytes. For optimal performance, the value should be a power of two. When Ceph’s RBD object storage system is used as the storage backend for storing Glance images, the images are chunked into objects of the size set using this option. These chunked objects are then stored across the distributed block data store to use for Glance. Possible Values:
Related options:
|
| string value | RADOS pool in which images are stored.
When RBD is used as the storage backend for storing Glance images, the images are stored by means of logical grouping of the objects (chunks of images) into a More information on the RBD storage backend can be found here: http://ceph.com/planet/how-data-is-stored-in-ceph-cluster/ Possible Values:
Related options:
|
| string value | RADOS user to authenticate as. This configuration option takes in the RADOS user to authenticate as. This is only needed when RADOS authentication is enabled and is applicable only if the user is using Cephx authentication. If the value for this option is not set by the user or is set to None, a default value will be chosen, which will be based on the client. section in rbd_store_ceph_conf. Possible Values:
Related options:
|
3.1.8. glance.store.sheepdog.store
The following table outlines the options available under the [glance.store.sheepdog.store]
group in the /etc/glance/glance-api.conf
file.
Table 3.7. glance.store.sheepdog.store
Configuration option = Default value | Type | Description |
---|---|---|
| host address value | (DEPRECATED FOR REMOVAL) Address to bind the Sheepdog daemon to. Provide a string value representing the address to bind the Sheepdog daemon to. The default address set for the sheep is 127.0.0.1.
The Sheepdog daemon, also called sheep, manages the storage in the distributed cluster by writing objects across the storage network. It identifies and acts on the messages directed to the address set using Possible values:
Related Options:
|
| integer value | (DEPRECATED FOR REMOVAL) Chunk size for images to be stored in Sheepdog data store. Provide an integer value representing the size in mebibyte (1048576 bytes) to chunk Glance images into. The default chunk size is 64 mebibytes. When using Sheepdog distributed storage system, the images are chunked into objects of this size and then stored across the distributed data store to use for Glance. Chunk sizes, if a power of two, help avoid fragmentation and enable improved performance. Possible values:
Related Options:
|
| port value | (DEPRECATED FOR REMOVAL) Port number on which the sheep daemon will listen. Provide an integer value representing a valid port number on which you want the Sheepdog daemon to listen on. The default port is 7000.
The Sheepdog daemon, also called sheep, manages the storage in the distributed cluster by writing objects across the storage network. It identifies and acts on the messages it receives on the port number set using Possible values:
Related Options:
|
3.1.9. glance.store.swift.store
The following table outlines the options available under the [glance.store.swift.store]
group in the /etc/glance/glance-api.conf
file.
Table 3.8. glance.store.swift.store
Configuration option = Default value | Type | Description |
---|---|---|
| string value | Reference to default Swift account/backing store parameters. Provide a string value representing a reference to the default set of parameters required for using swift account/backing store for image storage. The default reference value for this configuration option is ref1. This configuration option dereferences the parameters and facilitates image storage in Swift storage backend every time a new image is added. Possible values:
Related options:
|
| boolean value | Buffer image segments before upload to Swift. Provide a boolean value to indicate whether or not Glance should buffer image data to disk while uploading to swift. This enables Glance to resume uploads on error.
NOTES: When enabling this option, one should take great care as this increases disk usage on the API node. Be aware that depending upon how the file system is configured, the disk space used for buffering may decrease the actual disk space available for the glance image cache. Disk utilization will cap according to the following equation: ( Possible values:
Related options:
|
| list value | List of tenants that will be granted admin access. This is a list of tenants that will be granted read/write access on all Swift containers created by Glance in multi-tenant mode. The default value is an empty list. Possible values:
Related options:
|
| string value | (DEPRECATED FOR REMOVAL) The address where the Swift authentication service is listening. |
| boolean value | Set verification of the server certificate. This boolean determines whether or not to verify the server certificate. If this option is set to True, swiftclient won’t check for a valid SSL certificate when authenticating. If the option is set to False, then the default CA truststore is used for verification. Possible values:
Related options:
|
| string value | (DEPRECATED FOR REMOVAL) Version of the authentication service to use. Valid versions are 2 and 3 for keystone and 1 (deprecated) for swauth and rackspace. |
| string value | Path to the CA bundle file. This configuration option enables the operator to specify the path to a custom Certificate Authority file for SSL verification when connecting to Swift. Possible values:
Related options:
|
| string value | Absolute path to the file containing the swift account(s) configurations. Include a string value representing the path to a configuration file that has references for each of the configured Swift account(s)/backing stores. By default, no file path is specified and customized Swift referencing is disabled. Configuring this option is highly recommended while using Swift storage backend for image storage as it avoids storage of credentials in the database. Note
Please do not configure this option if you have set Possible values:
Related options:
|
| string value | Name of single container to store images/name prefix for multiple containers
When a single container is being used to store images, this configuration option indicates the container within the Glance account to be used for storing all images. When multiple containers are used to store images, this will be the name prefix for all containers. Usage of single/multiple containers can be controlled using the configuration option
When using multiple containers, the containers will be named after the value set for this configuration option with the first N chars of the image UUID as the suffix delimited by an underscore (where N is specified by
Example: if the seed is set to 3 and swift_store_container = Possible values:
Related options:
|
| boolean value | Create container, if it doesn’t already exist, when uploading image. At the time of uploading an image, if the corresponding container doesn’t exist, it will be created provided this configuration option is set to True. By default, it won’t be created. This behavior is applicable for both single and multiple containers mode. Possible values:
Related options:
|
| string value | The URL endpoint to use for Swift backend storage.
Provide a string value representing the URL endpoint to use for storing Glance images in Swift store. By default, an endpoint is not set and the storage URL returned by Note The URL should include the path up to, but excluding the container. The location of an object is obtained by appending the container and object to the configured URL. Possible values:
Related Options:
|
| string value | Endpoint Type of Swift service. This string value indicates the endpoint type to use to fetch the Swift endpoint. The endpoint type determines the actions the user will be allowed to perform, for instance, reading and writing to the Store. This setting is only used if swift_store_auth_version is greater than 1. Possible values:
Related options:
|
| integer value | Time in seconds defining the size of the window in which a new token may be requested before the current token is due to expire. Typically, the Swift storage driver fetches a new token upon the expiration of the current token to ensure continued access to Swift. However, some Swift transactions (like uploading image segments) may not recover well if the token expires on the fly. Hence, by fetching a new token before the current token expiration, we make sure that the token does not expire or is close to expiry before a transaction is attempted. By default, the Swift storage driver requests for a new token 60 seconds or less before the current token expiration. Possible values:
Related Options:
|
| string value | (DEPRECATED FOR REMOVAL) Auth key for the user authenticating against the Swift authentication service. |
| integer value | The maximum size, in MB, of the segments when image data is segmented.
When image data is segmented to upload images that are larger than the limit enforced by the Swift cluster, image data is broken into segments that are no bigger than the size specified by this configuration option. Refer to
For example: if Possible values:
Related options:
|
| integer value | The size threshold, in MB, after which Glance will start segmenting image data. Swift has an upper limit on the size of a single uploaded object. By default, this is 5GB. To upload objects bigger than this limit, objects are segmented into multiple smaller objects that are tied together with a manifest file. For more detail, refer to https://docs.openstack.org/swift/latest/overview_large_objects.html This configuration option specifies the size threshold over which the Swift driver will start segmenting image data into multiple smaller files. Currently, the Swift driver only supports creating Dynamic Large Objects. Note This should be set by taking into account the large object limit enforced by the Swift cluster in consideration. Possible values:
Related options:
|
| boolean value | Store images in tenant’s Swift account. This enables multi-tenant storage mode which causes Glance images to be stored in tenant specific Swift accounts. If this is disabled, Glance stores all images in its own account. More details multi-tenant store can be found at https://wiki.openstack.org/wiki/GlanceSwiftTenantSpecificStorage Note If using multi-tenant swift store, please make sure that you do not set a swift configuration file with the swift_store_config_file option. Possible values:
Related options:
|
| integer value | Seed indicating the number of containers to use for storing images. When using a single-tenant store, images can be stored in one or more than one containers. When set to 0, all images will be stored in one single container. When set to an integer value between 1 and 32, multiple containers will be used to store images. This configuration option will determine how many containers are created. The total number of containers that will be used is equal to 16^N, so if this config option is set to 2, then 16^2=256 containers will be used to store images.
Please refer to Note This is used only when swift_store_multi_tenant is disabled. Possible values:
Related options:
|
| string value | The region of Swift endpoint to use by Glance. Provide a string value representing a Swift region where Glance can connect to for image storage. By default, there is no region set.
When Glance uses Swift as the storage backend to store images for a specific tenant that has multiple endpoints, setting of a Swift region with This option can be configured for both single-tenant and multi-tenant storage. Note
Setting the region with Possible values:
Related Options:
|
| integer value | The number of times a Swift download will be retried before the request fails.
Provide an integer value representing the number of times an image download must be retried before erroring out. The default value is zero (no retry on a failed image download). When set to a positive integer value, Possible values:
Related Options:
|
| string value | Type of Swift service to use.
Provide a string value representing the service type to use for storing images while using Swift backend storage. The default service type is set to Note
If Possible values:
Related Options:
|
| boolean value | SSL layer compression for HTTPS Swift requests. Provide a boolean value to determine whether or not to compress HTTPS Swift requests for images at the SSL layer. By default, compression is enabled. When using Swift as the backend store for Glance image storage, SSL layer compression of HTTPS Swift requests can be set using this option. If set to False, SSL layer compression of HTTPS Swift requests is disabled. Disabling this option may improve performance for images which are already in a compressed format, for example, qcow2. Possible values:
Related Options:
|
| boolean value | Use trusts for multi-tenant Swift store. This option instructs the Swift store to create a trust for each add/get request when the multi-tenant store is in use. Using trusts allows the Swift store to avoid problems that can be caused by an authentication token expiring during the upload or download of data.
By default, Note
This option is considered only when Possible values:
Related options:
|
| string value | (DEPRECATED FOR REMOVAL) The user to authenticate against the Swift authentication service. |
| string value | Directory to buffer image segments before upload to Swift. Provide a string value representing the absolute path to the directory on the glance node where image segments will be buffered briefly before they are uploaded to swift.
NOTES: * This is required only when the configuration option Possible values:
Related options:
|
3.1.10. glance.store.vmware_datastore.store
The following table outlines the options available under the [glance.store.vmware_datastore.store]
group in the /etc/glance/glance-api.conf
file.
Table 3.9. glance.store.vmware_datastore.store
Configuration option = Default value | Type | Description |
---|---|---|
| integer value | The number of VMware API retries. This configuration option specifies the number of times the VMware ESX/VC server API must be retried upon connection related issues or server API call overload. It is not possible to specify retry forever. Possible Values:
Related options:
|
| string value | Absolute path to the CA bundle file. This configuration option enables the operator to use a custom Cerificate Authority File to verify the ESX/vCenter certificate. If this option is set, the "vmware_insecure" option will be ignored and the CA file specified will be used to authenticate the ESX/vCenter server certificate and establish a secure connection to the server. Possible Values:
Related options:
|
| multi valued | The datastores where the image can be stored. This configuration option specifies the datastores where the image can be stored in the VMWare store backend. This option may be specified multiple times for specifying multiple datastores. The datastore name should be specified after its datacenter path, separated by ":". An optional weight may be given after the datastore name, separated again by ":" to specify the priority. Thus, the required format becomes <datacenter_path>:<datastore_name>:<optional_weight>. When adding an image, the datastore with highest weight will be selected, unless there is not enough free space available in cases where the image size is already known. If no weight is given, it is assumed to be zero and the directory will be considered for selection last. If multiple datastores have the same weight, then the one with the most free space available is selected. Possible Values:
Related options: * None |
| boolean value | Set verification of the ESX/vCenter server certificate. This configuration option takes a boolean value to determine whether or not to verify the ESX/vCenter server certificate. If this option is set to True, the ESX/vCenter server certificate is not verified. If this option is set to False, then the default CA truststore is used for verification. This option is ignored if the "vmware_ca_file" option is set. In that case, the ESX/vCenter server certificate will then be verified using the file specified using the "vmware_ca_file" option . Possible Values:
Related options:
|
| host address value | Address of the ESX/ESXi or vCenter Server target system. This configuration option sets the address of the ESX/ESXi or vCenter Server target system. This option is required when using the VMware storage backend. The address can contain an IP address (127.0.0.1) or a DNS name (www.my-domain.com). Possible Values:
Related options:
|
| string value | Server password. This configuration option takes the password for authenticating with the VMware ESX/ESXi or vCenter Server. This option is required when using the VMware storage backend. Possible Values:
Related options:
|
| string value | Server username. This configuration option takes the username for authenticating with the VMware ESX/ESXi or vCenter Server. This option is required when using the VMware storage backend. Possible Values:
Related options:
|
| string value | The directory where the glance images will be stored in the datastore. This configuration option specifies the path to the directory where the glance images will be stored in the VMware datastore. If this option is not set, the default directory where the glance images are stored is openstack_glance. Possible Values:
Related options:
|
| integer value | Interval in seconds used for polling remote tasks invoked on VMware ESX/VC server. This configuration option takes in the sleep time in seconds for polling an on-going async task as part of the VMWare ESX/VC server API call. Possible Values:
Related options:
|
3.1.11. glance_store
The following table outlines the options available under the [glance_store]
group in the /etc/glance/glance-api.conf
file.
Table 3.10. glance_store
Configuration option = Default value | Type | Description |
---|---|---|
| boolean value | Allow to perform insecure SSL requests to cinder.
If this option is set to True, HTTPS endpoint connection is verified using the CA certificates file specified by Possible values:
Related options:
|
| string value | Location of a CA certificates file used for cinder client requests.
The specified CA certificates file, if set, is used to verify cinder connections via HTTPS endpoint. If the endpoint is HTTP, this value is ignored. Possible values:
Related options:
|
| string value | Information to match when looking for cinder in the service catalog.
When the
The service catalog can be listed by the Possible values:
Related options:
|
| string value | Override service catalog lookup with template for cinder endpoint.
When this option is set, this value is used to generate cinder endpoint, instead of looking up from the service catalog. This value is ignored if
If this configuration option is set, Possible values:
Related options:
|
| boolean value | If this is set to True, attachment of volumes for image transfer will be aborted when multipathd is not running. Otherwise, it will fallback to single path. Possible values:
Related options:
|
| integer value | Number of cinderclient retries on failed http calls. When a call failed by any errors, cinderclient will retry the call up to the specified times after sleeping a few seconds. Possible values:
Related options:
|
| string value | Directory where the NFS volume is mounted on the glance node. Possible values:
|
| string value | Region name to lookup cinder service from the service catalog.
This is used only when Possible values:
Related options:
|
| integer value | Time period, in seconds, to wait for a cinder volume transition to complete.
When the cinder volume is created, deleted, or attached to the glance node to read/write the volume data, the volume’s state is changed. For example, the newly created volume status changes from Possible values:
Related options:
|
| string value | The address where the cinder authentication service is listening.
When all of If either of these options are not set, the cinder endpoint is looked up from the service catalog, and current context’s user and project are used. Possible values:
Related options:
|
| string value | Password for the user authenticating against cinder. This must be used with all the following related options. If any of these are not specified, the user of the current context is used. Possible values:
Related options:
|
| string value | Project name where the image volume is stored in cinder. If this configuration option is not set, the project in current context is used. This must be used with all the following related options. If any of these are not specified, the project of the current context is used. Possible values:
Related options:
|
| string value | User name to authenticate against cinder. This must be used with all the following related options. If any of these are not specified, the user of the current context is used. Possible values:
Related options:
|
| boolean value | Flag to identify mutipath is supported or not in the deployment. Set it to False if multipath is not supported. Possible values:
Related options:
|
| string value | Volume type that will be used for volume creation in cinder. Some cinder backends can have several volume types to optimize storage usage. Adding this option allows an operator to choose a specific volume type in cinder that can be optimized for images. If this is not set, then the default volume type specified in the cinder configuration will be used for volume creation. Possible values:
Related options:
|
| string value | The store identifier for the default backend in which data will be stored.
The value must be defined as one of the keys in the dict defined by the If a value is not defined for this option:
Related Options:
|
| string value | (DEPRECATED FOR REMOVAL) The default scheme to use for storing images.
Provide a string value representing the default scheme to use for storing images. If not set, Glance uses Note
The value given for this configuration option must be a valid scheme for a store registered with the Possible values:
Related Options:
|
| string value | Reference to default Swift account/backing store parameters. Provide a string value representing a reference to the default set of parameters required for using swift account/backing store for image storage. The default reference value for this configuration option is ref1. This configuration option dereferences the parameters and facilitates image storage in Swift storage backend every time a new image is added. Possible values:
Related options:
|
| integer value | Chunk size, in bytes. The chunk size used when reading or writing image files. Raising this value may improve the throughput but it may also slightly increase the memory usage when handling a large number of requests. Possible Values:
Related options:
|
| string value | Directory to which the filesystem backend store writes images.
Upon start up, Glance creates the directory if it doesn’t already exist and verifies write access to the user under which Note
This directory is used only when filesystem store is used as a storage backend. Either Possible values:
Related options:
|
| multi valued | List of directories and their priorities to which the filesystem backend store writes images.
The filesystem store can be configured to store images in multiple directories as opposed to using a single directory specified by the More information on configuring filesystem store with multiple store directories can be found at https://docs.openstack.org/glance/latest/configuration/configuring.html Note
This directory is used only when filesystem store is used as a storage backend. Either Possible values:
Related options:
|
| integer value | File access permissions for the image files. Set the intended file access permissions for image data. This provides a way to enable other services, e.g. Nova, to consume images directly from the filesystem store. The users running the services that are intended to be given access to could be made a member of the group that owns the files created. Assigning a value less then or equal to zero for this configuration option signifies that no changes be made to the default permissions. This value will be decoded as an octal digit. For more information, please refer the documentation at https://docs.openstack.org/glance/latest/configuration/configuring.html Possible values:
Related options:
|
| string value | Filesystem store metadata file.
The path to a file which contains the metadata to be returned with any location associated with the filesystem store. The file must contain a valid JSON object. The object should contain the keys Possible values:
Related options:
|
| dict value | The http/https proxy information to be used to connect to the remote server. This configuration option specifies the http/https proxy information that should be used to connect to the remote server. The proxy information should be a key value pair of the scheme and proxy, for example, http:10.0.0.1:3128. You can also specify proxies for multiple schemes by separating the key value pairs with a comma, for example, http:10.0.0.1:3128, https:10.0.0.1:1080. Possible values:
Related options:
|
| string value | Path to the CA bundle file.
This configuration option enables the operator to use a custom Certificate Authority file to verify the remote server certificate. If this option is set, the Possible values:
Related options:
|
| boolean value | Set verification of the remote server certificate. This configuration option takes in a boolean value to determine whether or not to verify the remote server certificate. If set to True, the remote server certificate is not verified. If the option is set to False, then the default CA truststore is used for verification.
This option is ignored if Possible values:
Related options:
|
| integer value | Timeout value for connecting to Ceph cluster. This configuration option takes in the timeout value in seconds used when connecting to the Ceph cluster i.e. it sets the time to wait for glance-api before closing the connection. This prevents glance-api hangups during the connection to RBD. If the value for this option is set to less than or equal to 0, no timeout is set and the default librados value is used. Possible Values:
Related options:
|
`rbd_store_ceph_conf = ` | string value | Ceph configuration file path. This configuration option specifies the path to the Ceph configuration file to be used. If the value for this option is not set by the user or is set to the empty string, librados will read the standard ceph.conf file by searching the default Ceph configuration file locations in sequential order. See the Ceph documentation for details. Note If using Cephx authentication, this file should include a reference to the right keyring in a client.<USER> section NOTE 2: If you leave this option empty (the default), the actual Ceph configuration file used may change depending on what version of librados is being used. If it is important for you to know exactly which configuration file is in effect, you may specify that file here using this option. Possible Values:
Related options:
|
| integer value | Size, in megabytes, to chunk RADOS images into. Provide an integer value representing the size in megabytes to chunk Glance images into. The default chunk size is 8 megabytes. For optimal performance, the value should be a power of two. When Ceph’s RBD object storage system is used as the storage backend for storing Glance images, the images are chunked into objects of the size set using this option. These chunked objects are then stored across the distributed block data store to use for Glance. Possible Values:
Related options:
|
| string value | RADOS pool in which images are stored.
When RBD is used as the storage backend for storing Glance images, the images are stored by means of logical grouping of the objects (chunks of images) into a More information on the RBD storage backend can be found here: http://ceph.com/planet/how-data-is-stored-in-ceph-cluster/ Possible Values:
Related options:
|
| string value | RADOS user to authenticate as. This configuration option takes in the RADOS user to authenticate as. This is only needed when RADOS authentication is enabled and is applicable only if the user is using Cephx authentication. If the value for this option is not set by the user or is set to None, a default value will be chosen, which will be based on the client. section in rbd_store_ceph_conf. Possible Values:
Related options:
|
| string value | Path to the rootwrap configuration file to use for running commands as root. The cinder store requires root privileges to operate the image volumes (for connecting to iSCSI/FC volumes and reading/writing the volume data, etc.). The configuration file should allow the required commands by cinder store and os-brick library. Possible values:
Related options:
|
| host address value | (DEPRECATED FOR REMOVAL) Address to bind the Sheepdog daemon to. Provide a string value representing the address to bind the Sheepdog daemon to. The default address set for the sheep is 127.0.0.1.
The Sheepdog daemon, also called sheep, manages the storage in the distributed cluster by writing objects across the storage network. It identifies and acts on the messages directed to the address set using Possible values:
Related Options:
|
| integer value | (DEPRECATED FOR REMOVAL) Chunk size for images to be stored in Sheepdog data store. Provide an integer value representing the size in mebibyte (1048576 bytes) to chunk Glance images into. The default chunk size is 64 mebibytes. When using Sheepdog distributed storage system, the images are chunked into objects of this size and then stored across the distributed data store to use for Glance. Chunk sizes, if a power of two, help avoid fragmentation and enable improved performance. Possible values:
Related Options:
|
| port value | (DEPRECATED FOR REMOVAL) Port number on which the sheep daemon will listen. Provide an integer value representing a valid port number on which you want the Sheepdog daemon to listen on. The default port is 7000.
The Sheepdog daemon, also called sheep, manages the storage in the distributed cluster by writing objects across the storage network. It identifies and acts on the messages it receives on the port number set using Possible values:
Related Options:
|
| list value | (DEPRECATED FOR REMOVAL) List of enabled Glance stores.
Register the storage backends to use for storing disk images as a comma separated list. The default stores enabled for storing disk images with Glance are Possible values:
Related Options:
|
| boolean value | Buffer image segments before upload to Swift. Provide a boolean value to indicate whether or not Glance should buffer image data to disk while uploading to swift. This enables Glance to resume uploads on error.
NOTES: When enabling this option, one should take great care as this increases disk usage on the API node. Be aware that depending upon how the file system is configured, the disk space used for buffering may decrease the actual disk space available for the glance image cache. Disk utilization will cap according to the following equation: ( Possible values:
Related options:
|
| list value | List of tenants that will be granted admin access. This is a list of tenants that will be granted read/write access on all Swift containers created by Glance in multi-tenant mode. The default value is an empty list. Possible values:
Related options:
|
| string value | (DEPRECATED FOR REMOVAL) The address where the Swift authentication service is listening. |
| boolean value | Set verification of the server certificate. This boolean determines whether or not to verify the server certificate. If this option is set to True, swiftclient won’t check for a valid SSL certificate when authenticating. If the option is set to False, then the default CA truststore is used for verification. Possible values:
Related options:
|
| string value | (DEPRECATED FOR REMOVAL) Version of the authentication service to use. Valid versions are 2 and 3 for keystone and 1 (deprecated) for swauth and rackspace. |
| string value | Path to the CA bundle file. This configuration option enables the operator to specify the path to a custom Certificate Authority file for SSL verification when connecting to Swift. Possible values:
Related options:
|
| string value | Absolute path to the file containing the swift account(s) configurations. Include a string value representing the path to a configuration file that has references for each of the configured Swift account(s)/backing stores. By default, no file path is specified and customized Swift referencing is disabled. Configuring this option is highly recommended while using Swift storage backend for image storage as it avoids storage of credentials in the database. Note
Please do not configure this option if you have set Possible values:
Related options:
|
| string value | Name of single container to store images/name prefix for multiple containers
When a single container is being used to store images, this configuration option indicates the container within the Glance account to be used for storing all images. When multiple containers are used to store images, this will be the name prefix for all containers. Usage of single/multiple containers can be controlled using the configuration option
When using multiple containers, the containers will be named after the value set for this configuration option with the first N chars of the image UUID as the suffix delimited by an underscore (where N is specified by
Example: if the seed is set to 3 and swift_store_container = Possible values:
Related options:
|
| boolean value | Create container, if it doesn’t already exist, when uploading image. At the time of uploading an image, if the corresponding container doesn’t exist, it will be created provided this configuration option is set to True. By default, it won’t be created. This behavior is applicable for both single and multiple containers mode. Possible values:
Related options:
|
| string value | The URL endpoint to use for Swift backend storage.
Provide a string value representing the URL endpoint to use for storing Glance images in Swift store. By default, an endpoint is not set and the storage URL returned by Note The URL should include the path up to, but excluding the container. The location of an object is obtained by appending the container and object to the configured URL. Possible values:
Related Options:
|
| string value | Endpoint Type of Swift service. This string value indicates the endpoint type to use to fetch the Swift endpoint. The endpoint type determines the actions the user will be allowed to perform, for instance, reading and writing to the Store. This setting is only used if swift_store_auth_version is greater than 1. Possible values:
Related options:
|
| integer value | Time in seconds defining the size of the window in which a new token may be requested before the current token is due to expire. Typically, the Swift storage driver fetches a new token upon the expiration of the current token to ensure continued access to Swift. However, some Swift transactions (like uploading image segments) may not recover well if the token expires on the fly. Hence, by fetching a new token before the current token expiration, we make sure that the token does not expire or is close to expiry before a transaction is attempted. By default, the Swift storage driver requests for a new token 60 seconds or less before the current token expiration. Possible values:
Related Options:
|
| string value | (DEPRECATED FOR REMOVAL) Auth key for the user authenticating against the Swift authentication service. |
| integer value | The maximum size, in MB, of the segments when image data is segmented.
When image data is segmented to upload images that are larger than the limit enforced by the Swift cluster, image data is broken into segments that are no bigger than the size specified by this configuration option. Refer to
For example: if Possible values:
Related options:
|
| integer value | The size threshold, in MB, after which Glance will start segmenting image data. Swift has an upper limit on the size of a single uploaded object. By default, this is 5GB. To upload objects bigger than this limit, objects are segmented into multiple smaller objects that are tied together with a manifest file. For more detail, refer to https://docs.openstack.org/swift/latest/overview_large_objects.html This configuration option specifies the size threshold over which the Swift driver will start segmenting image data into multiple smaller files. Currently, the Swift driver only supports creating Dynamic Large Objects. Note This should be set by taking into account the large object limit enforced by the Swift cluster in consideration. Possible values:
Related options:
|
| boolean value | Store images in tenant’s Swift account. This enables multi-tenant storage mode which causes Glance images to be stored in tenant specific Swift accounts. If this is disabled, Glance stores all images in its own account. More details multi-tenant store can be found at https://wiki.openstack.org/wiki/GlanceSwiftTenantSpecificStorage Note If using multi-tenant swift store, please make sure that you do not set a swift configuration file with the swift_store_config_file option. Possible values:
Related options:
|
| integer value | Seed indicating the number of containers to use for storing images. When using a single-tenant store, images can be stored in one or more than one containers. When set to 0, all images will be stored in one single container. When set to an integer value between 1 and 32, multiple containers will be used to store images. This configuration option will determine how many containers are created. The total number of containers that will be used is equal to 16^N, so if this config option is set to 2, then 16^2=256 containers will be used to store images.
Please refer to Note This is used only when swift_store_multi_tenant is disabled. Possible values:
Related options:
|
| string value | The region of Swift endpoint to use by Glance. Provide a string value representing a Swift region where Glance can connect to for image storage. By default, there is no region set.
When Glance uses Swift as the storage backend to store images for a specific tenant that has multiple endpoints, setting of a Swift region with This option can be configured for both single-tenant and multi-tenant storage. Note
Setting the region with Possible values:
Related Options:
|
| integer value | The number of times a Swift download will be retried before the request fails.
Provide an integer value representing the number of times an image download must be retried before erroring out. The default value is zero (no retry on a failed image download). When set to a positive integer value, Possible values:
Related Options:
|
| string value | Type of Swift service to use.
Provide a string value representing the service type to use for storing images while using Swift backend storage. The default service type is set to Note
If Possible values:
Related Options:
|
| boolean value | SSL layer compression for HTTPS Swift requests. Provide a boolean value to determine whether or not to compress HTTPS Swift requests for images at the SSL layer. By default, compression is enabled. When using Swift as the backend store for Glance image storage, SSL layer compression of HTTPS Swift requests can be set using this option. If set to False, SSL layer compression of HTTPS Swift requests is disabled. Disabling this option may improve performance for images which are already in a compressed format, for example, qcow2. Possible values:
Related Options:
|
| boolean value | Use trusts for multi-tenant Swift store. This option instructs the Swift store to create a trust for each add/get request when the multi-tenant store is in use. Using trusts allows the Swift store to avoid problems that can be caused by an authentication token expiring during the upload or download of data.
By default, Note
This option is considered only when Possible values:
Related options:
|
| string value | (DEPRECATED FOR REMOVAL) The user to authenticate against the Swift authentication service. |
| string value | Directory to buffer image segments before upload to Swift. Provide a string value representing the absolute path to the directory on the glance node where image segments will be buffered briefly before they are uploaded to swift.
NOTES: * This is required only when the configuration option Possible values:
Related options:
|
| integer value | The number of VMware API retries. This configuration option specifies the number of times the VMware ESX/VC server API must be retried upon connection related issues or server API call overload. It is not possible to specify retry forever. Possible Values:
Related options:
|
| string value | Absolute path to the CA bundle file. This configuration option enables the operator to use a custom Cerificate Authority File to verify the ESX/vCenter certificate. If this option is set, the "vmware_insecure" option will be ignored and the CA file specified will be used to authenticate the ESX/vCenter server certificate and establish a secure connection to the server. Possible Values:
Related options:
|
| multi valued | The datastores where the image can be stored. This configuration option specifies the datastores where the image can be stored in the VMWare store backend. This option may be specified multiple times for specifying multiple datastores. The datastore name should be specified after its datacenter path, separated by ":". An optional weight may be given after the datastore name, separated again by ":" to specify the priority. Thus, the required format becomes <datacenter_path>:<datastore_name>:<optional_weight>. When adding an image, the datastore with highest weight will be selected, unless there is not enough free space available in cases where the image size is already known. If no weight is given, it is assumed to be zero and the directory will be considered for selection last. If multiple datastores have the same weight, then the one with the most free space available is selected. Possible Values:
Related options: * None |
| boolean value | Set verification of the ESX/vCenter server certificate. This configuration option takes a boolean value to determine whether or not to verify the ESX/vCenter server certificate. If this option is set to True, the ESX/vCenter server certificate is not verified. If this option is set to False, then the default CA truststore is used for verification. This option is ignored if the "vmware_ca_file" option is set. In that case, the ESX/vCenter server certificate will then be verified using the file specified using the "vmware_ca_file" option . Possible Values:
Related options:
|
| host address value | Address of the ESX/ESXi or vCenter Server target system. This configuration option sets the address of the ESX/ESXi or vCenter Server target system. This option is required when using the VMware storage backend. The address can contain an IP address (127.0.0.1) or a DNS name (www.my-domain.com). Possible Values:
Related options:
|
| string value | Server password. This configuration option takes the password for authenticating with the VMware ESX/ESXi or vCenter Server. This option is required when using the VMware storage backend. Possible Values:
Related options:
|
| string value | Server username. This configuration option takes the username for authenticating with the VMware ESX/ESXi or vCenter Server. This option is required when using the VMware storage backend. Possible Values:
Related options:
|
| string value | The directory where the glance images will be stored in the datastore. This configuration option specifies the path to the directory where the glance images will be stored in the VMware datastore. If this option is not set, the default directory where the glance images are stored is openstack_glance. Possible Values:
Related options:
|
| integer value | Interval in seconds used for polling remote tasks invoked on VMware ESX/VC server. This configuration option takes in the sleep time in seconds for polling an on-going async task as part of the VMWare ESX/VC server API call. Possible Values:
Related options:
|
3.1.12. image_format
The following table outlines the options available under the [image_format]
group in the /etc/glance/glance-api.conf
file.
Table 3.11. image_format
Configuration option = Default value | Type | Description |
---|---|---|
| list value | Supported values for the container_format image attribute |
| list value | Supported values for the disk_format image attribute |
3.1.13. keystone_authtoken
The following table outlines the options available under the [keystone_authtoken]
group in the /etc/glance/glance-api.conf
file.
Table 3.12. keystone_authtoken
Configuration option = Default value | Type | Description |
---|---|---|
| string value | Config Section from which to load plugin specific options |
| string value | Authentication type to load |
| string value | (DEPRECATED FOR REMOVAL) Complete "public" Identity API endpoint. This endpoint should not be an "admin" endpoint, as it should be accessible by all end users. Unauthenticated clients are redirected to this endpoint to authenticate. Although this endpoint should ideally be unversioned, client support in the wild varies. If you’re using a versioned v2 endpoint here, then this should not be the same endpoint the service user utilizes for validating tokens, because normal end users may not be able to reach that endpoint. This option is deprecated in favor of www_authenticate_uri and will be removed in the S release. |
| string value | API version of the Identity API endpoint. |
| string value |
Request environment key where the Swift cache object is stored. When auth_token middleware is deployed with a Swift cache, use this option to have the middleware share a caching backend with swift. Otherwise, use the |
| string value | A PEM encoded Certificate Authority to use when verifying HTTPs connections. Defaults to system CAs. |
| string value | Required if identity server requires client certificate |
| boolean value | Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components. |
| string value | Used to control the use and type of token binding. Can be set to: "disabled" to not check token binding. "permissive" (default) to validate binding information if the bind type is of a form known to the server and ignore it if not. "strict" like "permissive" but if the bind type is unknown the token will be rejected. "required" any form of token binding is needed to be allowed. Finally the name of a binding method that must be present in tokens. |
| integer value | Request timeout value for communicating with Identity API server. |
| integer value | How many times are we trying to reconnect when communicating with Identity API Server. |
| boolean value | (Optional) Indicate whether to set the X-Service-Catalog header. If False, middleware will not ask for service catalog on token validation and will not set the X-Service-Catalog header. |
| boolean value | Verify HTTPS connections. |
| string value | Interface to use for the Identity API endpoint. Valid values are "public", "internal" or "admin"(default). |
| string value | Required if identity server requires client certificate |
| integer value | (Optional) Number of seconds that an operation will wait to get a memcached client connection from the pool. |
| integer value | (Optional) Number of seconds memcached server is considered dead before it is tried again. |
| integer value | (Optional) Maximum total number of open connections to every memcached server. |
| integer value | (Optional) Socket timeout in seconds for communicating with a memcached server. |
| integer value | (Optional) Number of seconds a connection to memcached is held unused in the pool before it is closed. |
| string value | (Optional, mandatory if memcache_security_strategy is defined) This string is used for key derivation. |
| string value | (Optional) If defined, indicate whether token data should be authenticated or authenticated and encrypted. If MAC, token data is authenticated (with HMAC) in the cache. If ENCRYPT, token data is encrypted and authenticated in the cache. If the value is not one of these options or empty, auth_token will raise an exception on initialization. |
| boolean value | (Optional) Use the advanced (eventlet safe) memcached client pool. The advanced pool will only work under python 2.x. |
| list value | Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process. |
| string value | The region in which the identity server can be found. |
| list value | A choice of roles that must be present in a service token. Service tokens are allowed to request that an expired token can be used and so this check should tightly control that only actual services should be sending this token. Roles here are applied as an ANY check so any role in this list must be present. For backwards compatibility reasons this currently only affects the allow_expired check. |
| boolean value | For backwards compatibility reasons we must let valid service tokens pass that don’t pass the service_token_roles check as valid. Setting this true will become the default in a future release and should be enabled if possible. |
| string value | The name or type of the service as it appears in the service catalog. This is used to validate tokens that have restricted access rules. |
| integer value | In order to prevent excessive effort spent validating tokens, the middleware caches previously-seen tokens for a configurable duration (in seconds). Set to -1 to disable caching completely. |
| string value | Complete "public" Identity API endpoint. This endpoint should not be an "admin" endpoint, as it should be accessible by all end users. Unauthenticated clients are redirected to this endpoint to authenticate. Although this endpoint should ideally be unversioned, client support in the wild varies. If you’re using a versioned v2 endpoint here, then this should not be the same endpoint the service user utilizes for validating tokens, because normal end users may not be able to reach that endpoint. |
3.1.14. oslo_concurrency
The following table outlines the options available under the [oslo_concurrency]
group in the /etc/glance/glance-api.conf
file.
Table 3.13. oslo_concurrency
Configuration option = Default value | Type | Description |
---|---|---|
| boolean value | Enables or disables inter-process locks. |
| string value | 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. |
3.1.15. oslo_messaging_amqp
The following table outlines the options available under the [oslo_messaging_amqp]
group in the /etc/glance/glance-api.conf
file.
Table 3.14. oslo_messaging_amqp
Configuration option = Default value | Type | Description |
---|---|---|
| string value | 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 |
| string value | 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. |
| string value | address prefix used when broadcasting to all servers |
| integer value | Increase the connection_retry_interval by this many seconds after each unsuccessful failover attempt. |
| integer value | Seconds to pause before attempting to re-connect. |
| integer value | Maximum limit for connection_retry_interval + connection_retry_backoff |
| string value | Name for the AMQP container. must be globally unique. Defaults to a generated UUID |
| string value | 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 |
| integer value | The deadline for a sent notification message delivery. Only used when caller does not provide a timeout expiry. |
| integer value | The maximum number of attempts to re-send a reply message which failed due to a recoverable error. |
| integer value | The deadline for an rpc reply message delivery. |
| string value | 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 |
| integer value | The deadline for an rpc cast or call message delivery. Only used when caller does not provide a timeout expiry. |
| integer value | The duration to schedule a purge of idle sender links. Detach link after expiry. |
| string value | address prefix when sending to any server in group |
| integer value | Timeout for inactive connections (in seconds) |
| integer value | Time to pause between re-connecting an AMQP 1.0 link that failed due to a recoverable error. |
| string value | Appended to the address prefix when sending a fanout message. Used by the message bus to identify fanout messages. |
| string value | Address prefix for all generated Notification addresses |
| integer value | Window size for incoming Notification messages |
| multi valued | Send messages of this type pre-settled. Pre-settled messages will not receive acknowledgement from the peer. Note well: pre-settled messages may be silently discarded if the delivery fails. Permitted values: rpc-call - send RPC Calls pre-settled rpc-reply- send RPC Replies pre-settled rpc-cast - Send RPC Casts pre-settled notify - Send Notifications pre-settled |
| boolean value | Enable virtual host support for those message buses that do not natively support virtual hosting (such as qpidd). When set to true the virtual host name will be added to all message bus addresses, effectively creating a private subnet per virtual host. Set to False if the message bus supports virtual hosting using the hostname field in the AMQP 1.0 Open performative as the name of the virtual host. |
| integer value | Window size for incoming RPC Reply messages. |
| string value | Address prefix for all generated RPC addresses |
| integer value | Window size for incoming RPC Request messages |
`sasl_config_dir = ` | string value | Path to directory that contains the SASL configuration |
`sasl_config_name = ` | string value | Name of configuration file (without .conf suffix) |
`sasl_default_realm = ` | string value | SASL realm to use if no realm present in username |
`sasl_mechanisms = ` | string value | Space separated list of acceptable SASL mechanisms |
| string value | address prefix used when sending to a specific server |
| boolean value | Attempt to connect via SSL. If no other ssl-related parameters are given, it will use the system’s CA-bundle to verify the server’s certificate. |
`ssl_ca_file = ` | string value | CA certificate PEM file used to verify the server’s certificate |
`ssl_cert_file = ` | string value | Self-identifying certificate PEM file for client authentication |
`ssl_key_file = ` | string value | Private key PEM file used to sign ssl_cert_file certificate (optional) |
| string value | Password for decrypting ssl_key_file (if encrypted) |
| boolean value | By default SSL checks that the name in the server’s certificate matches the hostname in the transport_url. In some configurations it may be preferable to use the virtual hostname instead, for example if the server uses the Server Name Indication TLS extension (rfc6066) to provide a certificate per virtual host. Set ssl_verify_vhost to True if the server’s SSL certificate uses the virtual host name instead of the DNS name. |
| boolean value | Debug: dump AMQP frames to stdout |
| string value | 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. |
3.1.16. oslo_messaging_kafka
The following table outlines the options available under the [oslo_messaging_kafka]
group in the /etc/glance/glance-api.conf
file.
Table 3.15. oslo_messaging_kafka
Configuration option = Default value | Type | Description |
---|---|---|
| string value | The compression codec for all data generated by the producer. If not set, compression will not be used. Note that the allowed values of this depend on the kafka version |
| integer value | (DEPRECATED FOR REMOVAL) The pool size limit for connections expiration policy |
| integer value | (DEPRECATED FOR REMOVAL) The time-to-live in sec of idle connections in the pool |
| string value | Group id for Kafka consumer. Consumers in one group will coordinate message consumption |
| boolean value | Enable asynchronous consumer commits |
| floating point value | Default timeout(s) for Kafka consumers |
| integer value | Max fetch bytes of Kafka consumer |
| integer value | The maximum number of records returned in a poll call |
| integer value | (DEPRECATED FOR REMOVAL) Pool Size for Kafka Consumers |
| integer value | Size of batch for the producer async send |
| floating point value | Upper bound on the delay for KafkaProducer batching in seconds |
| string value | Mechanism when security protocol is SASL |
| string value | Protocol used to communicate with brokers |
`ssl_cafile = ` | string value | CA certificate PEM file used to verify the server certificate |
3.1.17. oslo_messaging_notifications
The following table outlines the options available under the [oslo_messaging_notifications]
group in the /etc/glance/glance-api.conf
file.
Table 3.16. oslo_messaging_notifications
Configuration option = Default value | Type | Description |
---|---|---|
| multi valued | The Drivers(s) to handle sending notifications. Possible values are messaging, messagingv2, routing, log, test, noop |
| integer value | The maximum number of attempts to re-send a notification message which failed to be delivered due to a recoverable error. 0 - No retry, -1 - indefinite |
| list value | AMQP topic used for OpenStack notifications. |
| string value | A URL representing the messaging driver to use for notifications. If not set, we fall back to the same configuration used for RPC. |
3.1.18. oslo_messaging_rabbit
The following table outlines the options available under the [oslo_messaging_rabbit]
group in the /etc/glance/glance-api.conf
file.
Table 3.17. oslo_messaging_rabbit
Configuration option = Default value | Type | Description |
---|---|---|
| boolean value | Auto-delete queues in AMQP. |
| boolean value | Use durable queues in AMQP. |
| integer value | Enable/Disable the RabbitMQ mandatory flag for direct send. The direct send is used as reply,so the MessageUndeliverable exception is raised in case the client queue does not exist. |
| boolean value | EXPERIMENTAL: Run the health check heartbeat threadthrough a native python thread. By default if thisoption isn’t provided the health check heartbeat willinherit the execution model from the parent process. Byexample if the parent process have monkey patched thestdlib by using eventlet/greenlet then the heartbeatwill be run through a green thread. |
| integer value | How often times during the heartbeat_timeout_threshold we check the heartbeat. |
| integer value | Number of seconds after which the Rabbit broker is considered down if heartbeat’s keep-alive fails (0 disables heartbeat). |
| string value | EXPERIMENTAL: Possible values are: gzip, bz2. If not set compression will not be used. This option may not be available in future versions. |
| string value | 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. |
| integer value | How long to wait a missing client before abandoning to send it its replies. This value should not be longer than rpc_response_timeout. |
| floating point value | How long to wait before reconnecting in response to an AMQP consumer cancel notification. |
| boolean value | 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"} " |
| integer value | Maximum interval of RabbitMQ connection retries. Default is 30 seconds. |
| string value | The RabbitMQ login method. |
| integer value | Specifies the number of messages to prefetch. Setting to zero allows unlimited messages. |
| integer value | How long to backoff for between retries when connecting to RabbitMQ. |
| integer value | How frequently to retry connecting with RabbitMQ. |
| integer value | 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. |
| boolean value | Connect over SSL. |
`ssl_ca_file = ` | string value | SSL certification authority file (valid only if SSL enabled). |
`ssl_cert_file = ` | string value | SSL cert file (valid only if SSL enabled). |
`ssl_key_file = ` | string value | SSL key file (valid only if SSL enabled). |
`ssl_version = ` | string value | 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. |
3.1.19. oslo_middleware
The following table outlines the options available under the [oslo_middleware]
group in the /etc/glance/glance-api.conf
file.
Table 3.18. oslo_middleware
Configuration option = Default value | Type | Description |
---|---|---|
| boolean value | Whether the application is behind a proxy or not. This determines if the middleware should parse the headers or not. |
3.1.20. oslo_policy
The following table outlines the options available under the [oslo_policy]
group in the /etc/glance/glance-api.conf
file.
Table 3.19. oslo_policy
Configuration option = Default value | Type | Description |
---|---|---|
| boolean value |
This option controls whether or not to enforce scope when evaluating policies. If |
| string value | Default rule. Enforced when a requested rule is not found. |
| multi valued | 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. |
| string value | The relative or absolute path of a file that maps roles to permissions for a given service. Relative paths must be specified in relation to the configuration file setting this option. |
| string value | Content Type to send and receive data for REST based policy check |
| string value | Absolute path to ca cert file for REST based policy check |
| string value | Absolute path to client cert for REST based policy check |
| string value | Absolute path client key file REST based policy check |
| boolean value | server identity verification for REST based policy check |
3.1.21. paste_deploy
The following table outlines the options available under the [paste_deploy]
group in the /etc/glance/glance-api.conf
file.
Table 3.20. paste_deploy
Configuration option = Default value | Type | Description |
---|---|---|
| string value | Name of the paste configuration file. Provide a string value representing the name of the paste configuration file to use for configuring piplelines for server application deployments. NOTES:
If no value is specified for this option, the Possible values:
Related Options:
|
| string value | Deployment flavor to use in the server application pipeline. Provide a string value representing the appropriate deployment flavor used in the server application pipleline. This is typically the partial name of a pipeline in the paste configuration file with the service name removed.
For example, if your paste section name in the paste configuration file is [pipeline:glance-api-keystone], set Possible values:
Related Options:
|
3.1.22. profiler
The following table outlines the options available under the [profiler]
group in the /etc/glance/glance-api.conf
file.
Table 3.21. profiler
Configuration option = Default value | Type | Description |
---|---|---|
| string value | Connection string for a notifier backend.
Default value is Examples of possible values:
|
| boolean value | Enable the profiling for all services on this node. Default value is False (fully disable the profiling feature). Possible values:
|
| string value | Document type for notification indexing in elasticsearch. |
| integer value | Elasticsearch splits large requests in batches. This parameter defines maximum size of each batch (for example: es_scroll_size=10000). |
| string value | 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. |
| boolean value | Enable filter traces that contain error/exception to a separated place. Default value is set to False. Possible values:
|
| string value | 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 value |
Redissentinel uses a service name to identify a master redis service. This parameter defines the name (for example: |
| floating point value | Redissentinel provides a timeout option on the connections. This parameter defines that timeout (for example: socket_timeout=0.1). |
| boolean value | Enable SQL requests profiling in services. Default value is False (SQL requests won’t be traced). Possible values:
|
3.1.23. store_type_location_strategy
The following table outlines the options available under the [store_type_location_strategy]
group in the /etc/glance/glance-api.conf
file.
Table 3.22. store_type_location_strategy
Configuration option = Default value | Type | Description |
---|---|---|
| list value | Preference order of storage backends.
Provide a comma separated list of store names in the order in which images should be retrieved from storage backends. These store names must be registered with the Note
The Possible values:
Related options:
|
3.1.24. task
The following table outlines the options available under the [task]
group in the /etc/glance/glance-api.conf
file.
Table 3.23. task
Configuration option = Default value | Type | Description |
---|---|---|
| string value | Task executor to be used to run task scripts.
Provide a string value representing the executor to use for task executions. By default,
Possible values:
Related Options:
|
| integer value | Time in hours for which a task lives after, either succeeding or failing |
| string value | Absolute path to the work directory to use for asynchronous task operations. The directory set here will be used to operate over images - normally before they are imported in the destination store. Note
When providing a value for
A rough estimation can be done by multiplying the number of Possible values:
Related Options:
|
3.1.25. taskflow_executor
The following table outlines the options available under the [taskflow_executor]
group in the /etc/glance/glance-api.conf
file.
Table 3.24. taskflow_executor
Configuration option = Default value | Type | Description |
---|---|---|
| string value | Set the desired image conversion format. Provide a valid image format to which you want images to be converted before they are stored for consumption by Glance. Appropriate image format conversions are desirable for specific storage backends in order to facilitate efficient handling of bandwidth and usage of the storage infrastructure.
By default,
The allowed values for this option are Possible values:
Related options:
|
| string value | Set the taskflow engine mode.
Provide a string type value to set the mode in which the taskflow engine would schedule tasks to the workers on the hosts. Based on this mode, the engine executes tasks either in single or multiple threads. The possible values for this configuration option are: Possible values:
Related options:
|
| integer value | Set the number of engine executable tasks. Provide an integer value to limit the number of workers that can be instantiated on the hosts. In other words, this number defines the number of parallel tasks that can be executed at the same time by the taskflow engine. This value can be greater than one when the engine mode is set to parallel. Possible values:
Related options:
|
3.2. glance-scrubber.conf
This section contains options for the /etc/glance/glance-scrubber.conf
file.
3.2.1. DEFAULT
The following table outlines the options available under the [DEFAULT]
group in the /etc/glance/glance-scrubber.conf
file.
.
Configuration option = Default value | Type | Description |
---|---|---|
| boolean value | Allow users to add additional/custom properties to images.
Glance defines a standard set of properties (in its schema) that appear on every image. These properties are also known as
By default, this configuration option is set to Possible values:
Related options:
|
| integer value | Maximum number of results that could be returned by a request.
As described in the help text of Note Setting this to a very large value may slow down database queries and increase response times. Setting this to a very low value may result in poor user experience. Possible values:
Related options:
|
| boolean value | Run scrubber as a daemon.
This boolean configuration option indicates whether scrubber should run as a long-running process that wakes up at regular intervals to scrub images. The wake up interval can be specified using the configuration option
If this configuration option is set to Possible values:
Related options:
|
| string value | (DEPRECATED FOR REMOVAL) Python module path of data access API. Specifies the path to the API to use for accessing the data model. This option determines how the image catalog data will be accessed. Possible values:
If this option is set to
Setting this option to Note
In v2 OpenStack Images API, the registry service is optional. In order to use the Registry API in v2, the option
Finally, when this configuration option is set to Related options:
|
| boolean value | If set to true, the logging level will be set to DEBUG instead of the default INFO level. |
| list value | List of package logging levels in logger=LEVEL pairs. This option is ignored if log_config_append is set. |
| boolean value | Turn on/off delayed delete.
Typically when an image is deleted, the Note When delayed delete is turned on, image scrubber MUST be running as a periodic task to prevent the backend storage from filling up with undesired usage. Possible values:
Related options:
|
| string value | Digest algorithm to use for digital signature.
Provide a string value representing the digest algorithm to use for generating digital signatures. By default,
To get a list of the available algorithms supported by the version of OpenSSL on your platform, run the command: Note
Possible values:
Relation options:
|
| boolean value | DEPRECATED FOR REMOVAL |
| boolean value | Deploy the v2 OpenStack Images API.
When this option is set to NOTES:
Possible values:
Related options:
|
| boolean value | (DEPRECATED FOR REMOVAL) Deploy the v2 API Registry service.
When this option is set to NOTES:
Possible values:
Related options:
|
| list value | List of enabled Image Import Methods 'glance-direct', 'copy-image' and 'web-download' are enabled by default. Related options: ** [DEFAULT]/node_staging_uri |
| boolean value | Enables or disables fatal status of deprecations. |
| string value | Secure hashing algorithm used for computing the os_hash_value property. This option configures the Glance "multihash", which consists of two image properties: the os_hash_algo and the os_hash_value. The os_hash_algo will be populated by the value of this configuration option, and the os_hash_value will be populated by the hexdigest computed when the algorithm is applied to the uploaded or imported image data. The value must be a valid secure hash algorithm name recognized by the python hashlib library. You can determine what these are by examining the hashlib.algorithms_available data member of the version of the library being used in your Glance installation. For interoperability purposes, however, we recommend that you use the set of secure hash names supplied by the hashlib.algorithms_guaranteed data member because those algorithms are guaranteed to be supported by the hashlib library on all platforms. Thus, any image consumer using hashlib locally should be able to verify the os_hash_value of the image. The default value of sha512 is a performant secure hash algorithm. If this option is misconfigured, any attempts to store image data will fail. For that reason, we recommend using the default value. Possible values:
Related options:
|
| integer value | Maximum number of locations allowed on an image. Any negative value is interpreted as unlimited. Related options:
|
| integer value | Maximum number of image members per image. This limits the maximum of users an image can be shared with. Any negative value is interpreted as unlimited. Related options:
|
| integer value | Maximum number of properties allowed on an image. This enforces an upper limit on the number of additional properties an image can have. Any negative value is interpreted as unlimited. Note
This won’t have any impact if additional properties are disabled. Please refer to Related options:
|
| integer value | Maximum size of image a user can upload in bytes. An image upload greater than the size mentioned here would result in an image creation failure. This configuration option defaults to 1099511627776 bytes (1 TiB). NOTES:
Possible values:
|
| integer value | Maximum number of tags allowed on an image. Any negative value is interpreted as unlimited. Related options:
|
`instance_format = [instance: %(uuid)s] ` | string value | The format for an instance that is passed with the log message. |
`instance_uuid_format = [instance: %(uuid)s] ` | string value | The format for an instance UUID that is passed with the log message. |
| integer value | The default number of results to return for a request.
Responses to certain API requests, like list images, may return multiple items. The number of results returned can be explicitly controlled by specifying the NOTES:
Possible values:
Related options:
|
| string value | 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. Note that when logging configuration files are used then all logging configuration is set in the configuration file and other logging configuration options are ignored (for example, log-date-format). |
| string value | Defines the format string for %%(asctime)s in log records. Default: %(default)s . This option is ignored if log_config_append is set. |
| string value | (Optional) The base directory used for relative log_file paths. This option is ignored if log_config_append is set. |
| string value | (Optional) Name of log file to send logging output to. If no default is set, logging will go to stderr as defined by use_stderr. This option is ignored if log_config_append is set. |
| integer value | The amount of time before the log files are rotated. This option is ignored unless log_rotation_type is setto "interval". |
| string value | Rotation interval type. The time of the last file change (or the time when the service was started) is used when scheduling the next rotation. |
| string value | Log rotation type. |
| string value | Format string to use for log messages with context. Used by oslo_log.formatters.ContextFormatter |
| string value | Additional data to append to log message when logging level for the message is DEBUG. Used by oslo_log.formatters.ContextFormatter |
| string value | Format string to use for log messages when context is undefined. Used by oslo_log.formatters.ContextFormatter |
| string value | Prefix each line of exception output with this format. Used by oslo_log.formatters.ContextFormatter |
| string value | Defines the format string for %(user_identity)s that is used in logging_context_format_string. Used by oslo_log.formatters.ContextFormatter |
| integer value | Maximum number of rotated log files. |
| integer value | Log file maximum size in MB. This option is ignored if "log_rotation_type" is not set to "size". |
| string value | AES key for encrypting store location metadata. Provide a string value representing the AES cipher to use for encrypting Glance store metadata. Note The AES key to use must be set to a random string of length 16, 24 or 32 bytes. Possible values:
Related options:
|
| string value | The URL provides location where the temporary data will be stored This option is for Glance internal use only. Glance will save the image data uploaded by the user to staging endpoint during the image import process. This option does not change the staging API endpoint by any means. Note It is discouraged to use same path as [task]/work_dir Note file://<absolute-directory-path> is the only option api_image_import flow will support for now. Note The staging path must be on shared filesystem available to all Glance API nodes. Possible values:
Related options:
|
| boolean value | Enables or disables publication of error events. |
| host address value | Host address of the pydev server. Provide a string value representing the hostname or IP of the pydev server to use for debugging. The pydev server listens for debug connections on this address, facilitating remote debugging in Glance. Possible values:
Related options:
|
| port value | Port number that the pydev server will listen on. Provide a port number to bind the pydev server to. The pydev process accepts debug connections on this port and facilitates remote debugging in Glance. Possible values:
Related options:
|
| integer value | Maximum number of logged messages per rate_limit_interval. |
| string value | Log level name used by rate limiting: CRITICAL, ERROR, INFO, WARNING, DEBUG or empty string. Logs with level greater or equal to rate_limit_except_level are not filtered. An empty string means that all levels are filtered. |
| integer value | Interval, number of seconds, of log rate limiting. |
| string value | Restore the image status from pending_delete to active. This option is used by administrator to reset the image’s status from pending_delete to active when the image is deleted by mistake and pending delete feature is enabled in Glance. Please make sure the glance-scrubber daemon is stopped before restoring the image to avoid image data inconsistency. Possible values:
|
| integer value | The size of thread pool to be used for scrubbing images. When there are a large number of images to scrub, it is beneficial to scrub images in parallel so that the scrub queue stays in control and the backend storage is reclaimed in a timely fashion. This configuration option denotes the maximum number of images to be scrubbed in parallel. The default value is one, which signifies serial scrubbing. Any value above one indicates parallel scrubbing. Possible values:
Related options:
|
| integer value | The amount of time, in seconds, to delay image scrubbing.
When delayed delete is turned on, an image is put into
It is important to realize that this has storage implications. The larger the Possible values:
Related options:
|
| boolean value | Show direct image location when returning an image.
This configuration option indicates whether to show the direct image location when returning image details to the user. The direct image location is where the image data is stored in backend storage. This image location is shown under the image property
When multiple image locations exist for an image, the best location is displayed based on the location strategy indicated by the configuration option NOTES:
Possible values:
Related options:
|
| boolean value | (DEPRECATED FOR REMOVAL) Show all image locations when returning an image.
This configuration option indicates whether to show all the image locations when returning image details to the user. When multiple image locations exist for an image, the locations are ordered based on the location strategy indicated by the configuration opt NOTES:
Possible values:
Related options:
|
| string value | Syslog facility to receive log lines. This option is ignored if log_config_append is set. |
| boolean value | Enable journald for logging. If running in a systemd environment you may wish to enable journal support. Doing so will use the journal native protocol which includes structured metadata in addition to log messages.This option is ignored if log_config_append is set. |
| boolean value | Use JSON formatting for logging. This option is ignored if log_config_append is set. |
| boolean value | Use syslog for logging. Existing syslog format is DEPRECATED and will be changed later to honor RFC5424. This option is ignored if log_config_append is set. |
| boolean value | Log output to Windows Event Log. |
| boolean value | Log output to standard error. This option is ignored if log_config_append is set. |
| string value | Maximum amount of image storage per tenant. This enforces an upper limit on the cumulative storage consumed by all images of a tenant across all stores. This is a per-tenant limit.
The default unit for this configuration option is Bytes. However, storage units can be specified using case-sensitive literals Possible values:
Related options:
|
| integer value | Time interval, in seconds, between scrubber runs in daemon mode.
Scrubber can be run either as a cron job or daemon. When run as a daemon, this configuration time specifies the time period between two runs. When the scrubber wakes up, it fetches and scrubs all If the wakeup time is set to a large number, there may be a large number of images to be scrubbed for each run. Also, this impacts how quickly the backend storage is reclaimed. Possible values:
Related options:
|
| boolean value | Uses logging handler designed to watch file system. When log file is moved or removed this handler will open a new log file with specified path instantaneously. It makes sense only if log_file option is specified and Linux platform is used. This option is ignored if log_config_append is set. |
3.2.2. database
The following table outlines the options available under the [database]
group in the /etc/glance/glance-scrubber.conf
file.
Table 3.25. database
Configuration option = Default value | Type | Description |
---|---|---|
| string value | The back end to use for the database. |
| string value | The SQLAlchemy connection string to use to connect to the database. |
| integer value | Verbosity of SQL debugging information: 0=None, 100=Everything. |
`connection_parameters = ` | string value | Optional URL parameters to append onto the connection URL at connect time; specify as param1=value1¶m2=value2&… |
| integer value | Connections which have been present in the connection pool longer than this number of seconds will be replaced with a new one the next time they are checked out from the pool. |
| boolean value | Add Python stack traces to SQL as comment strings. |
| boolean value | If True, increases the interval between retries of a database operation up to db_max_retry_interval. |
| integer value | Maximum retries in case of connection error or deadlock error before error is raised. Set to -1 to specify an infinite retry count. |
| integer value | If db_inc_retry_interval is set, the maximum seconds between retries of a database operation. |
| integer value | Seconds between retries of a database transaction. |
| integer value | If set, use this value for max_overflow with SQLAlchemy. |
| integer value | Maximum number of SQL connections to keep open in a pool. Setting a value of 0 indicates no limit. |
| integer value | Maximum number of database connection retries during startup. Set to -1 to specify an infinite retry count. |
| boolean value | If True, transparently enables support for handling MySQL Cluster (NDB). |
| string value | The SQL mode to be used for MySQL sessions. This option, including the default, overrides any server-set SQL mode. To use whatever SQL mode is set by the server configuration, set this to no value. Example: mysql_sql_mode= |
| integer value | If set, use this value for pool_timeout with SQLAlchemy. |
| integer value | Interval between retries of opening a SQL connection. |
| string value | The SQLAlchemy connection string to use to connect to the slave database. |
| boolean value | If True, SQLite uses synchronous mode. |
| boolean value | Enable the experimental use of database reconnect on connection lost. |
| boolean value | Enable the experimental use of thread pooling for all DB API calls |
3.2.3. glance_store
The following table outlines the options available under the [glance_store]
group in the /etc/glance/glance-scrubber.conf
file.
Table 3.26. glance_store
Configuration option = Default value | Type | Description |
---|---|---|
| boolean value | Allow to perform insecure SSL requests to cinder.
If this option is set to True, HTTPS endpoint connection is verified using the CA certificates file specified by Possible values:
Related options:
|
| string value | Location of a CA certificates file used for cinder client requests.
The specified CA certificates file, if set, is used to verify cinder connections via HTTPS endpoint. If the endpoint is HTTP, this value is ignored. Possible values:
Related options:
|
| string value | Information to match when looking for cinder in the service catalog.
When the
The service catalog can be listed by the Possible values:
Related options:
|
| string value | Override service catalog lookup with template for cinder endpoint.
When this option is set, this value is used to generate cinder endpoint, instead of looking up from the service catalog. This value is ignored if
If this configuration option is set, Possible values:
Related options:
|
| boolean value | If this is set to True, attachment of volumes for image transfer will be aborted when multipathd is not running. Otherwise, it will fallback to single path. Possible values:
Related options:
|
| integer value | Number of cinderclient retries on failed http calls. When a call failed by any errors, cinderclient will retry the call up to the specified times after sleeping a few seconds. Possible values:
Related options:
|
| string value | Directory where the NFS volume is mounted on the glance node. Possible values:
|
| string value | Region name to lookup cinder service from the service catalog.
This is used only when Possible values:
Related options:
|
| integer value | Time period, in seconds, to wait for a cinder volume transition to complete.
When the cinder volume is created, deleted, or attached to the glance node to read/write the volume data, the volume’s state is changed. For example, the newly created volume status changes from Possible values:
Related options:
|
| string value | The address where the cinder authentication service is listening.
When all of If either of these options are not set, the cinder endpoint is looked up from the service catalog, and current context’s user and project are used. Possible values:
Related options:
|
| string value | Password for the user authenticating against cinder. This must be used with all the following related options. If any of these are not specified, the user of the current context is used. Possible values:
Related options:
|
| string value | Project name where the image volume is stored in cinder. If this configuration option is not set, the project in current context is used. This must be used with all the following related options. If any of these are not specified, the project of the current context is used. Possible values:
Related options:
|
| string value | User name to authenticate against cinder. This must be used with all the following related options. If any of these are not specified, the user of the current context is used. Possible values:
Related options:
|
| boolean value | Flag to identify mutipath is supported or not in the deployment. Set it to False if multipath is not supported. Possible values:
Related options:
|
| string value | Volume type that will be used for volume creation in cinder. Some cinder backends can have several volume types to optimize storage usage. Adding this option allows an operator to choose a specific volume type in cinder that can be optimized for images. If this is not set, then the default volume type specified in the cinder configuration will be used for volume creation. Possible values:
Related options:
|
| string value | (DEPRECATED FOR REMOVAL) The default scheme to use for storing images.
Provide a string value representing the default scheme to use for storing images. If not set, Glance uses Note
The value given for this configuration option must be a valid scheme for a store registered with the Possible values:
Related Options:
|
| string value | Reference to default Swift account/backing store parameters. Provide a string value representing a reference to the default set of parameters required for using swift account/backing store for image storage. The default reference value for this configuration option is ref1. This configuration option dereferences the parameters and facilitates image storage in Swift storage backend every time a new image is added. Possible values:
Related options:
|
| integer value | Chunk size, in bytes. The chunk size used when reading or writing image files. Raising this value may improve the throughput but it may also slightly increase the memory usage when handling a large number of requests. Possible Values:
Related options:
|
| string value | Directory to which the filesystem backend store writes images.
Upon start up, Glance creates the directory if it doesn’t already exist and verifies write access to the user under which Note
This directory is used only when filesystem store is used as a storage backend. Either Possible values:
Related options:
|
| multi valued | List of directories and their priorities to which the filesystem backend store writes images.
The filesystem store can be configured to store images in multiple directories as opposed to using a single directory specified by the More information on configuring filesystem store with multiple store directories can be found at https://docs.openstack.org/glance/latest/configuration/configuring.html Note
This directory is used only when filesystem store is used as a storage backend. Either Possible values:
Related options:
|
| integer value | File access permissions for the image files. Set the intended file access permissions for image data. This provides a way to enable other services, e.g. Nova, to consume images directly from the filesystem store. The users running the services that are intended to be given access to could be made a member of the group that owns the files created. Assigning a value less then or equal to zero for this configuration option signifies that no changes be made to the default permissions. This value will be decoded as an octal digit. For more information, please refer the documentation at https://docs.openstack.org/glance/latest/configuration/configuring.html Possible values:
Related options:
|
| string value | Filesystem store metadata file.
The path to a file which contains the metadata to be returned with any location associated with the filesystem store. The file must contain a valid JSON object. The object should contain the keys Possible values:
Related options:
|
| dict value | The http/https proxy information to be used to connect to the remote server. This configuration option specifies the http/https proxy information that should be used to connect to the remote server. The proxy information should be a key value pair of the scheme and proxy, for example, http:10.0.0.1:3128. You can also specify proxies for multiple schemes by separating the key value pairs with a comma, for example, http:10.0.0.1:3128, https:10.0.0.1:1080. Possible values:
Related options:
|
| string value | Path to the CA bundle file.
This configuration option enables the operator to use a custom Certificate Authority file to verify the remote server certificate. If this option is set, the Possible values:
Related options:
|
| boolean value | Set verification of the remote server certificate. This configuration option takes in a boolean value to determine whether or not to verify the remote server certificate. If set to True, the remote server certificate is not verified. If the option is set to False, then the default CA truststore is used for verification.
This option is ignored if Possible values:
Related options:
|
| integer value | Timeout value for connecting to Ceph cluster. This configuration option takes in the timeout value in seconds used when connecting to the Ceph cluster i.e. it sets the time to wait for glance-api before closing the connection. This prevents glance-api hangups during the connection to RBD. If the value for this option is set to less than or equal to 0, no timeout is set and the default librados value is used. Possible Values:
Related options:
|
`rbd_store_ceph_conf = ` | string value | Ceph configuration file path. This configuration option specifies the path to the Ceph configuration file to be used. If the value for this option is not set by the user or is set to the empty string, librados will read the standard ceph.conf file by searching the default Ceph configuration file locations in sequential order. See the Ceph documentation for details. Note If using Cephx authentication, this file should include a reference to the right keyring in a client.<USER> section NOTE 2: If you leave this option empty (the default), the actual Ceph configuration file used may change depending on what version of librados is being used. If it is important for you to know exactly which configuration file is in effect, you may specify that file here using this option. Possible Values:
Related options:
|
| integer value | Size, in megabytes, to chunk RADOS images into. Provide an integer value representing the size in megabytes to chunk Glance images into. The default chunk size is 8 megabytes. For optimal performance, the value should be a power of two. When Ceph’s RBD object storage system is used as the storage backend for storing Glance images, the images are chunked into objects of the size set using this option. These chunked objects are then stored across the distributed block data store to use for Glance. Possible Values:
Related options:
|
| string value | RADOS pool in which images are stored.
When RBD is used as the storage backend for storing Glance images, the images are stored by means of logical grouping of the objects (chunks of images) into a More information on the RBD storage backend can be found here: http://ceph.com/planet/how-data-is-stored-in-ceph-cluster/ Possible Values:
Related options:
|
| string value | RADOS user to authenticate as. This configuration option takes in the RADOS user to authenticate as. This is only needed when RADOS authentication is enabled and is applicable only if the user is using Cephx authentication. If the value for this option is not set by the user or is set to None, a default value will be chosen, which will be based on the client. section in rbd_store_ceph_conf. Possible Values:
Related options:
|
| string value | Path to the rootwrap configuration file to use for running commands as root. The cinder store requires root privileges to operate the image volumes (for connecting to iSCSI/FC volumes and reading/writing the volume data, etc.). The configuration file should allow the required commands by cinder store and os-brick library. Possible values:
Related options:
|
| host address value | (DEPRECATED FOR REMOVAL) Address to bind the Sheepdog daemon to. Provide a string value representing the address to bind the Sheepdog daemon to. The default address set for the sheep is 127.0.0.1.
The Sheepdog daemon, also called sheep, manages the storage in the distributed cluster by writing objects across the storage network. It identifies and acts on the messages directed to the address set using Possible values:
Related Options:
|
| integer value | (DEPRECATED FOR REMOVAL) Chunk size for images to be stored in Sheepdog data store. Provide an integer value representing the size in mebibyte (1048576 bytes) to chunk Glance images into. The default chunk size is 64 mebibytes. When using Sheepdog distributed storage system, the images are chunked into objects of this size and then stored across the distributed data store to use for Glance. Chunk sizes, if a power of two, help avoid fragmentation and enable improved performance. Possible values:
Related Options:
|
| port value | (DEPRECATED FOR REMOVAL) Port number on which the sheep daemon will listen. Provide an integer value representing a valid port number on which you want the Sheepdog daemon to listen on. The default port is 7000.
The Sheepdog daemon, also called sheep, manages the storage in the distributed cluster by writing objects across the storage network. It identifies and acts on the messages it receives on the port number set using Possible values:
Related Options:
|
| list value | (DEPRECATED FOR REMOVAL) List of enabled Glance stores.
Register the storage backends to use for storing disk images as a comma separated list. The default stores enabled for storing disk images with Glance are Possible values:
Related Options:
|
| boolean value | Buffer image segments before upload to Swift. Provide a boolean value to indicate whether or not Glance should buffer image data to disk while uploading to swift. This enables Glance to resume uploads on error.
NOTES: When enabling this option, one should take great care as this increases disk usage on the API node. Be aware that depending upon how the file system is configured, the disk space used for buffering may decrease the actual disk space available for the glance image cache. Disk utilization will cap according to the following equation: ( Possible values:
Related options:
|
| list value | List of tenants that will be granted admin access. This is a list of tenants that will be granted read/write access on all Swift containers created by Glance in multi-tenant mode. The default value is an empty list. Possible values:
Related options:
|
| string value | (DEPRECATED FOR REMOVAL) The address where the Swift authentication service is listening. |
| boolean value | Set verification of the server certificate. This boolean determines whether or not to verify the server certificate. If this option is set to True, swiftclient won’t check for a valid SSL certificate when authenticating. If the option is set to False, then the default CA truststore is used for verification. Possible values:
Related options:
|
| string value | (DEPRECATED FOR REMOVAL) Version of the authentication service to use. Valid versions are 2 and 3 for keystone and 1 (deprecated) for swauth and rackspace. |
| string value | Path to the CA bundle file. This configuration option enables the operator to specify the path to a custom Certificate Authority file for SSL verification when connecting to Swift. Possible values:
Related options:
|
| string value | Absolute path to the file containing the swift account(s) configurations. Include a string value representing the path to a configuration file that has references for each of the configured Swift account(s)/backing stores. By default, no file path is specified and customized Swift referencing is disabled. Configuring this option is highly recommended while using Swift storage backend for image storage as it avoids storage of credentials in the database. Note
Please do not configure this option if you have set Possible values:
Related options:
|
| string value | Name of single container to store images/name prefix for multiple containers
When a single container is being used to store images, this configuration option indicates the container within the Glance account to be used for storing all images. When multiple containers are used to store images, this will be the name prefix for all containers. Usage of single/multiple containers can be controlled using the configuration option
When using multiple containers, the containers will be named after the value set for this configuration option with the first N chars of the image UUID as the suffix delimited by an underscore (where N is specified by
Example: if the seed is set to 3 and swift_store_container = Possible values:
Related options:
|
| boolean value | Create container, if it doesn’t already exist, when uploading image. At the time of uploading an image, if the corresponding container doesn’t exist, it will be created provided this configuration option is set to True. By default, it won’t be created. This behavior is applicable for both single and multiple containers mode. Possible values:
Related options:
|
| string value | The URL endpoint to use for Swift backend storage.
Provide a string value representing the URL endpoint to use for storing Glance images in Swift store. By default, an endpoint is not set and the storage URL returned by Note The URL should include the path up to, but excluding the container. The location of an object is obtained by appending the container and object to the configured URL. Possible values:
Related Options:
|
| string value | Endpoint Type of Swift service. This string value indicates the endpoint type to use to fetch the Swift endpoint. The endpoint type determines the actions the user will be allowed to perform, for instance, reading and writing to the Store. This setting is only used if swift_store_auth_version is greater than 1. Possible values:
Related options:
|
| integer value | Time in seconds defining the size of the window in which a new token may be requested before the current token is due to expire. Typically, the Swift storage driver fetches a new token upon the expiration of the current token to ensure continued access to Swift. However, some Swift transactions (like uploading image segments) may not recover well if the token expires on the fly. Hence, by fetching a new token before the current token expiration, we make sure that the token does not expire or is close to expiry before a transaction is attempted. By default, the Swift storage driver requests for a new token 60 seconds or less before the current token expiration. Possible values:
Related Options:
|
| string value | (DEPRECATED FOR REMOVAL) Auth key for the user authenticating against the Swift authentication service. |
| integer value | The maximum size, in MB, of the segments when image data is segmented.
When image data is segmented to upload images that are larger than the limit enforced by the Swift cluster, image data is broken into segments that are no bigger than the size specified by this configuration option. Refer to
For example: if Possible values:
Related options:
|
| integer value | The size threshold, in MB, after which Glance will start segmenting image data. Swift has an upper limit on the size of a single uploaded object. By default, this is 5GB. To upload objects bigger than this limit, objects are segmented into multiple smaller objects that are tied together with a manifest file. For more detail, refer to https://docs.openstack.org/swift/latest/overview_large_objects.html This configuration option specifies the size threshold over which the Swift driver will start segmenting image data into multiple smaller files. Currently, the Swift driver only supports creating Dynamic Large Objects. Note This should be set by taking into account the large object limit enforced by the Swift cluster in consideration. Possible values:
Related options:
|
| boolean value | Store images in tenant’s Swift account. This enables multi-tenant storage mode which causes Glance images to be stored in tenant specific Swift accounts. If this is disabled, Glance stores all images in its own account. More details multi-tenant store can be found at https://wiki.openstack.org/wiki/GlanceSwiftTenantSpecificStorage Note If using multi-tenant swift store, please make sure that you do not set a swift configuration file with the swift_store_config_file option. Possible values:
Related options:
|
| integer value | Seed indicating the number of containers to use for storing images. When using a single-tenant store, images can be stored in one or more than one containers. When set to 0, all images will be stored in one single container. When set to an integer value between 1 and 32, multiple containers will be used to store images. This configuration option will determine how many containers are created. The total number of containers that will be used is equal to 16^N, so if this config option is set to 2, then 16^2=256 containers will be used to store images.
Please refer to Note This is used only when swift_store_multi_tenant is disabled. Possible values:
Related options:
|
| string value | The region of Swift endpoint to use by Glance. Provide a string value representing a Swift region where Glance can connect to for image storage. By default, there is no region set.
When Glance uses Swift as the storage backend to store images for a specific tenant that has multiple endpoints, setting of a Swift region with This option can be configured for both single-tenant and multi-tenant storage. Note
Setting the region with Possible values:
Related Options:
|
| integer value | The number of times a Swift download will be retried before the request fails.
Provide an integer value representing the number of times an image download must be retried before erroring out. The default value is zero (no retry on a failed image download). When set to a positive integer value, Possible values:
Related Options:
|
| string value | Type of Swift service to use.
Provide a string value representing the service type to use for storing images while using Swift backend storage. The default service type is set to Note
If Possible values:
Related Options:
|
| boolean value | SSL layer compression for HTTPS Swift requests. Provide a boolean value to determine whether or not to compress HTTPS Swift requests for images at the SSL layer. By default, compression is enabled. When using Swift as the backend store for Glance image storage, SSL layer compression of HTTPS Swift requests can be set using this option. If set to False, SSL layer compression of HTTPS Swift requests is disabled. Disabling this option may improve performance for images which are already in a compressed format, for example, qcow2. Possible values:
Related Options:
|
| boolean value | Use trusts for multi-tenant Swift store. This option instructs the Swift store to create a trust for each add/get request when the multi-tenant store is in use. Using trusts allows the Swift store to avoid problems that can be caused by an authentication token expiring during the upload or download of data.
By default, Note
This option is considered only when Possible values:
Related options:
|
| string value | (DEPRECATED FOR REMOVAL) The user to authenticate against the Swift authentication service. |
| string value | Directory to buffer image segments before upload to Swift. Provide a string value representing the absolute path to the directory on the glance node where image segments will be buffered briefly before they are uploaded to swift.
NOTES: * This is required only when the configuration option Possible values:
Related options:
|
| integer value | The number of VMware API retries. This configuration option specifies the number of times the VMware ESX/VC server API must be retried upon connection related issues or server API call overload. It is not possible to specify retry forever. Possible Values:
Related options:
|
| string value | Absolute path to the CA bundle file. This configuration option enables the operator to use a custom Cerificate Authority File to verify the ESX/vCenter certificate. If this option is set, the "vmware_insecure" option will be ignored and the CA file specified will be used to authenticate the ESX/vCenter server certificate and establish a secure connection to the server. Possible Values:
Related options:
|
| multi valued | The datastores where the image can be stored. This configuration option specifies the datastores where the image can be stored in the VMWare store backend. This option may be specified multiple times for specifying multiple datastores. The datastore name should be specified after its datacenter path, separated by ":". An optional weight may be given after the datastore name, separated again by ":" to specify the priority. Thus, the required format becomes <datacenter_path>:<datastore_name>:<optional_weight>. When adding an image, the datastore with highest weight will be selected, unless there is not enough free space available in cases where the image size is already known. If no weight is given, it is assumed to be zero and the directory will be considered for selection last. If multiple datastores have the same weight, then the one with the most free space available is selected. Possible Values:
Related options: * None |
| boolean value | Set verification of the ESX/vCenter server certificate. This configuration option takes a boolean value to determine whether or not to verify the ESX/vCenter server certificate. If this option is set to True, the ESX/vCenter server certificate is not verified. If this option is set to False, then the default CA truststore is used for verification. This option is ignored if the "vmware_ca_file" option is set. In that case, the ESX/vCenter server certificate will then be verified using the file specified using the "vmware_ca_file" option . Possible Values:
Related options:
|
| host address value | Address of the ESX/ESXi or vCenter Server target system. This configuration option sets the address of the ESX/ESXi or vCenter Server target system. This option is required when using the VMware storage backend. The address can contain an IP address (127.0.0.1) or a DNS name (www.my-domain.com). Possible Values:
Related options:
|
| string value | Server password. This configuration option takes the password for authenticating with the VMware ESX/ESXi or vCenter Server. This option is required when using the VMware storage backend. Possible Values:
Related options:
|
| string value | Server username. This configuration option takes the username for authenticating with the VMware ESX/ESXi or vCenter Server. This option is required when using the VMware storage backend. Possible Values:
Related options:
|
| string value | The directory where the glance images will be stored in the datastore. This configuration option specifies the path to the directory where the glance images will be stored in the VMware datastore. If this option is not set, the default directory where the glance images are stored is openstack_glance. Possible Values:
Related options:
|
| integer value | Interval in seconds used for polling remote tasks invoked on VMware ESX/VC server. This configuration option takes in the sleep time in seconds for polling an on-going async task as part of the VMWare ESX/VC server API call. Possible Values:
Related options:
|
3.2.4. oslo_concurrency
The following table outlines the options available under the [oslo_concurrency]
group in the /etc/glance/glance-scrubber.conf
file.
Table 3.27. oslo_concurrency
Configuration option = Default value | Type | Description |
---|---|---|
| boolean value | Enables or disables inter-process locks. |
| string value | 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. |
3.2.5. oslo_policy
The following table outlines the options available under the [oslo_policy]
group in the /etc/glance/glance-scrubber.conf
file.
Table 3.28. oslo_policy
Configuration option = Default value | Type | Description |
---|---|---|
| boolean value |
This option controls whether or not to enforce scope when evaluating policies. If |
| string value | Default rule. Enforced when a requested rule is not found. |
| multi valued | 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. |
| string value | The relative or absolute path of a file that maps roles to permissions for a given service. Relative paths must be specified in relation to the configuration file setting this option. |
| string value | Content Type to send and receive data for REST based policy check |
| string value | Absolute path to ca cert file for REST based policy check |
| string value | Absolute path to client cert for REST based policy check |
| string value | Absolute path client key file REST based policy check |
| boolean value | server identity verification for REST based policy check |
3.3. glance-cache.conf
This section contains options for the /etc/glance/glance-cache.conf
file.
3.3.1. DEFAULT
The following table outlines the options available under the [DEFAULT]
group in the /etc/glance/glance-cache.conf
file.
.
Configuration option = Default value | Type | Description |
---|---|---|
| string value | (DEPRECATED FOR REMOVAL) The administrators password. If "use_user_token" is not in effect, then admin credentials can be specified. |
| string value | (DEPRECATED FOR REMOVAL) The tenant name of the administrative user. If "use_user_token" is not in effect, then admin tenant name can be specified. |
| string value | (DEPRECATED FOR REMOVAL) The administrators user name. If "use_user_token" is not in effect, then admin credentials can be specified. |
| boolean value | Allow users to add additional/custom properties to images.
Glance defines a standard set of properties (in its schema) that appear on every image. These properties are also known as
By default, this configuration option is set to Possible values:
Related options:
|
| integer value | Maximum number of results that could be returned by a request.
As described in the help text of Note Setting this to a very large value may slow down database queries and increase response times. Setting this to a very low value may result in poor user experience. Possible values:
Related options:
|
| string value | (DEPRECATED FOR REMOVAL) The region for the authentication service. If "use_user_token" is not in effect and using keystone auth, then region name can be specified. |
| string value | (DEPRECATED FOR REMOVAL) The strategy to use for authentication. If "use_user_token" is not in effect, then auth strategy can be specified. |
| string value | (DEPRECATED FOR REMOVAL) The URL to the keystone service. If "use_user_token" is not in effect and using keystone auth, then URL of keystone can be specified. |
| string value | (DEPRECATED FOR REMOVAL) Python module path of data access API. Specifies the path to the API to use for accessing the data model. This option determines how the image catalog data will be accessed. Possible values:
If this option is set to
Setting this option to Note
In v2 OpenStack Images API, the registry service is optional. In order to use the Registry API in v2, the option
Finally, when this configuration option is set to Related options:
|
| boolean value | If set to true, the logging level will be set to DEBUG instead of the default INFO level. |
| list value | List of package logging levels in logger=LEVEL pairs. This option is ignored if log_config_append is set. |
| string value | Digest algorithm to use for digital signature.
Provide a string value representing the digest algorithm to use for generating digital signatures. By default,
To get a list of the available algorithms supported by the version of OpenSSL on your platform, run the command: Note
Possible values:
Relation options:
|
| boolean value | DEPRECATED FOR REMOVAL |
| boolean value | Deploy the v2 OpenStack Images API.
When this option is set to NOTES:
Possible values:
Related options:
|
| boolean value | (DEPRECATED FOR REMOVAL) Deploy the v2 API Registry service.
When this option is set to NOTES:
Possible values:
Related options:
|
| list value | List of enabled Image Import Methods 'glance-direct', 'copy-image' and 'web-download' are enabled by default. Related options: ** [DEFAULT]/node_staging_uri |
| boolean value | Enables or disables fatal status of deprecations. |
| string value | Secure hashing algorithm used for computing the os_hash_value property. This option configures the Glance "multihash", which consists of two image properties: the os_hash_algo and the os_hash_value. The os_hash_algo will be populated by the value of this configuration option, and the os_hash_value will be populated by the hexdigest computed when the algorithm is applied to the uploaded or imported image data. The value must be a valid secure hash algorithm name recognized by the python hashlib library. You can determine what these are by examining the hashlib.algorithms_available data member of the version of the library being used in your Glance installation. For interoperability purposes, however, we recommend that you use the set of secure hash names supplied by the hashlib.algorithms_guaranteed data member because those algorithms are guaranteed to be supported by the hashlib library on all platforms. Thus, any image consumer using hashlib locally should be able to verify the os_hash_value of the image. The default value of sha512 is a performant secure hash algorithm. If this option is misconfigured, any attempts to store image data will fail. For that reason, we recommend using the default value. Possible values:
Related options:
|
| string value | Base directory for image cache.
This is the location where image data is cached and served out of. All cached images are stored directly under this directory. This directory also contains three subdirectories, namely,
The
The Possible values:
Related options:
|
| string value | The driver to use for image cache management. This configuration option provides the flexibility to choose between the different image-cache drivers available. An image-cache driver is responsible for providing the essential functions of image-cache like write images to/read images from cache, track age and usage of cached images, provide a list of cached images, fetch size of the cache, queue images for caching and clean up the cache, etc.
The essential functions of a driver are defined in the base class
Possible values:
Related options:
|
| integer value | The upper limit on cache size, in bytes, after which the cache-pruner cleans up the image cache. Note This is just a threshold for cache-pruner to act upon. It is NOT a hard limit beyond which the image cache would never grow. In fact, depending on how often the cache-pruner runs and how quickly the cache fills, the image cache can far exceed the size specified here very easily. Hence, care must be taken to appropriately schedule the cache-pruner and in setting this limit. Glance caches an image when it is downloaded. Consequently, the size of the image cache grows over time as the number of downloads increases. To keep the cache size from becoming unmanageable, it is recommended to run the cache-pruner as a periodic task. When the cache pruner is kicked off, it compares the current size of image cache and triggers a cleanup if the image cache grew beyond the size specified here. After the cleanup, the size of cache is less than or equal to size specified here. Possible values:
Related options:
|
| string value | The relative path to sqlite file database that will be used for image cache management.
This is a relative path to the sqlite file database that tracks the age and usage statistics of image cache. The path is relative to image cache base directory, specified by the configuration option This is a lightweight database with just one table. Possible values:
Related options:
|
| integer value | The amount of time, in seconds, an incomplete image remains in the cache.
Incomplete images are images for which download is in progress. Please see the description of configuration option It is recommended to run cache-cleaner as a periodic task on the Glance API nodes to keep the incomplete images from occupying disk space. Possible values:
Related options:
|
| integer value | Maximum number of locations allowed on an image. Any negative value is interpreted as unlimited. Related options:
|
| integer value | Maximum number of image members per image. This limits the maximum of users an image can be shared with. Any negative value is interpreted as unlimited. Related options:
|
| integer value | Maximum number of properties allowed on an image. This enforces an upper limit on the number of additional properties an image can have. Any negative value is interpreted as unlimited. Note
This won’t have any impact if additional properties are disabled. Please refer to Related options:
|
| integer value | Maximum size of image a user can upload in bytes. An image upload greater than the size mentioned here would result in an image creation failure. This configuration option defaults to 1099511627776 bytes (1 TiB). NOTES:
Possible values:
|
| integer value | Maximum number of tags allowed on an image. Any negative value is interpreted as unlimited. Related options:
|
`instance_format = [instance: %(uuid)s] ` | string value | The format for an instance that is passed with the log message. |
`instance_uuid_format = [instance: %(uuid)s] ` | string value | The format for an instance UUID that is passed with the log message. |
| integer value | The default number of results to return for a request.
Responses to certain API requests, like list images, may return multiple items. The number of results returned can be explicitly controlled by specifying the NOTES:
Possible values:
Related options:
|
| string value | 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. Note that when logging configuration files are used then all logging configuration is set in the configuration file and other logging configuration options are ignored (for example, log-date-format). |
| string value | Defines the format string for %%(asctime)s in log records. Default: %(default)s . This option is ignored if log_config_append is set. |
| string value | (Optional) The base directory used for relative log_file paths. This option is ignored if log_config_append is set. |
| string value | (Optional) Name of log file to send logging output to. If no default is set, logging will go to stderr as defined by use_stderr. This option is ignored if log_config_append is set. |
| integer value | The amount of time before the log files are rotated. This option is ignored unless log_rotation_type is setto "interval". |
| string value | Rotation interval type. The time of the last file change (or the time when the service was started) is used when scheduling the next rotation. |
| string value | Log rotation type. |
| string value | Format string to use for log messages with context. Used by oslo_log.formatters.ContextFormatter |
| string value | Additional data to append to log message when logging level for the message is DEBUG. Used by oslo_log.formatters.ContextFormatter |
| string value | Format string to use for log messages when context is undefined. Used by oslo_log.formatters.ContextFormatter |
| string value | Prefix each line of exception output with this format. Used by oslo_log.formatters.ContextFormatter |
| string value | Defines the format string for %(user_identity)s that is used in logging_context_format_string. Used by oslo_log.formatters.ContextFormatter |
| integer value | Maximum number of rotated log files. |
| integer value | Log file maximum size in MB. This option is ignored if "log_rotation_type" is not set to "size". |
| string value | AES key for encrypting store location metadata. Provide a string value representing the AES cipher to use for encrypting Glance store metadata. Note The AES key to use must be set to a random string of length 16, 24 or 32 bytes. Possible values:
Related options:
|
| string value | The URL provides location where the temporary data will be stored This option is for Glance internal use only. Glance will save the image data uploaded by the user to staging endpoint during the image import process. This option does not change the staging API endpoint by any means. Note It is discouraged to use same path as [task]/work_dir Note file://<absolute-directory-path> is the only option api_image_import flow will support for now. Note The staging path must be on shared filesystem available to all Glance API nodes. Possible values:
Related options:
|
| boolean value | Enables or disables publication of error events. |
| host address value | Host address of the pydev server. Provide a string value representing the hostname or IP of the pydev server to use for debugging. The pydev server listens for debug connections on this address, facilitating remote debugging in Glance. Possible values:
Related options:
|
| port value | Port number that the pydev server will listen on. Provide a port number to bind the pydev server to. The pydev process accepts debug connections on this port and facilitates remote debugging in Glance. Possible values:
Related options:
|
| integer value | Maximum number of logged messages per rate_limit_interval. |
| string value | Log level name used by rate limiting: CRITICAL, ERROR, INFO, WARNING, DEBUG or empty string. Logs with level greater or equal to rate_limit_except_level are not filtered. An empty string means that all levels are filtered. |
| integer value | Interval, number of seconds, of log rate limiting. |
| string value | (DEPRECATED FOR REMOVAL) Absolute path to the Certificate Authority file. Provide a string value representing a valid absolute path to the certificate authority file to use for establishing a secure connection to the registry server. Note
This option must be set if Possible values:
Related options:
|
| string value | (DEPRECATED FOR REMOVAL) Absolute path to the certificate file. Provide a string value representing a valid absolute path to the certificate file to use for establishing a secure connection to the registry server. Note
This option must be set if Possible values:
Related options:
|
| boolean value | (DEPRECATED FOR REMOVAL) Set verification of the registry server certificate.
Provide a boolean value to determine whether or not to validate SSL connections to the registry server. By default, this option is set to
If set to Possible values:
Related options:
|
| string value | (DEPRECATED FOR REMOVAL) Absolute path to the private key file. Provide a string value representing a valid absolute path to the private key file to use for establishing a secure connection to the registry server. Note
This option must be set if Possible values:
Related options:
|
| string value | (DEPRECATED FOR REMOVAL) Protocol to use for communication with the registry server.
Provide a string value representing the protocol to use for communication with the registry server. By default, this option is set to
This option can be set to Possible values:
Related options:
|
| integer value | (DEPRECATED FOR REMOVAL) Timeout value for registry requests. Provide an integer value representing the period of time in seconds that the API server will wait for a registry request to complete. The default value is 600 seconds. A value of 0 implies that a request will never timeout. Possible values:
Related options:
|
| host address value | (DEPRECATED FOR REMOVAL) Address the registry server is hosted on. Possible values:
Related options:
|
| port value | (DEPRECATED FOR REMOVAL) Port the registry server is listening on. Possible values:
Related options:
|
| boolean value | Show direct image location when returning an image.
This configuration option indicates whether to show the direct image location when returning image details to the user. The direct image location is where the image data is stored in backend storage. This image location is shown under the image property
When multiple image locations exist for an image, the best location is displayed based on the location strategy indicated by the configuration option NOTES:
Possible values:
Related options:
|
| boolean value | (DEPRECATED FOR REMOVAL) Show all image locations when returning an image.
This configuration option indicates whether to show all the image locations when returning image details to the user. When multiple image locations exist for an image, the locations are ordered based on the location strategy indicated by the configuration opt NOTES:
Possible values:
Related options:
|
| string value | Syslog facility to receive log lines. This option is ignored if log_config_append is set. |
| boolean value | Enable journald for logging. If running in a systemd environment you may wish to enable journal support. Doing so will use the journal native protocol which includes structured metadata in addition to log messages.This option is ignored if log_config_append is set. |
| boolean value | Use JSON formatting for logging. This option is ignored if log_config_append is set. |
| boolean value | Use syslog for logging. Existing syslog format is DEPRECATED and will be changed later to honor RFC5424. This option is ignored if log_config_append is set. |
| boolean value | Log output to Windows Event Log. |
| boolean value | Log output to standard error. This option is ignored if log_config_append is set. |
| boolean value | (DEPRECATED FOR REMOVAL) Whether to pass through the user token when making requests to the registry. To prevent failures with token expiration during big files upload, it is recommended to set this parameter to False.If "use_user_token" is not in effect, then admin credentials can be specified. |
| string value | Maximum amount of image storage per tenant. This enforces an upper limit on the cumulative storage consumed by all images of a tenant across all stores. This is a per-tenant limit.
The default unit for this configuration option is Bytes. However, storage units can be specified using case-sensitive literals Possible values:
Related options:
|
| boolean value | Uses logging handler designed to watch file system. When log file is moved or removed this handler will open a new log file with specified path instantaneously. It makes sense only if log_file option is specified and Linux platform is used. This option is ignored if log_config_append is set. |
3.3.2. glance_store
The following table outlines the options available under the [glance_store]
group in the /etc/glance/glance-cache.conf
file.
Table 3.29. glance_store
Configuration option = Default value | Type | Description |
---|---|---|
| boolean value | Allow to perform insecure SSL requests to cinder.
If this option is set to True, HTTPS endpoint connection is verified using the CA certificates file specified by Possible values:
Related options:
|
| string value | Location of a CA certificates file used for cinder client requests.
The specified CA certificates file, if set, is used to verify cinder connections via HTTPS endpoint. If the endpoint is HTTP, this value is ignored. Possible values:
Related options:
|
| string value | Information to match when looking for cinder in the service catalog.
When the
The service catalog can be listed by the Possible values:
Related options:
|
| string value | Override service catalog lookup with template for cinder endpoint.
When this option is set, this value is used to generate cinder endpoint, instead of looking up from the service catalog. This value is ignored if
If this configuration option is set, Possible values:
Related options:
|
| boolean value | If this is set to True, attachment of volumes for image transfer will be aborted when multipathd is not running. Otherwise, it will fallback to single path. Possible values:
Related options:
|
| integer value | Number of cinderclient retries on failed http calls. When a call failed by any errors, cinderclient will retry the call up to the specified times after sleeping a few seconds. Possible values:
Related options:
|
| string value | Directory where the NFS volume is mounted on the glance node. Possible values:
|
| string value | Region name to lookup cinder service from the service catalog.
This is used only when Possible values:
Related options:
|
| integer value | Time period, in seconds, to wait for a cinder volume transition to complete.
When the cinder volume is created, deleted, or attached to the glance node to read/write the volume data, the volume’s state is changed. For example, the newly created volume status changes from Possible values:
Related options:
|
| string value | The address where the cinder authentication service is listening.
When all of If either of these options are not set, the cinder endpoint is looked up from the service catalog, and current context’s user and project are used. Possible values:
Related options:
|
| string value | Password for the user authenticating against cinder. This must be used with all the following related options. If any of these are not specified, the user of the current context is used. Possible values:
Related options:
|
| string value | Project name where the image volume is stored in cinder. If this configuration option is not set, the project in current context is used. This must be used with all the following related options. If any of these are not specified, the project of the current context is used. Possible values:
Related options:
|
| string value | User name to authenticate against cinder. This must be used with all the following related options. If any of these are not specified, the user of the current context is used. Possible values:
Related options:
|
| boolean value | Flag to identify mutipath is supported or not in the deployment. Set it to False if multipath is not supported. Possible values:
Related options:
|
| string value | Volume type that will be used for volume creation in cinder. Some cinder backends can have several volume types to optimize storage usage. Adding this option allows an operator to choose a specific volume type in cinder that can be optimized for images. If this is not set, then the default volume type specified in the cinder configuration will be used for volume creation. Possible values:
Related options:
|
| string value | (DEPRECATED FOR REMOVAL) The default scheme to use for storing images.
Provide a string value representing the default scheme to use for storing images. If not set, Glance uses Note
The value given for this configuration option must be a valid scheme for a store registered with the Possible values:
Related Options:
|
| string value | Reference to default Swift account/backing store parameters. Provide a string value representing a reference to the default set of parameters required for using swift account/backing store for image storage. The default reference value for this configuration option is ref1. This configuration option dereferences the parameters and facilitates image storage in Swift storage backend every time a new image is added. Possible values:
Related options:
|
| integer value | Chunk size, in bytes. The chunk size used when reading or writing image files. Raising this value may improve the throughput but it may also slightly increase the memory usage when handling a large number of requests. Possible Values:
Related options:
|
| string value | Directory to which the filesystem backend store writes images.
Upon start up, Glance creates the directory if it doesn’t already exist and verifies write access to the user under which Note
This directory is used only when filesystem store is used as a storage backend. Either Possible values:
Related options:
|
| multi valued | List of directories and their priorities to which the filesystem backend store writes images.
The filesystem store can be configured to store images in multiple directories as opposed to using a single directory specified by the More information on configuring filesystem store with multiple store directories can be found at https://docs.openstack.org/glance/latest/configuration/configuring.html Note
This directory is used only when filesystem store is used as a storage backend. Either Possible values:
Related options:
|
| integer value | File access permissions for the image files. Set the intended file access permissions for image data. This provides a way to enable other services, e.g. Nova, to consume images directly from the filesystem store. The users running the services that are intended to be given access to could be made a member of the group that owns the files created. Assigning a value less then or equal to zero for this configuration option signifies that no changes be made to the default permissions. This value will be decoded as an octal digit. For more information, please refer the documentation at https://docs.openstack.org/glance/latest/configuration/configuring.html Possible values:
Related options:
|
| string value | Filesystem store metadata file.
The path to a file which contains the metadata to be returned with any location associated with the filesystem store. The file must contain a valid JSON object. The object should contain the keys Possible values:
Related options:
|
| dict value | The http/https proxy information to be used to connect to the remote server. This configuration option specifies the http/https proxy information that should be used to connect to the remote server. The proxy information should be a key value pair of the scheme and proxy, for example, http:10.0.0.1:3128. You can also specify proxies for multiple schemes by separating the key value pairs with a comma, for example, http:10.0.0.1:3128, https:10.0.0.1:1080. Possible values:
Related options:
|
| string value | Path to the CA bundle file.
This configuration option enables the operator to use a custom Certificate Authority file to verify the remote server certificate. If this option is set, the Possible values:
Related options:
|
| boolean value | Set verification of the remote server certificate. This configuration option takes in a boolean value to determine whether or not to verify the remote server certificate. If set to True, the remote server certificate is not verified. If the option is set to False, then the default CA truststore is used for verification.
This option is ignored if Possible values:
Related options:
|
| integer value | Timeout value for connecting to Ceph cluster. This configuration option takes in the timeout value in seconds used when connecting to the Ceph cluster i.e. it sets the time to wait for glance-api before closing the connection. This prevents glance-api hangups during the connection to RBD. If the value for this option is set to less than or equal to 0, no timeout is set and the default librados value is used. Possible Values:
Related options:
|
`rbd_store_ceph_conf = ` | string value | Ceph configuration file path. This configuration option specifies the path to the Ceph configuration file to be used. If the value for this option is not set by the user or is set to the empty string, librados will read the standard ceph.conf file by searching the default Ceph configuration file locations in sequential order. See the Ceph documentation for details. Note If using Cephx authentication, this file should include a reference to the right keyring in a client.<USER> section NOTE 2: If you leave this option empty (the default), the actual Ceph configuration file used may change depending on what version of librados is being used. If it is important for you to know exactly which configuration file is in effect, you may specify that file here using this option. Possible Values:
Related options:
|
| integer value | Size, in megabytes, to chunk RADOS images into. Provide an integer value representing the size in megabytes to chunk Glance images into. The default chunk size is 8 megabytes. For optimal performance, the value should be a power of two. When Ceph’s RBD object storage system is used as the storage backend for storing Glance images, the images are chunked into objects of the size set using this option. These chunked objects are then stored across the distributed block data store to use for Glance. Possible Values:
Related options:
|
| string value | RADOS pool in which images are stored.
When RBD is used as the storage backend for storing Glance images, the images are stored by means of logical grouping of the objects (chunks of images) into a More information on the RBD storage backend can be found here: http://ceph.com/planet/how-data-is-stored-in-ceph-cluster/ Possible Values:
Related options:
|
| string value | RADOS user to authenticate as. This configuration option takes in the RADOS user to authenticate as. This is only needed when RADOS authentication is enabled and is applicable only if the user is using Cephx authentication. If the value for this option is not set by the user or is set to None, a default value will be chosen, which will be based on the client. section in rbd_store_ceph_conf. Possible Values:
Related options:
|
| string value | Path to the rootwrap configuration file to use for running commands as root. The cinder store requires root privileges to operate the image volumes (for connecting to iSCSI/FC volumes and reading/writing the volume data, etc.). The configuration file should allow the required commands by cinder store and os-brick library. Possible values:
Related options:
|
| host address value | (DEPRECATED FOR REMOVAL) Address to bind the Sheepdog daemon to. Provide a string value representing the address to bind the Sheepdog daemon to. The default address set for the sheep is 127.0.0.1.
The Sheepdog daemon, also called sheep, manages the storage in the distributed cluster by writing objects across the storage network. It identifies and acts on the messages directed to the address set using Possible values:
Related Options:
|
| integer value | (DEPRECATED FOR REMOVAL) Chunk size for images to be stored in Sheepdog data store. Provide an integer value representing the size in mebibyte (1048576 bytes) to chunk Glance images into. The default chunk size is 64 mebibytes. When using Sheepdog distributed storage system, the images are chunked into objects of this size and then stored across the distributed data store to use for Glance. Chunk sizes, if a power of two, help avoid fragmentation and enable improved performance. Possible values:
Related Options:
|
| port value | (DEPRECATED FOR REMOVAL) Port number on which the sheep daemon will listen. Provide an integer value representing a valid port number on which you want the Sheepdog daemon to listen on. The default port is 7000.
The Sheepdog daemon, also called sheep, manages the storage in the distributed cluster by writing objects across the storage network. It identifies and acts on the messages it receives on the port number set using Possible values:
Related Options:
|
| list value | (DEPRECATED FOR REMOVAL) List of enabled Glance stores.
Register the storage backends to use for storing disk images as a comma separated list. The default stores enabled for storing disk images with Glance are Possible values:
Related Options:
|
| boolean value | Buffer image segments before upload to Swift. Provide a boolean value to indicate whether or not Glance should buffer image data to disk while uploading to swift. This enables Glance to resume uploads on error.
NOTES: When enabling this option, one should take great care as this increases disk usage on the API node. Be aware that depending upon how the file system is configured, the disk space used for buffering may decrease the actual disk space available for the glance image cache. Disk utilization will cap according to the following equation: ( Possible values:
Related options:
|
| list value | List of tenants that will be granted admin access. This is a list of tenants that will be granted read/write access on all Swift containers created by Glance in multi-tenant mode. The default value is an empty list. Possible values:
Related options:
|
| string value | (DEPRECATED FOR REMOVAL) The address where the Swift authentication service is listening. |
| boolean value | Set verification of the server certificate. This boolean determines whether or not to verify the server certificate. If this option is set to True, swiftclient won’t check for a valid SSL certificate when authenticating. If the option is set to False, then the default CA truststore is used for verification. Possible values:
Related options:
|
| string value | (DEPRECATED FOR REMOVAL) Version of the authentication service to use. Valid versions are 2 and 3 for keystone and 1 (deprecated) for swauth and rackspace. |
| string value | Path to the CA bundle file. This configuration option enables the operator to specify the path to a custom Certificate Authority file for SSL verification when connecting to Swift. Possible values:
Related options:
|
| string value | Absolute path to the file containing the swift account(s) configurations. Include a string value representing the path to a configuration file that has references for each of the configured Swift account(s)/backing stores. By default, no file path is specified and customized Swift referencing is disabled. Configuring this option is highly recommended while using Swift storage backend for image storage as it avoids storage of credentials in the database. Note
Please do not configure this option if you have set Possible values:
Related options:
|
| string value | Name of single container to store images/name prefix for multiple containers
When a single container is being used to store images, this configuration option indicates the container within the Glance account to be used for storing all images. When multiple containers are used to store images, this will be the name prefix for all containers. Usage of single/multiple containers can be controlled using the configuration option
When using multiple containers, the containers will be named after the value set for this configuration option with the first N chars of the image UUID as the suffix delimited by an underscore (where N is specified by
Example: if the seed is set to 3 and swift_store_container = Possible values:
Related options:
|
| boolean value | Create container, if it doesn’t already exist, when uploading image. At the time of uploading an image, if the corresponding container doesn’t exist, it will be created provided this configuration option is set to True. By default, it won’t be created. This behavior is applicable for both single and multiple containers mode. Possible values:
Related options:
|
| string value | The URL endpoint to use for Swift backend storage.
Provide a string value representing the URL endpoint to use for storing Glance images in Swift store. By default, an endpoint is not set and the storage URL returned by Note The URL should include the path up to, but excluding the container. The location of an object is obtained by appending the container and object to the configured URL. Possible values:
Related Options:
|
| string value | Endpoint Type of Swift service. This string value indicates the endpoint type to use to fetch the Swift endpoint. The endpoint type determines the actions the user will be allowed to perform, for instance, reading and writing to the Store. This setting is only used if swift_store_auth_version is greater than 1. Possible values:
Related options:
|
| integer value | Time in seconds defining the size of the window in which a new token may be requested before the current token is due to expire. Typically, the Swift storage driver fetches a new token upon the expiration of the current token to ensure continued access to Swift. However, some Swift transactions (like uploading image segments) may not recover well if the token expires on the fly. Hence, by fetching a new token before the current token expiration, we make sure that the token does not expire or is close to expiry before a transaction is attempted. By default, the Swift storage driver requests for a new token 60 seconds or less before the current token expiration. Possible values:
Related Options:
|
| string value | (DEPRECATED FOR REMOVAL) Auth key for the user authenticating against the Swift authentication service. |
| integer value | The maximum size, in MB, of the segments when image data is segmented.
When image data is segmented to upload images that are larger than the limit enforced by the Swift cluster, image data is broken into segments that are no bigger than the size specified by this configuration option. Refer to
For example: if Possible values:
Related options:
|
| integer value | The size threshold, in MB, after which Glance will start segmenting image data. Swift has an upper limit on the size of a single uploaded object. By default, this is 5GB. To upload objects bigger than this limit, objects are segmented into multiple smaller objects that are tied together with a manifest file. For more detail, refer to https://docs.openstack.org/swift/latest/overview_large_objects.html This configuration option specifies the size threshold over which the Swift driver will start segmenting image data into multiple smaller files. Currently, the Swift driver only supports creating Dynamic Large Objects. Note This should be set by taking into account the large object limit enforced by the Swift cluster in consideration. Possible values:
Related options:
|
| boolean value | Store images in tenant’s Swift account. This enables multi-tenant storage mode which causes Glance images to be stored in tenant specific Swift accounts. If this is disabled, Glance stores all images in its own account. More details multi-tenant store can be found at https://wiki.openstack.org/wiki/GlanceSwiftTenantSpecificStorage Note If using multi-tenant swift store, please make sure that you do not set a swift configuration file with the swift_store_config_file option. Possible values:
Related options:
|
| integer value | Seed indicating the number of containers to use for storing images. When using a single-tenant store, images can be stored in one or more than one containers. When set to 0, all images will be stored in one single container. When set to an integer value between 1 and 32, multiple containers will be used to store images. This configuration option will determine how many containers are created. The total number of containers that will be used is equal to 16^N, so if this config option is set to 2, then 16^2=256 containers will be used to store images.
Please refer to Note This is used only when swift_store_multi_tenant is disabled. Possible values:
Related options:
|
| string value | The region of Swift endpoint to use by Glance. Provide a string value representing a Swift region where Glance can connect to for image storage. By default, there is no region set.
When Glance uses Swift as the storage backend to store images for a specific tenant that has multiple endpoints, setting of a Swift region with This option can be configured for both single-tenant and multi-tenant storage. Note
Setting the region with Possible values:
Related Options:
|
| integer value | The number of times a Swift download will be retried before the request fails.
Provide an integer value representing the number of times an image download must be retried before erroring out. The default value is zero (no retry on a failed image download). When set to a positive integer value, Possible values:
Related Options:
|
| string value | Type of Swift service to use.
Provide a string value representing the service type to use for storing images while using Swift backend storage. The default service type is set to Note
If Possible values:
Related Options:
|
| boolean value | SSL layer compression for HTTPS Swift requests. Provide a boolean value to determine whether or not to compress HTTPS Swift requests for images at the SSL layer. By default, compression is enabled. When using Swift as the backend store for Glance image storage, SSL layer compression of HTTPS Swift requests can be set using this option. If set to False, SSL layer compression of HTTPS Swift requests is disabled. Disabling this option may improve performance for images which are already in a compressed format, for example, qcow2. Possible values:
Related Options:
|
| boolean value | Use trusts for multi-tenant Swift store. This option instructs the Swift store to create a trust for each add/get request when the multi-tenant store is in use. Using trusts allows the Swift store to avoid problems that can be caused by an authentication token expiring during the upload or download of data.
By default, Note
This option is considered only when Possible values:
Related options:
|
| string value | (DEPRECATED FOR REMOVAL) The user to authenticate against the Swift authentication service. |
| string value | Directory to buffer image segments before upload to Swift. Provide a string value representing the absolute path to the directory on the glance node where image segments will be buffered briefly before they are uploaded to swift.
NOTES: * This is required only when the configuration option Possible values:
Related options:
|
| integer value | The number of VMware API retries. This configuration option specifies the number of times the VMware ESX/VC server API must be retried upon connection related issues or server API call overload. It is not possible to specify retry forever. Possible Values:
Related options:
|
| string value | Absolute path to the CA bundle file. This configuration option enables the operator to use a custom Cerificate Authority File to verify the ESX/vCenter certificate. If this option is set, the "vmware_insecure" option will be ignored and the CA file specified will be used to authenticate the ESX/vCenter server certificate and establish a secure connection to the server. Possible Values:
Related options:
|
| multi valued | The datastores where the image can be stored. This configuration option specifies the datastores where the image can be stored in the VMWare store backend. This option may be specified multiple times for specifying multiple datastores. The datastore name should be specified after its datacenter path, separated by ":". An optional weight may be given after the datastore name, separated again by ":" to specify the priority. Thus, the required format becomes <datacenter_path>:<datastore_name>:<optional_weight>. When adding an image, the datastore with highest weight will be selected, unless there is not enough free space available in cases where the image size is already known. If no weight is given, it is assumed to be zero and the directory will be considered for selection last. If multiple datastores have the same weight, then the one with the most free space available is selected. Possible Values:
Related options: * None |
| boolean value | Set verification of the ESX/vCenter server certificate. This configuration option takes a boolean value to determine whether or not to verify the ESX/vCenter server certificate. If this option is set to True, the ESX/vCenter server certificate is not verified. If this option is set to False, then the default CA truststore is used for verification. This option is ignored if the "vmware_ca_file" option is set. In that case, the ESX/vCenter server certificate will then be verified using the file specified using the "vmware_ca_file" option . Possible Values:
Related options:
|
| host address value | Address of the ESX/ESXi or vCenter Server target system. This configuration option sets the address of the ESX/ESXi or vCenter Server target system. This option is required when using the VMware storage backend. The address can contain an IP address (127.0.0.1) or a DNS name (www.my-domain.com). Possible Values:
Related options:
|
| string value | Server password. This configuration option takes the password for authenticating with the VMware ESX/ESXi or vCenter Server. This option is required when using the VMware storage backend. Possible Values:
Related options:
|
| string value | Server username. This configuration option takes the username for authenticating with the VMware ESX/ESXi or vCenter Server. This option is required when using the VMware storage backend. Possible Values:
Related options:
|
| string value | The directory where the glance images will be stored in the datastore. This configuration option specifies the path to the directory where the glance images will be stored in the VMware datastore. If this option is not set, the default directory where the glance images are stored is openstack_glance. Possible Values:
Related options:
|
| integer value | Interval in seconds used for polling remote tasks invoked on VMware ESX/VC server. This configuration option takes in the sleep time in seconds for polling an on-going async task as part of the VMWare ESX/VC server API call. Possible Values:
Related options:
|
3.3.3. oslo_policy
The following table outlines the options available under the [oslo_policy]
group in the /etc/glance/glance-cache.conf
file.
Table 3.30. oslo_policy
Configuration option = Default value | Type | Description |
---|---|---|
| boolean value |
This option controls whether or not to enforce scope when evaluating policies. If |
| string value | Default rule. Enforced when a requested rule is not found. |
| multi valued | 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. |
| string value | The relative or absolute path of a file that maps roles to permissions for a given service. Relative paths must be specified in relation to the configuration file setting this option. |
| string value | Content Type to send and receive data for REST based policy check |
| string value | Absolute path to ca cert file for REST based policy check |
| string value | Absolute path to client cert for REST based policy check |
| string value | Absolute path client key file REST based policy check |
| boolean value | server identity verification for REST based policy check |
Chapter 4. heat
The following chapter contains information about the configuration options in the heat
service.
4.1. heat.conf
This section contains options for the /etc/heat/heat.conf
file.
4.1.1. DEFAULT
The following table outlines the options available under the [DEFAULT]
group in the /etc/heat/heat.conf
file.
.
Configuration option = Default value | Type | Description |
---|---|---|
| integer value | Number of times to retry to bring a resource to a non-error state. Set to 0 to disable retries. |
| boolean value | Create trusts with redelegation enabled. This option is only used when reauthentication_auth_method is set to "trusts". Note that enabling this option does have security implications as all trusts created by Heat will use both impersonation and redelegation enabled. Enable it only when there are other services that need to create trusts from tokens Heat uses to access them, examples are Aodh and Heat in another region when configured to use trusts too. |
| string value | Key used to encrypt authentication info in the database. Length of this key must be 32 characters. |
| string value | Enable eventlet backdoor. Acceptable values are 0, <port>, and <start>:<end>, where 0 results in listening on a random tcp port number; <port> results in listening on the specified port number (and not enabling backdoor if that port is in use); and <start>:<end> results in listening on the smallest unused port number within the specified range of port numbers. The chosen port is displayed in the service’s log file. |
| string value | Enable eventlet backdoor, using the provided path as a unix socket that can receive connections. This option is mutually exclusive with backdoor_port in that only one should be provided. If both are provided then the existence of this option overrides the usage of that option. Inside the path {pid} will be replaced with the PID of the current process. |
| integer value | Number of times to retry when a client encounters an expected intermittent error. Set to 0 to disable retries. |
| string value | Fully qualified class name to use as a client backend. |
| integer value | The pool size limit for connections expiration policy |
| integer value | The time-to-live in sec of idle connections in the pool |
| string value | The default exchange under which topics are scoped. May be overridden by an exchange name specified in the transport_url option. |
| boolean value | Enables engine with convergence architecture. All stacks with this option will be created using convergence engine. |
| boolean value | If set to true, the logging level will be set to DEBUG instead of the default INFO level. |
| string value | 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. |
| list value | List of package logging levels in logger=LEVEL pairs. This option is ignored if log_config_append is set. |
| string value | Default notification level for outgoing notifications. |
| string value | Default publisher_id for outgoing notifications. |
| string value | 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).ZAQAR_MESSAGE will create a dedicated zaqar queue and post the metadata for polling. |
| string value | Template default for how the user_data should be formatted for the server. For HEAT_CFNTOOLS, the user_data is bundled as part of the heat-cfntools cloud-init boot configuration data. For RAW the user_data is passed to Nova unmodified. For SOFTWARE_CONFIG user_data is bundled as part of the software config data, and metadata is derived from any associated SoftwareDeployment resources. |
| string value | (DEPRECATED FOR REMOVAL) Select deferred auth method, stored password or trusts. |
| boolean value | (DEPRECATED FOR REMOVAL) Enable the legacy OS::Heat::CWLiteAlarm resource. |
| boolean value | Enable the preview Stack Abandon feature. |
| boolean value | Enable the preview Stack Adopt feature. |
| boolean value | Encrypt template parameters that were marked as hidden and also all the resource properties before storing them in database. |
| integer value | RPC timeout for the engine liveness check that is used for stack locking. |
| string value | The directory to search for environment files. |
| integer value | The amount of time in seconds after an error has occurred that tasks may continue to run before being cancelled. |
| integer value | Controls how many events will be pruned whenever a stack’s events are purged. Set this lower to keep more events at the expense of more frequent purges. |
| integer value | Size of executor thread pool when executor is threading or eventlet. |
| boolean value | Enables or disables fatal status of deprecations. |
| integer value | Specify a timeout after which a gracefully shutdown server will exit. Zero value means endless wait. |
| string value | URL of the Heat metadata server. NOTE: Setting this is only needed if you require instances to use a different endpoint than in the keystone catalog |
| string value | Keystone role for heat template-defined users. |
| string value | URL of the Heat waitcondition server. |
`heat_watch_server_url = ` | string value | (DEPRECATED FOR REMOVAL) URL of the Heat CloudWatch server. |
| list value | Stacks containing these tag names will be hidden. Multiple tags should be given in a comma-delimited list (eg. hidden_stack_tags=hide_me,me_too). |
| string value | Name of the engine node. This can be an opaque identifier. It is not necessarily a hostname, FQDN, or IP address. |
| string value | Instance connection to CFN/CW API validate certs if SSL is used. |
| string value | Instance connection to CFN/CW API via https. |
`instance_format = [instance: %(uuid)s] ` | string value | The format for an instance that is passed with the log message. |
`instance_uuid_format = [instance: %(uuid)s] ` | string value | The format for an instance UUID that is passed with the log message. |
| string value | Fully qualified class name to use as a keystone backend. |
| string value | Custom template for the built-in loadbalancer nested stack. |
| string value | 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. Note that when logging configuration files are used then all logging configuration is set in the configuration file and other logging configuration options are ignored (for example, log-date-format). |
| string value | Defines the format string for %%(asctime)s in log records. Default: %(default)s . This option is ignored if log_config_append is set. |
| string value | (Optional) The base directory used for relative log_file paths. This option is ignored if log_config_append is set. |
| string value | (Optional) Name of log file to send logging output to. If no default is set, logging will go to stderr as defined by use_stderr. This option is ignored if log_config_append is set. |
| boolean value | Enables or disables logging values of all registered options when starting a service (at DEBUG level). |
| integer value | The amount of time before the log files are rotated. This option is ignored unless log_rotation_type is setto "interval". |
| string value | Rotation interval type. The time of the last file change (or the time when the service was started) is used when scheduling the next rotation. |
| string value | Log rotation type. |
| string value | Format string to use for log messages with context. Used by oslo_log.formatters.ContextFormatter |
| string value | Additional data to append to log message when logging level for the message is DEBUG. Used by oslo_log.formatters.ContextFormatter |
| string value | Format string to use for log messages when context is undefined. Used by oslo_log.formatters.ContextFormatter |
| string value | Prefix each line of exception output with this format. Used by oslo_log.formatters.ContextFormatter |
| string value | Defines the format string for %(user_identity)s that is used in logging_context_format_string. Used by oslo_log.formatters.ContextFormatter |
| integer value | Rough number of maximum events that will be available per stack. Actual number of events can be a bit higher since purge checks take place randomly 200/event_purge_batch_size percent of the time. Older events are deleted when events are purged. Set to 0 for unlimited events per stack. |
| integer value | Number of times to check whether an interface has been attached or detached. |
| integer value | Maximum raw byte size of JSON request body. Should be larger than max_template_size. |
| integer value | Maximum number of rotated log files. |
| integer value | Log file maximum size in MB. This option is ignored if "log_rotation_type" is not set to "size". |
| integer value | Maximum depth allowed when using nested stacks. |
| floating point value | Maximum nova API version for client plugin. With this limitation, any nova feature supported with microversion number above max_nova_api_microversion will not be available. |
| integer value | Maximum resources allowed per top-level stack. -1 stands for unlimited. |
| integer value | Maximum length of a server name to be used in nova. |
| integer value | Maximum number of stacks any one tenant may have active at one time. |
| integer value | Maximum raw byte size of any template. |
| integer value | 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. |
| boolean value | On update, enables heat to collect existing resource properties from reality and converge to updated template. |
| string value | Deprecated. |
| integer value | Seconds between running periodic tasks. |
| list value | List of directories to search for plug-ins. |
| boolean value | Enables or disables publication of error events. |
| integer value | Maximum number of logged messages per rate_limit_interval. |
| string value | Log level name used by rate limiting: CRITICAL, ERROR, INFO, WARNING, DEBUG or empty string. Logs with level greater or equal to rate_limit_except_level are not filtered. An empty string means that all levels are filtered. |
| integer value | Interval, number of seconds, of log rate limiting. |
`reauthentication_auth_method = ` | string value | Allow reauthentication on token expiry, such that long-running tasks may complete. Note this defeats the expiry of any provided user tokens. |
| string value | Default region name used to get services endpoints. |
| integer value | Size of RPC connection pool. |
| integer value | Seconds to wait for a response from a call. |
| boolean value | Some periodic tasks can be run in a separate process. Should we run them here? |
`server_keystone_endpoint_type = ` | string value | If set, is used to control which authentication endpoint is used by user-controlled servers to make calls back to Heat. If unset www_authenticate_uri is used. |
| integer value | Timeout in seconds for stack action (ie. create or update). |
| string value | Keystone username, a user with roles sufficient to manage users and projects in the stack_user_domain. |
| string value | Keystone password for stack_domain_admin user. |
| boolean value | 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. |
| string value | Keystone domain ID which contains heat template-defined users. If this option is set, stack_user_domain_name option will be ignored. |
| string value |
Keystone domain name which contains heat template-defined users. If |
| string value | Syslog facility to receive log lines. This option is ignored if log_config_append is set. |
| string value | The directory to search for template files. |
| string value | The network address and optional user credentials for connecting to the messaging backend, in URL format. The expected format is: driver://[user:pass@]host:port[,[userN:passN@]hostN:portN]/virtual_host?query Example: rabbit://rabbitmq:password@127.0.0.1:5672// For full details on the fields in the URL see the documentation of oslo_messaging.TransportURL at https://docs.openstack.org/oslo.messaging/latest/reference/transport.html |
| list value | Subset of trustor roles to be delegated to heat. If left unset, all roles of a user will be delegated to heat when creating a stack. |
| boolean value | Enable journald for logging. If running in a systemd environment you may wish to enable journal support. Doing so will use the journal native protocol which includes structured metadata in addition to log messages.This option is ignored if log_config_append is set. |
| boolean value | Use JSON formatting for logging. This option is ignored if log_config_append is set. |
| boolean value | Use syslog for logging. Existing syslog format is DEPRECATED and will be changed later to honor RFC5424. This option is ignored if log_config_append is set. |
| boolean value | Log output to Windows Event Log. |
| boolean value | Log output to standard error. This option is ignored if log_config_append is set. |
| boolean value | Uses logging handler designed to watch file system. When log file is moved or removed this handler will open a new log file with specified path instantaneously. It makes sense only if log_file option is specified and Linux platform is used. This option is ignored if log_config_append is set. |
4.1.2. auth_password
The following table outlines the options available under the [auth_password]
group in the /etc/heat/heat.conf
file.
Table 4.1. auth_password
Configuration option = Default value | Type | Description |
---|---|---|
| list value | Allowed keystone endpoints for auth_uri when multi_cloud is enabled. At least one endpoint needs to be specified. |
| boolean value | Allow orchestration of multiple clouds. |
4.1.3. clients
The following table outlines the options available under the [clients]
group in the /etc/heat/heat.conf
file.
Table 4.2. clients
Configuration option = Default value | Type | Description |
---|---|---|
| string value | Optional CA cert file to use in SSL connections. |
| string value | Optional PEM-formatted certificate chain file. |
| string value | Type of endpoint in Identity service catalog to use for communication with the OpenStack service. |
| boolean value | If set, then the server’s certificate will not be verified. |
| string value | Optional PEM-formatted file that contains the private key. |
4.1.4. clients_aodh
The following table outlines the options available under the [clients_aodh]
group in the /etc/heat/heat.conf
file.
Table 4.3. clients_aodh
Configuration option = Default value | Type | Description |
---|---|---|
| string value | Optional CA cert file to use in SSL connections. |
| string value | Optional PEM-formatted certificate chain file. |
| string value | Type of endpoint in Identity service catalog to use for communication with the OpenStack service. |
| boolean value | If set, then the server’s certificate will not be verified. |
| string value | Optional PEM-formatted file that contains the private key. |
4.1.5. clients_barbican
The following table outlines the options available under the [clients_barbican]
group in the /etc/heat/heat.conf
file.
Table 4.4. clients_barbican
Configuration option = Default value | Type | Description |
---|---|---|
| string value | Optional CA cert file to use in SSL connections. |
| string value | Optional PEM-formatted certificate chain file. |
| string value | Type of endpoint in Identity service catalog to use for communication with the OpenStack service. |
| boolean value | If set, then the server’s certificate will not be verified. |
| string value | Optional PEM-formatted file that contains the private key. |
4.1.6. clients_cinder
The following table outlines the options available under the [clients_cinder]
group in the /etc/heat/heat.conf
file.
Table 4.5. clients_cinder
Configuration option = Default value | Type | Description |
---|---|---|
| string value | Optional CA cert file to use in SSL connections. |
| string value | Optional PEM-formatted certificate chain file. |
| string value | Type of endpoint in Identity service catalog to use for communication with the OpenStack service. |
| boolean value | Allow client’s debug log output. |
| boolean value | If set, then the server’s certificate will not be verified. |
| string value | Optional PEM-formatted file that contains the private key. |
4.1.7. clients_designate
The following table outlines the options available under the [clients_designate]
group in the /etc/heat/heat.conf
file.
Table 4.6. clients_designate
Configuration option = Default value | Type | Description |
---|---|---|
| string value | Optional CA cert file to use in SSL connections. |
| string value | Optional PEM-formatted certificate chain file. |
| string value | Type of endpoint in Identity service catalog to use for communication with the OpenStack service. |
| boolean value | If set, then the server’s certificate will not be verified. |
| string value | Optional PEM-formatted file that contains the private key. |
4.1.8. clients_glance
The following table outlines the options available under the [clients_glance]
group in the /etc/heat/heat.conf
file.
Table 4.7. clients_glance
Configuration option = Default value | Type | Description |
---|---|---|
| string value | Optional CA cert file to use in SSL connections. |
| string value | Optional PEM-formatted certificate chain file. |
| string value | Type of endpoint in Identity service catalog to use for communication with the OpenStack service. |
| boolean value | If set, then the server’s certificate will not be verified. |
| string value | Optional PEM-formatted file that contains the private key. |
4.1.9. clients_heat
The following table outlines the options available under the [clients_heat]
group in the /etc/heat/heat.conf
file.
Table 4.8. clients_heat
Configuration option = Default value | Type | Description |
---|---|---|
| string value | Optional CA cert file to use in SSL connections. |
| string value | Optional PEM-formatted certificate chain file. |
| string value | Type of endpoint in Identity service catalog to use for communication with the OpenStack service. |
| boolean value | If set, then the server’s certificate will not be verified. |
| string value | Optional PEM-formatted file that contains the private key. |
`url = ` | string value | Optional heat url in format like http://0.0.0.0:8004/v1/%(tenant_id)s. |
4.1.10. clients_keystone
The following table outlines the options available under the [clients_keystone]
group in the /etc/heat/heat.conf
file.
Table 4.9. clients_keystone
Configuration option = Default value | Type | Description |
---|---|---|
`auth_uri = ` | string value | Unversioned keystone url in format like http://0.0.0.0:5000. |
| string value | Optional CA cert file to use in SSL connections. |
| string value | Optional PEM-formatted certificate chain file. |
| string value | Type of endpoint in Identity service catalog to use for communication with the OpenStack service. |
| boolean value | If set, then the server’s certificate will not be verified. |
| string value | Optional PEM-formatted file that contains the private key. |
4.1.11. clients_magnum
The following table outlines the options available under the [clients_magnum]
group in the /etc/heat/heat.conf
file.
Table 4.10. clients_magnum
Configuration option = Default value | Type | Description |
---|---|---|
| string value | Optional CA cert file to use in SSL connections. |
| string value | Optional PEM-formatted certificate chain file. |
| string value | Type of endpoint in Identity service catalog to use for communication with the OpenStack service. |
| boolean value | If set, then the server’s certificate will not be verified. |
| string value | Optional PEM-formatted file that contains the private key. |
4.1.12. clients_manila
The following table outlines the options available under the [clients_manila]
group in the /etc/heat/heat.conf
file.
Table 4.11. clients_manila
Configuration option = Default value | Type | Description |
---|---|---|
| string value | Optional CA cert file to use in SSL connections. |
| string value | Optional PEM-formatted certificate chain file. |
| string value | Type of endpoint in Identity service catalog to use for communication with the OpenStack service. |
| boolean value | If set, then the server’s certificate will not be verified. |
| string value | Optional PEM-formatted file that contains the private key. |
4.1.13. clients_mistral
The following table outlines the options available under the [clients_mistral]
group in the /etc/heat/heat.conf
file.
Table 4.12. clients_mistral
Configuration option = Default value | Type | Description |
---|---|---|
| string value | Optional CA cert file to use in SSL connections. |
| string value | Optional PEM-formatted certificate chain file. |
| string value | Type of endpoint in Identity service catalog to use for communication with the OpenStack service. |
| boolean value | If set, then the server’s certificate will not be verified. |
| string value | Optional PEM-formatted file that contains the private key. |
4.1.14. clients_monasca
The following table outlines the options available under the [clients_monasca]
group in the /etc/heat/heat.conf
file.
Table 4.13. clients_monasca
Configuration option = Default value | Type | Description |
---|---|---|
| string value | Optional CA cert file to use in SSL connections. |
| string value | Optional PEM-formatted certificate chain file. |
| string value | Type of endpoint in Identity service catalog to use for communication with the OpenStack service. |
| boolean value | If set, then the server’s certificate will not be verified. |
| string value | Optional PEM-formatted file that contains the private key. |
4.1.15. clients_neutron
The following table outlines the options available under the [clients_neutron]
group in the /etc/heat/heat.conf
file.
Table 4.14. clients_neutron
Configuration option = Default value | Type | Description |
---|---|---|
| string value | Optional CA cert file to use in SSL connections. |
| string value | Optional PEM-formatted certificate chain file. |
| string value | Type of endpoint in Identity service catalog to use for communication with the OpenStack service. |
| boolean value | If set, then the server’s certificate will not be verified. |
| string value | Optional PEM-formatted file that contains the private key. |
4.1.16. clients_nova
The following table outlines the options available under the [clients_nova]
group in the /etc/heat/heat.conf
file.
Table 4.15. clients_nova
Configuration option = Default value | Type | Description |
---|---|---|
| string value | Optional CA cert file to use in SSL connections. |
| string value | Optional PEM-formatted certificate chain file. |
| string value | Type of endpoint in Identity service catalog to use for communication with the OpenStack service. |
| boolean value | Allow client’s debug log output. |
| boolean value | If set, then the server’s certificate will not be verified. |
| string value | Optional PEM-formatted file that contains the private key. |
4.1.17. clients_octavia
The following table outlines the options available under the [clients_octavia]
group in the /etc/heat/heat.conf
file.
Table 4.16. clients_octavia
Configuration option = Default value | Type | Description |
---|---|---|
| string value | Optional CA cert file to use in SSL connections. |
| string value | Optional PEM-formatted certificate chain file. |
| string value | Type of endpoint in Identity service catalog to use for communication with the OpenStack service. |
| boolean value | If set, then the server’s certificate will not be verified. |
| string value | Optional PEM-formatted file that contains the private key. |
4.1.18. clients_sahara
The following table outlines the options available under the [clients_sahara]
group in the /etc/heat/heat.conf
file.
Table 4.17. clients_sahara
Configuration option = Default value | Type | Description |
---|---|---|
| string value | Optional CA cert file to use in SSL connections. |
| string value | Optional PEM-formatted certificate chain file. |
| string value | Type of endpoint in Identity service catalog to use for communication with the OpenStack service. |
| boolean value | If set, then the server’s certificate will not be verified. |
| string value | Optional PEM-formatted file that contains the private key. |
4.1.19. clients_senlin
The following table outlines the options available under the [clients_senlin]
group in the /etc/heat/heat.conf
file.
Table 4.18. clients_senlin
Configuration option = Default value | Type | Description |
---|---|---|
| string value | Optional CA cert file to use in SSL connections. |
| string value | Optional PEM-formatted certificate chain file. |
| string value | Type of endpoint in Identity service catalog to use for communication with the OpenStack service. |
| boolean value | If set, then the server’s certificate will not be verified. |
| string value | Optional PEM-formatted file that contains the private key. |
4.1.20. clients_swift
The following table outlines the options available under the [clients_swift]
group in the /etc/heat/heat.conf
file.
Table 4.19. clients_swift
Configuration option = Default value | Type | Description |
---|---|---|
| string value | Optional CA cert file to use in SSL connections. |
| string value | Optional PEM-formatted certificate chain file. |
| string value | Type of endpoint in Identity service catalog to use for communication with the OpenStack service. |
| boolean value | If set, then the server’s certificate will not be verified. |
| string value | Optional PEM-formatted file that contains the private key. |
4.1.21. clients_trove
The following table outlines the options available under the [clients_trove]
group in the /etc/heat/heat.conf
file.
Table 4.20. clients_trove
Configuration option = Default value | Type | Description |
---|---|---|
| string value | Optional CA cert file to use in SSL connections. |
| string value | Optional PEM-formatted certificate chain file. |
| string value | Type of endpoint in Identity service catalog to use for communication with the OpenStack service. |
| boolean value | If set, then the server’s certificate will not be verified. |
| string value | Optional PEM-formatted file that contains the private key. |
4.1.22. clients_zaqar
The following table outlines the options available under the [clients_zaqar]
group in the /etc/heat/heat.conf
file.
Table 4.21. clients_zaqar
Configuration option = Default value | Type | Description |
---|---|---|
| string value | Optional CA cert file to use in SSL connections. |
| string value | Optional PEM-formatted certificate chain file. |
| string value | Type of endpoint in Identity service catalog to use for communication with the OpenStack service. |
| boolean value | If set, then the server’s certificate will not be verified. |
| string value | Optional PEM-formatted file that contains the private key. |
4.1.23. cors
The following table outlines the options available under the [cors]
group in the /etc/heat/heat.conf
file.
Table 4.22. cors
Configuration option = Default value | Type | Description |
---|---|---|
| boolean value | Indicate that the actual request can include user credentials |
| list value | Indicate which header field names may be used during the actual request. |
| list value | Indicate which methods can be used during the actual request. |
| list value | Indicate whether this resource may be shared with the domain received in the requests "origin" header. Format: "<protocol>://<host>[:<port>]", no trailing slash. Example: https://horizon.example.com |
| list value | Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers. |
| integer value | Maximum cache age of CORS preflight requests. |
4.1.24. database
The following table outlines the options available under the [database]
group in the /etc/heat/heat.conf
file.
Table 4.23. database
Configuration option = Default value | Type | Description |
---|---|---|
| string value | The back end to use for the database. |
| string value | The SQLAlchemy connection string to use to connect to the database. |
| integer value | Verbosity of SQL debugging information: 0=None, 100=Everything. |
`connection_parameters = ` | string value | Optional URL parameters to append onto the connection URL at connect time; specify as param1=value1¶m2=value2&… |
| integer value | Connections which have been present in the connection pool longer than this number of seconds will be replaced with a new one the next time they are checked out from the pool. |
| boolean value | Add Python stack traces to SQL as comment strings. |
| boolean value | If True, increases the interval between retries of a database operation up to db_max_retry_interval. |
| integer value | Maximum retries in case of connection error or deadlock error before error is raised. Set to -1 to specify an infinite retry count. |
| integer value | If db_inc_retry_interval is set, the maximum seconds between retries of a database operation. |
| integer value | Seconds between retries of a database transaction. |
| integer value | If set, use this value for max_overflow with SQLAlchemy. |
| integer value | Maximum number of SQL connections to keep open in a pool. Setting a value of 0 indicates no limit. |
| integer value | Maximum number of database connection retries during startup. Set to -1 to specify an infinite retry count. |
| boolean value | If True, transparently enables support for handling MySQL Cluster (NDB). |
| string value | The SQL mode to be used for MySQL sessions. This option, including the default, overrides any server-set SQL mode. To use whatever SQL mode is set by the server configuration, set this to no value. Example: mysql_sql_mode= |
| integer value | If set, use this value for pool_timeout with SQLAlchemy. |
| integer value | Interval between retries of opening a SQL connection. |
| string value | The SQLAlchemy connection string to use to connect to the slave database. |
| boolean value | If True, SQLite uses synchronous mode. |
| boolean value | Enable the experimental use of database reconnect on connection lost. |
4.1.25. ec2authtoken
The following table outlines the options available under the [ec2authtoken]
group in the /etc/heat/heat.conf
file.
Table 4.24. ec2authtoken
Configuration option = Default value | Type | Description |
---|---|---|
| list value | Allowed keystone endpoints for auth_uri when multi_cloud is enabled. At least one endpoint needs to be specified. |
| string value | Authentication Endpoint URI. |
| string value | Optional CA cert file to use in SSL connections. |
| string value | Optional PEM-formatted certificate chain file. |
| boolean value | If set, then the server’s certificate will not be verified. |
| string value | Optional PEM-formatted file that contains the private key. |
| boolean value | Allow orchestration of multiple clouds. |
4.1.26. eventlet_opts
The following table outlines the options available under the [eventlet_opts]
group in the /etc/heat/heat.conf
file.
Table 4.25. eventlet_opts
Configuration option = Default value | Type | Description |
---|---|---|
| integer value | Timeout for client connections' socket operations. If an incoming connection is idle for this number of seconds it will be closed. A value of 0 means wait forever. |
| boolean value | If False, closes the client socket connection explicitly. |
4.1.27. healthcheck
The following table outlines the options available under the [healthcheck]
group in the /etc/heat/heat.conf
file.
Table 4.26. healthcheck
Configuration option = Default value | Type | Description |
---|---|---|
| list value | Additional backends that can perform health checks and report that information back as part of a request. |
| boolean value | Show more detailed information as part of the response. Security note: Enabling this option may expose sensitive details about the service being monitored. Be sure to verify that it will not violate your security policies. |
| string value | Check the presence of a file to determine if an application is running on a port. Used by DisableByFileHealthcheck plugin. |
| list value | Check the presence of a file based on a port to determine if an application is running on a port. Expects a "port:path" list of strings. Used by DisableByFilesPortsHealthcheck plugin. |
| string value | (DEPRECATED FOR REMOVAL) The path to respond to healtcheck requests on. |
4.1.28. heat_api
The following table outlines the options available under the [heat_api]
group in the /etc/heat/heat.conf
file.
Table 4.27. heat_api
Configuration option = Default value | Type | Description |
---|---|---|
| integer value | Number of backlog requests to configure the socket with. |
| IP address value | Address to bind the server. Useful when selecting a particular network interface. |
| port value | The port on which the server will listen. |
| string value | Location of the SSL certificate file to use for SSL mode. |
| string value | Location of the SSL key file to use for enabling SSL mode. |
| integer value | 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). |
| integer value | The value for the socket option TCP_KEEPIDLE. This is the time in seconds that the connection must be idle before TCP starts sending keepalive probes. |
| integer value | Number of workers for Heat service. Default value 0 means, that service will start number of workers equal number of cores on server. |
4.1.29. heat_api_cfn
The following table outlines the options available under the [heat_api_cfn]
group in the /etc/heat/heat.conf
file.
Table 4.28. heat_api_cfn
Configuration option = Default value | Type | Description |
---|---|---|
| integer value | Number of backlog requests to configure the socket with. |
| IP address value | Address to bind the server. Useful when selecting a particular network interface. |
| port value | The port on which the server will listen. |
| string value | Location of the SSL certificate file to use for SSL mode. |
| string value | Location of the SSL key file to use for enabling SSL mode. |
| integer value | 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). |
| integer value | The value for the socket option TCP_KEEPIDLE. This is the time in seconds that the connection must be idle before TCP starts sending keepalive probes. |
| integer value | Number of workers for Heat service. |
4.1.30. heat_api_cloudwatch
The following table outlines the options available under the [heat_api_cloudwatch]
group in the /etc/heat/heat.conf
file.
Table 4.29. heat_api_cloudwatch
Configuration option = Default value | Type | Description |
---|---|---|
| integer value | (DEPRECATED FOR REMOVAL) Number of backlog requests to configure the socket with. |
| IP address value | (DEPRECATED FOR REMOVAL) Address to bind the server. Useful when selecting a particular network interface. |
| port value | (DEPRECATED FOR REMOVAL) The port on which the server will listen. |
| string value | (DEPRECATED FOR REMOVAL) Location of the SSL certificate file to use for SSL mode. |
| string value | (DEPRECATED FOR REMOVAL) Location of the SSL key file to use for enabling SSL mode. |
| integer value | (DEPRECATED FOR REMOVAL) 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.) |
| integer value | (DEPRECATED FOR REMOVAL) The value for the socket option TCP_KEEPIDLE. This is the time in seconds that the connection must be idle before TCP starts sending keepalive probes. |
| integer value | (DEPRECATED FOR REMOVAL) Number of workers for Heat service. |
4.1.31. keystone_authtoken
The following table outlines the options available under the [keystone_authtoken]
group in the /etc/heat/heat.conf
file.
Table 4.30. keystone_authtoken
Configuration option = Default value | Type | Description |
---|---|---|
| string value | Config Section from which to load plugin specific options |
| string value | Authentication type to load |
| string value | (DEPRECATED FOR REMOVAL) Complete "public" Identity API endpoint. This endpoint should not be an "admin" endpoint, as it should be accessible by all end users. Unauthenticated clients are redirected to this endpoint to authenticate. Although this endpoint should ideally be unversioned, client support in the wild varies. If you’re using a versioned v2 endpoint here, then this should not be the same endpoint the service user utilizes for validating tokens, because normal end users may not be able to reach that endpoint. This option is deprecated in favor of www_authenticate_uri and will be removed in the S release. |
| string value | API version of the Identity API endpoint. |
| string value |
Request environment key where the Swift cache object is stored. When auth_token middleware is deployed with a Swift cache, use this option to have the middleware share a caching backend with swift. Otherwise, use the |
| string value | A PEM encoded Certificate Authority to use when verifying HTTPs connections. Defaults to system CAs. |
| string value | Required if identity server requires client certificate |
| boolean value | Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components. |
| string value | Used to control the use and type of token binding. Can be set to: "disabled" to not check token binding. "permissive" (default) to validate binding information if the bind type is of a form known to the server and ignore it if not. "strict" like "permissive" but if the bind type is unknown the token will be rejected. "required" any form of token binding is needed to be allowed. Finally the name of a binding method that must be present in tokens. |
| integer value | Request timeout value for communicating with Identity API server. |
| integer value | How many times are we trying to reconnect when communicating with Identity API Server. |
| boolean value | (Optional) Indicate whether to set the X-Service-Catalog header. If False, middleware will not ask for service catalog on token validation and will not set the X-Service-Catalog header. |
| boolean value | Verify HTTPS connections. |
| string value | Interface to use for the Identity API endpoint. Valid values are "public", "internal" or "admin"(default). |
| string value | Required if identity server requires client certificate |
| integer value | (Optional) Number of seconds that an operation will wait to get a memcached client connection from the pool. |
| integer value | (Optional) Number of seconds memcached server is considered dead before it is tried again. |
| integer value | (Optional) Maximum total number of open connections to every memcached server. |
| integer value | (Optional) Socket timeout in seconds for communicating with a memcached server. |
| integer value | (Optional) Number of seconds a connection to memcached is held unused in the pool before it is closed. |
| string value | (Optional, mandatory if memcache_security_strategy is defined) This string is used for key derivation. |
| string value | (Optional) If defined, indicate whether token data should be authenticated or authenticated and encrypted. If MAC, token data is authenticated (with HMAC) in the cache. If ENCRYPT, token data is encrypted and authenticated in the cache. If the value is not one of these options or empty, auth_token will raise an exception on initialization. |
| boolean value | (Optional) Use the advanced (eventlet safe) memcached client pool. The advanced pool will only work under python 2.x. |
| list value | Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process. |
| string value | The region in which the identity server can be found. |
| list value | A choice of roles that must be present in a service token. Service tokens are allowed to request that an expired token can be used and so this check should tightly control that only actual services should be sending this token. Roles here are applied as an ANY check so any role in this list must be present. For backwards compatibility reasons this currently only affects the allow_expired check. |
| boolean value | For backwards compatibility reasons we must let valid service tokens pass that don’t pass the service_token_roles check as valid. Setting this true will become the default in a future release and should be enabled if possible. |
| string value | The name or type of the service as it appears in the service catalog. This is used to validate tokens that have restricted access rules. |
| integer value | In order to prevent excessive effort spent validating tokens, the middleware caches previously-seen tokens for a configurable duration (in seconds). Set to -1 to disable caching completely. |
| string value | Complete "public" Identity API endpoint. This endpoint should not be an "admin" endpoint, as it should be accessible by all end users. Unauthenticated clients are redirected to this endpoint to authenticate. Although this endpoint should ideally be unversioned, client support in the wild varies. If you’re using a versioned v2 endpoint here, then this should not be the same endpoint the service user utilizes for validating tokens, because normal end users may not be able to reach that endpoint. |
4.1.32. noauth
The following table outlines the options available under the [noauth]
group in the /etc/heat/heat.conf
file.
Table 4.31. noauth
Configuration option = Default value | Type | Description |
---|---|---|
`token_response = ` | string value | JSON file containing the content returned by the noauth middleware. |
4.1.33. oslo_messaging_amqp
The following table outlines the options available under the [oslo_messaging_amqp]
group in the /etc/heat/heat.conf
file.
Table 4.32. oslo_messaging_amqp
Configuration option = Default value | Type | Description |
---|---|---|
| string value | 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 |
| string value | 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. |
| string value | address prefix used when broadcasting to all servers |
| integer value | Increase the connection_retry_interval by this many seconds after each unsuccessful failover attempt. |
| integer value | Seconds to pause before attempting to re-connect. |
| integer value | Maximum limit for connection_retry_interval + connection_retry_backoff |
| string value | Name for the AMQP container. must be globally unique. Defaults to a generated UUID |
| string value | 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 |
| integer value | The deadline for a sent notification message delivery. Only used when caller does not provide a timeout expiry. |
| integer value | The maximum number of attempts to re-send a reply message which failed due to a recoverable error. |
| integer value | The deadline for an rpc reply message delivery. |
| string value | 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 |
| integer value | The deadline for an rpc cast or call message delivery. Only used when caller does not provide a timeout expiry. |
| integer value | The duration to schedule a purge of idle sender links. Detach link after expiry. |
| string value | address prefix when sending to any server in group |
| integer value | Timeout for inactive connections (in seconds) |
| integer value | Time to pause between re-connecting an AMQP 1.0 link that failed due to a recoverable error. |
| string value | Appended to the address prefix when sending a fanout message. Used by the message bus to identify fanout messages. |
| string value | Address prefix for all generated Notification addresses |
| integer value | Window size for incoming Notification messages |
| multi valued | Send messages of this type pre-settled. Pre-settled messages will not receive acknowledgement from the peer. Note well: pre-settled messages may be silently discarded if the delivery fails. Permitted values: rpc-call - send RPC Calls pre-settled rpc-reply- send RPC Replies pre-settled rpc-cast - Send RPC Casts pre-settled notify - Send Notifications pre-settled |
| boolean value | Enable virtual host support for those message buses that do not natively support virtual hosting (such as qpidd). When set to true the virtual host name will be added to all message bus addresses, effectively creating a private subnet per virtual host. Set to False if the message bus supports virtual hosting using the hostname field in the AMQP 1.0 Open performative as the name of the virtual host. |
| integer value | Window size for incoming RPC Reply messages. |
| string value | Address prefix for all generated RPC addresses |
| integer value | Window size for incoming RPC Request messages |
`sasl_config_dir = ` | string value | Path to directory that contains the SASL configuration |
`sasl_config_name = ` | string value | Name of configuration file (without .conf suffix) |
`sasl_default_realm = ` | string value | SASL realm to use if no realm present in username |
`sasl_mechanisms = ` | string value | Space separated list of acceptable SASL mechanisms |
| string value | address prefix used when sending to a specific server |
| boolean value | Attempt to connect via SSL. If no other ssl-related parameters are given, it will use the system’s CA-bundle to verify the server’s certificate. |
`ssl_ca_file = ` | string value | CA certificate PEM file used to verify the server’s certificate |
`ssl_cert_file = ` | string value | Self-identifying certificate PEM file for client authentication |
`ssl_key_file = ` | string value | Private key PEM file used to sign ssl_cert_file certificate (optional) |
| string value | Password for decrypting ssl_key_file (if encrypted) |
| boolean value | By default SSL checks that the name in the server’s certificate matches the hostname in the transport_url. In some configurations it may be preferable to use the virtual hostname instead, for example if the server uses the Server Name Indication TLS extension (rfc6066) to provide a certificate per virtual host. Set ssl_verify_vhost to True if the server’s SSL certificate uses the virtual host name instead of the DNS name. |
| boolean value | Debug: dump AMQP frames to stdout |
| string value | 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. |
4.1.34. oslo_messaging_kafka
The following table outlines the options available under the [oslo_messaging_kafka]
group in the /etc/heat/heat.conf
file.
Table 4.33. oslo_messaging_kafka
Configuration option = Default value | Type | Description |
---|---|---|
| string value | The compression codec for all data generated by the producer. If not set, compression will not be used. Note that the allowed values of this depend on the kafka version |
| integer value | (DEPRECATED FOR REMOVAL) The pool size limit for connections expiration policy |
| integer value | (DEPRECATED FOR REMOVAL) The time-to-live in sec of idle connections in the pool |
| string value | Group id for Kafka consumer. Consumers in one group will coordinate message consumption |
| boolean value | Enable asynchronous consumer commits |
| floating point value | Default timeout(s) for Kafka consumers |
| integer value | Max fetch bytes of Kafka consumer |
| integer value | The maximum number of records returned in a poll call |
| integer value | (DEPRECATED FOR REMOVAL) Pool Size for Kafka Consumers |
| integer value | Size of batch for the producer async send |
| floating point value | Upper bound on the delay for KafkaProducer batching in seconds |
| string value | Mechanism when security protocol is SASL |
| string value | Protocol used to communicate with brokers |
`ssl_cafile = ` | string value | CA certificate PEM file used to verify the server certificate |
4.1.35. oslo_messaging_notifications
The following table outlines the options available under the [oslo_messaging_notifications]
group in the /etc/heat/heat.conf
file.
Table 4.34. oslo_messaging_notifications
Configuration option = Default value | Type | Description |
---|---|---|
| multi valued | The Drivers(s) to handle sending notifications. Possible values are messaging, messagingv2, routing, log, test, noop |
| integer value | The maximum number of attempts to re-send a notification message which failed to be delivered due to a recoverable error. 0 - No retry, -1 - indefinite |
| list value | AMQP topic used for OpenStack notifications. |
| string value | A URL representing the messaging driver to use for notifications. If not set, we fall back to the same configuration used for RPC. |
4.1.36. oslo_messaging_rabbit
The following table outlines the options available under the [oslo_messaging_rabbit]
group in the /etc/heat/heat.conf
file.
Table 4.35. oslo_messaging_rabbit
Configuration option = Default value | Type | Description |
---|---|---|
| boolean value | Auto-delete queues in AMQP. |
| boolean value | Use durable queues in AMQP. |
| integer value | Enable/Disable the RabbitMQ mandatory flag for direct send. The direct send is used as reply,so the MessageUndeliverable exception is raised in case the client queue does not exist. |
| boolean value | EXPERIMENTAL: Run the health check heartbeat threadthrough a native python thread. By default if thisoption isn’t provided the health check heartbeat willinherit the execution model from the parent process. Byexample if the parent process have monkey patched thestdlib by using eventlet/greenlet then the heartbeatwill be run through a green thread. |
| integer value | How often times during the heartbeat_timeout_threshold we check the heartbeat. |
| integer value | Number of seconds after which the Rabbit broker is considered down if heartbeat’s keep-alive fails (0 disables heartbeat). |
| string value | EXPERIMENTAL: Possible values are: gzip, bz2. If not set compression will not be used. This option may not be available in future versions. |
| string value | 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. |
| integer value | How long to wait a missing client before abandoning to send it its replies. This value should not be longer than rpc_response_timeout. |
| floating point value | How long to wait before reconnecting in response to an AMQP consumer cancel notification. |
| boolean value | 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"} " |
| integer value | Maximum interval of RabbitMQ connection retries. Default is 30 seconds. |
| string value | The RabbitMQ login method. |
| integer value | Specifies the number of messages to prefetch. Setting to zero allows unlimited messages. |
| integer value | How long to backoff for between retries when connecting to RabbitMQ. |
| integer value | How frequently to retry connecting with RabbitMQ. |
| integer value | 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. |
| boolean value | Connect over SSL. |
`ssl_ca_file = ` | string value | SSL certification authority file (valid only if SSL enabled). |
`ssl_cert_file = ` | string value | SSL cert file (valid only if SSL enabled). |
`ssl_key_file = ` | string value | SSL key file (valid only if SSL enabled). |
`ssl_version = ` | string value | 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. |
4.1.37. oslo_middleware
The following table outlines the options available under the [oslo_middleware]
group in the /etc/heat/heat.conf
file.
Table 4.36. oslo_middleware
Configuration option = Default value | Type | Description |
---|---|---|
| boolean value | Whether the application is behind a proxy or not. This determines if the middleware should parse the headers or not. |
| integer value | The maximum body size for each request, in bytes. |
| string value | (DEPRECATED FOR REMOVAL) 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. |
4.1.38. oslo_policy
The following table outlines the options available under the [oslo_policy]
group in the /etc/heat/heat.conf
file.
Table 4.37. oslo_policy
Configuration option = Default value | Type | Description |
---|---|---|
| boolean value |
This option controls whether or not to enforce scope when evaluating policies. If |
| string value | Default rule. Enforced when a requested rule is not found. |
| multi valued | 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. |
| string value | The relative or absolute path of a file that maps roles to permissions for a given service. Relative paths must be specified in relation to the configuration file setting this option. |
| string value | Content Type to send and receive data for REST based policy check |
| string value | Absolute path to ca cert file for REST based policy check |
| string value | Absolute path to client cert for REST based policy check |
| string value | Absolute path client key file REST based policy check |
| boolean value | server identity verification for REST based policy check |
4.1.39. paste_deploy
The following table outlines the options available under the [paste_deploy]
group in the /etc/heat/heat.conf
file.
Table 4.38. paste_deploy
Configuration option = Default value | Type | Description |
---|---|---|
| string value | The API paste config file to use. |
| string value | The flavor to use. |
4.1.40. profiler
The following table outlines the options available under the [profiler]
group in the /etc/heat/heat.conf
file.
Table 4.39. profiler
Configuration option = Default value | Type | Description |
---|---|---|
| string value | Connection string for a notifier backend.
Default value is Examples of possible values:
|
| boolean value | Enable the profiling for all services on this node. Default value is False (fully disable the profiling feature). Possible values:
|
| string value | Document type for notification indexing in elasticsearch. |
| integer value | Elasticsearch splits large requests in batches. This parameter defines maximum size of each batch (for example: es_scroll_size=10000). |
| string value | 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. |
| boolean value | Enable filter traces that contain error/exception to a separated place. Default value is set to False. Possible values:
|
| string value | 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 value |
Redissentinel uses a service name to identify a master redis service. This parameter defines the name (for example: |
| floating point value | Redissentinel provides a timeout option on the connections. This parameter defines that timeout (for example: socket_timeout=0.1). |
| boolean value | Enable SQL requests profiling in services. Default value is False (SQL requests won’t be traced). Possible values:
|
4.1.41. revision
The following table outlines the options available under the [revision]
group in the /etc/heat/heat.conf
file.
Table 4.40. revision
Configuration option = Default value | Type | Description |
---|---|---|
| string value | Heat build revision. If you would prefer to manage your build revision separately, you can move this section to a different file and add it as another config option. |
4.1.42. ssl
The following table outlines the options available under the [ssl]
group in the /etc/heat/heat.conf
file.
Table 4.41. ssl
Configuration option = Default value | Type | Description |
---|---|---|
| string value | CA certificate file to use to verify connecting clients. |
| string value | Certificate file to use when starting the server securely. |
| string value | Sets the list of available ciphers. value should be a string in the OpenSSL cipher list format. |
| string value | Private key file to use when starting the server securely. |
| string value | 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. |
4.1.43. trustee
The following table outlines the options available under the [trustee]
group in the /etc/heat/heat.conf
file.
Table 4.42. trustee
Configuration option = Default value | Type | Description |
---|---|---|
| string value | Authentication URL |
| string value | Config Section from which to load plugin specific options |
| string value | Authentication type to load |
| string value | Optional domain ID to use with v3 and v2 parameters. It will be used for both the user and project domain in v3 and ignored in v2 authentication. |
| string value | Optional domain name to use with v3 API and v2 parameters. It will be used for both the user and project domain in v3 and ignored in v2 authentication. |
| string value | Domain ID to scope to |
| string value | Domain name to scope to |
| string value | User’s password |
| string value | Domain ID containing project |
| string value | Domain name containing project |
| string value | Project ID to scope to |
| string value | Project name to scope to |
| string value | Scope for system operations |
| string value | Trust ID |
| string value | User’s domain id |
| string value | User’s domain name |
| string value | User id |
| string value | Username |
4.1.44. volumes
The following table outlines the options available under the [volumes]
group in the /etc/heat/heat.conf
file.
Table 4.43. volumes
Configuration option = Default value | Type | Description |
---|---|---|
| boolean value | Indicate if cinder-backup service is enabled. This is a temporary workaround until cinder-backup service becomes discoverable, see LP#1334856. |
Chapter 5. ironic
The following chapter contains information about the configuration options in the ironic
service.
5.1. ironic.conf
This section contains options for the /etc/ironic/ironic.conf
file.
5.1.1. DEFAULT
The following table outlines the options available under the [DEFAULT]
group in the /etc/ironic/ironic.conf
file.
.
Configuration option = Default value | Type | Description |
---|---|---|
| string value | Authentication strategy used by ironic-api. "noauth" should not be used in a production environment because all authentication will be disabled. |
| string value | Enable eventlet backdoor. Acceptable values are 0, <port>, and <start>:<end>, where 0 results in listening on a random tcp port number; <port> results in listening on the specified port number (and not enabling backdoor if that port is in use); and <start>:<end> results in listening on the smallest unused port number within the specified range of port numbers. The chosen port is displayed in the service’s log file. |
| string value | Enable eventlet backdoor, using the provided path as a unix socket that can receive connections. This option is mutually exclusive with backdoor_port in that only one should be provided. If both are provided then the existence of this option overrides the usage of that option. Inside the path {pid} will be replaced with the PID of the current process. |
| string value | Directory where ironic binaries are installed. |
| integer value | The pool size limit for connections expiration policy |
| integer value | The time-to-live in sec of idle connections in the pool |
| string value | The default exchange under which topics are scoped. May be overridden by an exchange name specified in the transport_url option. |
| boolean value | If set to true, the logging level will be set to DEBUG instead of the default INFO level. |
| boolean value | Return server tracebacks in the API response for any error responses. WARNING: this is insecure and should not be used in a production environment. |
| string value | Default bios interface to be used for nodes that do not have bios_interface field set. A complete list of bios interfaces present on your system may be found by enumerating the "ironic.hardware.interfaces.bios" entrypoint. |
| string value | Default boot interface to be used for nodes that do not have boot_interface field set. A complete list of boot interfaces present on your system may be found by enumerating the "ironic.hardware.interfaces.boot" entrypoint. |
| string value | Default console interface to be used for nodes that do not have console_interface field set. A complete list of console interfaces present on your system may be found by enumerating the "ironic.hardware.interfaces.console" entrypoint. |
| string value | Default deploy interface to be used for nodes that do not have deploy_interface field set. A complete list of deploy interfaces present on your system may be found by enumerating the "ironic.hardware.interfaces.deploy" entrypoint. |
| string value | Default inspect interface to be used for nodes that do not have inspect_interface field set. A complete list of inspect interfaces present on your system may be found by enumerating the "ironic.hardware.interfaces.inspect" entrypoint. |
| list value | List of package logging levels in logger=LEVEL pairs. This option is ignored if log_config_append is set. |
| string value | Default management interface to be used for nodes that do not have management_interface field set. A complete list of management interfaces present on your system may be found by enumerating the "ironic.hardware.interfaces.management" entrypoint. |
| string value | Default network interface to be used for nodes that do not have network_interface field set. A complete list of network interfaces present on your system may be found by enumerating the "ironic.hardware.interfaces.network" entrypoint. |
| string value | Default mode for portgroups. Allowed values can be found in the linux kernel documentation on bonding: https://www.kernel.org/doc/Documentation/networking/bonding.txt. |
| string value | Default power interface to be used for nodes that do not have power_interface field set. A complete list of power interfaces present on your system may be found by enumerating the "ironic.hardware.interfaces.power" entrypoint. |
| string value | Default raid interface to be used for nodes that do not have raid_interface field set. A complete list of raid interfaces present on your system may be found by enumerating the "ironic.hardware.interfaces.raid" entrypoint. |
| string value | Default rescue interface to be used for nodes that do not have rescue_interface field set. A complete list of rescue interfaces present on your system may be found by enumerating the "ironic.hardware.interfaces.rescue" entrypoint. |
| string value | Resource class to use for new nodes when no resource class is provided in the creation request. |
| string value | Default storage interface to be used for nodes that do not have storage_interface field set. A complete list of storage interfaces present on your system may be found by enumerating the "ironic.hardware.interfaces.storage" entrypoint. |
| string value | Default vendor interface to be used for nodes that do not have vendor_interface field set. A complete list of vendor interfaces present on your system may be found by enumerating the "ironic.hardware.interfaces.vendor" entrypoint. |
| list value | Specify the list of bios interfaces to load during service initialization. Missing bios interfaces, or bios interfaces which fail to initialize, will prevent the ironic-conductor service from starting. At least one bios interface that is supported by each enabled hardware type must be enabled here, or the ironic-conductor service will not start. Must not be an empty list. The default value is a recommended set of production-oriented bios interfaces. A complete list of bios interfaces present on your system may be found by enumerating the "ironic.hardware.interfaces.bios" entrypoint. When setting this value, please make sure that every enabled hardware type will have the same set of enabled bios interfaces on every ironic-conductor service. |
| list value | Specify the list of boot interfaces to load during service initialization. Missing boot interfaces, or boot interfaces which fail to initialize, will prevent the ironic-conductor service from starting. At least one boot interface that is supported by each enabled hardware type must be enabled here, or the ironic-conductor service will not start. Must not be an empty list. The default value is a recommended set of production-oriented boot interfaces. A complete list of boot interfaces present on your system may be found by enumerating the "ironic.hardware.interfaces.boot" entrypoint. When setting this value, please make sure that every enabled hardware type will have the same set of enabled boot interfaces on every ironic-conductor service. |
| list value | Specify the list of console interfaces to load during service initialization. Missing console interfaces, or console interfaces which fail to initialize, will prevent the ironic-conductor service from starting. At least one console interface that is supported by each enabled hardware type must be enabled here, or the ironic-conductor service will not start. Must not be an empty list. The default value is a recommended set of production-oriented console interfaces. A complete list of console interfaces present on your system may be found by enumerating the "ironic.hardware.interfaces.console" entrypoint. When setting this value, please make sure that every enabled hardware type will have the same set of enabled console interfaces on every ironic-conductor service. |
| list value | Specify the list of deploy interfaces to load during service initialization. Missing deploy interfaces, or deploy interfaces which fail to initialize, will prevent the ironic-conductor service from starting. At least one deploy interface that is supported by each enabled hardware type must be enabled here, or the ironic-conductor service will not start. Must not be an empty list. The default value is a recommended set of production-oriented deploy interfaces. A complete list of deploy interfaces present on your system may be found by enumerating the "ironic.hardware.interfaces.deploy" entrypoint. When setting this value, please make sure that every enabled hardware type will have the same set of enabled deploy interfaces on every ironic-conductor service. |
| list value | Specify the list of hardware types to load during service initialization. Missing hardware types, or hardware types which fail to initialize, will prevent the conductor service from starting. This option defaults to a recommended set of production-oriented hardware types. A complete list of hardware types present on your system may be found by enumerating the "ironic.hardware.types" entrypoint. |
| list value | Specify the list of inspect interfaces to load during service initialization. Missing inspect interfaces, or inspect interfaces which fail to initialize, will prevent the ironic-conductor service from starting. At least one inspect interface that is supported by each enabled hardware type must be enabled here, or the ironic-conductor service will not start. Must not be an empty list. The default value is a recommended set of production-oriented inspect interfaces. A complete list of inspect interfaces present on your system may be found by enumerating the "ironic.hardware.interfaces.inspect" entrypoint. When setting this value, please make sure that every enabled hardware type will have the same set of enabled inspect interfaces on every ironic-conductor service. |
| list value | Specify the list of management interfaces to load during service initialization. Missing management interfaces, or management interfaces which fail to initialize, will prevent the ironic-conductor service from starting. At least one management interface that is supported by each enabled hardware type must be enabled here, or the ironic-conductor service will not start. Must not be an empty list. The default value is a recommended set of production-oriented management interfaces. A complete list of management interfaces present on your system may be found by enumerating the "ironic.hardware.interfaces.management" entrypoint. When setting this value, please make sure that every enabled hardware type will have the same set of enabled management interfaces on every ironic-conductor service. |
| list value | Specify the list of network interfaces to load during service initialization. Missing network interfaces, or network interfaces which fail to initialize, will prevent the ironic-conductor service from starting. At least one network interface that is supported by each enabled hardware type must be enabled here, or the ironic-conductor service will not start. Must not be an empty list. The default value is a recommended set of production-oriented network interfaces. A complete list of network interfaces present on your system may be found by enumerating the "ironic.hardware.interfaces.network" entrypoint. When setting this value, please make sure that every enabled hardware type will have the same set of enabled network interfaces on every ironic-conductor service. |
| list value | Specify the list of power interfaces to load during service initialization. Missing power interfaces, or power interfaces which fail to initialize, will prevent the ironic-conductor service from starting. At least one power interface that is supported by each enabled hardware type must be enabled here, or the ironic-conductor service will not start. Must not be an empty list. The default value is a recommended set of production-oriented power interfaces. A complete list of power interfaces present on your system may be found by enumerating the "ironic.hardware.interfaces.power" entrypoint. When setting this value, please make sure that every enabled hardware type will have the same set of enabled power interfaces on every ironic-conductor service. |
| list value | Specify the list of raid interfaces to load during service initialization. Missing raid interfaces, or raid interfaces which fail to initialize, will prevent the ironic-conductor service from starting. At least one raid interface that is supported by each enabled hardware type must be enabled here, or the ironic-conductor service will not start. Must not be an empty list. The default value is a recommended set of production-oriented raid interfaces. A complete list of raid interfaces present on your system may be found by enumerating the "ironic.hardware.interfaces.raid" entrypoint. When setting this value, please make sure that every enabled hardware type will have the same set of enabled raid interfaces on every ironic-conductor service. |
| list value | Specify the list of rescue interfaces to load during service initialization. Missing rescue interfaces, or rescue interfaces which fail to initialize, will prevent the ironic-conductor service from starting. At least one rescue interface that is supported by each enabled hardware type must be enabled here, or the ironic-conductor service will not start. Must not be an empty list. The default value is a recommended set of production-oriented rescue interfaces. A complete list of rescue interfaces present on your system may be found by enumerating the "ironic.hardware.interfaces.rescue" entrypoint. When setting this value, please make sure that every enabled hardware type will have the same set of enabled rescue interfaces on every ironic-conductor service. |
| list value | Specify the list of storage interfaces to load during service initialization. Missing storage interfaces, or storage interfaces which fail to initialize, will prevent the ironic-conductor service from starting. At least one storage interface that is supported by each enabled hardware type must be enabled here, or the ironic-conductor service will not start. Must not be an empty list. The default value is a recommended set of production-oriented storage interfaces. A complete list of storage interfaces present on your system may be found by enumerating the "ironic.hardware.interfaces.storage" entrypoint. When setting this value, please make sure that every enabled hardware type will have the same set of enabled storage interfaces on every ironic-conductor service. |
| list value | Specify the list of vendor interfaces to load during service initialization. Missing vendor interfaces, or vendor interfaces which fail to initialize, will prevent the ironic-conductor service from starting. At least one vendor interface that is supported by each enabled hardware type must be enabled here, or the ironic-conductor service will not start. Must not be an empty list. The default value is a recommended set of production-oriented vendor interfaces. A complete list of vendor interfaces present on your system may be found by enumerating the "ironic.hardware.interfaces.vendor" entrypoint. When setting this value, please make sure that every enabled hardware type will have the same set of enabled vendor interfaces on every ironic-conductor service. |
| string value | Path to EFI System Partition image file. This file is recommended for creating UEFI bootable ISO images efficiently. ESP image should contain a FAT12/16/32-formatted file system holding EFI boot loaders (e.g. GRUB2) for each hardware architecture ironic needs to boot. This option is only used when neither ESP nor ISO deploy image is configured to the node being deployed in which case ironic will attempt to fetch ESP image from the configured location or extract ESP image from UEFI-bootable deploy ISO image. |
| integer value | Size of executor thread pool when executor is threading or eventlet. |
| boolean value | Enables or disables fatal status of deprecations. |
| boolean value | (DEPRECATED FOR REMOVAL) Used if there is a formatting error when generating an exception message (a programming error). If True, raise an exception; if False, use the unformatted message. |
| boolean value | If True, convert backing images to "raw" disk image format. |
| integer value | Specify a timeout after which a gracefully shutdown server will exit. Zero value means endless wait. |
| string value | GRUB2 configuration file location on the UEFI ISO images produced by ironic. |
| string value | Template file for grub configuration file. |
| integer value | Exponent to determine number of hash partitions to use when distributing load across conductors. Larger values will result in more even distribution of load and less load when rebalancing the ring, but more memory usage. Number of partitions per conductor is (2^hash_partition_exponent). This determines the granularity of rebalancing: given 10 hosts, and an exponent of the 2, there are 40 partitions in the ring.A few thousand partitions should make rebalancing smooth in most cases. The default is suitable for up to a few hundred conductors. Configuring for too many partitions has a negative impact on CPU usage. |
| integer value | Time (in seconds) after which the hash ring is considered outdated and is refreshed on the next access. |
| string value | Name of this node. This can be an opaque identifier. It is not necessarily a hostname, FQDN, or IP address. However, the node name must be valid within an AMQP key, and if using ZeroMQ (will be removed in the Stein release), a valid hostname, FQDN, or IP address. |
`instance_format = [instance: %(uuid)s] ` | string value | The format for an instance that is passed with the log message. |
`instance_uuid_format = [instance: %(uuid)s] ` | string value | The format for an instance UUID that is passed with the log message. |
| string value | Path to isolinux binary file. |
| string value | Template file for isolinux configuration file. |
| string value | Path to ldlinux.c32 file. This file is required for syslinux 5.0 or later. If not specified, the file is looked for in "/usr/lib/syslinux/modules/bios/ldlinux.c32" and "/usr/share/syslinux/ldlinux.c32". |
| string value | 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. Note that when logging configuration files are used then all logging configuration is set in the configuration file and other logging configuration options are ignored (for example, log-date-format). |
| string value | Defines the format string for %%(asctime)s in log records. Default: %(default)s . This option is ignored if log_config_append is set. |
| string value | (Optional) The base directory used for relative log_file paths. This option is ignored if log_config_append is set. |
| string value | (Optional) Name of log file to send logging output to. If no default is set, logging will go to stderr as defined by use_stderr. This option is ignored if log_config_append is set. |
| integer value | Max number of characters of any node last_error/maintenance_reason pushed to database. |
| boolean value | Enables or disables logging values of all registered options when starting a service (at DEBUG level). |
| integer value | The amount of time before the log files are rotated. This option is ignored unless log_rotation_type is setto "interval". |
| string value | Rotation interval type. The time of the last file change (or the time when the service was started) is used when scheduling the next rotation. |
| string value | Log rotation type. |
| string value | Format string to use for log messages with context. Used by oslo_log.formatters.ContextFormatter |
| string value | Additional data to append to log message when logging level for the message is DEBUG. Used by oslo_log.formatters.ContextFormatter |
| string value | Format string to use for log messages when context is undefined. Used by oslo_log.formatters.ContextFormatter |
| string value | Prefix each line of exception output with this format. Used by oslo_log.formatters.ContextFormatter |
| string value | Defines the format string for %(user_identity)s that is used in logging_context_format_string. Used by oslo_log.formatters.ContextFormatter |
| integer value | Maximum number of rotated log files. |
| integer value | Log file maximum size in MB. This option is ignored if "log_rotation_type" is not set to "size". |
| string value | IP address of this host. If unset, will determine the IP programmatically. If unable to do so, will use "127.0.0.1". |
| string value | Specifies the minimum level for which to send notifications. If not set, no notifications will be sent. The default is for this option to be unset. |
| boolean value | Run image downloads and raw format conversions in parallel. |
| boolean value | Enable pecan debug mode. WARNING: this is insecure and should not be used in a production environment. |
| string value | Used for rolling upgrades. Setting this option downgrades (or pins) the Bare Metal API, the internal ironic RPC communication, and the database objects to their respective versions, so they are compatible with older services. When doing a rolling upgrade from version N to version N+1, set (to pin) this to N. To unpin (default), leave it unset and the latest versions will be used. |
| boolean value | Enables or disables publication of error events. |
| string value | Directory where the ironic python module is installed. |
| integer value | Maximum number of logged messages per rate_limit_interval. |
| string value | Log level name used by rate limiting: CRITICAL, ERROR, INFO, WARNING, DEBUG or empty string. Logs with level greater or equal to rate_limit_except_level are not filtered. An empty string means that all levels are filtered. |
| integer value | Interval, number of seconds, of log rate limiting. |
| string value | Path to the rootwrap configuration file to use for running commands as root. |
| integer value | Size of RPC connection pool. |
| integer value | Seconds to wait for a response from a call. |
| string value | Which RPC transport implementation to use between conductor and API services |
| boolean value | Some periodic tasks can be run in a separate process. Should we run them here? |
| string value | Top-level directory for maintaining ironic’s state. |
| string value | Syslog facility to receive log lines. This option is ignored if log_config_append is set. |
| string value | Temporary working directory, default is Python temp dir. |
| string value | The network address and optional user credentials for connecting to the messaging backend, in URL format. The expected format is: driver://[user:pass@]host:port[,[userN:passN@]hostN:portN]/virtual_host?query Example: rabbit://rabbitmq:password@127.0.0.1:5672// For full details on the fields in the URL see the documentation of oslo_messaging.TransportURL at https://docs.openstack.org/oslo.messaging/latest/reference/transport.html |
| boolean value | Enable journald for logging. If running in a systemd environment you may wish to enable journal support. Doing so will use the journal native protocol which includes structured metadata in addition to log messages.This option is ignored if log_config_append is set. |
| boolean value | Use JSON formatting for logging. This option is ignored if log_config_append is set. |
| boolean value | Use syslog for logging. Existing syslog format is DEPRECATED and will be changed later to honor RFC5424. This option is ignored if log_config_append is set. |
| boolean value | Log output to Windows Event Log. |
| boolean value | Log output to standard error. This option is ignored if log_config_append is set. |
| list value | Specifies the topics for the versioned notifications issued by Ironic. The default value is fine for most deployments and rarely needs to be changed. However, if you have a third-party service that consumes versioned notifications, it might be worth getting a topic for that service. Ironic will send a message containing a versioned notification payload to each topic queue in this list. The list of versioned notifications is visible in https://docs.openstack.org/ironic/latest/admin/notifications.html |
| boolean value | Uses logging handler designed to watch file system. When log file is moved or removed this handler will open a new log file with specified path instantaneously. It makes sense only if log_file option is specified and Linux platform is used. This option is ignored if log_config_append is set. |
5.1.2. agent
The following table outlines the options available under the [agent]
group in the /etc/ironic/ironic.conf
file.
Table 5.1. agent
Configuration option = Default value | Type | Description |
---|---|---|
| string value | API version to use for communicating with the ramdisk agent. |
| integer value | Timeout (in seconds) for IPA commands. Please note, the bootloader installation command to the agent is permitted a timeout of twice the value set here as these are IO heavy operations depending on the configuration of the instance. |
| string value | Whether Ironic should collect the deployment logs on deployment failure (on_failure), always or never. |
| string value | The path to the directory where the logs should be stored, used when the deploy_logs_storage_backend is configured to "local". |
| string value | The name of the storage backend where the logs will be stored. |
| string value | The name of the Swift container to store the logs, used when the deploy_logs_storage_backend is configured to "swift". |
| integer value | Number of days before a log object is marked as expired in Swift. If None, the logs will be kept forever or until manually deleted. Used when the deploy_logs_storage_backend is configured to "swift". |
| string value | Specifies whether direct deploy interface should try to use the image source directly or if ironic should cache the image on the conductor and serve it from ironic’s own http server. This option takes effect only when instance image is provided from the Image service. |
| boolean value | Whether Ironic will manage booting of the agent ramdisk. If set to False, you will need to configure your mechanism to allow booting the agent ramdisk. |
| integer value | This is the maximum number of attempts that will be done for IPA commands that fails due to network problems. |
| integer value | The memory size in MiB consumed by agent when it is booted on a bare metal node. This is used for checking if the image can be downloaded and deployed on the bare metal node after booting agent ramdisk. This may be set according to the memory consumed by the agent ramdisk image. |
| integer value | Max number of attempts to validate a Neutron agent status before raising network error for a dead agent. |
| integer value | The number of seconds Neutron agent will wait between polling for device changes. This value should be the same as CONF.AGENT.polling_interval in Neutron configuration. |
| integer value | Wait time in seconds between attempts for validating Neutron agent status. |
| integer value | Number of times to retry getting power state to check if bare metal node has been powered off after a soft power off. |
| integer value | Amount of time (in seconds) to wait between polling power state after trigger soft poweroff. |
| boolean value | Whether the agent ramdisk should stream raw images directly onto the disk or not. By streaming raw images directly onto the disk the agent ramdisk will not spend time copying the image to a tmpfs partition (therefore consuming less memory) prior to writing it to the disk. Unless the disk where the image will be copied to is really slow, this option should be set to True. Defaults to True. |
5.1.3. ansible
The following table outlines the options available under the [ansible]
group in the /etc/ironic/ironic.conf
file.
Table 5.2. ansible
Configuration option = Default value | Type | Description |
---|---|---|
| string value | Extra arguments to pass on every invocation of Ansible. |
| string value | Path to "ansible-playbook" script. Default will search the $PATH configured for user running ironic-conductor process. Provide the full path when ansible-playbook is not in $PATH or installed in not default location. |
| string value | Path to ansible configuration file. If set to empty, system default will be used. |
| string value | Path (relative to $playbooks_path or absolute) to the default playbook used for node cleaning. It may be overridden by per-node ansible_clean_playbook option in node’s driver_info field. |
| string value | Path (relative to $playbooks_path or absolute) to the default auxiliary cleaning steps file used during the node cleaning. It may be overridden by per-node ansible_clean_steps_config option in node’s driver_info field. |
| string value | Path (relative to $playbooks_path or absolute) to the default playbook used for deployment. It may be overridden by per-node ansible_deploy_playbook option in node’s driver_info field. |
| string value | Absolute path to the private SSH key file to use by Ansible by default when connecting to the ramdisk over SSH. Default is to use default SSH keys configured for the user running the ironic-conductor service. Private keys with password must be pre-loaded into ssh-agent. It may be overridden by per-node ansible_key_file option in node’s driver_info field. |
| string value | Absolute path to the python interpreter on the managed machines. It may be overridden by per-node ansible_python_interpreter option in node’s driver_info field. By default, ansible uses /usr/bin/python |
| string value | Path (relative to $playbooks_path or absolute) to the default playbook used for graceful in-band shutdown of the node. It may be overridden by per-node ansible_shutdown_playbook option in node’s driver_info field. |
| string value | Name of the user to use for Ansible when connecting to the ramdisk over SSH. It may be overridden by per-node ansible_username option in node’s driver_info field. |
| integer value | Extra amount of memory in MiB expected to be consumed by Ansible-related processes on the node. Affects decision whether image will fit into RAM. |
| string value | Specific CA bundle to use for validating SSL connections to the image store. If not specified, CA available in the ramdisk will be used. Is not used by default playbooks included with the driver. Suitable for environments that use self-signed certificates. |
| string value | Client cert to use for SSL connections to image store. Is not used by default playbooks included with the driver. |
| boolean value | Skip verifying SSL connections to the image store when downloading the image. Setting it to "True" is only recommended for testing environments that use self-signed certificates. |
| string value | Client key to use for SSL connections to image store. Is not used by default playbooks included with the driver. |
| string value | Path to directory with playbooks, roles and local inventory. |
| integer value | Number of times to retry getting power state to check if bare metal node has been powered off after a soft power off. Value of 0 means do not retry on failure. |
| integer value | Amount of time (in seconds) to wait between polling power state after trigger soft poweroff. |
| integer value | Set ansible verbosity level requested when invoking "ansible-playbook" command. 4 includes detailed SSH session logging. Default is 4 when global debug is enabled and 0 otherwise. |
5.1.4. api
The following table outlines the options available under the [api]
group in the /etc/ironic/ironic.conf
file.
Table 5.3. api
Configuration option = Default value | Type | Description |
---|---|---|
| integer value | Number of workers for OpenStack Ironic API service. The default is equal to the number of CPUs available if that can be determined, else a default worker count of 1 is returned. |
| boolean value | Enable the integrated stand-alone API to service requests via HTTPS instead of HTTP. If there is a front-end service performing HTTPS offloading from the service, this option should be False; note, you will want to enable proxy headers parsing with [oslo_middleware]enable_proxy_headers_parsing option or configure [api]public_endpoint option to set URLs in responses to the SSL terminated one. |
| host address value | The IP address or hostname on which ironic-api listens. |
| integer value | The maximum number of items returned in a single response from a collection resource. |
| port value | The TCP port on which ironic-api listens. |
| string value | Public URL to use when building the links to the API resources (for example, "https://ironic.rocks:6384"). If None the links will be built using the request’s host URL. If the API is operating behind a proxy, you will want to change this to represent the proxy’s URL. Defaults to None. Ignored when proxy headers parsing is enabled via [oslo_middleware]enable_proxy_headers_parsing option. |
| integer value | Maximum interval (in seconds) for agent heartbeats. |
| boolean value | Whether to restrict the lookup API to only nodes in certain states. |
5.1.5. audit
The following table outlines the options available under the [audit]
group in the /etc/ironic/ironic.conf
file.
Table 5.4. audit
Configuration option = Default value | Type | Description |
---|---|---|
| string value | Path to audit map file for ironic-api service. Used only when API audit is enabled. |
| boolean value | Enable auditing of API requests (for ironic-api service). |
`ignore_req_list = ` | string value | Comma separated list of Ironic REST API HTTP methods to be ignored during audit logging. For example: auditing will not be done on any GET or POST requests if this is set to "GET,POST". It is used only when API audit is enabled. |
5.1.6. cinder
The following table outlines the options available under the [cinder]
group in the /etc/ironic/ironic.conf
file.
Table 5.5. cinder
Configuration option = Default value | Type | Description |
---|---|---|
| integer value | Number of retries in the case of a failed action (currently only used when detaching volumes). |
| integer value | Retry interval in seconds in the case of a failed action (only specific actions are retried). |
| string value | Authentication URL |
| string value | Authentication type to load |
| string value | PEM encoded Certificate Authority to use when verifying HTTPs connections. |
| string value | PEM encoded client certificate cert file |
| boolean value | Collect per-API call timing information. |
| integer value | The maximum number of retries that should be attempted for connection errors. |
| floating point value | Delay (in seconds) between two retries for connection errors. If not set, exponential retry starting with 0.5 seconds up to a maximum of 60 seconds is used. |
| string value | Optional domain ID to use with v3 and v2 parameters. It will be used for both the user and project domain in v3 and ignored in v2 authentication. |
| string value | Optional domain name to use with v3 API and v2 parameters. It will be used for both the user and project domain in v3 and ignored in v2 authentication. |
| string value | Domain ID to scope to |
| string value | Domain name to scope to |
| string value |
Always use this endpoint URL for requests for this client. NOTE: The unversioned endpoint should be specified here; to request a particular API version, use the |
| boolean value | Verify HTTPS connections. |
| string value | PEM encoded client certificate key file |
| string value | The maximum major version of a given API, intended to be used as the upper bound of a range with min_version. Mutually exclusive with version. |
| string value | The minimum major version of a given API, intended to be used as the lower bound of a range with max_version. Mutually exclusive with version. If min_version is given with no max_version it is as if max version is "latest". |
| string value | User’s password |
| string value | Domain ID containing project |
| string value | Domain name containing project |
| string value | Project ID to scope to |
| string value | Project name to scope to |
| string value | The default region_name for endpoint URL discovery. |
| integer value | Client retries in the case of a failed request connection. |
| string value | The default service_name for endpoint URL discovery. |
| string value | The default service_type for endpoint URL discovery. |
| boolean value | Log requests to multiple loggers. |
| integer value | The maximum number of retries that should be attempted for retriable HTTP status codes. |
| floating point value | Delay (in seconds) between two retries for retriable status codes. If not set, exponential retry starting with 0.5 seconds up to a maximum of 60 seconds is used. |
| string value | Scope for system operations |
| string value | Tenant ID |
| string value | Tenant Name |
| integer value | Timeout value for http requests |
| string value | Trust ID |
| uri value | (DEPRECATED FOR REMOVAL) URL for connecting to cinder. If set, the value must start with either http:// or https://. |
| string value | User’s domain id |
| string value | User’s domain name |
| string value | User id |
| string value | Username |
| list value | List of interfaces, in order of preference, for endpoint URL. |
| string value | Minimum Major API version within a given Major API version for endpoint URL discovery. Mutually exclusive with min_version and max_version |
5.1.7. conductor
The following table outlines the options available under the [conductor]
group in the /etc/ironic/ironic.conf
file.
Table 5.6. conductor
Configuration option = Default value | Type | Description |
---|---|---|
| boolean value | Allow deleting nodes which are in state available. Defaults to True. |
| boolean value | Whether to allow nodes to enter or undergo deploy or cleaning when in maintenance mode. If this option is set to False, and a node enters maintenance during deploy or cleaning, the process will be aborted after the next heartbeat. Automated cleaning or making a node available will also fail. If True (the default), the process will begin and will pause after the node starts heartbeating. Moving it from maintenance will make the process continue. |
| uri value | (DEPRECATED FOR REMOVAL) URL of Ironic API service. If not set ironic can get the current value from the keystone service catalog. If set, the value must start with either http:// or https://. |
| boolean value | Enables or disables automated cleaning. Automated cleaning is a configurable set of steps, such as erasing disk drives, that are performed on the node to ensure it is in a baseline state and ready to be deployed to. This is done after instance deletion as well as during the transition from a "manageable" to "available" state. When enabled, the particular steps performed to clean a node depend on which driver that node is managed by; see the individual driver’s documentation for details. NOTE: The introduction of the cleaning operation causes instance deletion to take significantly longer. In an environment where all tenants are trusted (eg, because there is only one tenant), this option could be safely disabled. |
| string value | Glance ID, http:// or file:// URL of the EFI system partition image containing EFI boot loader. This image will be used by ironic when building UEFI-bootable ISO out of kernel and ramdisk. Required for UEFI boot from partition images. |
| integer value | Interval between checks of orphaned allocations, in seconds. Set to 0 to disable checks. |
| integer value | Interval between checks of provision timeouts, in seconds. Set to 0 to disable checks. |
| integer value | Interval (seconds) between checks of rescue timeouts. |
| integer value | Timeout (seconds) to wait for a callback from the ramdisk doing the cleaning. If the timeout is reached the node will be put in the "clean failed" provision state. Set to 0 to disable timeout. |
`conductor_group = ` | string value | Name of the conductor group to join. Can be up to 255 characters and is case insensitive. This conductor will only manage nodes with a matching "conductor_group" field set on the node. |
| string value | Name of the Swift container to store config drive data. Used when configdrive_use_object_store is True. |
| integer value | The timeout (in seconds) after which a configdrive temporary URL becomes invalid. Defaults to deploy_callback_timeout if it is set, otherwise to 1800 seconds. Used when configdrive_use_object_store is True. |
| integer value | Timeout (seconds) to wait for a callback from a deploy ramdisk. Set to 0 to disable timeout. |
| string value | Glance ID, http:// or file:// URL of the kernel of the default deploy image. |
| string value | Glance ID, http:// or file:// URL of the initramfs of the default deploy image. |
| boolean value | Whether to enable publishing the baremetal API endpoint via multicast DNS. |
| boolean value | During sync_power_state, should the hardware power state be set to the state recorded in the database (True) or should the database be updated based on the hardware state (False). |
| integer value | Seconds between conductor heart beats. |
| integer value | Maximum time (in seconds) since the last check-in of a conductor. A conductor is considered inactive when this time has been exceeded. |
| integer value | Timeout (seconds) for waiting for node inspection. 0 - unlimited. |
| integer value | Number of attempts to grab a node lock. |
| integer value | Seconds to sleep between node lock attempts. |
| integer value | Maximum number of worker threads that can be started simultaneously by a periodic task. Should be less than RPC thread pool size. |
| integer value | Interval (in seconds) between checking the power state for nodes previously put into maintenance mode due to power synchronization failure. A node is automatically moved out of maintenance mode once its power state is retrieved successfully. Set to 0 to disable this check. |
| integer value | Number of seconds to wait for power operations to complete, i.e., so that a baremetal node is in the desired power state. If timed out, the power operation is considered a failure. |
| integer value | During sync_power_state failures, limit the number of times Ironic should try syncing the hardware node power state with the node power state in DB |
| integer value | Timeout (seconds) to wait for a callback from the rescue ramdisk. If the timeout is reached the node will be put in the "rescue failed" provision state. Set to 0 to disable timeout. |
| string value | Glance ID, http:// or file:// URL of the kernel of the default rescue image. |
| string value | Glance ID, http:// or file:// URL of the initramfs of the default rescue image. |
| boolean value | Enable sending sensor data message via the notification bus |
| boolean value | The default for sensor data collection is to only collect data for machines that are deployed, however operators may desire to know if there are failures in hardware that is not presently in use. When set to true, the conductor will collect sensor information from all nodes when sensor data collection is enabled via the send_sensor_data setting. |
| integer value | Seconds between conductor sending sensor data message to ceilometer via the notification bus. |
| list value | List of comma separated meter types which need to be sent to Ceilometer. The default value, "ALL", is a special value meaning send all the sensor data. |
| integer value | The time in seconds to wait for send sensors data periodic task to be finished before allowing periodic call to happen again. Should be less than send_sensor_data_interval value. |
| integer value | The maximum number of workers that can be started simultaneously for send data from sensors periodic task. |
| integer value | Timeout (in seconds) of soft reboot and soft power off operation. This value always has to be positive. |
| integer value | When conductors join or leave the cluster, existing conductors may need to update any persistent local state as nodes are moved around the cluster. This option controls how often, in seconds, each conductor will check for nodes that it should "take over". Set it to 0 (or a negative value) to disable the check entirely. |
| integer value | Interval between syncing the node power state to the database, in seconds. Set to 0 to disable syncing. |
| integer value | The maximum number of worker threads that can be started simultaneously to sync nodes power states from the periodic task. |
| integer value |
The size of the workers greenthread pool. Note that 2 threads will be reserved by the conductor itself for handling heart beats and periodic tasks. On top of that, |
5.1.8. console
The following table outlines the options available under the [console]
group in the /etc/ironic/ironic.conf
file.
Table 5.7. console
Configuration option = Default value | Type | Description |
---|---|---|
| integer value | Time (in seconds) to wait for the shellinabox console subprocess to exit before sending SIGKILL signal. |
| IP address value | IP address of Socat service running on the host of ironic conductor. Used only by Socat console. |
| integer value | Time interval (in seconds) for checking the status of console subprocess. |
| integer value | Time (in seconds) to wait for the console subprocess to start. |
| string value | Path to serial console terminal program. Used only by Shell In A Box console. |
| string value | Directory containing the terminal SSL cert (PEM) for serial console access. Used only by Shell In A Box console. |
| string value | Directory for holding terminal pid files. If not specified, the temporary directory will be used. |
| integer value | Timeout (in seconds) for the terminal session to be closed on inactivity. Set to 0 to disable timeout. Used only by Socat console. |
5.1.9. cors
The following table outlines the options available under the [cors]
group in the /etc/ironic/ironic.conf
file.
Table 5.8. cors
Configuration option = Default value | Type | Description |
---|---|---|
| boolean value | Indicate that the actual request can include user credentials |
| list value | Indicate which header field names may be used during the actual request. |
| list value | Indicate which methods can be used during the actual request. |
| list value | Indicate whether this resource may be shared with the domain received in the requests "origin" header. Format: "<protocol>://<host>[:<port>]", no trailing slash. Example: https://horizon.example.com |
| list value | Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers. |
| integer value | Maximum cache age of CORS preflight requests. |
5.1.10. database
The following table outlines the options available under the [database]
group in the /etc/ironic/ironic.conf
file.
Table 5.9. database
Configuration option = Default value | Type | Description |
---|---|---|
| string value | The back end to use for the database. |
| string value | The SQLAlchemy connection string to use to connect to the database. |
| integer value | Verbosity of SQL debugging information: 0=None, 100=Everything. |
`connection_parameters = ` | string value | Optional URL parameters to append onto the connection URL at connect time; specify as param1=value1¶m2=value2&… |
| integer value | Connections which have been present in the connection pool longer than this number of seconds will be replaced with a new one the next time they are checked out from the pool. |
| boolean value | Add Python stack traces to SQL as comment strings. |
| boolean value | If True, increases the interval between retries of a database operation up to db_max_retry_interval. |
| integer value | Maximum retries in case of connection error or deadlock error before error is raised. Set to -1 to specify an infinite retry count. |
| integer value | If db_inc_retry_interval is set, the maximum seconds between retries of a database operation. |
| integer value | Seconds between retries of a database transaction. |
| integer value | If set, use this value for max_overflow with SQLAlchemy. |
| integer value | Maximum number of SQL connections to keep open in a pool. Setting a value of 0 indicates no limit. |
| integer value | Maximum number of database connection retries during startup. Set to -1 to specify an infinite retry count. |
| boolean value | If True, transparently enables support for handling MySQL Cluster (NDB). |
| string value | MySQL engine to use. |
| string value | The SQL mode to be used for MySQL sessions. This option, including the default, overrides any server-set SQL mode. To use whatever SQL mode is set by the server configuration, set this to no value. Example: mysql_sql_mode= |
| integer value | If set, use this value for pool_timeout with SQLAlchemy. |
| integer value | Interval between retries of opening a SQL connection. |
| string value | The SQLAlchemy connection string to use to connect to the slave database. |
| boolean value | If True, SQLite uses synchronous mode. |
| boolean value | Enable the experimental use of database reconnect on connection lost. |
5.1.11. deploy
The following table outlines the options available under the [deploy]
group in the /etc/ironic/ironic.conf
file.
Table 5.10. deploy
Configuration option = Default value | Type | Description |
---|---|---|
| boolean value | Whether to upload the config drive to object store. Set this option to True to store config drive in a swift endpoint. |
| boolean value |
Defines what to do if an ATA secure erase operation fails during cleaning in the Ironic Python Agent. If False, the cleaning operation will fail and the node will be put in |
| string value |
Default boot mode to use when no boot mode is requested in node’s driver_info, capabilities or in the |
| string value | Default boot option to use when no boot option is requested in node’s driver_info. Currently the default is "netboot", but it will be changed to "local" in the future. It is recommended to set an explicit value for this option. |
| integer value | Defines the target pool size used by Ironic Python Agent ramdisk to erase disk devices. The number of threads created to erase disks will not exceed this value or the number of disks to be erased. |
| boolean value | Whether to support the use of ATA Secure Erase during the cleaning process. Defaults to True. |
| integer value | Priority to run in-band clean step that erases metadata from devices, via the Ironic Python Agent ramdisk. If unset, will use the priority set in the ramdisk (defaults to 99 for the GenericHardwareManager). If set to 0, will not run during cleaning. |
| integer value | Priority to run in-band erase devices via the Ironic Python Agent ramdisk. If unset, will use the priority set in the ramdisk (defaults to 10 for the GenericHardwareManager). If set to 0, will not run during cleaning. |
| boolean value | Whether to allow deployment agents to perform lookup, heartbeat operations during initial states of a machine lifecycle and by-pass the normal setup procedures for a ramdisk. This feature also enables power operations which are part of deployment processes to be bypassed if the ramdisk has performed a heartbeat operation using the fast_track_timeout setting. |
| integer value | Seconds for which the last heartbeat event is to be considered valid for the purpose of a fast track sequence. This setting should generally be less than the number of seconds for "Power-On Self Test" and typical ramdisk start-up. This value should not exceed the [api]ramdisk_heartbeat_timeout setting. |
| string value | The name of subdirectory under ironic-conductor node’s HTTP root path which is used to place instance images for the direct deploy interface, when local HTTP service is incorporated to provide instance image instead of swift tempurls. |
| string value | ironic-conductor node’s HTTP root path. |
| string value | ironic-conductor node’s HTTP server URL. Example: http://192.1.2.3:8080 |
| boolean value | Whether to power off a node after deploy failure. Defaults to True. |
| boolean value | Whether to write zeros to a node’s block devices after writing random data. This will write zeros to the device even when deploy.shred_random_overwrite_iterations is 0. This option is only used if a device could not be ATA Secure Erased. Defaults to True. |
| integer value | During shred, overwrite all block devices N times with random data. This is only used if a device could not be ATA Secure Erased. Defaults to 1. |
5.1.12. dhcp
The following table outlines the options available under the [dhcp]
group in the /etc/ironic/ironic.conf
file.
Table 5.11. dhcp
Configuration option = Default value | Type | Description |
---|---|---|
| string value | DHCP provider to use. "neutron" uses Neutron, and "none" uses a no-op provider. |
5.1.13. disk_partitioner
The following table outlines the options available under the [disk_partitioner]
group in the /etc/ironic/ironic.conf
file.
Table 5.12. disk_partitioner
Configuration option = Default value | Type | Description |
---|---|---|
| integer value | After Ironic has completed creating the partition table, it continues to check for activity on the attached iSCSI device status at this interval prior to copying the image to the node, in seconds |
| integer value | The maximum number of times to check that the device is not accessed by another process. If the device is still busy after that, the disk partitioning will be treated as having failed. |
5.1.14. disk_utils
The following table outlines the options available under the [disk_utils]
group in the /etc/ironic/ironic.conf
file.
Table 5.13. disk_utils
Configuration option = Default value | Type | Description |
---|---|---|
| integer value | Size of BIOS Boot partition in MiB when configuring GPT partitioned systems for local boot in BIOS. |
| string value | Block size to use when writing to the nodes disk. |
| integer value | Size of EFI system partition in MiB when configuring UEFI systems for local boot. |
| integer value | Number of attempts to convert an image. |
| integer value | Memory limit for "qemu-img convert" in MiB. Implemented via the address space resource limit. |
| integer value | (DEPRECATED FOR REMOVAL) Maximum attempts to verify an iSCSI connection is active, sleeping 1 second between attempts. |
| integer value | Maximum attempts to detect a newly created partition. Defaults to iscsi_verify_attempts, will default to 3 when it is removed. |
| integer value | Maximum number of attempts to try to read the partition. |
5.1.15. drac
The following table outlines the options available under the [drac]
group in the /etc/ironic/ironic.conf
file.
Table 5.14. drac
Configuration option = Default value | Type | Description |
---|---|---|
| integer value | Maximum amount of time (in seconds) to wait for the boot device configuration job to transition to the correct state to allow a reboot or power on to complete. |
| integer value | Maximum number of retries for the configuration job to complete successfully. |
| integer value | Interval (in seconds) between periodic RAID job status checks to determine whether the asynchronous RAID configuration was successfully finished or not. |
5.1.16. glance
The following table outlines the options available under the [glance]
group in the /etc/ironic/ironic.conf
file.
Table 5.15. glance
Configuration option = Default value | Type | Description |
---|---|---|
| list value | A list of URL schemes that can be downloaded directly via the direct_url. Currently supported schemes: [file]. |
| string value | Authentication URL |
| string value | Authentication type to load |
| string value | PEM encoded Certificate Authority to use when verifying HTTPs connections. |
| string value | PEM encoded client certificate cert file |
| boolean value | Collect per-API call timing information. |
| integer value | The maximum number of retries that should be attempted for connection errors. |
| floating point value | Delay (in seconds) between two retries for connection errors. If not set, exponential retry starting with 0.5 seconds up to a maximum of 60 seconds is used. |
| string value | Optional domain ID to use with v3 and v2 parameters. It will be used for both the user and project domain in v3 and ignored in v2 authentication. |
| string value | Optional domain name to use with v3 API and v2 parameters. It will be used for both the user and project domain in v3 and ignored in v2 authentication. |
| string value | Domain ID to scope to |
| string value | Domain name to scope to |
| string value |
Always use this endpoint URL for requests for this client. NOTE: The unversioned endpoint should be specified here; to request a particular API version, use the |
| boolean value | Verify HTTPS connections. |
| string value | PEM encoded client certificate key file |
| string value | The maximum major version of a given API, intended to be used as the upper bound of a range with min_version. Mutually exclusive with version. |
| string value | The minimum major version of a given API, intended to be used as the lower bound of a range with max_version. Mutually exclusive with version. If min_version is given with no max_version it is as if max version is "latest". |
| integer value | Number of retries when downloading an image from glance. |
| string value | User’s password |
| string value | Domain ID containing project |
| string value | Domain name containing project |
| string value | Project ID to scope to |
| string value | Project name to scope to |
| string value | The default region_name for endpoint URL discovery. |
| string value | The default service_name for endpoint URL discovery. |
| string value | The default service_type for endpoint URL discovery. |
| boolean value | Log requests to multiple loggers. |
| integer value | The maximum number of retries that should be attempted for retriable HTTP status codes. |
| floating point value | Delay (in seconds) between two retries for retriable status codes. If not set, exponential retry starting with 0.5 seconds up to a maximum of 60 seconds is used. |
| string value | The account that Glance uses to communicate with Swift. The format is "AUTH_uuid". "uuid" is the UUID for the account configured in the glance-api.conf. For example: "AUTH_a422b2-91f3-2f46-74b7-d7c9e8958f5d30". If not set, the default value is calculated based on the ID of the project used to access Swift (as set in the [swift] section). Swift temporary URL format: "endpoint_url/api_version/account/container/object_id" |
| string value | The Swift API version to create a temporary URL for. Defaults to "v1". Swift temporary URL format: "endpoint_url/api_version/account/container/object_id" |
| string value | The Swift container Glance is configured to store its images in. Defaults to "glance", which is the default in glance-api.conf. Swift temporary URL format: "endpoint_url/api_version/account/container/object_id" |
| string value | The "endpoint" (scheme, hostname, optional port) for the Swift URL of the form "endpoint_url/api_version/account/container/object_id". Do not include trailing "/". For example, use "https://swift.example.com". If using RADOS Gateway, endpoint may also contain /swift path; if it does not, it will be appended. Used for temporary URLs, will be fetched from the service catalog, if not provided. |
| integer value | This should match a config by the same name in the Glance configuration file. When set to 0, a single-tenant store will only use one container to store all images. When set to an integer value between 1 and 32, a single-tenant store will use multiple containers to store images, and this value will determine how many containers are created. |
| boolean value | Whether to cache generated Swift temporary URLs. Setting it to true is only useful when an image caching proxy is used. Defaults to False. |
| integer value | The length of time in seconds that the temporary URL will be valid for. Defaults to 20 minutes. If some deploys get a 401 response code when trying to download from the temporary URL, try raising this duration. This value must be greater than or equal to the value for swift_temp_url_expected_download_start_delay |
| integer value | This is the delay (in seconds) from the time of the deploy request (when the Swift temporary URL is generated) to when the IPA ramdisk starts up and URL is used for the image download. This value is used to check if the Swift temporary URL duration is large enough to let the image download begin. Also if temporary URL caching is enabled this will determine if a cached entry will still be valid when the download starts. swift_temp_url_duration value must be greater than or equal to this option’s value. Defaults to 0. |
| string value | The secret token given to Swift to allow temporary URL downloads. Required for temporary URLs. For the Swift backend, the key on the service project (as set in the [swift] section) is used by default. |
| string value | Scope for system operations |
| string value | Tenant ID |
| string value | Tenant Name |
| integer value | Timeout value for http requests |
| string value | Trust ID |
| string value | User’s domain id |
| string value | User’s domain name |
| string value | User id |
| string value | Username |
| list value | List of interfaces, in order of preference, for endpoint URL. |
| string value | Minimum Major API version within a given Major API version for endpoint URL discovery. Mutually exclusive with min_version and max_version |
5.1.17. healthcheck
The following table outlines the options available under the [healthcheck]
group in the /etc/ironic/ironic.conf
file.
Table 5.16. healthcheck
Configuration option = Default value | Type | Description |
---|---|---|
| list value | Additional backends that can perform health checks and report that information back as part of a request. |
| boolean value | Show more detailed information as part of the response. Security note: Enabling this option may expose sensitive details about the service being monitored. Be sure to verify that it will not violate your security policies. |
| string value | Check the presence of a file to determine if an application is running on a port. Used by DisableByFileHealthcheck plugin. |
| list value | Check the presence of a file based on a port to determine if an application is running on a port. Expects a "port:path" list of strings. Used by DisableByFilesPortsHealthcheck plugin. |
| boolean value | Enable the health check endpoint at /healthcheck. Note that this is unauthenticated. More information is available at https://docs.openstack.org/oslo.middleware/latest/reference/healthcheck_plugins.html. |
| string value | (DEPRECATED FOR REMOVAL) The path to respond to healtcheck requests on. |
5.1.18. ilo
The following table outlines the options available under the [ilo]
group in the /etc/ironic/ironic.conf
file.
Table 5.17. ilo
Configuration option = Default value | Type | Description |
---|---|---|
| string value | CA certificate file to validate iLO. |
| integer value | Priority for clear_secure_boot_keys clean step. This step is not enabled by default. It can be enabled to clear all secure boot keys enrolled with iLO. |
| integer value | Priority for reset_bios_to_default clean step. |
| integer value | Priority for reset_ilo clean step. |
| integer value | Priority for reset_ilo_credential clean step. This step requires "ilo_change_password" parameter to be updated in nodes’s driver_info with the new password. |
| integer value | Priority for reset_secure_boot_keys clean step. This step will reset the secure boot keys to manufacturing defaults. |
| port value | Port to be used for iLO operations |
| integer value | Timeout (in seconds) for iLO operations |
| string value | Default boot mode to be used in provisioning when "boot_mode" capability is not provided in the "properties/capabilities" of the node. The default is "auto" for backward compatibility. When "auto" is specified, default boot mode will be selected based on boot mode settings on the system. |
| integer value | Interval (in seconds) between periodic erase-devices status checks to determine whether the asynchronous out-of-band erase-devices was successfully finished or not. |
| integer value | Amount of time in seconds to wait in between power operations |
| string value | The Swift iLO container to store data. |
| integer value | Amount of time in seconds for Swift objects to auto-expire. |
| boolean value | Set this to True to use http web server to host floppy images and generated boot ISO. This requires http_root and http_url to be configured in the [deploy] section of the config file. If this is set to False, then Ironic will use Swift to host the floppy images and generated boot_iso. |
5.1.19. inspector
The following table outlines the options available under the [inspector]
group in the /etc/ironic/ironic.conf
file.
Table 5.18. inspector
Configuration option = Default value | Type | Description |
---|---|---|
| string value | Authentication URL |
| string value | Authentication type to load |
| string value | PEM encoded Certificate Authority to use when verifying HTTPs connections. |
| string value | endpoint to use as a callback for posting back introspection data when boot is managed by ironic. Standard keystoneauth options are used by default. |
| string value | PEM encoded client certificate cert file |
| boolean value | Collect per-API call timing information. |
| integer value | The maximum number of retries that should be attempted for connection errors. |
| floating point value | Delay (in seconds) between two retries for connection errors. If not set, exponential retry starting with 0.5 seconds up to a maximum of 60 seconds is used. |
| string value | Optional domain ID to use with v3 and v2 parameters. It will be used for both the user and project domain in v3 and ignored in v2 authentication. |
| string value | Optional domain name to use with v3 API and v2 parameters. It will be used for both the user and project domain in v3 and ignored in v2 authentication. |
| string value | Domain ID to scope to |
| string value | Domain name to scope to |
| string value |
Always use this endpoint URL for requests for this client. NOTE: The unversioned endpoint should be specified here; to request a particular API version, use the |
`extra_kernel_params = ` | string value | extra kernel parameters to pass to the inspection ramdisk when boot is managed by ironic (not ironic-inspector). Pairs key=value separated by spaces. |
| boolean value | Verify HTTPS connections. |
| string value | PEM encoded client certificate key file |
| string value | The maximum major version of a given API, intended to be used as the upper bound of a range with min_version. Mutually exclusive with version. |
| string value | The minimum major version of a given API, intended to be used as the lower bound of a range with max_version. Mutually exclusive with version. If min_version is given with no max_version it is as if max version is "latest". |
| string value | User’s password |
| boolean value | whether to power off a node after inspection finishes |
| string value | Domain ID containing project |
| string value | Domain name containing project |
| string value | Project ID to scope to |
| string value | Project name to scope to |
| string value | The default region_name for endpoint URL discovery. |
| boolean value | require that the in-band inspection boot is fully managed by ironic. Set this to True if your installation of ironic-inspector does not have a separate PXE boot environment. |
| string value | The default service_name for endpoint URL discovery. |
| string value | The default service_type for endpoint URL discovery. |
| boolean value | Log requests to multiple loggers. |
| integer value | The maximum number of retries that should be attempted for retriable HTTP status codes. |
| floating point value | Delay (in seconds) between two retries for retriable status codes. If not set, exponential retry starting with 0.5 seconds up to a maximum of 60 seconds is used. |
| integer value | period (in seconds) to check status of nodes on inspection |
| string value | Scope for system operations |
| string value | Tenant ID |
| string value | Tenant Name |
| integer value | Timeout value for http requests |
| string value | Trust ID |
| string value | User’s domain id |
| string value | User’s domain name |
| string value | User id |
| string value | Username |
| list value | List of interfaces, in order of preference, for endpoint URL. |
| string value | Minimum Major API version within a given Major API version for endpoint URL discovery. Mutually exclusive with min_version and max_version |
5.1.20. ipmi
The following table outlines the options available under the [ipmi]
group in the /etc/ironic/ironic.conf
file.
Table 5.19. ipmi
Configuration option = Default value | Type | Description |
---|---|---|
| multi valued | Additional errors ipmitool may encounter, specific to the environment it is run in. |
| integer value | Maximum time in seconds to retry retryable IPMI operations. (An operation is retryable, for example, if the requested operation fails because the BMC is busy.) Setting this too high can cause the sync power state periodic task to hang when there are slow or unresponsive BMCs. |
| boolean value | Enables all ipmi commands to be executed with an additional debugging output. This is a separate option as ipmitool can log a substantial amount of misleading text when in this mode. |
| boolean value | Default timeout behavior whether ironic sends a raw IPMI command to disable the 60 second timeout for booting. Setting this option to False will NOT send that command, the default value is True. It may be overridden by per-node ipmi_disable_boot_timeout option in node’s driver_info field. |
| boolean value |
Kill |
| integer value | Minimum time, in seconds, between IPMI operations sent to a server. There is a risk with some hardware that setting this too low may cause the BMC to crash. Recommended setting is 5 seconds. |
| boolean value | When set to True and the parameters are supported by ipmitool, the number of retries and the retry interval are passed to ipmitool as parameters, and ipmitool will do the retries. When set to False, ironic will retry the ipmitool commands. Recommended setting is False |
5.1.21. irmc
The following table outlines the options available under the [irmc]
group in the /etc/ironic/ironic.conf
file.
Table 5.20. irmc
Configuration option = Default value | Type | Description |
---|---|---|
| string value | Authentication method to be used for iRMC operations |
| integer value | Priority for restore_irmc_bios_config clean step. |
| integer value | Timeout (in seconds) for iRMC operations |
| list value | List of vendor IDs and device IDs for CPU FPGA to inspect. List items are in format vendorID/deviceID and separated by commas. CPU inspection will use this value to find existence of CPU FPGA in a node. If this option is not defined, then leave out CUSTOM_CPU_FPGA in node traits. Sample fpga_ids value: 0x1000/0x0079,0x2100/0x0080 |
| list value | List of vendor IDs and device IDs for GPU device to inspect. List items are in format vendorID/deviceID and separated by commas. GPU inspection will use this value to count the number of GPU device in a node. If this option is not defined, then leave out pci_gpu_devices in capabilities property. Sample gpu_ids value: 0x1000/0x0079,0x2100/0x0080 |
| port value | Port to be used for iRMC operations |
| integer value | Interval (in seconds) between periodic RAID status checks to determine whether the asynchronous RAID configuration was successfully finished or not. Foreground Initialization (FGI) will start 5 minutes after creating virtual drives. |
| string value | IP of remote image server |
| string value | share name of remote_image_server |
| string value | Ironic conductor node’s "NFS" or "CIFS" root path |
| string value | Share type of virtual media |
`remote_image_user_domain = ` | string value | Domain name of remote_image_user_name |
| string value | User name of remote_image_server |
| string value | Password of remote_image_user_name |
| string value | Sensor data retrieval method. |
| string value | SNMP community. Required for versions "v1" and "v2c" |
| integer value | SNMP polling interval in seconds |
| port value | SNMP port |
| string value | SNMP security name. Required for version "v3" |
| string value | SNMP protocol version |
5.1.22. ironic_lib
The following table outlines the options available under the [ironic_lib]
group in the /etc/ironic/ironic.conf
file.
Table 5.21. ironic_lib
Configuration option = Default value | Type | Description |
---|---|---|
| boolean value | Used if there is a formatting error when generating an exception message (a programming error). If True, raise an exception; if False, use the unformatted message. |
| string value | Command that is prefixed to commands that are run as root. If not specified, no commands are run as root. |
5.1.23. iscsi
The following table outlines the options available under the [iscsi]
group in the /etc/ironic/ironic.conf
file.
Table 5.22. iscsi
Configuration option = Default value | Type | Description |
---|---|---|
| string value | Flags that need to be sent to the dd command, to control the conversion of the original file when copying to the host. It can contain several options separated by commas. |
| port value | The port number on which the iSCSI portal listens for incoming connections. |
| integer value | Maximum attempts to verify an iSCSI connection is active, sleeping 1 second between attempts. Defaults to the deprecated [disk_utils]iscsi_verify_attempts option, after its removal will default to 3. |
5.1.24. json_rpc
The following table outlines the options available under the [json_rpc]
group in the /etc/ironic/ironic.conf
file.
Table 5.23. json_rpc
Configuration option = Default value | Type | Description |
---|---|---|
| string value | Authentication URL |
| string value | Authentication strategy used by JSON RPC. Defaults to the global auth_strategy setting. |
| string value | Authentication type to load |
| string value | PEM encoded Certificate Authority to use when verifying HTTPs connections. |
| string value | PEM encoded client certificate cert file |
| boolean value | Collect per-API call timing information. |
| string value | Optional domain ID to use with v3 and v2 parameters. It will be used for both the user and project domain in v3 and ignored in v2 authentication. |
| string value | Optional domain name to use with v3 API and v2 parameters. It will be used for both the user and project domain in v3 and ignored in v2 authentication. |
| string value | Domain ID to scope to |
| string value | Domain name to scope to |
| host address value | The IP address or hostname on which JSON RPC will listen. |
| boolean value | Verify HTTPS connections. |
| string value | PEM encoded client certificate key file |
| string value | User’s password |
| port value | The port to use for JSON RPC |
| string value | Domain ID containing project |
| string value | Domain name containing project |
| string value | Project ID to scope to |
| string value | Project name to scope to |
| boolean value | Log requests to multiple loggers. |
| string value | Scope for system operations |
| string value | Tenant ID |
| string value | Tenant Name |
| integer value | Timeout value for http requests |
| string value | Trust ID |
| boolean value | Whether to use TLS for JSON RPC |
| string value | User’s domain id |
| string value | User’s domain name |
| string value | User id |
| string value | Username |
5.1.25. keystone_authtoken
The following table outlines the options available under the [keystone_authtoken]
group in the /etc/ironic/ironic.conf
file.
Table 5.24. keystone_authtoken
Configuration option = Default value | Type | Description |
---|---|---|
| string value | Config Section from which to load plugin specific options |
| string value | Authentication type to load |
| string value | (DEPRECATED FOR REMOVAL) Complete "public" Identity API endpoint. This endpoint should not be an "admin" endpoint, as it should be accessible by all end users. Unauthenticated clients are redirected to this endpoint to authenticate. Although this endpoint should ideally be unversioned, client support in the wild varies. If you’re using a versioned v2 endpoint here, then this should not be the same endpoint the service user utilizes for validating tokens, because normal end users may not be able to reach that endpoint. This option is deprecated in favor of www_authenticate_uri and will be removed in the S release. |
| string value | API version of the Identity API endpoint. |
| string value |
Request environment key where the Swift cache object is stored. When auth_token middleware is deployed with a Swift cache, use this option to have the middleware share a caching backend with swift. Otherwise, use the |
| string value | A PEM encoded Certificate Authority to use when verifying HTTPs connections. Defaults to system CAs. |
| string value | Required if identity server requires client certificate |
| boolean value | Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components. |
| string value | Used to control the use and type of token binding. Can be set to: "disabled" to not check token binding. "permissive" (default) to validate binding information if the bind type is of a form known to the server and ignore it if not. "strict" like "permissive" but if the bind type is unknown the token will be rejected. "required" any form of token binding is needed to be allowed. Finally the name of a binding method that must be present in tokens. |
| integer value | Request timeout value for communicating with Identity API server. |
| integer value | How many times are we trying to reconnect when communicating with Identity API Server. |
| boolean value | (Optional) Indicate whether to set the X-Service-Catalog header. If False, middleware will not ask for service catalog on token validation and will not set the X-Service-Catalog header. |
| boolean value | Verify HTTPS connections. |
| string value | Interface to use for the Identity API endpoint. Valid values are "public", "internal" or "admin"(default). |
| string value | Required if identity server requires client certificate |
| integer value | (Optional) Number of seconds that an operation will wait to get a memcached client connection from the pool. |
| integer value | (Optional) Number of seconds memcached server is considered dead before it is tried again. |
| integer value | (Optional) Maximum total number of open connections to every memcached server. |
| integer value | (Optional) Socket timeout in seconds for communicating with a memcached server. |
| integer value | (Optional) Number of seconds a connection to memcached is held unused in the pool before it is closed. |
| string value | (Optional, mandatory if memcache_security_strategy is defined) This string is used for key derivation. |
| string value | (Optional) If defined, indicate whether token data should be authenticated or authenticated and encrypted. If MAC, token data is authenticated (with HMAC) in the cache. If ENCRYPT, token data is encrypted and authenticated in the cache. If the value is not one of these options or empty, auth_token will raise an exception on initialization. |
| boolean value | (Optional) Use the advanced (eventlet safe) memcached client pool. The advanced pool will only work under python 2.x. |
| list value | Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process. |
| string value | The region in which the identity server can be found. |
| list value | A choice of roles that must be present in a service token. Service tokens are allowed to request that an expired token can be used and so this check should tightly control that only actual services should be sending this token. Roles here are applied as an ANY check so any role in this list must be present. For backwards compatibility reasons this currently only affects the allow_expired check. |
| boolean value | For backwards compatibility reasons we must let valid service tokens pass that don’t pass the service_token_roles check as valid. Setting this true will become the default in a future release and should be enabled if possible. |
| string value | The name or type of the service as it appears in the service catalog. This is used to validate tokens that have restricted access rules. |
| integer value | In order to prevent excessive effort spent validating tokens, the middleware caches previously-seen tokens for a configurable duration (in seconds). Set to -1 to disable caching completely. |
| string value | Complete "public" Identity API endpoint. This endpoint should not be an "admin" endpoint, as it should be accessible by all end users. Unauthenticated clients are redirected to this endpoint to authenticate. Although this endpoint should ideally be unversioned, client support in the wild varies. If you’re using a versioned v2 endpoint here, then this should not be the same endpoint the service user utilizes for validating tokens, because normal end users may not be able to reach that endpoint. |
5.1.26. mdns
The following table outlines the options available under the [mdns]
group in the /etc/ironic/ironic.conf
file.
Table 5.25. mdns
Configuration option = Default value | Type | Description |
---|---|---|
| list value | List of IP addresses of interfaces to use for mDNS. Defaults to all interfaces on the system. |
| integer value | Number of attempts to lookup a service. |
| dict value | Additional parameters to pass for the registered service. |
| integer value | Number of attempts to register a service. Currently has to be larger than 1 because of race conditions in the zeroconf library. |
5.1.27. metrics
The following table outlines the options available under the [metrics]
group in the /etc/ironic/ironic.conf
file.
Table 5.26. metrics
Configuration option = Default value | Type | Description |
---|---|---|
| string value | Backend for the agent ramdisk to use for metrics. Default possible backends are "noop" and "statsd". |
| string value | Prefix all metric names sent by the agent ramdisk with this value. The format of metric names is [global_prefix.][uuid.][host_name.]prefix.metric_name. |
| boolean value | Prepend the hostname to all metric names sent by the agent ramdisk. The format of metric names is [global_prefix.][uuid.][host_name.]prefix.metric_name. |
| boolean value | Split the prepended host value by "." and reverse it for metrics sent by the agent ramdisk (to better match the reverse hierarchical form of domain names). |
| boolean value | Prepend the node’s Ironic uuid to all metric names sent by the agent ramdisk. The format of metric names is [global_prefix.][uuid.][host_name.]prefix.metric_name. |
| string value | Backend to use for the metrics system. |
| string value | Prefix all metric names with this value. By default, there is no global prefix. The format of metric names is [global_prefix.][host_name.]prefix.metric_name. |
| boolean value | Prepend the hostname to all metric names. The format of metric names is [global_prefix.][host_name.]prefix.metric_name. |
| boolean value | Split the prepended host value by "." and reverse it (to better match the reverse hierarchical form of domain names). |
5.1.28. metrics_statsd
The following table outlines the options available under the [metrics_statsd]
group in the /etc/ironic/ironic.conf
file.
Table 5.27. metrics_statsd
Configuration option = Default value | Type | Description |
---|---|---|
| string value | Host for the agent ramdisk to use with the statsd backend. This must be accessible from networks the agent is booted on. |
| port value | Port for the agent ramdisk to use with the statsd backend. |
| string value | Host for use with the statsd backend. |
| port value | Port to use with the statsd backend. |
5.1.29. neutron
The following table outlines the options available under the [neutron]
group in the /etc/ironic/ironic.conf
file.
Table 5.28. neutron
Configuration option = Default value | Type | Description |
---|---|---|
| boolean value | Option to enable transmission of all ports to neutron when creating ports for provisioning, cleaning, or rescue. This is done without IP addresses assigned to the port, and may be useful in some bonded network configurations. |
| string value | Authentication URL |
| string value | Authentication type to load |
| string value | PEM encoded Certificate Authority to use when verifying HTTPs connections. |
| string value | PEM encoded client certificate cert file |
| string value | Neutron network UUID or name for the ramdisk to be booted into for cleaning nodes. Required for "neutron" network interface. It is also required if cleaning nodes when using "flat" network interface or "neutron" DHCP provider. If a name is provided, it must be unique among all networks or cleaning will fail. |
| list value | List of Neutron Security Group UUIDs to be applied during cleaning of the nodes. Optional for the "neutron" network interface and not used for the "flat" or "noop" network interfaces. If not specified, default security group is used. |
| boolean value | Collect per-API call timing information. |
| integer value | The maximum number of retries that should be attempted for connection errors. |
| floating point value | Delay (in seconds) between two retries for connection errors. If not set, exponential retry starting with 0.5 seconds up to a maximum of 60 seconds is used. |
| string value | Optional domain ID to use with v3 and v2 parameters. It will be used for both the user and project domain in v3 and ignored in v2 authentication. |
| string value | Optional domain name to use with v3 API and v2 parameters. It will be used for both the user and project domain in v3 and ignored in v2 authentication. |
| integer value | Number of IPv6 addresses to allocate for ports created for provisioning, cleaning, rescue or inspection on DHCPv6-stateful networks. Different stages of the chain-loading process will request addresses with different CLID/IAID. Due to non-identical identifiers multiple addresses must be reserved for the host to ensure each step of the boot process can successfully lease addresses. |
| string value | Domain ID to scope to |
| string value | Domain name to scope to |
| string value |
Always use this endpoint URL for requests for this client. NOTE: The unversioned endpoint should be specified here; to request a particular API version, use the |
| boolean value | Verify HTTPS connections. |
| string value | Neutron network UUID or name for the ramdisk to be booted into for in-band inspection of nodes. If a name is provided, it must be unique among all networks or inspection will fail. |
| list value | List of Neutron Security Group UUIDs to be applied during the node inspection process. Optional for the "neutron" network interface and not used for the "flat" or "noop" network interfaces. If not specified, the default security group is used. |
| string value | PEM encoded client certificate key file |
| string value | The maximum major version of a given API, intended to be used as the upper bound of a range with min_version. Mutually exclusive with version. |
| string value | The minimum major version of a given API, intended to be used as the lower bound of a range with max_version. Mutually exclusive with version. If min_version is given with no max_version it is as if max version is "latest". |
| string value | User’s password |
| integer value | Delay value to wait for Neutron agents to setup sufficient DHCP configuration for port. |
| string value | Domain ID containing project |
| string value | Domain name containing project |
| string value | Project ID to scope to |
| string value | Project name to scope to |
| string value | Neutron network UUID or name for the ramdisk to be booted into for provisioning nodes. Required for "neutron" network interface. If a name is provided, it must be unique among all networks or deploy will fail. |
| list value | List of Neutron Security Group UUIDs to be applied during provisioning of the nodes. Optional for the "neutron" network interface and not used for the "flat" or "noop" network interfaces. If not specified, default security group is used. |
| string value | The default region_name for endpoint URL discovery. |
| integer value | Timeout for request processing when interacting with Neutron. This value should be increased if neutron port action timeouts are observed as neutron performs pre-commit validation prior returning to the API client which can take longer than normal client/server interactions. |
| string value | Neutron network UUID or name for booting the ramdisk for rescue mode. This is not the network that the rescue ramdisk will use post-boot — the tenant network is used for that. Required for "neutron" network interface, if rescue mode will be used. It is not used for the "flat" or "noop" network interfaces. If a name is provided, it must be unique among all networks or rescue will fail. |
| list value | List of Neutron Security Group UUIDs to be applied during the node rescue process. Optional for the "neutron" network interface and not used for the "flat" or "noop" network interfaces. If not specified, the default security group is used. |
| integer value | Client retries in the case of a failed request. |
| string value | The default service_name for endpoint URL discovery. |
| string value | The default service_type for endpoint URL discovery. |
| boolean value | Log requests to multiple loggers. |
| integer value | The maximum number of retries that should be attempted for retriable HTTP status codes. |
| floating point value | Delay (in seconds) between two retries for retriable status codes. If not set, exponential retry starting with 0.5 seconds up to a maximum of 60 seconds is used. |
| string value | Scope for system operations |
| string value | Tenant ID |
| string value | Tenant Name |
| integer value | Timeout value for http requests |
| string value | Trust ID |
| string value | User’s domain id |
| string value | User’s domain name |
| string value | User id |
| string value | Username |
| list value | List of interfaces, in order of preference, for endpoint URL. |
| string value | Minimum Major API version within a given Major API version for endpoint URL discovery. Mutually exclusive with min_version and max_version |
5.1.30. nova
The following table outlines the options available under the [nova]
group in the /etc/ironic/ironic.conf
file.
Table 5.29. nova
Configuration option = Default value | Type | Description |
---|---|---|
| string value | Authentication URL |
| string value | Authentication type to load |
| string value | PEM encoded Certificate Authority to use when verifying HTTPs connections. |
| string value | PEM encoded client certificate cert file |
| boolean value | Collect per-API call timing information. |
| integer value | The maximum number of retries that should be attempted for connection errors. |
| floating point value | Delay (in seconds) between two retries for connection errors. If not set, exponential retry starting with 0.5 seconds up to a maximum of 60 seconds is used. |
| string value | Optional domain ID to use with v3 and v2 parameters. It will be used for both the user and project domain in v3 and ignored in v2 authentication. |
| string value | Optional domain name to use with v3 API and v2 parameters. It will be used for both the user and project domain in v3 and ignored in v2 authentication. |
| string value | Domain ID to scope to |
| string value | Domain name to scope to |
| string value |
Always use this endpoint URL for requests for this client. NOTE: The unversioned endpoint should be specified here; to request a particular API version, use the |
| boolean value | Verify HTTPS connections. |
| string value | PEM encoded client certificate key file |
| string value | The maximum major version of a given API, intended to be used as the upper bound of a range with min_version. Mutually exclusive with version. |
| string value | The minimum major version of a given API, intended to be used as the lower bound of a range with max_version. Mutually exclusive with version. If min_version is given with no max_version it is as if max version is "latest". |
| string value | User’s password |
| string value | Domain ID containing project |
| string value | Domain name containing project |
| string value | Project ID to scope to |
| string value | Project name to scope to |
| string value | The default region_name for endpoint URL discovery. |
| boolean value | When set to True, it will enable the support for power state change callbacks to nova. This option should be set to False in deployments that do not have the openstack compute service. |
| string value | The default service_name for endpoint URL discovery. |
| string value | The default service_type for endpoint URL discovery. |
| boolean value | Log requests to multiple loggers. |
| integer value | The maximum number of retries that should be attempted for retriable HTTP status codes. |
| floating point value | Delay (in seconds) between two retries for retriable status codes. If not set, exponential retry starting with 0.5 seconds up to a maximum of 60 seconds is used. |
| string value | Scope for system operations |
| string value | Tenant ID |
| string value | Tenant Name |
| integer value | Timeout value for http requests |
| string value | Trust ID |
| string value | User’s domain id |
| string value | User’s domain name |
| string value | User id |
| string value | Username |
| list value | List of interfaces, in order of preference, for endpoint URL. |
| string value | Minimum Major API version within a given Major API version for endpoint URL discovery. Mutually exclusive with min_version and max_version |
5.1.31. oslo_concurrency
The following table outlines the options available under the [oslo_concurrency]
group in the /etc/ironic/ironic.conf
file.
Table 5.30. oslo_concurrency
Configuration option = Default value | Type | Description |
---|---|---|
| boolean value | Enables or disables inter-process locks. |
| string value | 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. |
5.1.32. oslo_messaging_amqp
The following table outlines the options available under the [oslo_messaging_amqp]
group in the /etc/ironic/ironic.conf
file.
Table 5.31. oslo_messaging_amqp
Configuration option = Default value | Type | Description |
---|---|---|
| string value | 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 |
| string value | 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. |
| string value | address prefix used when broadcasting to all servers |
| integer value | Increase the connection_retry_interval by this many seconds after each unsuccessful failover attempt. |
| integer value | Seconds to pause before attempting to re-connect. |
| integer value | Maximum limit for connection_retry_interval + connection_retry_backoff |
| string value | Name for the AMQP container. must be globally unique. Defaults to a generated UUID |
| string value | 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 |
| integer value | The deadline for a sent notification message delivery. Only used when caller does not provide a timeout expiry. |
| integer value | The maximum number of attempts to re-send a reply message which failed due to a recoverable error. |
| integer value | The deadline for an rpc reply message delivery. |
| string value | 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 |
| integer value | The deadline for an rpc cast or call message delivery. Only used when caller does not provide a timeout expiry. |
| integer value | The duration to schedule a purge of idle sender links. Detach link after expiry. |
| string value | address prefix when sending to any server in group |
| integer value | Timeout for inactive connections (in seconds) |
| integer value | Time to pause between re-connecting an AMQP 1.0 link that failed due to a recoverable error. |
| string value | Appended to the address prefix when sending a fanout message. Used by the message bus to identify fanout messages. |
| string value | Address prefix for all generated Notification addresses |
| integer value | Window size for incoming Notification messages |
| multi valued | Send messages of this type pre-settled. Pre-settled messages will not receive acknowledgement from the peer. Note well: pre-settled messages may be silently discarded if the delivery fails. Permitted values: rpc-call - send RPC Calls pre-settled rpc-reply- send RPC Replies pre-settled rpc-cast - Send RPC Casts pre-settled notify - Send Notifications pre-settled |
| boolean value | Enable virtual host support for those message buses that do not natively support virtual hosting (such as qpidd). When set to true the virtual host name will be added to all message bus addresses, effectively creating a private subnet per virtual host. Set to False if the message bus supports virtual hosting using the hostname field in the AMQP 1.0 Open performative as the name of the virtual host. |
| integer value | Window size for incoming RPC Reply messages. |
| string value | Address prefix for all generated RPC addresses |
| integer value | Window size for incoming RPC Request messages |
`sasl_config_dir = ` | string value | Path to directory that contains the SASL configuration |
`sasl_config_name = ` | string value | Name of configuration file (without .conf suffix) |
`sasl_default_realm = ` | string value | SASL realm to use if no realm present in username |
`sasl_mechanisms = ` | string value | Space separated list of acceptable SASL mechanisms |
| string value | address prefix used when sending to a specific server |
| boolean value | Attempt to connect via SSL. If no other ssl-related parameters are given, it will use the system’s CA-bundle to verify the server’s certificate. |
`ssl_ca_file = ` | string value | CA certificate PEM file used to verify the server’s certificate |
`ssl_cert_file = ` | string value | Self-identifying certificate PEM file for client authentication |
`ssl_key_file = ` | string value | Private key PEM file used to sign ssl_cert_file certificate (optional) |
| string value | Password for decrypting ssl_key_file (if encrypted) |
| boolean value | By default SSL checks that the name in the server’s certificate matches the hostname in the transport_url. In some configurations it may be preferable to use the virtual hostname instead, for example if the server uses the Server Name Indication TLS extension (rfc6066) to provide a certificate per virtual host. Set ssl_verify_vhost to True if the server’s SSL certificate uses the virtual host name instead of the DNS name. |
| boolean value | Debug: dump AMQP frames to stdout |
| string value | 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. |
5.1.33. oslo_messaging_kafka
The following table outlines the options available under the [oslo_messaging_kafka]
group in the /etc/ironic/ironic.conf
file.
Table 5.32. oslo_messaging_kafka
Configuration option = Default value | Type | Description |
---|---|---|
| string value | The compression codec for all data generated by the producer. If not set, compression will not be used. Note that the allowed values of this depend on the kafka version |
| integer value | (DEPRECATED FOR REMOVAL) The pool size limit for connections expiration policy |
| integer value | (DEPRECATED FOR REMOVAL) The time-to-live in sec of idle connections in the pool |
| string value | Group id for Kafka consumer. Consumers in one group will coordinate message consumption |
| boolean value | Enable asynchronous consumer commits |
| floating point value | Default timeout(s) for Kafka consumers |
| integer value | Max fetch bytes of Kafka consumer |
| integer value | The maximum number of records returned in a poll call |
| integer value | (DEPRECATED FOR REMOVAL) Pool Size for Kafka Consumers |
| integer value | Size of batch for the producer async send |
| floating point value | Upper bound on the delay for KafkaProducer batching in seconds |
| string value | Mechanism when security protocol is SASL |
| string value | Protocol used to communicate with brokers |
`ssl_cafile = ` | string value | CA certificate PEM file used to verify the server certificate |
5.1.34. oslo_messaging_notifications
The following table outlines the options available under the [oslo_messaging_notifications]
group in the /etc/ironic/ironic.conf
file.
Table 5.33. oslo_messaging_notifications
Configuration option = Default value | Type | Description |
---|---|---|
| multi valued | The Drivers(s) to handle sending notifications. Possible values are messaging, messagingv2, routing, log, test, noop |
| integer value | The maximum number of attempts to re-send a notification message which failed to be delivered due to a recoverable error. 0 - No retry, -1 - indefinite |
| list value | AMQP topic used for OpenStack notifications. |
| string value | A URL representing the messaging driver to use for notifications. If not set, we fall back to the same configuration used for RPC. |
5.1.35. oslo_messaging_rabbit
The following table outlines the options available under the [oslo_messaging_rabbit]
group in the /etc/ironic/ironic.conf
file.
Table 5.34. oslo_messaging_rabbit
Configuration option = Default value | Type | Description |
---|---|---|
| boolean value | Auto-delete queues in AMQP. |
| boolean value | Use durable queues in AMQP. |
| integer value | Enable/Disable the RabbitMQ mandatory flag for direct send. The direct send is used as reply,so the MessageUndeliverable exception is raised in case the client queue does not exist. |
| boolean value | EXPERIMENTAL: Run the health check heartbeat threadthrough a native python thread. By default if thisoption isn’t provided the health check heartbeat willinherit the execution model from the parent process. Byexample if the parent process have monkey patched thestdlib by using eventlet/greenlet then the heartbeatwill be run through a green thread. |
| integer value | How often times during the heartbeat_timeout_threshold we check the heartbeat. |
| integer value | Number of seconds after which the Rabbit broker is considered down if heartbeat’s keep-alive fails (0 disables heartbeat). |
| string value | EXPERIMENTAL: Possible values are: gzip, bz2. If not set compression will not be used. This option may not be available in future versions. |
| string value | 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. |
| integer value | How long to wait a missing client before abandoning to send it its replies. This value should not be longer than rpc_response_timeout. |
| floating point value | How long to wait before reconnecting in response to an AMQP consumer cancel notification. |
| boolean value | 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"} " |
| integer value | Maximum interval of RabbitMQ connection retries. Default is 30 seconds. |
| string value | The RabbitMQ login method. |
| integer value | Specifies the number of messages to prefetch. Setting to zero allows unlimited messages. |
| integer value | How long to backoff for between retries when connecting to RabbitMQ. |
| integer value | How frequently to retry connecting with RabbitMQ. |
| integer value | 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. |
| boolean value | Connect over SSL. |
`ssl_ca_file = ` | string value | SSL certification authority file (valid only if SSL enabled). |
`ssl_cert_file = ` | string value | SSL cert file (valid only if SSL enabled). |
`ssl_key_file = ` | string value | SSL key file (valid only if SSL enabled). |
`ssl_version = ` | string value | 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. |
5.1.36. oslo_middleware
The following table outlines the options available under the [oslo_middleware]
group in the /etc/ironic/ironic.conf
file.
Table 5.35. oslo_middleware
Configuration option = Default value | Type | Description |
---|---|---|
| boolean value | Whether the application is behind a proxy or not. This determines if the middleware should parse the headers or not. |
5.1.37. oslo_policy
The following table outlines the options available under the [oslo_policy]
group in the /etc/ironic/ironic.conf
file.
Table 5.36. oslo_policy
Configuration option = Default value | Type | Description |
---|---|---|
| boolean value |
This option controls whether or not to enforce scope when evaluating policies. If |
| string value | Default rule. Enforced when a requested rule is not found. |
| multi valued | 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. |
| string value | The relative or absolute path of a file that maps roles to permissions for a given service. Relative paths must be specified in relation to the configuration file setting this option. |
| string value | Content Type to send and receive data for REST based policy check |
| string value | Absolute path to ca cert file for REST based policy check |
| string value | Absolute path to client cert for REST based policy check |
| string value | Absolute path client key file REST based policy check |
| boolean value | server identity verification for REST based policy check |
5.1.38. profiler
The following table outlines the options available under the [profiler]
group in the /etc/ironic/ironic.conf
file.
Table 5.37. profiler
Configuration option = Default value | Type | Description |
---|---|---|
| string value | Connection string for a notifier backend.
Default value is Examples of possible values:
|
| boolean value | Enable the profiling for all services on this node. Default value is False (fully disable the profiling feature). Possible values:
|
| string value | Document type for notification indexing in elasticsearch. |
| integer value | Elasticsearch splits large requests in batches. This parameter defines maximum size of each batch (for example: es_scroll_size=10000). |
| string value | 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. |
| boolean value | Enable filter traces that contain error/exception to a separated place. Default value is set to False. Possible values:
|
| string value | 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 value |
Redissentinel uses a service name to identify a master redis service. This parameter defines the name (for example: |
| floating point value | Redissentinel provides a timeout option on the connections. This parameter defines that timeout (for example: socket_timeout=0.1). |
| boolean value | Enable SQL requests profiling in services. Default value is False (SQL requests won’t be traced). Possible values:
|
5.1.39. pxe
The following table outlines the options available under the [pxe]
group in the /etc/ironic/ironic.conf
file.
Table 5.38. pxe
Configuration option = Default value | Type | Description |
---|---|---|
| integer value | Interval (in seconds) between periodic checks on PXE boot retry. Has no effect if boot_retry_timeout is not set. |
| integer value | Timeout (in seconds) after which PXE boot should be retried. Must be less than [conductor]deploy_callback_timeout. Disabled by default. |
| string value | Default file system format for ephemeral partition, if one is created. |
| integer value | The permission that will be applied to the TFTP folders upon creation. This should be set to the permission such that the tftpserver has access to read the contents of the configured TFTP folder. This setting is only required when the operating system’s umask is restrictive such that ironic-conductor is creating files that cannot be read by the TFTP server. Setting to <None> will result in the operating system’s umask to be utilized for the creation of new tftp folders. It is recommended that an octal representation is specified. For example: 0o755 |
| integer value | Maximum size (in MiB) of cache for master images, including those in use. |
| integer value | Maximum TTL (in minutes) for old master images in cache. |
| string value | On the ironic-conductor node, directory where images are stored on disk. |
| string value | On the ironic-conductor node, directory where master instance images are stored on disk. Setting to the empty string disables image caching. |
| string value | The IP version that will be used for PXE booting. Defaults to 4. EXPERIMENTAL |
| string value | On ironic-conductor node, the path to the main iPXE script file. |
| boolean value | (DEPRECATED FOR REMOVAL) Defaults the PXE interface to only use iPXE. |
| integer value | Timeout value (in seconds) for downloading an image via iPXE. Defaults to 0 (no timeout) |
| boolean value | Download deploy and rescue images directly from swift using temporary URLs. If set to false (default), images are downloaded to the ironic-conductor node and served over its local HTTP server. Applicable only when ipxe_enabled option is set to true. |
| string value | Additional append parameters for baremetal PXE boot. |
| string value | Bootfile DHCP parameter. |
| dict value | Bootfile DHCP parameter per node architecture. For example: aarch64:grubaa64.efi |
| string value | Directory in which to create symbolic links which represent the MAC or IP address of the ports on a node and allow boot loaders to load the PXE file for the node. This directory name is relative to the PXE or iPXE folders. |
| string value | On ironic-conductor node, template file for PXE configuration. |
| dict value | On ironic-conductor node, template file for PXE configuration per node architecture. For example: aarch64:/opt/share/grubaa64_pxe_config.template |
| string value | On ironic-conductor node, directory where master TFTP images are stored on disk. Setting to the empty string disables image caching. |
| string value | ironic-conductor node’s TFTP root path. The ironic-conductor must have read/write access to this path. |
| string value | IP address of ironic-conductor node’s TFTP server. |
| string value | Bootfile DHCP parameter for UEFI boot mode. |
| string value | On ironic-conductor node, template file for PXE configuration for UEFI boot loader. |
5.1.40. service_catalog
The following table outlines the options available under the [service_catalog]
group in the /etc/ironic/ironic.conf
file.
Table 5.39. service_catalog
Configuration option = Default value | Type | Description |
---|---|---|
| string value | Authentication URL |
| string value | Authentication type to load |
| string value | PEM encoded Certificate Authority to use when verifying HTTPs connections. |
| string value | PEM encoded client certificate cert file |
| boolean value | Collect per-API call timing information. |
| integer value | The maximum number of retries that should be attempted for connection errors. |
| floating point value | Delay (in seconds) between two retries for connection errors. If not set, exponential retry starting with 0.5 seconds up to a maximum of 60 seconds is used. |
| string value | Optional domain ID to use with v3 and v2 parameters. It will be used for both the user and project domain in v3 and ignored in v2 authentication. |
| string value | Optional domain name to use with v3 API and v2 parameters. It will be used for both the user and project domain in v3 and ignored in v2 authentication. |
| string value | Domain ID to scope to |
| string value | Domain name to scope to |
| string value |
Always use this endpoint URL for requests for this client. NOTE: The unversioned endpoint should be specified here; to request a particular API version, use the |
| boolean value | Verify HTTPS connections. |
| string value | PEM encoded client certificate key file |
| string value | The maximum major version of a given API, intended to be used as the upper bound of a range with min_version. Mutually exclusive with version. |
| string value | The minimum major version of a given API, intended to be used as the lower bound of a range with max_version. Mutually exclusive with version. If min_version is given with no max_version it is as if max version is "latest". |
| string value | User’s password |
| string value | Domain ID containing project |
| string value | Domain name containing project |
| string value | Project ID to scope to |
| string value | Project name to scope to |
| string value | The default region_name for endpoint URL discovery. |
| string value | The default service_name for endpoint URL discovery. |
| string value | The default service_type for endpoint URL discovery. |
| boolean value | Log requests to multiple loggers. |
| integer value | The maximum number of retries that should be attempted for retriable HTTP status codes. |
| floating point value | Delay (in seconds) between two retries for retriable status codes. If not set, exponential retry starting with 0.5 seconds up to a maximum of 60 seconds is used. |
| string value | Scope for system operations |
| string value | Tenant ID |
| string value | Tenant Name |
| integer value | Timeout value for http requests |
| string value | Trust ID |
| string value | User’s domain id |
| string value | User’s domain name |
| string value | User id |
| string value | Username |
| list value | List of interfaces, in order of preference, for endpoint URL. |
| string value | Minimum Major API version within a given Major API version for endpoint URL discovery. Mutually exclusive with min_version and max_version |
5.1.41. snmp
The following table outlines the options available under the [snmp]
group in the /etc/ironic/ironic.conf
file.
Table 5.40. snmp
Configuration option = Default value | Type | Description |
---|---|---|
| integer value | Seconds to wait for power action to be completed |
| integer value | Time (in seconds) to sleep between when rebooting (powering off and on again) |
| integer value | Maximum number of UDP request retries, 0 means no retries. |
| floating point value | Response timeout in seconds used for UDP transport. Timeout should be a multiple of 0.5 seconds and is applicable to each retry. |
5.1.42. ssl
The following table outlines the options available under the [ssl]
group in the /etc/ironic/ironic.conf
file.
Table 5.41. ssl
Configuration option = Default value | Type | Description |
---|---|---|
| string value | CA certificate file to use to verify connecting clients. |
| string value | Certificate file to use when starting the server securely. |
| string value | Sets the list of available ciphers. value should be a string in the OpenSSL cipher list format. |
| string value | Private key file to use when starting the server securely. |
| string value | 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. |
5.1.43. swift
The following table outlines the options available under the [swift]
group in the /etc/ironic/ironic.conf
file.
Table 5.42. swift
Configuration option = Default value | Type | Description |
---|---|---|
| string value | Authentication URL |
| string value | Authentication type to load |
| string value | PEM encoded Certificate Authority to use when verifying HTTPs connections. |
| string value | PEM encoded client certificate cert file |
| boolean value | Collect per-API call timing information. |
| integer value | The maximum number of retries that should be attempted for connection errors. |
| floating point value | Delay (in seconds) between two retries for connection errors. If not set, exponential retry starting with 0.5 seconds up to a maximum of 60 seconds is used. |
| string value | Optional domain ID to use with v3 and v2 parameters. It will be used for both the user and project domain in v3 and ignored in v2 authentication. |
| string value | Optional domain name to use with v3 API and v2 parameters. It will be used for both the user and project domain in v3 and ignored in v2 authentication. |
| string value | Domain ID to scope to |
| string value | Domain name to scope to |
| string value |
Always use this endpoint URL for requests for this client. NOTE: The unversioned endpoint should be specified here; to request a particular API version, use the |
| boolean value | Verify HTTPS connections. |
| string value | PEM encoded client certificate key file |
| string value | The maximum major version of a given API, intended to be used as the upper bound of a range with min_version. Mutually exclusive with version. |
| string value | The minimum major version of a given API, intended to be used as the lower bound of a range with max_version. Mutually exclusive with version. If min_version is given with no max_version it is as if max version is "latest". |
| string value | User’s password |
| string value | Domain ID containing project |
| string value | Domain name containing project |
| string value | Project ID to scope to |
| string value | Project name to scope to |
| string value | The default region_name for endpoint URL discovery. |
| string value | The default service_name for endpoint URL discovery. |
| string value | The default service_type for endpoint URL discovery. |
| boolean value | Log requests to multiple loggers. |
| integer value | The maximum number of retries that should be attempted for retriable HTTP status codes. |
| floating point value | Delay (in seconds) between two retries for retriable status codes. If not set, exponential retry starting with 0.5 seconds up to a maximum of 60 seconds is used. |
| integer value | Maximum number of times to retry a Swift request, before failing. |
| string value | Scope for system operations |
| string value | Tenant ID |
| string value | Tenant Name |
| integer value | Timeout value for http requests |
| string value | Trust ID |
| string value | User’s domain id |
| string value | User’s domain name |
| string value | User id |
| string value | Username |
| list value | List of interfaces, in order of preference, for endpoint URL. |
| string value | Minimum Major API version within a given Major API version for endpoint URL discovery. Mutually exclusive with min_version and max_version |
5.1.44. xclarity
The following table outlines the options available under the [xclarity]
group in the /etc/ironic/ironic.conf
file.
Table 5.43. xclarity
Configuration option = Default value | Type | Description |
---|---|---|
| string value | IP address of the XClarity Controller. Configuration here is deprecated and will be removed in the Stein release. Please update the driver_info field to use "xclarity_manager_ip" instead |
| string value | Password for XClarity Controller username. Configuration here is deprecated and will be removed in the Stein release. Please update the driver_info field to use "xclarity_password" instead |
| port value | Port to be used for XClarity Controller connection. |
| string value | Username for the XClarity Controller. Configuration here is deprecated and will be removed in the Stein release. Please update the driver_info field to use "xclarity_username" instead |
Chapter 6. ironic-inspector
The following chapter contains information about the configuration options in the ironic-inspector
service.
6.1. inspector.conf
This section contains options for the /etc/ironic-inspector/inspector.conf
file.
6.1.1. DEFAULT
The following table outlines the options available under the [DEFAULT]
group in the /etc/ironic-inspector/inspector.conf
file.
.
Configuration option = Default value | Type | Description |
---|---|---|
| integer value | Limit the number of elements an API list-call returns |
| string value | Authentication method used on the ironic-inspector API. Either "noauth" or "keystone" are currently valid options. "noauth" will disable all authentication. |
| boolean value | Whether the current installation of ironic-inspector can manage PXE booting of nodes. If set to False, the API will reject introspection requests with manage_boot missing or set to True. |
| integer value | Amount of time in seconds, after which repeat clean up of timed out nodes and old nodes status information. |
| boolean value | If set to true, the logging level will be set to DEBUG instead of the default INFO level. |
| list value | List of package logging levels in logger=LEVEL pairs. This option is ignored if log_config_append is set. |
| boolean value | Whether to enable publishing the ironic-inspector API endpoint via multicast DNS. |
| boolean value | Enables or disables fatal status of deprecations. |
| string value | Name of this node. This can be an opaque identifier. It is not necessarily a hostname, FQDN, or IP address. However, the node name must be valid within an AMQP key, and if using ZeroMQ, a valid hostname, FQDN, or IP address. |
`instance_format = [instance: %(uuid)s] ` | string value | The format for an instance that is passed with the log message. |
`instance_uuid_format = [instance: %(uuid)s] ` | string value | The format for an instance UUID that is passed with the log message. |
| integer value | Delay (in seconds) between two introspections. Only applies when boot is managed by ironic-inspector (i.e. manage_boot==True). |
| list value | Ironic driver_info fields that are equivalent to ipmi_address. |
| string value | IP to listen on. |
| port value | Port to listen on. |
| string value | 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. Note that when logging configuration files are used then all logging configuration is set in the configuration file and other logging configuration options are ignored (for example, log-date-format). |
| string value | Defines the format string for %%(asctime)s in log records. Default: %(default)s . This option is ignored if log_config_append is set. |
| string value | (Optional) The base directory used for relative log_file paths. This option is ignored if log_config_append is set. |
| string value | (Optional) Name of log file to send logging output to. If no default is set, logging will go to stderr as defined by use_stderr. This option is ignored if log_config_append is set. |
| integer value | The amount of time before the log files are rotated. This option is ignored unless log_rotation_type is setto "interval". |
| string value | Rotation interval type. The time of the last file change (or the time when the service was started) is used when scheduling the next rotation. |
| string value | Log rotation type. |
| string value | Format string to use for log messages with context. Used by oslo_log.formatters.ContextFormatter |
| string value | Additional data to append to log message when logging level for the message is DEBUG. Used by oslo_log.formatters.ContextFormatter |
| string value | Format string to use for log messages when context is undefined. Used by oslo_log.formatters.ContextFormatter |
| string value | Prefix each line of exception output with this format. Used by oslo_log.formatters.ContextFormatter |
| string value | Defines the format string for %(user_identity)s that is used in logging_context_format_string. Used by oslo_log.formatters.ContextFormatter |
| integer value | The green thread pool size. |
| integer value | Maximum number of rotated log files. |
| integer value | Log file maximum size in MB. This option is ignored if "log_rotation_type" is not set to "size". |
| boolean value | Enables or disables publication of error events. |
| integer value | Maximum number of logged messages per rate_limit_interval. |
| string value | Log level name used by rate limiting: CRITICAL, ERROR, INFO, WARNING, DEBUG or empty string. Logs with level greater or equal to rate_limit_except_level are not filtered. An empty string means that all levels are filtered. |
| integer value | Interval, number of seconds, of log rate limiting. |
| string value | Path to the rootwrap configuration file to use for running commands as root |
| boolean value | Whether to run ironic-inspector as a standalone service. It’s EXPERIMENTAL to set to False. |
| string value | Syslog facility to receive log lines. This option is ignored if log_config_append is set. |
| integer value | Timeout after which introspection is considered failed, set to 0 to disable. |
| boolean value | Enable journald for logging. If running in a systemd environment you may wish to enable journal support. Doing so will use the journal native protocol which includes structured metadata in addition to log messages.This option is ignored if log_config_append is set. |
| boolean value | Use JSON formatting for logging. This option is ignored if log_config_append is set. |
| boolean value | Use syslog for logging. Existing syslog format is DEPRECATED and will be changed later to honor RFC5424. This option is ignored if log_config_append is set. |
| boolean value | Log output to Windows Event Log. |
| boolean value | SSL Enabled/Disabled |
| boolean value | Log output to standard error. This option is ignored if log_config_append is set. |
| boolean value | Uses logging handler designed to watch file system. When log file is moved or removed this handler will open a new log file with specified path instantaneously. It makes sense only if log_file option is specified and Linux platform is used. This option is ignored if log_config_append is set. |
6.1.2. capabilities
The following table outlines the options available under the [capabilities]
group in the /etc/ironic-inspector/inspector.conf
file.
Table 6.1. capabilities
Configuration option = Default value | Type | Description |
---|---|---|
| boolean value | Whether to store the boot mode (BIOS or UEFI). |
| dict value | Mapping between a CPU flag and a capability to set if this flag is present. |
6.1.3. coordination
The following table outlines the options available under the [coordination]
group in the /etc/ironic-inspector/inspector.conf
file.
Table 6.2. coordination
Configuration option = Default value | Type | Description |
---|---|---|
| string value | The backend URL to use for distributed coordination. EXPERIMENTAL. |
6.1.4. cors
The following table outlines the options available under the [cors]
group in the /etc/ironic-inspector/inspector.conf
file.
Table 6.3. cors
Configuration option = Default value | Type | Description |
---|---|---|
| boolean value | Indicate that the actual request can include user credentials |
| list value | Indicate which header field names may be used during the actual request. |
| list value | Indicate which methods can be used during the actual request. |
| list value | Indicate whether this resource may be shared with the domain received in the requests "origin" header. Format: "<protocol>://<host>[:<port>]", no trailing slash. Example: https://horizon.example.com |
| list value | Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers. |
| integer value | Maximum cache age of CORS preflight requests. |
6.1.5. database
The following table outlines the options available under the [database]
group in the /etc/ironic-inspector/inspector.conf
file.
Table 6.4. database
Configuration option = Default value | Type | Description |
---|---|---|
| string value | The back end to use for the database. |
| string value | The SQLAlchemy connection string to use to connect to the database. |
| integer value | Verbosity of SQL debugging information: 0=None, 100=Everything. |
`connection_parameters = ` | string value | Optional URL parameters to append onto the connection URL at connect time; specify as param1=value1¶m2=value2&… |
| integer value | Connections which have been present in the connection pool longer than this number of seconds will be replaced with a new one the next time they are checked out from the pool. |
| boolean value | Add Python stack traces to SQL as comment strings. |
| boolean value | If True, increases the interval between retries of a database operation up to db_max_retry_interval. |
| integer value | Maximum retries in case of connection error or deadlock error before error is raised. Set to -1 to specify an infinite retry count. |
| integer value | If db_inc_retry_interval is set, the maximum seconds between retries of a database operation. |
| integer value | Seconds between retries of a database transaction. |
| integer value | If set, use this value for max_overflow with SQLAlchemy. |
| integer value | Maximum number of SQL connections to keep open in a pool. Setting a value of 0 indicates no limit. |
| integer value | Maximum number of database connection retries during startup. Set to -1 to specify an infinite retry count. |
| boolean value | If True, transparently enables support for handling MySQL Cluster (NDB). |
| string value | The SQL mode to be used for MySQL sessions. This option, including the default, overrides any server-set SQL mode. To use whatever SQL mode is set by the server configuration, set this to no value. Example: mysql_sql_mode= |
| integer value | If set, use this value for pool_timeout with SQLAlchemy. |
| integer value | Interval between retries of opening a SQL connection. |
| string value | The SQLAlchemy connection string to use to connect to the slave database. |
| boolean value | If True, SQLite uses synchronous mode. |
| boolean value | Enable the experimental use of database reconnect on connection lost. |
6.1.6. discovery
The following table outlines the options available under the [discovery]
group in the /etc/ironic-inspector/inspector.conf
file.
Table 6.5. discovery
Configuration option = Default value | Type | Description |
---|---|---|
| list value | IP version of BMC address that will be used when enrolling a new node in Ironic. Defaults to "4,6". Could be "4" (use v4 address only), "4,6" (v4 address have higher priority and if both addresses found v6 version is ignored), "6,4" (v6 is desired but fall back to v4 address for BMCs having v4 address, opposite to "4,6"), "6" (use v6 address only and ignore v4 version). |
| string value | The name of the Ironic driver used by the enroll hook when creating a new node in Ironic. |
6.1.7. dnsmasq_pxe_filter
The following table outlines the options available under the [dnsmasq_pxe_filter]
group in the /etc/ironic-inspector/inspector.conf
file.
Table 6.6. dnsmasq_pxe_filter
Configuration option = Default value | Type | Description |
---|---|---|
| string value | The MAC address cache directory, exposed to dnsmasq.This directory is expected to be in exclusive control of the driver. |
`dnsmasq_start_command = ` | string value | A (shell) command line to start the dnsmasq service upon filter initialization. Default: don’t start. |
`dnsmasq_stop_command = ` | string value | A (shell) command line to stop the dnsmasq service upon inspector (error) exit. Default: don’t stop. |
| boolean value | Purge the hostsdir upon driver initialization. Setting to false should only be performed when the deployment of inspector is such that there are multiple processes executing inside of the same host and namespace. In this case, the Operator is responsible for setting up a custom cleaning facility. |
6.1.8. iptables
The following table outlines the options available under the [iptables]
group in the /etc/ironic-inspector/inspector.conf
file.
Table 6.7. iptables
Configuration option = Default value | Type | Description |
---|---|---|
| string value | Interface on which dnsmasq listens, the default is for VM’s. |
| list value | List of Etherent Over InfiniBand interfaces on the Inspector host which are used for physical access to the DHCP network. Multiple interfaces would be attached to a bond or bridge specified in dnsmasq_interface. The MACs of the InfiniBand nodes which are not in desired state are going to be blacklisted based on the list of neighbor MACs on these interfaces. |
| string value | iptables chain name to use. |
| string value | The IP version that will be used for iptables filter. Defaults to 4. |
6.1.9. ironic
The following table outlines the options available under the [ironic]
group in the /etc/ironic-inspector/inspector.conf
file.
Table 6.8. ironic
Configuration option = Default value | Type | Description |
---|---|---|
| string value | Authentication URL |
| string value | Authentication type to load |
| string value | PEM encoded Certificate Authority to use when verifying HTTPs connections. |
| string value | PEM encoded client certificate cert file |
| boolean value | Collect per-API call timing information. |
| integer value | The maximum number of retries that should be attempted for connection errors. |
| floating point value | Delay (in seconds) between two retries for connection errors. If not set, exponential retry starting with 0.5 seconds up to a maximum of 60 seconds is used. |
| string value | Optional domain ID to use with v3 and v2 parameters. It will be used for both the user and project domain in v3 and ignored in v2 authentication. |
| string value | Optional domain name to use with v3 API and v2 parameters. It will be used for both the user and project domain in v3 and ignored in v2 authentication. |
| string value | Domain ID to scope to |
| string value | Domain name to scope to |
| string value |
Always use this endpoint URL for requests for this client. NOTE: The unversioned endpoint should be specified here; to request a particular API version, use the |
| boolean value | Verify HTTPS connections. |
| string value | PEM encoded client certificate key file |
| string value | The maximum major version of a given API, intended to be used as the upper bound of a range with min_version. Mutually exclusive with version. |
| integer value | Maximum number of retries in case of conflict error (HTTP 409). |
| string value | The minimum major version of a given API, intended to be used as the lower bound of a range with max_version. Mutually exclusive with version. If min_version is given with no max_version it is as if max version is "latest". |
| string value | User’s password |
| string value | Domain ID containing project |
| string value | Domain name containing project |
| string value | Project ID to scope to |
| string value | Project name to scope to |
| string value | The default region_name for endpoint URL discovery. |
| integer value | Interval between retries in case of conflict error (HTTP 409). |
| string value | The default service_name for endpoint URL discovery. |
| string value | The default service_type for endpoint URL discovery. |
| boolean value | Log requests to multiple loggers. |
| integer value | The maximum number of retries that should be attempted for retriable HTTP status codes. |
| floating point value | Delay (in seconds) between two retries for retriable status codes. If not set, exponential retry starting with 0.5 seconds up to a maximum of 60 seconds is used. |
| string value | Scope for system operations |
| string value | Tenant ID |
| string value | Tenant Name |
| integer value | Timeout value for http requests |
| string value | Trust ID |
| string value | User’s domain id |
| string value | User’s domain name |
| string value | User id |
| string value | Username |
| list value | List of interfaces, in order of preference, for endpoint URL. |
| string value | Minimum Major API version within a given Major API version for endpoint URL discovery. Mutually exclusive with min_version and max_version |
6.1.10. keystone_authtoken
The following table outlines the options available under the [keystone_authtoken]
group in the /etc/ironic-inspector/inspector.conf
file.
Table 6.9. keystone_authtoken
Configuration option = Default value | Type | Description |
---|---|---|
| string value | Config Section from which to load plugin specific options |
| string value | Authentication type to load |
| string value | (DEPRECATED FOR REMOVAL) Complete "public" Identity API endpoint. This endpoint should not be an "admin" endpoint, as it should be accessible by all end users. Unauthenticated clients are redirected to this endpoint to authenticate. Although this endpoint should ideally be unversioned, client support in the wild varies. If you’re using a versioned v2 endpoint here, then this should not be the same endpoint the service user utilizes for validating tokens, because normal end users may not be able to reach that endpoint. This option is deprecated in favor of www_authenticate_uri and will be removed in the S release. |
| string value | API version of the Identity API endpoint. |
| string value |
Request environment key where the Swift cache object is stored. When auth_token middleware is deployed with a Swift cache, use this option to have the middleware share a caching backend with swift. Otherwise, use the |
| string value | A PEM encoded Certificate Authority to use when verifying HTTPs connections. Defaults to system CAs. |
| string value | Required if identity server requires client certificate |
| boolean value | Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components. |
| string value | Used to control the use and type of token binding. Can be set to: "disabled" to not check token binding. "permissive" (default) to validate binding information if the bind type is of a form known to the server and ignore it if not. "strict" like "permissive" but if the bind type is unknown the token will be rejected. "required" any form of token binding is needed to be allowed. Finally the name of a binding method that must be present in tokens. |
| integer value | Request timeout value for communicating with Identity API server. |
| integer value | How many times are we trying to reconnect when communicating with Identity API Server. |
| boolean value | (Optional) Indicate whether to set the X-Service-Catalog header. If False, middleware will not ask for service catalog on token validation and will not set the X-Service-Catalog header. |
| boolean value | Verify HTTPS connections. |
| string value | Interface to use for the Identity API endpoint. Valid values are "public", "internal" or "admin"(default). |
| string value | Required if identity server requires client certificate |
| integer value | (Optional) Number of seconds that an operation will wait to get a memcached client connection from the pool. |
| integer value | (Optional) Number of seconds memcached server is considered dead before it is tried again. |
| integer value | (Optional) Maximum total number of open connections to every memcached server. |
| integer value | (Optional) Socket timeout in seconds for communicating with a memcached server. |
| integer value | (Optional) Number of seconds a connection to memcached is held unused in the pool before it is closed. |
| string value | (Optional, mandatory if memcache_security_strategy is defined) This string is used for key derivation. |
| string value | (Optional) If defined, indicate whether token data should be authenticated or authenticated and encrypted. If MAC, token data is authenticated (with HMAC) in the cache. If ENCRYPT, token data is encrypted and authenticated in the cache. If the value is not one of these options or empty, auth_token will raise an exception on initialization. |
| boolean value | (Optional) Use the advanced (eventlet safe) memcached client pool. The advanced pool will only work under python 2.x. |
| list value | Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process. |
| string value | The region in which the identity server can be found. |
| list value | A choice of roles that must be present in a service token. Service tokens are allowed to request that an expired token can be used and so this check should tightly control that only actual services should be sending this token. Roles here are applied as an ANY check so any role in this list must be present. For backwards compatibility reasons this currently only affects the allow_expired check. |
| boolean value | For backwards compatibility reasons we must let valid service tokens pass that don’t pass the service_token_roles check as valid. Setting this true will become the default in a future release and should be enabled if possible. |
| string value | The name or type of the service as it appears in the service catalog. This is used to validate tokens that have restricted access rules. |
| integer value | In order to prevent excessive effort spent validating tokens, the middleware caches previously-seen tokens for a configurable duration (in seconds). Set to -1 to disable caching completely. |
| string value | Complete "public" Identity API endpoint. This endpoint should not be an "admin" endpoint, as it should be accessible by all end users. Unauthenticated clients are redirected to this endpoint to authenticate. Although this endpoint should ideally be unversioned, client support in the wild varies. If you’re using a versioned v2 endpoint here, then this should not be the same endpoint the service user utilizes for validating tokens, because normal end users may not be able to reach that endpoint. |
6.1.11. oslo_policy
The following table outlines the options available under the [oslo_policy]
group in the /etc/ironic-inspector/inspector.conf
file.
Table 6.10. oslo_policy
Configuration option = Default value | Type | Description |
---|---|---|
| boolean value |
This option controls whether or not to enforce scope when evaluating policies. If |
| string value | Default rule. Enforced when a requested rule is not found. |
| multi valued | 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. |
| string value | The relative or absolute path of a file that maps roles to permissions for a given service. Relative paths must be specified in relation to the configuration file setting this option. |
| string value | Content Type to send and receive data for REST based policy check |
| string value | Absolute path to ca cert file for REST based policy check |
| string value | Absolute path to client cert for REST based policy check |
| string value | Absolute path client key file REST based policy check |
| boolean value | server identity verification for REST based policy check |
6.1.12. pci_devices
The following table outlines the options available under the [pci_devices]
group in the /etc/ironic-inspector/inspector.conf
file.
Table 6.11. pci_devices
Configuration option = Default value | Type | Description |
---|---|---|
| multi valued | An alias for PCI device identified by vendor_id and product_id fields. Format: {"vendor_id": "1234", "product_id": "5678", "name": "pci_dev1"} |
6.1.13. processing
The following table outlines the options available under the [processing]
group in the /etc/ironic-inspector/inspector.conf
file.
Table 6.12. processing
Configuration option = Default value | Type | Description |
---|---|---|
| string value | Which MAC addresses to add as ports during introspection. Possible values: all (all MAC addresses), active (MAC addresses of NIC with IP addresses), pxe (only MAC address of NIC node PXE booted from, falls back to "active" if PXE MAC is not supplied by the ramdisk). |
| boolean value | Whether to store ramdisk logs even if it did not return an error message (dependent upon "ramdisk_logs_dir" option being set). |
| string value | Comma-separated list of default hooks for processing pipeline. Hook scheduler updates the node with the minimum properties required by the Nova scheduler. Hook validate_interfaces ensures that valid NIC data was provided by the ramdisk. Do not exclude these two unless you really know what you’re doing. |
| boolean value | Whether to leave 1 GiB of disk size untouched for partitioning. Only has effect when used with the IPA as a ramdisk, for older ramdisk local_gb is calculated on the ramdisk side. |
| string value | Which ports (already present on a node) to keep after introspection. Possible values: all (do not delete anything), present (keep ports which MACs were present in introspection data), added (keep only MACs that we added during introspection). |
| string value | The name of the hook to run when inspector receives inspection information from a node it isn’t already aware of. This hook is ignored by default. |
| boolean value | Whether to overwrite existing values in node database. Disable this option to make introspection a non-destructive operation. |
| boolean value | Whether to process nodes that are in running states. |
| boolean value | Whether to power off a node after introspection.Nodes in active or rescue states which submit introspection data will be left on if the feature is enabled via the permit_active_introspection configuration option. |
| string value | Comma-separated list of enabled hooks for processing pipeline. The default for this is $default_processing_hooks, hooks can be added before or after the defaults like this: "prehook,$default_processing_hooks,posthook". |
| string value | If set, logs from ramdisk will be stored in this directory. |
| string value | File name template for storing ramdisk logs. The following replacements can be used: {uuid} - node UUID or "unknown", {bmc} - node BMC address or "unknown", {dt} - current UTC date and time, {mac} - PXE booting MAC or "unknown". |
| string value | The storage backend for storing introspection data. Possible values are: none, database and swift. If set to none, introspection data will not be stored. |
6.1.14. pxe_filter
The following table outlines the options available under the [pxe_filter]
group in the /etc/ironic-inspector/inspector.conf
file.
Table 6.13. pxe_filter
Configuration option = Default value | Type | Description |
---|---|---|
| string value | PXE boot filter driver to use, possible filters are: "iptables", "dnsmasq" and "noop". Set "noop " to disable the firewall filtering. |
| integer value | Amount of time in seconds, after which repeat periodic update of the filter. |
6.1.15. service_catalog
The following table outlines the options available under the [service_catalog]
group in the /etc/ironic-inspector/inspector.conf
file.
Table 6.14. service_catalog
Configuration option = Default value | Type | Description |
---|---|---|
| string value | Authentication URL |
| string value | Authentication type to load |
| string value | PEM encoded Certificate Authority to use when verifying HTTPs connections. |
| string value | PEM encoded client certificate cert file |
| boolean value | Collect per-API call timing information. |
| integer value | The maximum number of retries that should be attempted for connection errors. |
| floating point value | Delay (in seconds) between two retries for connection errors. If not set, exponential retry starting with 0.5 seconds up to a maximum of 60 seconds is used. |
| string value | Optional domain ID to use with v3 and v2 parameters. It will be used for both the user and project domain in v3 and ignored in v2 authentication. |
| string value | Optional domain name to use with v3 API and v2 parameters. It will be used for both the user and project domain in v3 and ignored in v2 authentication. |
| string value | Domain ID to scope to |
| string value | Domain name to scope to |
| string value |
Always use this endpoint URL for requests for this client. NOTE: The unversioned endpoint should be specified here; to request a particular API version, use the |
| boolean value | Verify HTTPS connections. |
| string value | PEM encoded client certificate key file |
| string value | The maximum major version of a given API, intended to be used as the upper bound of a range with min_version. Mutually exclusive with version. |
| string value | The minimum major version of a given API, intended to be used as the lower bound of a range with max_version. Mutually exclusive with version. If min_version is given with no max_version it is as if max version is "latest". |
| string value | User’s password |
| string value | Domain ID containing project |
| string value | Domain name containing project |
| string value | Project ID to scope to |
| string value | Project name to scope to |
| string value | The default region_name for endpoint URL discovery. |
| string value | The default service_name for endpoint URL discovery. |
| string value | The default service_type for endpoint URL discovery. |
| boolean value | Log requests to multiple loggers. |
| integer value | The maximum number of retries that should be attempted for retriable HTTP status codes. |
| floating point value | Delay (in seconds) between two retries for retriable status codes. If not set, exponential retry starting with 0.5 seconds up to a maximum of 60 seconds is used. |
| string value | Scope for system operations |
| string value | Tenant ID |
| string value | Tenant Name |
| integer value | Timeout value for http requests |
| string value | Trust ID |
| string value | User’s domain id |
| string value | User’s domain name |
| string value | User id |
| string value | Username |
| list value | List of interfaces, in order of preference, for endpoint URL. |
| string value | Minimum Major API version within a given Major API version for endpoint URL discovery. Mutually exclusive with min_version and max_version |
6.1.16. swift
The following table outlines the options available under the [swift]
group in the /etc/ironic-inspector/inspector.conf
file.
Table 6.15. swift
Configuration option = Default value | Type | Description |
---|---|---|
| string value | Authentication URL |
| string value | Authentication type to load |
| string value | PEM encoded Certificate Authority to use when verifying HTTPs connections. |
| string value | PEM encoded client certificate cert file |
| boolean value | Collect per-API call timing information. |
| integer value | The maximum number of retries that should be attempted for connection errors. |
| floating point value | Delay (in seconds) between two retries for connection errors. If not set, exponential retry starting with 0.5 seconds up to a maximum of 60 seconds is used. |
| string value | Default Swift container to use when creating objects. |
| string value | Optional domain ID to use with v3 and v2 parameters. It will be used for both the user and project domain in v3 and ignored in v2 authentication. |
| string value | Optional domain name to use with v3 API and v2 parameters. It will be used for both the user and project domain in v3 and ignored in v2 authentication. |
| integer value | Number of seconds that the Swift object will last before being deleted. (set to 0 to never delete the object). |
| string value | Domain ID to scope to |
| string value | Domain name to scope to |
| string value |
Always use this endpoint URL for requests for this client. NOTE: The unversioned endpoint should be specified here; to request a particular API version, use the |
| boolean value | Verify HTTPS connections. |
| string value | PEM encoded client certificate key file |
| string value | The maximum major version of a given API, intended to be used as the upper bound of a range with min_version. Mutually exclusive with version. |
| integer value | (DEPRECATED FOR REMOVAL) This option is deprecated and has no effect. |
| string value | The minimum major version of a given API, intended to be used as the lower bound of a range with max_version. Mutually exclusive with version. If min_version is given with no max_version it is as if max version is "latest". |
| string value | User’s password |
| string value | Domain ID containing project |
| string value | Domain name containing project |
| string value | Project ID to scope to |
| string value | Project name to scope to |
| string value | The default region_name for endpoint URL discovery. |
| string value | The default service_name for endpoint URL discovery. |
| string value | The default service_type for endpoint URL discovery. |
| boolean value | Log requests to multiple loggers. |
| integer value | The maximum number of retries that should be attempted for retriable HTTP status codes. |
| floating point value | Delay (in seconds) between two retries for retriable status codes. If not set, exponential retry starting with 0.5 seconds up to a maximum of 60 seconds is used. |
| string value | Scope for system operations |
| string value | Tenant ID |
| string value | Tenant Name |
| integer value | Timeout value for http requests |
| string value | Trust ID |
| string value | User’s domain id |
| string value | User’s domain name |
| string value | User id |
| string value | Username |
| list value | List of interfaces, in order of preference, for endpoint URL. |
| string value | Minimum Major API version within a given Major API version for endpoint URL discovery. Mutually exclusive with min_version and max_version |
Chapter 7. keystone
The following chapter contains information about the configuration options in the keystone
service.
7.1. keystone.conf
This section contains options for the /etc/keystone/keystone.conf
file.
7.1.1. DEFAULT
The following table outlines the options available under the [DEFAULT]
group in the /etc/keystone/keystone.conf
file.
.
Configuration option = Default value | Type | Description |
---|---|---|
| string value |
Using this feature is NOT recommended. Instead, use the |
| integer value | The pool size limit for connections expiration policy |
| integer value | The time-to-live in sec of idle connections in the pool |
| string value | The default exchange under which topics are scoped. May be overridden by an exchange name specified in the transport_url option. |
| boolean value | If set to true, the logging level will be set to DEBUG instead of the default INFO level. |
| list value | List of package logging levels in logger=LEVEL pairs. This option is ignored if log_config_append is set. |
| string value |
Default |
| integer value | Size of executor thread pool when executor is threading or eventlet. |
| boolean value | Enables or disables fatal status of deprecations. |
| boolean value | If set to true, then the server will return information in HTTP responses that may allow an unauthenticated or authenticated user to get more information than normal, such as additional details about why authentication failed. This may be useful for debugging but is insecure. |
`instance_format = [instance: %(uuid)s] ` | string value | The format for an instance that is passed with the log message. |
`instance_uuid_format = [instance: %(uuid)s] ` | string value | The format for an instance UUID that is passed with the log message. |
| integer value |
The maximum number of entities that will be returned in a collection. This global limit may be then overridden for a specific driver, by specifying a list_limit in the appropriate section (for example, |
| string value | 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. Note that when logging configuration files are used then all logging configuration is set in the configuration file and other logging configuration options are ignored (for example, log-date-format). |
| string value | Defines the format string for %%(asctime)s in log records. Default: %(default)s . This option is ignored if log_config_append is set. |
| string value | (Optional) The base directory used for relative log_file paths. This option is ignored if log_config_append is set. |
| string value | (Optional) Name of log file to send logging output to. If no default is set, logging will go to stderr as defined by use_stderr. This option is ignored if log_config_append is set. |
| integer value | The amount of time before the log files are rotated. This option is ignored unless log_rotation_type is setto "interval". |
| string value | Rotation interval type. The time of the last file change (or the time when the service was started) is used when scheduling the next rotation. |
| string value | Log rotation type. |
| string value | Format string to use for log messages with context. Used by oslo_log.formatters.ContextFormatter |
| string value | Additional data to append to log message when logging level for the message is DEBUG. Used by oslo_log.formatters.ContextFormatter |
| string value | Format string to use for log messages when context is undefined. Used by oslo_log.formatters.ContextFormatter |
| string value | Prefix each line of exception output with this format. Used by oslo_log.formatters.ContextFormatter |
| string value | Defines the format string for %(user_identity)s that is used in logging_context_format_string. Used by oslo_log.formatters.ContextFormatter |
| integer value | Maximum number of rotated log files. |
| integer value | Log file maximum size in MB. This option is ignored if "log_rotation_type" is not set to "size". |
| integer value | Limit the sizes of user & project ID/names. |
| integer value | Maximum depth of the project hierarchy, excluding the project acting as a domain at the top of the hierarchy. WARNING: Setting it to a large value may adversely impact performance. |
| integer value |
Similar to |
| string value |
Define the notification format for identity service events. A |
| multi valued |
You can reduce the number of notifications keystone emits by explicitly opting out. Keystone will not emit notifications that match the patterns expressed in this list. Values are expected to be in the form of |
| uri value |
The base public endpoint URL for Keystone that is advertised to clients (NOTE: this does NOT affect how Keystone listens for connections). Defaults to the base host URL of the request. For example, if keystone receives a request to |
| boolean value | Enables or disables publication of error events. |
| integer value | Maximum number of logged messages per rate_limit_interval. |
| string value | Log level name used by rate limiting: CRITICAL, ERROR, INFO, WARNING, DEBUG or empty string. Logs with level greater or equal to rate_limit_except_level are not filtered. An empty string means that all levels are filtered. |
| integer value | Interval, number of seconds, of log rate limiting. |
| integer value | Size of RPC connection pool. |
| integer value | Seconds to wait for a response from a call. |
| boolean value | If set to true, strict password length checking is performed for password manipulation. If a password exceeds the maximum length, the operation will fail with an HTTP 403 Forbidden error. If set to false, passwords are automatically truncated to the maximum length. |
| string value | Syslog facility to receive log lines. This option is ignored if log_config_append is set. |
| string value | The network address and optional user credentials for connecting to the messaging backend, in URL format. The expected format is: driver://[user:pass@]host:port[,[userN:passN@]hostN:portN]/virtual_host?query Example: rabbit://rabbitmq:password@127.0.0.1:5672// For full details on the fields in the URL see the documentation of oslo_messaging.TransportURL at https://docs.openstack.org/oslo.messaging/latest/reference/transport.html |
| boolean value | Enable journald for logging. If running in a systemd environment you may wish to enable journal support. Doing so will use the journal native protocol which includes structured metadata in addition to log messages.This option is ignored if log_config_append is set. |
| boolean value | Use JSON formatting for logging. This option is ignored if log_config_append is set. |
| boolean value | Use syslog for logging. Existing syslog format is DEPRECATED and will be changed later to honor RFC5424. This option is ignored if log_config_append is set. |
| boolean value | Log output to Windows Event Log. |
| boolean value | Log output to standard error. This option is ignored if log_config_append is set. |
| boolean value | Uses logging handler designed to watch file system. When log file is moved or removed this handler will open a new log file with specified path instantaneously. It makes sense only if log_file option is specified and Linux platform is used. This option is ignored if log_config_append is set. |
7.1.2. application_credential
The following table outlines the options available under the [application_credential]
group in the /etc/keystone/keystone.conf
file.
Table 7.1. application_credential
Configuration option = Default value | Type | Description |
---|---|---|
| integer value | Time to cache application credential data in seconds. This has no effect unless global caching is enabled. |
| boolean value | Toggle for application credential caching. This has no effect unless global caching is enabled. |
| string value |
Entry point for the application credential backend driver in the |
| integer value | Maximum number of application credentials a user is permitted to create. A value of -1 means unlimited. If a limit is not set, users are permitted to create application credentials at will, which could lead to bloat in the keystone database or open keystone to a DoS attack. |
7.1.3. assignment
The following table outlines the options available under the [assignment]
group in the /etc/keystone/keystone.conf
file.
Table 7.2. assignment
Configuration option = Default value | Type | Description |
---|---|---|
| string value |
Entry point for the assignment backend driver (where role assignments are stored) in the |
| list value | A list of role names which are prohibited from being an implied role. |
7.1.4. auth
The following table outlines the options available under the [auth]
group in the /etc/keystone/keystone.conf
file.
Table 7.3. auth
Configuration option = Default value | Type | Description |
---|---|---|
| string value |
Entry point for the application_credential auth plugin module in the |
| string value |
Entry point for the external ( |
| string value |
Entry point for the mapped auth plugin module in the |
| list value |
Allowed authentication methods. Note: You should disable the |
| string value |
Entry point for the OAuth 1.0a auth plugin module in the |
| string value |
Entry point for the password auth plugin module in the |
| string value |
Entry point for the token auth plugin module in the |
7.1.5. cache
The following table outlines the options available under the [cache]
group in the /etc/keystone/keystone.conf
file.
Table 7.4. cache
Configuration option = Default value | Type | Description |
---|---|---|
| string value | Cache backend module. For eventlet-based or environments with hundreds of threaded servers, Memcache with pooling (oslo_cache.memcache_pool) is recommended. For environments with less than 100 threaded servers, Memcached (dogpile.cache.memcached) or Redis (dogpile.cache.redis) is recommended. Test environments with a single instance of the server can use the dogpile.cache.memory backend. |
| multi valued | Arguments supplied to the backend module. Specify this option once per argument to be passed to the dogpile.cache backend. Example format: "<argname>:<value>". |
| string value | Prefix for building the configuration dictionary for the cache region. This should not need to be changed unless there is another dogpile.cache region with the same configuration name. |
| boolean value | Extra debugging from the cache backend (cache keys, get/set/delete/etc calls). This is only really useful if you need to see the specific cache-backend get/set/delete calls with the keys/values. Typically this should be left set to false. |
| boolean value | Global toggle for caching. |
| integer value | Default TTL, in seconds, for any cached item in the dogpile.cache region. This applies to any cached method that doesn’t have an explicit cache expiration time defined for it. |
| integer value | Number of seconds memcached server is considered dead before it is tried again. (dogpile.cache.memcache and oslo_cache.memcache_pool backends only). |
| integer value | Number of seconds that an operation will wait to get a memcache client connection. |
| integer value | Max total number of open connections to every memcached server. (oslo_cache.memcache_pool backend only). |
| integer value | Number of seconds a connection to memcached is held unused in the pool before it is closed. (oslo_cache.memcache_pool backend only). |
| list value | Memcache servers in the format of "host:port". (dogpile.cache.memcache and oslo_cache.memcache_pool backends only). |
| floating point value | Timeout in seconds for every call to a server. (dogpile.cache.memcache and oslo_cache.memcache_pool backends only). |
| list value | Proxy classes to import that will affect the way the dogpile.cache backend functions. See the dogpile.cache documentation on changing-backend-behavior. |
7.1.6. catalog
The following table outlines the options available under the [catalog]
group in the /etc/keystone/keystone.conf
file.
Table 7.5. catalog
Configuration option = Default value | Type | Description |
---|---|---|
| integer value | Time to cache catalog data (in seconds). This has no effect unless global and catalog caching are both enabled. Catalog data (services, endpoints, etc.) typically does not change frequently, and so a longer duration than the global default may be desirable. |
| boolean value | Toggle for catalog caching. This has no effect unless global caching is enabled. In a typical deployment, there is no reason to disable this. |
| string value |
Entry point for the catalog driver in the |
| integer value | Maximum number of entities that will be returned in a catalog collection. There is typically no reason to set this, as it would be unusual for a deployment to have enough services or endpoints to exceed a reasonable limit. |
| string value |
Absolute path to the file used for the templated catalog backend. This option is only used if the |
7.1.7. cors
The following table outlines the options available under the [cors]
group in the /etc/keystone/keystone.conf
file.
Table 7.6. cors
Configuration option = Default value | Type | Description |
---|---|---|
| boolean value | Indicate that the actual request can include user credentials |
| list value | Indicate which header field names may be used during the actual request. |
| list value | Indicate which methods can be used during the actual request. |
| list value | Indicate whether this resource may be shared with the domain received in the requests "origin" header. Format: "<protocol>://<host>[:<port>]", no trailing slash. Example: https://horizon.example.com |
| list value | Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers. |
| integer value | Maximum cache age of CORS preflight requests. |
7.1.8. credential
The following table outlines the options available under the [credential]
group in the /etc/keystone/keystone.conf
file.
Table 7.7. credential
Configuration option = Default value | Type | Description |
---|---|---|
| integer value | The length of time in minutes for which a signed EC2 or S3 token request is valid from the timestamp contained in the token request. |
| integer value | Time to cache credential data in seconds. This has no effect unless global caching is enabled. |
| boolean value | Toggle for caching only on retrieval of user credentials. This has no effect unless global caching is enabled. |
| string value |
Entry point for the credential backend driver in the |
| string value | Directory containing Fernet keys used to encrypt and decrypt credentials stored in the credential backend. Fernet keys used to encrypt credentials have no relationship to Fernet keys used to encrypt Fernet tokens. Both sets of keys should be managed separately and require different rotation policies. Do not share this repository with the repository used to manage keys for Fernet tokens. |
| string value |
Entry point for credential encryption and decryption operations in the |
7.1.9. database
The following table outlines the options available under the [database]
group in the /etc/keystone/keystone.conf
file.
Table 7.8. database
Configuration option = Default value | Type | Description |
---|---|---|
| string value | The back end to use for the database. |
| string value | The SQLAlchemy connection string to use to connect to the database. |
| integer value | Verbosity of SQL debugging information: 0=None, 100=Everything. |
`connection_parameters = ` | string value | Optional URL parameters to append onto the connection URL at connect time; specify as param1=value1¶m2=value2&… |
| integer value | Connections which have been present in the connection pool longer than this number of seconds will be replaced with a new one the next time they are checked out from the pool. |
| boolean value | Add Python stack traces to SQL as comment strings. |
| boolean value | If True, increases the interval between retries of a database operation up to db_max_retry_interval. |
| integer value | Maximum retries in case of connection error or deadlock error before error is raised. Set to -1 to specify an infinite retry count. |
| integer value | If db_inc_retry_interval is set, the maximum seconds between retries of a database operation. |
| integer value | Seconds between retries of a database transaction. |
| integer value | If set, use this value for max_overflow with SQLAlchemy. |
| integer value | Maximum number of SQL connections to keep open in a pool. Setting a value of 0 indicates no limit. |
| integer value | Maximum number of database connection retries during startup. Set to -1 to specify an infinite retry count. |
| boolean value | If True, transparently enables support for handling MySQL Cluster (NDB). |
| string value | The SQL mode to be used for MySQL sessions. This option, including the default, overrides any server-set SQL mode. To use whatever SQL mode is set by the server configuration, set this to no value. Example: mysql_sql_mode= |
| integer value | If set, use this value for pool_timeout with SQLAlchemy. |
| integer value | Interval between retries of opening a SQL connection. |
| string value | The SQLAlchemy connection string to use to connect to the slave database. |
| boolean value | If True, SQLite uses synchronous mode. |
| boolean value | Enable the experimental use of database reconnect on connection lost. |
7.1.10. domain_config
The following table outlines the options available under the [domain_config]
group in the /etc/keystone/keystone.conf
file.
Table 7.9. domain_config
Configuration option = Default value | Type | Description |
---|---|---|
| integer value |
Time-to-live (TTL, in seconds) to cache domain-specific configuration data. This has no effect unless |
| boolean value | Toggle for caching of the domain-specific configuration backend. This has no effect unless global caching is enabled. There is normally no reason to disable this. |
| string value |
Entry point for the domain-specific configuration driver in the |
7.1.11. endpoint_filter
The following table outlines the options available under the [endpoint_filter]
group in the /etc/keystone/keystone.conf
file.
Table 7.10. endpoint_filter
Configuration option = Default value | Type | Description |
---|---|---|
| string value |
Entry point for the endpoint filter driver in the |
| boolean value | This controls keystone’s behavior if the configured endpoint filters do not result in any endpoints for a user + project pair (and therefore a potentially empty service catalog). If set to true, keystone will return the entire service catalog. If set to false, keystone will return an empty service catalog. |
7.1.12. endpoint_policy
The following table outlines the options available under the [endpoint_policy]
group in the /etc/keystone/keystone.conf
file.
Table 7.11. endpoint_policy
Configuration option = Default value | Type | Description |
---|---|---|
| string value |
Entry point for the endpoint policy driver in the |
7.1.13. eventlet_server
The following table outlines the options available under the [eventlet_server]
group in the /etc/keystone/keystone.conf
file.
Table 7.12. eventlet_server
Configuration option = Default value | Type | Description |
---|---|---|
| host address value | (DEPRECATED FOR REMOVAL) The IP address of the network interface for the admin service to listen on. |
| port value | (DEPRECATED FOR REMOVAL) The port number for the admin service to listen on. |
| host address value | (DEPRECATED FOR REMOVAL) The IP address of the network interface for the public service to listen on. |
| port value | (DEPRECATED FOR REMOVAL) The port number for the public service to listen on. |
7.1.14. federation
The following table outlines the options available under the [federation]
group in the /etc/keystone/keystone.conf
file.
Table 7.13. federation
Configuration option = Default value | Type | Description |
---|---|---|
`assertion_prefix = ` | string value | Prefix to use when filtering environment variable names for federated assertions. Matched variables are passed into the federated mapping engine. |
| boolean value | Toggle for federation caching. This has no effect unless global caching is enabled. There is typically no reason to disable this. |
| string value |
Entry point for the federation backend driver in the |
| string value | (DEPRECATED FOR REMOVAL) An arbitrary domain name that is reserved to allow federated ephemeral users to have a domain concept. Note that an admin will not be able to create a domain with this name or update an existing domain to this name. You are not advised to change this value unless you really have to. |
| string value |
Default value for all protocols to be used to obtain the entity ID of the Identity Provider from the environment. For |
| string value | Absolute path to an HTML file used as a Single Sign-On callback handler. This page is expected to redirect the user from keystone back to a trusted dashboard host, by form encoding a token in a POST request. Keystone’s default value should be sufficient for most deployments. |
| multi valued | A list of trusted dashboard hosts. Before accepting a Single Sign-On request to return a token, the origin host must be a member of this list. This configuration option may be repeated for multiple values. You must set this in order to use web-based SSO flows. For example: trusted_dashboard=https://acme.example.com/auth/websso trusted_dashboard=https://beta.example.com/auth/websso |
7.1.15. fernet_receipts
The following table outlines the options available under the [fernet_receipts]
group in the /etc/keystone/keystone.conf
file.
Table 7.14. fernet_receipts
Configuration option = Default value | Type | Description |
---|---|---|
| string value |
Directory containing Fernet receipt keys. This directory must exist before using |
| integer value |
This controls how many keys are held in rotation by |
7.1.16. fernet_tokens
The following table outlines the options available under the [fernet_tokens]
group in the /etc/keystone/keystone.conf
file.
Table 7.15. fernet_tokens
Configuration option = Default value | Type | Description |
---|---|---|
| string value |
Directory containing Fernet token keys. This directory must exist before using |
| integer value |
This controls how many keys are held in rotation by |
7.1.17. healthcheck
The following table outlines the options available under the [healthcheck]
group in the /etc/keystone/keystone.conf
file.
Table 7.16. healthcheck
Configuration option = Default value | Type | Description |
---|---|---|
| list value | Additional backends that can perform health checks and report that information back as part of a request. |
| boolean value | Show more detailed information as part of the response. Security note: Enabling this option may expose sensitive details about the service being monitored. Be sure to verify that it will not violate your security policies. |
| string value | Check the presence of a file to determine if an application is running on a port. Used by DisableByFileHealthcheck plugin. |
| list value | Check the presence of a file based on a port to determine if an application is running on a port. Expects a "port:path" list of strings. Used by DisableByFilesPortsHealthcheck plugin. |
| string value | (DEPRECATED FOR REMOVAL) The path to respond to healtcheck requests on. |
7.1.18. identity
The following table outlines the options available under the [identity]
group in the /etc/keystone/keystone.conf
file.
Table 7.17. identity
Configuration option = Default value | Type | Description |
---|---|---|
| integer value | Time to cache identity data (in seconds). This has no effect unless global and identity caching are enabled. |
| boolean value | Toggle for identity caching. This has no effect unless global caching is enabled. There is typically no reason to disable this. |
| string value |
This references the domain to use for all Identity API v2 requests (which are not aware of domains). A domain with this ID can optionally be created for you by |
| string value |
Absolute path where keystone should locate domain-specific |
| boolean value |
By default, domain-specific configuration data is read from files in the directory identified by |
| boolean value |
A subset (or all) of domains can have their own identity driver, each with their own partial configuration options, stored in either the resource backend or in a file in a domain configuration directory (depending on the setting of |
| string value |
Entry point for the identity backend driver in the |
| integer value | Maximum number of entities that will be returned in an identity collection. |
| integer value | Maximum allowed length for user passwords. Decrease this value to improve performance. Changing this value does not effect existing passwords. |
| string value | The password hashing algorithm to use for passwords stored within keystone. |
| integer value |
This option represents a trade off between security and performance. Higher values lead to slower performance, but higher security. Changing this option will only affect newly created passwords as existing password hashes already have a fixed number of rounds applied, so it is safe to tune this option in a running cluster. The default for bcrypt is 12, must be between 4 and 31, inclusive. The default for scrypt is 16, must be within |
| integer value | Number of bytes to use in scrypt and pbkfd2_sha512 hashing salt. Default for scrypt is 16 bytes. Default for pbkfd2_sha512 is 16 bytes. Limited to a maximum of 96 bytes due to the size of the column used to store password hashes. |
| integer value |
Optional block size to pass to scrypt hash function (the |
| integer value |
Optional parallelism to pass to scrypt hash function (the |
7.1.19. identity_mapping
The following table outlines the options available under the [identity_mapping]
group in the /etc/keystone/keystone.conf
file.
Table 7.18. identity_mapping
Configuration option = Default value | Type | Description |
---|---|---|
| boolean value |
The format of user and group IDs changed in Juno for backends that do not generate UUIDs (for example, LDAP), with keystone providing a hash mapping to the underlying attribute in LDAP. By default this mapping is disabled, which ensures that existing IDs will not change. Even when the mapping is enabled by using domain-specific drivers ( |
| string value |
Entry point for the identity mapping backend driver in the |
| string value |
Entry point for the public ID generator for user and group entities in the |
7.1.20. jwt_tokens
The following table outlines the options available under the [jwt_tokens]
group in the /etc/keystone/keystone.conf
file.
Table 7.19. jwt_tokens
Configuration option = Default value | Type | Description |
---|---|---|
| string value |
Directory containing private keys for signing JWS tokens. This directory must exist in order for keystone’s server process to start. It must also be readable by keystone’s server process. It must contain at least one private key that corresponds to a public key in |
| string value |
Directory containing public keys for validating JWS token signatures. This directory must exist in order for keystone’s server process to start. It must also be readable by keystone’s server process. It must contain at least one public key that corresponds to a private key in |
7.1.21. ldap
The following table outlines the options available under the [ldap]
group in the /etc/keystone/keystone.conf
file.
Table 7.20. ldap
Configuration option = Default value | Type | Description |
---|---|---|
| string value |
The LDAP dereferencing option to use for queries involving aliases. A value of |
| integer value |
The maximum end user authentication connection lifetime to the LDAP server in seconds. When this lifetime is exceeded, the connection will be unbound and removed from the connection pool. This option has no effect unless |
| integer value |
The size of the connection pool to use for end user authentication. This option has no effect unless |
| boolean value | Sets keystone’s referral chasing behavior across directory partitions. If left unset, the system’s default behavior will be used. |
| integer value |
The connection timeout to use with the LDAP server. A value of |
| integer value | Sets the LDAP debugging level for LDAP calls. A value of 0 means that debugging is not enabled. This value is a bitmask, consult your LDAP documentation for possible values. |
| boolean value | If enabled, group queries will use Active Directory specific filters for nested groups. |
| list value |
A list of LDAP attribute to keystone group attribute pairs used for mapping additional attributes to groups in keystone. The expected format is |
| list value | List of group attributes to ignore on create and update. or whether a specific group attribute should be filtered for list or show group. |
| string value | The LDAP attribute mapped to group descriptions in keystone. |
| string value | The LDAP search filter to use for groups. |
| string value | The LDAP attribute mapped to group IDs in keystone. This must NOT be a multivalued attribute. Group IDs are expected to be globally unique across keystone domains and URL-safe. |
| string value | The LDAP attribute used to indicate that a user is a member of the group. |
| boolean value |
Enable this option if the members of the group object class are keystone user IDs rather than LDAP DNs. This is the case when using |
| string value | The LDAP attribute mapped to group names in keystone. Group names are expected to be unique only within a keystone domain and are not expected to be URL-safe. |
| string value |
The LDAP object class to use for groups. If setting this option to |
| string value |
The search base to use for groups. Defaults to the |
| integer value |
Defines the maximum number of results per page that keystone should request from the LDAP server when listing objects. A value of zero ( |
| string value | The password of the administrator bind DN to use when querying the LDAP server, if your LDAP server requires it. |
| integer value |
The maximum connection lifetime to the LDAP server in seconds. When this lifetime is exceeded, the connection will be unbound and removed from the connection pool. This option has no effect unless |
| integer value |
The connection timeout to use when pooling LDAP connections. A value of |
| floating point value |
The number of seconds to wait before attempting to reconnect to the LDAP server. This option has no effect unless |
| integer value |
The maximum number of times to attempt reconnecting to the LDAP server before aborting. A value of zero prevents retries. This option has no effect unless |
| integer value |
The size of the LDAP connection pool. This option has no effect unless |
| string value |
The search scope which defines how deep to search within the search base. A value of |
| string value |
The default LDAP server suffix to use, if a DN is not defined via either |
| string value |
An absolute path to a CA certificate directory to use when communicating with LDAP servers. There is no reason to set this option if you’ve also set |
| string value |
An absolute path to a CA certificate file to use when communicating with LDAP servers. This option will take precedence over |
| string value |
Specifies which checks to perform against client certificates on incoming TLS sessions. If set to |
| string value | URL(s) for connecting to the LDAP server. Multiple LDAP URLs may be specified as a comma separated string. The first URL to successfully bind is used for the connection. |
| boolean value | Enable LDAP connection pooling for end user authentication. There is typically no reason to disable this. |
| boolean value | Enable LDAP connection pooling for queries to the LDAP server. There is typically no reason to disable this. |
| boolean value |
Enable TLS when communicating with LDAP servers. You should also set the |
| string value | The user name of the administrator bind DN to use when querying the LDAP server, if your LDAP server requires it. |
| list value |
A list of LDAP attribute to keystone user attribute pairs used for mapping additional attributes to users in keystone. The expected format is |
| list value | List of user attributes to ignore on create and update, or whether a specific user attribute should be filtered for list or show user. |
| string value | The LDAP attribute mapped to a user’s default_project_id in keystone. This is most commonly used when keystone has write access to LDAP. |
| string value | The LDAP attribute mapped to user descriptions in keystone. |
| string value |
The LDAP attribute mapped to the user enabled attribute in keystone. If setting this option to |
| string value |
The default value to enable users. This should match an appropriate integer value if the LDAP server uses non-boolean (bitmask) values to indicate if a user is enabled or disabled. If this is not set to |
| boolean value |
If enabled, keystone uses an alternative method to determine if a user is enabled or not by checking if they are a member of the group defined by the |
| string value |
DN of the group entry to hold enabled users when using enabled emulation. Setting this option has no effect unless |
| boolean value |
Use the |
| boolean value |
Logically negate the boolean value of the enabled attribute obtained from the LDAP server. Some LDAP servers use a boolean lock attribute where "true" means an account is disabled. Setting |
| integer value |
Bitmask integer to select which bit indicates the enabled value if the LDAP server represents "enabled" as a bit on an integer rather than as a discrete boolean. A value of |
| string value | The LDAP search filter to use for users. |
| string value | The LDAP attribute mapped to user IDs in keystone. This must NOT be a multivalued attribute. User IDs are expected to be globally unique across keystone domains and URL-safe. |
| string value | The LDAP attribute mapped to user emails in keystone. |
| string value | The LDAP attribute mapped to user names in keystone. User names are expected to be unique only within a keystone domain and are not expected to be URL-safe. |
| string value | The LDAP object class to use for users. |
| string value | The LDAP attribute mapped to user passwords in keystone. |
| string value |
The search base to use for users. Defaults to the |
7.1.22. memcache
The following table outlines the options available under the [memcache]
group in the /etc/keystone/keystone.conf
file.
Table 7.21. memcache
Configuration option = Default value | Type | Description |
---|---|---|
| integer value | Number of seconds memcached server is considered dead before it is tried again. This is used by the key value store system. |
| integer value | Number of seconds that an operation will wait to get a memcache client connection. This is used by the key value store system. |
| integer value | Max total number of open connections to every memcached server. This is used by the key value store system. |
| integer value | Number of seconds a connection to memcached is held unused in the pool before it is closed. This is used by the key value store system. |
| integer value | (DEPRECATED FOR REMOVAL) Timeout in seconds for every call to a server. This is used by the key value store system. |
7.1.23. oauth1
The following table outlines the options available under the [oauth1]
group in the /etc/keystone/keystone.conf
file.
Table 7.22. oauth1
Configuration option = Default value | Type | Description |
---|---|---|
| integer value | Number of seconds for the OAuth Access Token to remain valid after being created. This is the amount of time the consumer has to interact with the service provider (which is typically keystone). Setting this option to zero means that access tokens will last forever. |
| string value |
Entry point for the OAuth backend driver in the |
| integer value | Number of seconds for the OAuth Request Token to remain valid after being created. This is the amount of time the user has to authorize the token. Setting this option to zero means that request tokens will last forever. |
7.1.24. oslo_messaging_amqp
The following table outlines the options available under the [oslo_messaging_amqp]
group in the /etc/keystone/keystone.conf
file.
Table 7.23. oslo_messaging_amqp
Configuration option = Default value | Type | Description |
---|---|---|
| string value | 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 |
| string value | 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. |
| string value | address prefix used when broadcasting to all servers |
| integer value | Increase the connection_retry_interval by this many seconds after each unsuccessful failover attempt. |
| integer value | Seconds to pause before attempting to re-connect. |
| integer value | Maximum limit for connection_retry_interval + connection_retry_backoff |
| string value | Name for the AMQP container. must be globally unique. Defaults to a generated UUID |
| string value | 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 |
| integer value | The deadline for a sent notification message delivery. Only used when caller does not provide a timeout expiry. |
| integer value | The maximum number of attempts to re-send a reply message which failed due to a recoverable error. |
| integer value | The deadline for an rpc reply message delivery. |
| string value | 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 |
| integer value | The deadline for an rpc cast or call message delivery. Only used when caller does not provide a timeout expiry. |
| integer value | The duration to schedule a purge of idle sender links. Detach link after expiry. |
| string value | address prefix when sending to any server in group |
| integer value | Timeout for inactive connections (in seconds) |
| integer value | Time to pause between re-connecting an AMQP 1.0 link that failed due to a recoverable error. |
| string value | Appended to the address prefix when sending a fanout message. Used by the message bus to identify fanout messages. |
| string value | Address prefix for all generated Notification addresses |
| integer value | Window size for incoming Notification messages |
| multi valued | Send messages of this type pre-settled. Pre-settled messages will not receive acknowledgement from the peer. Note well: pre-settled messages may be silently discarded if the delivery fails. Permitted values: rpc-call - send RPC Calls pre-settled rpc-reply- send RPC Replies pre-settled rpc-cast - Send RPC Casts pre-settled notify - Send Notifications pre-settled |
| boolean value | Enable virtual host support for those message buses that do not natively support virtual hosting (such as qpidd). When set to true the virtual host name will be added to all message bus addresses, effectively creating a private subnet per virtual host. Set to False if the message bus supports virtual hosting using the hostname field in the AMQP 1.0 Open performative as the name of the virtual host. |
| integer value | Window size for incoming RPC Reply messages. |
| string value | Address prefix for all generated RPC addresses |
| integer value | Window size for incoming RPC Request messages |
`sasl_config_dir = ` | string value | Path to directory that contains the SASL configuration |
`sasl_config_name = ` | string value | Name of configuration file (without .conf suffix) |
`sasl_default_realm = ` | string value | SASL realm to use if no realm present in username |
`sasl_mechanisms = ` | string value | Space separated list of acceptable SASL mechanisms |
| string value | address prefix used when sending to a specific server |
| boolean value | Attempt to connect via SSL. If no other ssl-related parameters are given, it will use the system’s CA-bundle to verify the server’s certificate. |
`ssl_ca_file = ` | string value | CA certificate PEM file used to verify the server’s certificate |
`ssl_cert_file = ` | string value | Self-identifying certificate PEM file for client authentication |
`ssl_key_file = ` | string value | Private key PEM file used to sign ssl_cert_file certificate (optional) |
| string value | Password for decrypting ssl_key_file (if encrypted) |
| boolean value | By default SSL checks that the name in the server’s certificate matches the hostname in the transport_url. In some configurations it may be preferable to use the virtual hostname instead, for example if the server uses the Server Name Indication TLS extension (rfc6066) to provide a certificate per virtual host. Set ssl_verify_vhost to True if the server’s SSL certificate uses the virtual host name instead of the DNS name. |
| boolean value | Debug: dump AMQP frames to stdout |
| string value | 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. |
7.1.25. oslo_messaging_kafka
The following table outlines the options available under the [oslo_messaging_kafka]
group in the /etc/keystone/keystone.conf
file.
Table 7.24. oslo_messaging_kafka
Configuration option = Default value | Type | Description |
---|---|---|
| string value | The compression codec for all data generated by the producer. If not set, compression will not be used. Note that the allowed values of this depend on the kafka version |
| integer value | (DEPRECATED FOR REMOVAL) The pool size limit for connections expiration policy |
| integer value | (DEPRECATED FOR REMOVAL) The time-to-live in sec of idle connections in the pool |
| string value | Group id for Kafka consumer. Consumers in one group will coordinate message consumption |
| boolean value | Enable asynchronous consumer commits |
| floating point value | Default timeout(s) for Kafka consumers |
| integer value | Max fetch bytes of Kafka consumer |
| integer value | The maximum number of records returned in a poll call |
| integer value | (DEPRECATED FOR REMOVAL) Pool Size for Kafka Consumers |
| integer value | Size of batch for the producer async send |
| floating point value | Upper bound on the delay for KafkaProducer batching in seconds |
| string value | Mechanism when security protocol is SASL |
| string value | Protocol used to communicate with brokers |
`ssl_cafile = ` | string value | CA certificate PEM file used to verify the server certificate |
7.1.26. oslo_messaging_notifications
The following table outlines the options available under the [oslo_messaging_notifications]
group in the /etc/keystone/keystone.conf
file.
Table 7.25. oslo_messaging_notifications
Configuration option = Default value | Type | Description |
---|---|---|
| multi valued | The Drivers(s) to handle sending notifications. Possible values are messaging, messagingv2, routing, log, test, noop |
| integer value | The maximum number of attempts to re-send a notification message which failed to be delivered due to a recoverable error. 0 - No retry, -1 - indefinite |
| list value | AMQP topic used for OpenStack notifications. |
| string value | A URL representing the messaging driver to use for notifications. If not set, we fall back to the same configuration used for RPC. |
7.1.27. oslo_messaging_rabbit
The following table outlines the options available under the [oslo_messaging_rabbit]
group in the /etc/keystone/keystone.conf
file.
Table 7.26. oslo_messaging_rabbit
Configuration option = Default value | Type | Description |
---|---|---|
| boolean value | Auto-delete queues in AMQP. |
| boolean value | Use durable queues in AMQP. |
| integer value | Enable/Disable the RabbitMQ mandatory flag for direct send. The direct send is used as reply,so the MessageUndeliverable exception is raised in case the client queue does not exist. |
| boolean value | EXPERIMENTAL: Run the health check heartbeat threadthrough a native python thread. By default if thisoption isn’t provided the health check heartbeat willinherit the execution model from the parent process. Byexample if the parent process have monkey patched thestdlib by using eventlet/greenlet then the heartbeatwill be run through a green thread. |
| integer value | How often times during the heartbeat_timeout_threshold we check the heartbeat. |
| integer value | Number of seconds after which the Rabbit broker is considered down if heartbeat’s keep-alive fails (0 disables heartbeat). |
| string value | EXPERIMENTAL: Possible values are: gzip, bz2. If not set compression will not be used. This option may not be available in future versions. |
| string value | 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. |
| integer value | How long to wait a missing client before abandoning to send it its replies. This value should not be longer than rpc_response_timeout. |
| floating point value | How long to wait before reconnecting in response to an AMQP consumer cancel notification. |
| boolean value | 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"} " |
| integer value | Maximum interval of RabbitMQ connection retries. Default is 30 seconds. |
| string value | The RabbitMQ login method. |
| integer value | Specifies the number of messages to prefetch. Setting to zero allows unlimited messages. |
| integer value | How long to backoff for between retries when connecting to RabbitMQ. |
| integer value | How frequently to retry connecting with RabbitMQ. |
| integer value | 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. |
| boolean value | Connect over SSL. |
`ssl_ca_file = ` | string value | SSL certification authority file (valid only if SSL enabled). |
`ssl_cert_file = ` | string value | SSL cert file (valid only if SSL enabled). |
`ssl_key_file = ` | string value | SSL key file (valid only if SSL enabled). |
`ssl_version = ` | string value | 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. |
7.1.28. oslo_middleware
The following table outlines the options available under the [oslo_middleware]
group in the /etc/keystone/keystone.conf
file.
Table 7.27. oslo_middleware
Configuration option = Default value | Type | Description |
---|---|---|
| boolean value | Whether the application is behind a proxy or not. This determines if the middleware should parse the headers or not. |
| integer value | The maximum body size for each request, in bytes. |
| string value | (DEPRECATED FOR REMOVAL) 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. |
7.1.29. oslo_policy
The following table outlines the options available under the [oslo_policy]
group in the /etc/keystone/keystone.conf
file.
Table 7.28. oslo_policy
Configuration option = Default value | Type | Description |
---|---|---|
| boolean value |
This option controls whether or not to enforce scope when evaluating policies. If |
| string value | Default rule. Enforced when a requested rule is not found. |
| multi valued | 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. |
| string value | The relative or absolute path of a file that maps roles to permissions for a given service. Relative paths must be specified in relation to the configuration file setting this option. |
| string value | Content Type to send and receive data for REST based policy check |
| string value | Absolute path to ca cert file for REST based policy check |
| string value | Absolute path to client cert for REST based policy check |
| string value | Absolute path client key file REST based policy check |
| boolean value | server identity verification for REST based policy check |
7.1.30. policy
The following table outlines the options available under the [policy]
group in the /etc/keystone/keystone.conf
file.
Table 7.29. policy
Configuration option = Default value | Type | Description |
---|---|---|
| string value |
Entry point for the policy backend driver in the |
| integer value | Maximum number of entities that will be returned in a policy collection. |
7.1.31. profiler
The following table outlines the options available under the [profiler]
group in the /etc/keystone/keystone.conf
file.
Table 7.30. profiler
Configuration option = Default value | Type | Description |
---|---|---|
| string value | Connection string for a notifier backend.
Default value is Examples of possible values:
|
| boolean value | Enable the profiling for all services on this node. Default value is False (fully disable the profiling feature). Possible values:
|
| string value | Document type for notification indexing in elasticsearch. |
| integer value | Elasticsearch splits large requests in batches. This parameter defines maximum size of each batch (for example: es_scroll_size=10000). |
| string value | 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. |
| boolean value | Enable filter traces that contain error/exception to a separated place. Default value is set to False. Possible values:
|
| string value | 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 value |
Redissentinel uses a service name to identify a master redis service. This parameter defines the name (for example: |
| floating point value | Redissentinel provides a timeout option on the connections. This parameter defines that timeout (for example: socket_timeout=0.1). |
| boolean value | Enable SQL requests profiling in services. Default value is False (SQL requests won’t be traced). Possible values:
|
7.1.32. receipt
The following table outlines the options available under the [receipt]
group in the /etc/keystone/keystone.conf
file.
Table 7.31. receipt
Configuration option = Default value | Type | Description |
---|---|---|
| boolean value | Enable storing issued receipt data to receipt validation cache so that first receipt validation doesn’t actually cause full validation cycle. This option has no effect unless global caching and receipt caching are enabled. |
| integer value |
The number of seconds to cache receipt creation and validation data. This has no effect unless both global and |
| boolean value | Toggle for caching receipt creation and validation data. This has no effect unless global caching is enabled, or if cache_on_issue is disabled as we only cache receipts on issue. |
| integer value | The amount of time that a receipt should remain valid (in seconds). This value should always be very short, as it represents how long a user has to reattempt auth with the missing auth methods. |
| string value |
Entry point for the receipt provider in the |
7.1.33. resource
The following table outlines the options available under the [resource]
group in the /etc/keystone/keystone.conf
file.
Table 7.32. resource
Configuration option = Default value | Type | Description |
---|---|---|
| string value |
Name of the domain that owns the |
| string value |
This is a special project which represents cloud-level administrator privileges across services. Tokens scoped to this project will contain a true |
| integer value | Time to cache resource data in seconds. This has no effect unless global caching is enabled. |
| boolean value | Toggle for resource caching. This has no effect unless global caching is enabled. |
| string value |
This controls whether the names of domains are restricted from containing URL-reserved characters. If set to |
| string value |
(DEPRECATED FOR REMOVAL) Entry point for the resource driver in the |
| integer value | Maximum number of entities that will be returned in a resource collection. |
| string value |
This controls whether the names of projects are restricted from containing URL-reserved characters. If set to |
7.1.34. revoke
The following table outlines the options available under the [revoke]
group in the /etc/keystone/keystone.conf
file.
Table 7.33. revoke
Configuration option = Default value | Type | Description |
---|---|---|
| integer value |
Time to cache the revocation list and the revocation events (in seconds). This has no effect unless global and |
| boolean value | Toggle for revocation event caching. This has no effect unless global caching is enabled. |
| string value |
Entry point for the token revocation backend driver in the |
| integer value | The number of seconds after a token has expired before a corresponding revocation event may be purged from the backend. |
7.1.35. role
The following table outlines the options available under the [role]
group in the /etc/keystone/keystone.conf
file.
Table 7.34. role
Configuration option = Default value | Type | Description |
---|---|---|
| integer value |
Time to cache role data, in seconds. This has no effect unless both global caching and |
| boolean value | Toggle for role caching. This has no effect unless global caching is enabled. In a typical deployment, there is no reason to disable this. |
| string value |
Entry point for the role backend driver in the |
| integer value | Maximum number of entities that will be returned in a role collection. This may be useful to tune if you have a large number of discrete roles in your deployment. |
7.1.36. saml
The following table outlines the options available under the [saml]
group in the /etc/keystone/keystone.conf
file.
Table 7.35. saml
Configuration option = Default value | Type | Description |
---|---|---|
| integer value |
Determines the lifetime for any SAML assertions generated by keystone, using |
| string value |
Absolute path to the public certificate file to use for SAML signing. The value cannot contain a comma ( |
| string value | This is the company name of the identity provider’s contact person. |
| string value | This is the email address of the identity provider’s contact person. |
| string value | This is the given name of the identity provider’s contact person. |
| string value | This is the surname of the identity provider’s contact person. |
| string value | This is the telephone number of the identity provider’s contact person. |
| string value | This is the type of contact that best describes the identity provider’s contact person. |
| uri value |
This is the unique entity identifier of the identity provider (keystone) to use when generating SAML assertions. This value is required to generate identity provider metadata and must be a URI (a URL is recommended). For example: |
| string value | This is the language used by the identity provider’s organization. |
| string value |
Absolute path to the identity provider metadata file. This file should be generated with the |
| string value | This is the name of the identity provider’s organization to be displayed. |
| string value | This is the name of the identity provider’s organization. |
| uri value | This is the URL of the identity provider’s organization. The URL referenced here should be useful to humans. |
| uri value |
This is the single sign-on (SSO) service location of the identity provider which accepts HTTP POST requests. A value is required to generate identity provider metadata. For example: |
| string value |
Absolute path to the private key file to use for SAML signing. The value cannot contain a comma ( |
| string value | The prefix of the RelayState SAML attribute to use when generating enhanced client and proxy (ECP) assertions. In a typical deployment, there is no reason to change this value. |
| string value |
Name of, or absolute path to, the binary to be used for XML signing. Although only the XML Security Library ( |
7.1.37. security_compliance
The following table outlines the options available under the [security_compliance]
group in the /etc/keystone/keystone.conf
file.
Table 7.36. security_compliance
Configuration option = Default value | Type | Description |
---|---|---|
| boolean value |
Enabling this option requires users to change their password when the user is created, or upon administrative reset. Before accessing any services, affected users will have to change their password. To ignore this requirement for specific users, such as service users, set the |
| integer value |
The maximum number of days a user can go without authenticating before being considered "inactive" and automatically disabled (locked). This feature is disabled by default; set any value to enable it. This feature depends on the |
| integer value |
The number of seconds a user account will be locked when the maximum number of failed authentication attempts (as specified by |
| integer value |
The maximum number of times that a user can fail to authenticate before the user account is locked for the number of seconds specified by |
| integer value |
The number of days that a password must be used before the user can change it. This prevents users from changing their passwords immediately in order to wipe out their password history and reuse an old password. This feature does not prevent administrators from manually resetting passwords. It is disabled by default and allows for immediate password changes. This feature depends on the |
| integer value |
The number of days for which a password will be considered valid before requiring it to be changed. This feature is disabled by default. If enabled, new password changes will have an expiration date, however existing passwords would not be impacted. This feature depends on the |
| string value |
The regular expression used to validate password strength requirements. By default, the regular expression will match any password. The following is an example of a pattern which requires at least 1 letter, 1 digit, and have a minimum length of 7 characters: ^(?=.\d)(?=.[a-zA-Z]).{7,}$ This feature depends on the |
| string value | Describe your password regular expression here in language for humans. If a password fails to match the regular expression, the contents of this configuration variable will be returned to users to explain why their requested password was insufficient. |
| integer value |
This controls the number of previous user password iterations to keep in history, in order to enforce that newly created passwords are unique. The total number which includes the new password should not be greater or equal to this value. Setting the value to zero (the default) disables this feature. Thus, to enable this feature, values must be greater than 0. This feature depends on the |
7.1.38. shadow_users
The following table outlines the options available under the [shadow_users]
group in the /etc/keystone/keystone.conf
file.
Table 7.37. shadow_users
Configuration option = Default value | Type | Description |
---|---|---|
| string value |
Entry point for the shadow users backend driver in the |
7.1.39. token
The following table outlines the options available under the [token]
group in the /etc/keystone/keystone.conf
file.
Table 7.38. token
Configuration option = Default value | Type | Description |
---|---|---|
| integer value | This controls the number of seconds that a token can be retrieved for beyond the built-in expiry time. This allows long running operations to succeed. Defaults to two days. |
| boolean value | This toggles whether scoped tokens may be re-scoped to a new project or domain, thereby preventing users from exchanging a scoped token (including those with a default project scope) for any other token. This forces users to either authenticate for unscoped tokens (and later exchange that unscoped token for tokens with a more specific scope) or to provide their credentials in every request for a scoped token to avoid re-scoping altogether. |
| boolean value |
(DEPRECATED FOR REMOVAL) Enable storing issued token data to token validation cache so that first token validation doesn’t actually cause full validation cycle. This option has no effect unless global caching is enabled and will still cache tokens even if |
| integer value |
The number of seconds to cache token creation and validation data. This has no effect unless both global and |
| boolean value | Toggle for caching token creation and validation data. This has no effect unless global caching is enabled. |
| integer value | The amount of time that a token should remain valid (in seconds). Drastically reducing this value may break "long-running" operations that involve multiple services to coordinate together, and will force users to authenticate with keystone more frequently. Drastically increasing this value will increase the number of tokens that will be simultaneously valid. Keystone tokens are also bearer tokens, so a shorter duration will also reduce the potential security impact of a compromised token. |
| string value |
Entry point for the token provider in the |
| boolean value |
This toggles support for revoking individual tokens by the token identifier and thus various token enumeration operations (such as listing all tokens issued to a specific user). These operations are used to determine the list of tokens to consider revoked. Do not disable this option if you’re using the |
7.1.40. tokenless_auth
The following table outlines the options available under the [tokenless_auth]
group in the /etc/keystone/keystone.conf
file.
Table 7.39. tokenless_auth
Configuration option = Default value | Type | Description |
---|---|---|
| string value | The name of the WSGI environment variable used to pass the issuer of the client certificate to keystone. This attribute is used as an identity provider ID for the X.509 tokenless authorization along with the protocol to look up its corresponding mapping. In a typical deployment, there is no reason to change this value. |
| string value |
The federated protocol ID used to represent X.509 tokenless authorization. This is used in combination with the value of |
| multi valued |
The list of distinguished names which identify trusted issuers of client certificates allowed to use X.509 tokenless authorization. If the option is absent then no certificates will be allowed. The format for the values of a distinguished name (DN) must be separated by a comma and contain no spaces. Furthermore, because an individual DN may contain commas, this configuration option may be repeated multiple times to represent multiple values. For example, keystone.conf would include two consecutive lines in order to trust two different DNs, such as |
7.1.41. totp
The following table outlines the options available under the [totp]
group in the /etc/keystone/keystone.conf
file.
Table 7.40. totp
Configuration option = Default value | Type | Description |
---|---|---|
| integer value | The number of previous windows to check when processing TOTP passcodes. |
7.1.42. trust
The following table outlines the options available under the [trust]
group in the /etc/keystone/keystone.conf
file.
Table 7.41. trust
Configuration option = Default value | Type | Description |
---|---|---|
| boolean value |
Allows authorization to be redelegated from one user to another, effectively chaining trusts together. When disabled, the |
| string value |
Entry point for the trust backend driver in the |
| integer value | Maximum number of times that authorization can be redelegated from one user to another in a chain of trusts. This number may be reduced further for a specific trust. |
7.1.43. unified_limit
The following table outlines the options available under the [unified_limit]
group in the /etc/keystone/keystone.conf
file.
Table 7.42. unified_limit
Configuration option = Default value | Type | Description |
---|---|---|
| integer value |
Time to cache unified limit data, in seconds. This has no effect unless both global caching and |
| boolean value | Toggle for unified limit caching. This has no effect unless global caching is enabled. In a typical deployment, there is no reason to disable this. |
| string value |
Entry point for the unified limit backend driver in the |
| string value | The enforcement model to use when validating limits associated to projects. Enforcement models will behave differently depending on the existing limits, which may result in backwards incompatible changes if a model is switched in a running deployment. |
| integer value | Maximum number of entities that will be returned in a role collection. This may be useful to tune if you have a large number of unified limits in your deployment. |
7.1.44. wsgi
The following table outlines the options available under the [wsgi]
group in the /etc/keystone/keystone.conf
file.
Table 7.43. wsgi
Configuration option = Default value | Type | Description |
---|---|---|
| boolean value | If set to true, this enables the oslo debug middleware in Keystone. This Middleware prints a lot of information about the request and the response. It is useful for getting information about the data on the wire (decoded) and passed to the WSGI application pipeline. This middleware has no effect on the "debug" setting in the [DEFAULT] section of the config file or setting Keystone’s log-level to "DEBUG"; it is specific to debugging the WSGI data as it enters and leaves Keystone (specific request-related data). This option is used for introspection on the request and response data between the web server (apache, nginx, etc) and Keystone. This middleware is inserted as the first element in the middleware chain and will show the data closest to the wire. WARNING: NOT INTENDED FOR USE IN PRODUCTION. THIS MIDDLEWARE CAN AND WILL EMIT SENSITIVE/PRIVILEGED DATA. |
Chapter 8. neutron
The following chapter contains information about the configuration options in the neutron
service.
8.1. dhcp_agent.ini
This section contains options for the /etc/neutron/dhcp_agent.ini
file.
8.1.1. DEFAULT
The following table outlines the options available under the [DEFAULT]
group in the /etc/neutron/dhcp_agent.ini
file.
.
Configuration option = Default value | Type | Description |
---|---|---|
| boolean value | If set to true, the logging level will be set to DEBUG instead of the default INFO level. |
| list value | List of package logging levels in logger=LEVEL pairs. This option is ignored if log_config_append is set. |
| boolean value | Use broadcast in DHCP replies. |
| string value | Location to store DHCP server config files. |
| string value | The driver used to manage the DHCP server. |
| integer value | DHCP rebinding time T2 (in seconds). If set to 0, it will default to 7/8 of the lease time. |
| integer value | DHCP renewal time T1 (in seconds). If set to 0, it will default to half of the lease time. |
| string value | Base log dir for dnsmasq logging. The log contains DHCP and DNS log information and is useful for debugging issues with either DHCP or DNS. If this section is null, disable dnsmasq log. |
`dnsmasq_config_file = ` | string value | Override the default dnsmasq settings with this file. |
| list value | Comma-separated list of the DNS servers which will be used as forwarders. |
| boolean value | Enable dhcp-host entry with list of addresses when port has multiple IPv6 addresses in the same subnet. |
| integer value | Limit number of leases to prevent a denial-of-service. |
| boolean value | Enables the dnsmasq service to provide name resolution for instances via DNS resolvers on the host running the DHCP agent. Effectively removes the --no-resolv option from the dnsmasq process arguments. Adding custom DNS resolvers to the dnsmasq_dns_servers option disables this feature. |
| boolean value | The DHCP server can assist with providing metadata support on isolated networks. Setting this value to True will cause the DHCP server to append specific host routes to the DHCP request. The metadata service will only be activated when the subnet does not contain any router port. The guest instance must be configured to request host routes via DHCP (Option 121). This option doesn’t have any effect when force_metadata is set to True. |
| boolean value | Allows for serving metadata requests coming from a dedicated metadata access network whose CIDR is 169.254.169.254/16 (or larger prefix), and is connected to a Neutron router from which the VMs send metadata:1 request. In this case DHCP Option 121 will not be injected in VMs, as they will be able to reach 169.254.169.254 through a router. This option requires enable_isolated_metadata = True. |
| boolean value | Enables or disables fatal status of deprecations. |
| boolean value | In some cases the Neutron router is not present to provide the metadata IP but the DHCP server can be used to provide this info. Setting this value will force the DHCP server to append specific host routes to the DHCP request. If this option is set, then the metadata service will be activated for all the networks. |
`instance_format = [instance: %(uuid)s] ` | string value | The format for an instance that is passed with the log message. |
`instance_uuid_format = [instance: %(uuid)s] ` | string value | The format for an instance UUID that is passed with the log message. |
| string value | The driver used to manage the virtual interface. |
| string value | 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. Note that when logging configuration files are used then all logging configuration is set in the configuration file and other logging configuration options are ignored (for example, log-date-format). |
| string value | Defines the format string for %%(asctime)s in log records. Default: %(default)s . This option is ignored if log_config_append is set. |
| string value | (Optional) The base directory used for relative log_file paths. This option is ignored if log_config_append is set. |
| string value | (Optional) Name of log file to send logging output to. If no default is set, logging will go to stderr as defined by use_stderr. This option is ignored if log_config_append is set. |
| integer value | The amount of time before the log files are rotated. This option is ignored unless log_rotation_type is setto "interval". |
| string value | Rotation interval type. The time of the last file change (or the time when the service was started) is used when scheduling the next rotation. |
| string value | Log rotation type. |
| string value | Format string to use for log messages with context. Used by oslo_log.formatters.ContextFormatter |
| string value | Additional data to append to log message when logging level for the message is DEBUG. Used by oslo_log.formatters.ContextFormatter |
| string value | Format string to use for log messages when context is undefined. Used by oslo_log.formatters.ContextFormatter |
| string value | Prefix each line of exception output with this format. Used by oslo_log.formatters.ContextFormatter |
| string value | Defines the format string for %(user_identity)s that is used in logging_context_format_string. Used by oslo_log.formatters.ContextFormatter |
| integer value | Maximum number of rotated log files. |
| integer value | Log file maximum size in MB. This option is ignored if "log_rotation_type" is not set to "size". |
| integer value | Number of threads to use during sync process. Should not exceed connection pool size configured on server. |
| string value | Name of Open vSwitch bridge to use |
| boolean value | Uses veth for an OVS interface or not. Support kernels with limited namespace support (e.g. RHEL 6.5) and rate limiting on router’s gateway port so long as ovs_use_veth is set to True. |
| boolean value | Enables or disables publication of error events. |
| integer value | Maximum number of logged messages per rate_limit_interval. |
| string value | Log level name used by rate limiting: CRITICAL, ERROR, INFO, WARNING, DEBUG or empty string. Logs with level greater or equal to rate_limit_except_level are not filtered. An empty string means that all levels are filtered. |
| integer value | Interval, number of seconds, of log rate limiting. |
| integer value | The DHCP agent will resync its state with Neutron to recover from any transient notification or RPC errors. The interval is maximum number of seconds between attempts. The resync can be done more often based on the events triggered. |
| integer value | Throttle the number of resync state events between the local DHCP state and Neutron to only once per resync_throttle seconds. The value of throttle introduces a minimum interval between resync state events. Otherwise the resync may end up in a busy-loop. The value must be less than resync_interval. |
| integer value | Maximum seconds to wait for a response from an RPC call. |
| string value | Syslog facility to receive log lines. This option is ignored if log_config_append is set. |
| boolean value | Enable journald for logging. If running in a systemd environment you may wish to enable journal support. Doing so will use the journal native protocol which includes structured metadata in addition to log messages.This option is ignored if log_config_append is set. |
| boolean value | Use JSON formatting for logging. This option is ignored if log_config_append is set. |
| boolean value | Use syslog for logging. Existing syslog format is DEPRECATED and will be changed later to honor RFC5424. This option is ignored if log_config_append is set. |
| boolean value | Log output to Windows Event Log. |
| boolean value | Log output to standard error. This option is ignored if log_config_append is set. |
| boolean value | Uses logging handler designed to watch file system. When log file is moved or removed this handler will open a new log file with specified path instantaneously. It makes sense only if log_file option is specified and Linux platform is used. This option is ignored if log_config_append is set. |
8.1.2. agent
The following table outlines the options available under the [agent]
group in the /etc/neutron/dhcp_agent.ini
file.
Table 8.1. agent
Configuration option = Default value | Type | Description |
---|---|---|
| string value | Availability zone of this node |
| boolean value | Log agent heartbeats |
| floating point value | Seconds between nodes reporting state to server; should be less than agent_down_time, best if it is half or less than agent_down_time. |
8.1.3. ovs
The following table outlines the options available under the [ovs]
group in the /etc/neutron/dhcp_agent.ini
file.
Table 8.2. ovs
Configuration option = Default value | Type | Description |
---|---|---|
| integer value | The maximum number of MAC addresses to learn on a bridge managed by the Neutron OVS agent. Values outside a reasonable range (10 to 1,000,000) might be overridden by Open vSwitch according to the documentation. |
| boolean value | Enable IGMP snooping for integration bridge. If this option is set to True, support for Internet Group Management Protocol (IGMP) is enabled in integration bridge. Setting this option to True will also enable Open vSwitch mcast-snooping-disable-flood-unregistered flag. This option will disable flooding of unregistered multicast packets to all ports. The switch will send unregistered multicast packets only to ports connected to multicast routers. |
| string value | The connection string for the OVSDB backend. Will be used by ovsdb-client when monitoring and used for the all ovsdb commands when native ovsdb_interface is enabled |
| boolean value | Enable OVSDB debug logs |
| integer value | Timeout in seconds for ovsdb commands. If the timeout expires, ovsdb commands will fail with ALARMCLOCK error. |
| string value | The Certificate Authority (CA) certificate to use when interacting with OVSDB. Required when using an "ssl:" prefixed ovsdb_connection |
| string value | The SSL certificate file to use when interacting with OVSDB. Required when using an "ssl:" prefixed ovsdb_connection |
| string value | The SSL private key file to use when interacting with OVSDB. Required when using an "ssl:" prefixed ovsdb_connection |
8.2. l3_agent.ini
This section contains options for the /etc/neutron/l3_agent.ini
file.
8.2.1. DEFAULT
The following table outlines the options available under the [DEFAULT]
group in the /etc/neutron/l3_agent.ini
file.
.
Configuration option = Default value | Type | Description |
---|---|---|
| string value | The working mode for the agent. Allowed modes are: legacy - this preserves the existing behavior where the L3 agent is deployed on a centralized networking node to provide L3 services like DNAT, and SNAT. Use this mode if you do not want to adopt DVR. dvr - this mode enables DVR functionality and must be used for an L3 agent that runs on a compute host. dvr_snat - this enables centralized SNAT support in conjunction with DVR. This mode must be used for an L3 agent running on a centralized node (or in single-host deployments, e.g. devstack). dvr_no_external - this mode enables only East/West DVR routing functionality for a L3 agent that runs on a compute host, the North/South functionality such as DNAT and SNAT will be provided by the centralized network node that is running in dvr_snat mode. This mode should be used when there is no external network connectivity on the compute host. |
| integer value | Number of separate API worker processes for service. If not specified, the default is equal to the number of CPUs available for best performance, capped by potential RAM usage. |
| boolean value | If set to true, the logging level will be set to DEBUG instead of the default INFO level. |
| list value | List of package logging levels in logger=LEVEL pairs. This option is ignored if log_config_append is set. |
| boolean value | Allow running metadata proxy. |
| string value | Iptables mangle mark used to mark ingress from external network. This mark will be masked with 0xffff so that only the lower 16 bits will be used. |
| boolean value | Enables or disables fatal status of deprecations. |
| string value | Location to store keepalived config files |
| integer value | Number of concurrent threads for keepalived server connection requests. More threads create a higher CPU load on the agent node. |
| integer value | The advertisement interval in seconds |
| string value | VRRP authentication password |
| string value | VRRP authentication type |
| integer value | The VRRP health check interval in seconds. Values > 0 enable VRRP health checks. Setting it to 0 disables VRRP health checks. Recommended value is 5. This will cause pings to be sent to the gateway IP address(es) - requires ICMP_ECHO_REQUEST to be enabled on the gateway. If gateway fails, all routers will be reported as master, and master election will be repeated in round-robin fashion, until one of the router restore the gateway connection. |
| boolean value | Indicates that this L3 agent should also handle routers that do not have an external network gateway configured. This option should be True only for a single agent in a Neutron deployment, and may be False for all agents if all routers must have an external network gateway. |
`instance_format = [instance: %(uuid)s] ` | string value | The format for an instance that is passed with the log message. |
`instance_uuid_format = [instance: %(uuid)s] ` | string value | The format for an instance UUID that is passed with the log message. |
| string value | The driver used to manage the virtual interface. |
`ipv6_gateway = ` | string value | With IPv6, the network used for the external gateway does not need to have an associated subnet, since the automatically assigned link-local address (LLA) can be used. However, an IPv6 gateway address is needed for use as the next-hop for the default route. If no IPv6 gateway address is configured here, (and only then) the neutron router will be configured to get its default route from router advertisements (RAs) from the upstream router; in which case the upstream router must also be configured to send these RAs. The ipv6_gateway, when configured, should be the LLA of the interface on the upstream router. If a next-hop using a global unique address (GUA) is desired, it needs to be done via a subnet allocated to the network and not through this parameter. |
| boolean value | If keepalived without support for "no_track" option is used, this should be set to False. Support for this option was introduced in keepalived 2.x |
| string value | 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. Note that when logging configuration files are used then all logging configuration is set in the configuration file and other logging configuration options are ignored (for example, log-date-format). |
| string value | Defines the format string for %%(asctime)s in log records. Default: %(default)s . This option is ignored if log_config_append is set. |
| string value | (Optional) The base directory used for relative log_file paths. This option is ignored if log_config_append is set. |
| string value | (Optional) Name of log file to send logging output to. If no default is set, logging will go to stderr as defined by use_stderr. This option is ignored if log_config_append is set. |
| integer value | The amount of time before the log files are rotated. This option is ignored unless log_rotation_type is setto "interval". |
| string value | Rotation interval type. The time of the last file change (or the time when the service was started) is used when scheduling the next rotation. |
| string value | Log rotation type. |
| string value | Format string to use for log messages with context. Used by oslo_log.formatters.ContextFormatter |
| string value | Additional data to append to log message when logging level for the message is DEBUG. Used by oslo_log.formatters.ContextFormatter |
| string value | Format string to use for log messages when context is undefined. Used by oslo_log.formatters.ContextFormatter |
| string value | Prefix each line of exception output with this format. Used by oslo_log.formatters.ContextFormatter |
| string value | Defines the format string for %(user_identity)s that is used in logging_context_format_string. Used by oslo_log.formatters.ContextFormatter |
| integer value | Maximum number of rotated log files. |
| integer value | Log file maximum size in MB. This option is ignored if "log_rotation_type" is not set to "size". |
| integer value | MaxRtrAdvInterval setting for radvd.conf |
| string value | Iptables mangle mark used to mark metadata valid requests. This mark will be masked with 0xffff so that only the lower 16 bits will be used. |
| port value | TCP Port used by Neutron metadata namespace proxy. |
| integer value | MinRtrAdvInterval setting for radvd.conf |
| string value | Name of Open vSwitch bridge to use |
| boolean value | Uses veth for an OVS interface or not. Support kernels with limited namespace support (e.g. RHEL 6.5) and rate limiting on router’s gateway port so long as ovs_use_veth is set to True. |
| string value | Location to store IPv6 PD files. |
| integer value | Range of seconds to randomly delay when starting the periodic task scheduler to reduce stampeding. (Disable by setting to 0) |
| integer value | Seconds between running periodic tasks. |
| string value | Driver used for ipv6 prefix delegation. This needs to be an entry point defined in the neutron.agent.linux.pd_drivers namespace. See setup.cfg for entry points included with the neutron source. |
| boolean value | Enables or disables publication of error events. |
| string value | Location to store IPv6 RA config files |
`radvd_user = ` | string value | The username passed to radvd, used to drop root privileges and change user ID to username and group ID to the primary group of username. If no user specified (by default), the user executing the L3 agent will be passed. If "root" specified, because radvd is spawned as root, no "username" parameter will be passed. |
| integer value | Maximum number of logged messages per rate_limit_interval. |
| string value | Log level name used by rate limiting: CRITICAL, ERROR, INFO, WARNING, DEBUG or empty string. Logs with level greater or equal to rate_limit_except_level are not filtered. An empty string means that all levels are filtered. |
| integer value | Interval, number of seconds, of log rate limiting. |
| integer value | Maximum seconds to wait for a response from an RPC call. |
| integer value | Number of RPC worker processes dedicated to state reports queue. |
| integer value | Number of RPC worker processes for service. If not specified, the default is equal to half the number of API workers. |
| string value | Syslog facility to receive log lines. This option is ignored if log_config_append is set. |
| boolean value | Enable journald for logging. If running in a systemd environment you may wish to enable journal support. Doing so will use the journal native protocol which includes structured metadata in addition to log messages.This option is ignored if log_config_append is set. |
| boolean value | Use JSON formatting for logging. This option is ignored if log_config_append is set. |
| boolean value | Use syslog for logging. Existing syslog format is DEPRECATED and will be changed later to honor RFC5424. This option is ignored if log_config_append is set. |
| boolean value | Log output to Windows Event Log. |
| boolean value | Log output to standard error. This option is ignored if log_config_append is set. |
| string value | A decimal value as Vendor’s Registered Private Enterprise Number as required by RFC3315 DUID-EN. |
| boolean value | Uses logging handler designed to watch file system. When log file is moved or removed this handler will open a new log file with specified path instantaneously. It makes sense only if log_file option is specified and Linux platform is used. This option is ignored if log_config_append is set. |
8.2.2. agent
The following table outlines the options available under the [agent]
group in the /etc/neutron/l3_agent.ini
file.
Table 8.3. agent
Configuration option = Default value | Type | Description |
---|---|---|
| string value | Availability zone of this node |
| list value | Extensions list to use |
| boolean value | Log agent heartbeats |
| floating point value | Seconds between nodes reporting state to server; should be less than agent_down_time, best if it is half or less than agent_down_time. |
8.2.3. network_log
The following table outlines the options available under the [network_log]
group in the /etc/neutron/l3_agent.ini
file.
Table 8.4. network_log
Configuration option = Default value | Type | Description |
---|---|---|
| integer value | Maximum number of packets per rate_limit. |
| string value | Output logfile path on agent side, default syslog file. |
| integer value | Maximum packets logging per second. |
8.2.4. ovs
The following table outlines the options available under the [ovs]
group in the /etc/neutron/l3_agent.ini
file.
Table 8.5. ovs
Configuration option = Default value | Type | Description |
---|---|---|
| integer value | The maximum number of MAC addresses to learn on a bridge managed by the Neutron OVS agent. Values outside a reasonable range (10 to 1,000,000) might be overridden by Open vSwitch according to the documentation. |
| boolean value | Enable IGMP snooping for integration bridge. If this option is set to True, support for Internet Group Management Protocol (IGMP) is enabled in integration bridge. Setting this option to True will also enable Open vSwitch mcast-snooping-disable-flood-unregistered flag. This option will disable flooding of unregistered multicast packets to all ports. The switch will send unregistered multicast packets only to ports connected to multicast routers. |
| string value | The connection string for the OVSDB backend. Will be used by ovsdb-client when monitoring and used for the all ovsdb commands when native ovsdb_interface is enabled |
| boolean value | Enable OVSDB debug logs |
| integer value | Timeout in seconds for ovsdb commands. If the timeout expires, ovsdb commands will fail with ALARMCLOCK error. |
| string value | The Certificate Authority (CA) certificate to use when interacting with OVSDB. Required when using an "ssl:" prefixed ovsdb_connection |
| string value | The SSL certificate file to use when interacting with OVSDB. Required when using an "ssl:" prefixed ovsdb_connection |
| string value | The SSL private key file to use when interacting with OVSDB. Required when using an "ssl:" prefixed ovsdb_connection |
8.3. linuxbridge_agent.ini
This section contains options for the /etc/neutron/plugins/ml2/linuxbridge_agent.ini
file.
8.3.1. DEFAULT
The following table outlines the options available under the [DEFAULT]
group in the /etc/neutron/plugins/ml2/linuxbridge_agent.ini
file.
.
Configuration option = Default value | Type | Description |
---|---|---|
| boolean value | If set to true, the logging level will be set to DEBUG instead of the default INFO level. |
| list value | List of package logging levels in logger=LEVEL pairs. This option is ignored if log_config_append is set. |
| boolean value | Enables or disables fatal status of deprecations. |
`instance_format = [instance: %(uuid)s] ` | string value | The format for an instance that is passed with the log message. |
`instance_uuid_format = [instance: %(uuid)s] ` | string value | The format for an instance UUID that is passed with the log message. |
| string value | 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. Note that when logging configuration files are used then all logging configuration is set in the configuration file and other logging configuration options are ignored (for example, log-date-format). |
| string value | Defines the format string for %%(asctime)s in log records. Default: %(default)s . This option is ignored if log_config_append is set. |
| string value | (Optional) The base directory used for relative log_file paths. This option is ignored if log_config_append is set. |
| string value | (Optional) Name of log file to send logging output to. If no default is set, logging will go to stderr as defined by use_stderr. This option is ignored if log_config_append is set. |
| integer value | The amount of time before the log files are rotated. This option is ignored unless log_rotation_type is setto "interval". |
| string value | Rotation interval type. The time of the last file change (or the time when the service was started) is used when scheduling the next rotation. |
| string value | Log rotation type. |
| string value | Format string to use for log messages with context. Used by oslo_log.formatters.ContextFormatter |
| string value | Additional data to append to log message when logging level for the message is DEBUG. Used by oslo_log.formatters.ContextFormatter |
| string value | Format string to use for log messages when context is undefined. Used by oslo_log.formatters.ContextFormatter |
| string value | Prefix each line of exception output with this format. Used by oslo_log.formatters.ContextFormatter |
| string value | Defines the format string for %(user_identity)s that is used in logging_context_format_string. Used by oslo_log.formatters.ContextFormatter |
| integer value | Maximum number of rotated log files. |
| integer value | Log file maximum size in MB. This option is ignored if "log_rotation_type" is not set to "size". |
| boolean value | Enables or disables publication of error events. |
| integer value | Maximum number of logged messages per rate_limit_interval. |
| string value | Log level name used by rate limiting: CRITICAL, ERROR, INFO, WARNING, DEBUG or empty string. Logs with level greater or equal to rate_limit_except_level are not filtered. An empty string means that all levels are filtered. |
| integer value | Interval, number of seconds, of log rate limiting. |
| integer value | Maximum seconds to wait for a response from an RPC call. |
| string value | Syslog facility to receive log lines. This option is ignored if log_config_append is set. |
| boolean value | Enable journald for logging. If running in a systemd environment you may wish to enable journal support. Doing so will use the journal native protocol which includes structured metadata in addition to log messages.This option is ignored if log_config_append is set. |
| boolean value | Use JSON formatting for logging. This option is ignored if log_config_append is set. |
| boolean value | Use syslog for logging. Existing syslog format is DEPRECATED and will be changed later to honor RFC5424. This option is ignored if log_config_append is set. |
| boolean value | Log output to Windows Event Log. |
| boolean value | Log output to standard error. This option is ignored if log_config_append is set. |
| boolean value | Uses logging handler designed to watch file system. When log file is moved or removed this handler will open a new log file with specified path instantaneously. It makes sense only if log_file option is specified and Linux platform is used. This option is ignored if log_config_append is set. |
8.3.2. agent
The following table outlines the options available under the [agent]
group in the /etc/neutron/plugins/ml2/linuxbridge_agent.ini
file.
Table 8.6. agent
Configuration option = Default value | Type | Description |
---|---|---|
| integer value | The DSCP value to use for outer headers during tunnel encapsulation. |
| boolean value | If set to True, the DSCP value of tunnel interfaces is overwritten and set to inherit. The DSCP value of the inner header is then copied to the outer header. |
| list value | Extensions list to use |
| integer value | The number of seconds the agent will wait between polling for local device changes. |
| integer value | Set new timeout in seconds for new rpc calls after agent receives SIGTERM. If value is set to 0, rpc timeout won’t be changed |
8.3.3. linux_bridge
The following table outlines the options available under the [linux_bridge]
group in the /etc/neutron/plugins/ml2/linuxbridge_agent.ini
file.
Table 8.7. linux_bridge
Configuration option = Default value | Type | Description |
---|---|---|
| list value | List of <physical_network>:<physical_bridge> |
| list value | Comma-separated list of <physical_network>:<physical_interface> tuples mapping physical network names to the agent’s node-specific physical network interfaces to be used for flat and VLAN networks. All physical networks listed in network_vlan_ranges on the server should have mappings to appropriate interfaces on each agent. |
8.3.4. network_log
The following table outlines the options available under the [network_log]
group in the /etc/neutron/plugins/ml2/linuxbridge_agent.ini
file.
Table 8.8. network_log
Configuration option = Default value | Type | Description |
---|---|---|
| integer value | Maximum number of packets per rate_limit. |
| string value | Output logfile path on agent side, default syslog file. |
| integer value | Maximum packets logging per second. |
8.3.5. securitygroup
The following table outlines the options available under the [securitygroup]
group in the /etc/neutron/plugins/ml2/linuxbridge_agent.ini
file.
Table 8.9. securitygroup
Configuration option = Default value | Type | Description |
---|---|---|
| boolean value | Use ipset to speed-up the iptables based security groups. Enabling ipset support requires that ipset is installed on L2 agent node. |
| boolean value | Controls whether the neutron security group API is enabled in the server. It should be false when using no security groups or using the nova security group API. |
| string value | Driver for security groups firewall in the L2 agent |
| list value | Comma-separated list of ethertypes to be permitted, in hexadecimal (starting with "0x"). For example, "0x4008" to permit InfiniBand. |
8.3.6. vxlan
The following table outlines the options available under the [vxlan]
group in the /etc/neutron/plugins/ml2/linuxbridge_agent.ini
file.
Table 8.10. vxlan
Configuration option = Default value | Type | Description |
---|---|---|
| boolean value | Enable local ARP responder which provides local responses instead of performing ARP broadcast into the overlay. Enabling local ARP responder is not fully compatible with the allowed-address-pairs extension. |
| boolean value | Enable VXLAN on the agent. Can be enabled when agent is managed by ml2 plugin using linuxbridge mechanism driver |
| boolean value | Extension to use alongside ml2 plugin’s l2population mechanism driver. It enables the plugin to populate VXLAN forwarding table. |
| IP address value | IP address of local overlay (tunnel) network endpoint. Use either an IPv4 or IPv6 address that resides on one of the host network interfaces. The IP version of this value must match the value of the overlay_ip_version option in the ML2 plug-in configuration file on the neutron server node(s). |
| list value | Optional comma-separated list of <multicast address>:<vni_min>:<vni_max> triples describing how to assign a multicast address to VXLAN according to its VNI ID. |
| integer value | (DEPRECATED FOR REMOVAL) TOS for vxlan interface protocol packets. This option is deprecated in favor of the dscp option in the AGENT section and will be removed in a future release. To convert the TOS value to DSCP, divide by 4. |
| integer value | TTL for vxlan interface protocol packets. |
| port value | The UDP port used for VXLAN communication. By default, the Linux kernel doesn’t use the IANA assigned standard value, so if you want to use it, this option must be set to 4789. It is not set by default because of backward compatibiltiy. |
| port value | The maximum of the UDP source port range used for VXLAN communication. |
| port value | The minimum of the UDP source port range used for VXLAN communication. |
| string value | Multicast group(s) for vxlan interface. A range of group addresses may be specified by using CIDR notation. Specifying a range allows different VNIs to use different group addresses, reducing or eliminating spurious broadcast traffic to the tunnel endpoints. To reserve a unique group for each possible (24-bit) VNI, use a /8 such as 239.0.0.0/8. This setting must be the same on all the agents. |
8.4. metadata_agent.ini
This section contains options for the /etc/neutron/metadata_agent.ini
file.
8.4.1. DEFAULT
The following table outlines the options available under the [DEFAULT]
group in the /etc/neutron/metadata_agent.ini
file.
.
Configuration option = Default value | Type | Description |
---|---|---|
| string value | Certificate Authority public key (CA cert) file for ssl |
| boolean value | If set to true, the logging level will be set to DEBUG instead of the default INFO level. |
| list value | List of package logging levels in logger=LEVEL pairs. This option is ignored if log_config_append is set. |
| boolean value | Enables or disables fatal status of deprecations. |
`instance_format = [instance: %(uuid)s] ` | string value | The format for an instance that is passed with the log message. |
`instance_uuid_format = [instance: %(uuid)s] ` | string value | The format for an instance UUID that is passed with the log message. |
| string value | 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. Note that when logging configuration files are used then all logging configuration is set in the configuration file and other logging configuration options are ignored (for example, log-date-format). |
| string value | Defines the format string for %%(asctime)s in log records. Default: %(default)s . This option is ignored if log_config_append is set. |
| string value | (Optional) The base directory used for relative log_file paths. This option is ignored if log_config_append is set. |
| string value | (Optional) Name of log file to send logging output to. If no default is set, logging will go to stderr as defined by use_stderr. This option is ignored if log_config_append is set. |
| integer value | The amount of time before the log files are rotated. This option is ignored unless log_rotation_type is setto "interval". |
| string value | Rotation interval type. The time of the last file change (or the time when the service was started) is used when scheduling the next rotation. |
| string value | Log rotation type. |
| string value | Format string to use for log messages with context. Used by oslo_log.formatters.ContextFormatter |
| string value | Additional data to append to log message when logging level for the message is DEBUG. Used by oslo_log.formatters.ContextFormatter |
| string value | Format string to use for log messages when context is undefined. Used by oslo_log.formatters.ContextFormatter |
| string value | Prefix each line of exception output with this format. Used by oslo_log.formatters.ContextFormatter |
| string value | Defines the format string for %(user_identity)s that is used in logging_context_format_string. Used by oslo_log.formatters.ContextFormatter |
| integer value | Maximum number of rotated log files. |
| integer value | Log file maximum size in MB. This option is ignored if "log_rotation_type" is not set to "size". |
| integer value | Number of backlog requests to configure the metadata server socket with |
`metadata_proxy_group = ` | string value | Group (gid or name) running metadata proxy after its initialization (if empty: agent effective group). |
`metadata_proxy_shared_secret = ` | string value | When proxying metadata requests, Neutron signs the Instance-ID header with a shared secret to prevent spoofing. You may select any string for a secret, but it must match here and in the configuration used by the Nova Metadata Server. NOTE: Nova uses the same config key, but in [neutron] section. |
| string value | Location for Metadata Proxy UNIX domain socket. |
| string value | Metadata Proxy UNIX domain socket mode, 4 values allowed: deduce: deduce mode from metadata_proxy_user/group values, user: set metadata proxy socket mode to 0o644, to use when metadata_proxy_user is agent effective user or root, group: set metadata proxy socket mode to 0o664, to use when metadata_proxy_group is agent effective group or root, all: set metadata proxy socket mode to 0o666, to use otherwise. |
`metadata_proxy_user = ` | string value | User (uid or name) running metadata proxy after its initialization (if empty: agent effective user). |
| integer value | Number of separate worker processes for metadata server (defaults to half of the number of CPUs) |
`nova_client_cert = ` | string value | Client certificate for nova metadata api server. |
`nova_client_priv_key = ` | string value | Private key of client certificate. |
| host address value | IP address or DNS name of Nova metadata server. |
| boolean value | Allow to perform insecure SSL (https) requests to nova metadata |
| port value | TCP Port used by Nova metadata server. |
| string value | Protocol to access nova metadata, http or https |
| boolean value | Enables or disables publication of error events. |
| integer value | Maximum number of logged messages per rate_limit_interval. |
| string value | Log level name used by rate limiting: CRITICAL, ERROR, INFO, WARNING, DEBUG or empty string. Logs with level greater or equal to rate_limit_except_level are not filtered. An empty string means that all levels are filtered. |
| integer value | Interval, number of seconds, of log rate limiting. |
| string value | Syslog facility to receive log lines. This option is ignored if log_config_append is set. |
| boolean value | Enable journald for logging. If running in a systemd environment you may wish to enable journal support. Doing so will use the journal native protocol which includes structured metadata in addition to log messages.This option is ignored if log_config_append is set. |
| boolean value | Use JSON formatting for logging. This option is ignored if log_config_append is set. |
| boolean value | Use syslog for logging. Existing syslog format is DEPRECATED and will be changed later to honor RFC5424. This option is ignored if log_config_append is set. |
| boolean value | Log output to Windows Event Log. |
| boolean value | Log output to standard error. This option is ignored if log_config_append is set. |
| boolean value | Uses logging handler designed to watch file system. When log file is moved or removed this handler will open a new log file with specified path instantaneously. It makes sense only if log_file option is specified and Linux platform is used. This option is ignored if log_config_append is set. |
8.4.2. agent
The following table outlines the options available under the [agent]
group in the /etc/neutron/metadata_agent.ini
file.
Table 8.11. agent
Configuration option = Default value | Type | Description |
---|---|---|
| boolean value | Log agent heartbeats |
| floating point value | Seconds between nodes reporting state to server; should be less than agent_down_time, best if it is half or less than agent_down_time. |
8.4.3. cache
The following table outlines the options available under the [cache]
group in the /etc/neutron/metadata_agent.ini
file.
Table 8.12. cache
Configuration option = Default value | Type | Description |
---|---|---|
| string value | Cache backend module. For eventlet-based or environments with hundreds of threaded servers, Memcache with pooling (oslo_cache.memcache_pool) is recommended. For environments with less than 100 threaded servers, Memcached (dogpile.cache.memcached) or Redis (dogpile.cache.redis) is recommended. Test environments with a single instance of the server can use the dogpile.cache.memory backend. |
| multi valued | Arguments supplied to the backend module. Specify this option once per argument to be passed to the dogpile.cache backend. Example format: "<argname>:<value>". |
| string value | Prefix for building the configuration dictionary for the cache region. This should not need to be changed unless there is another dogpile.cache region with the same configuration name. |
| boolean value | Extra debugging from the cache backend (cache keys, get/set/delete/etc calls). This is only really useful if you need to see the specific cache-backend get/set/delete calls with the keys/values. Typically this should be left set to false. |
| boolean value | Global toggle for caching. |
| integer value | Default TTL, in seconds, for any cached item in the dogpile.cache region. This applies to any cached method that doesn’t have an explicit cache expiration time defined for it. |
| integer value | Number of seconds memcached server is considered dead before it is tried again. (dogpile.cache.memcache and oslo_cache.memcache_pool backends only). |
| integer value | Number of seconds that an operation will wait to get a memcache client connection. |
| integer value | Max total number of open connections to every memcached server. (oslo_cache.memcache_pool backend only). |
| integer value | Number of seconds a connection to memcached is held unused in the pool before it is closed. (oslo_cache.memcache_pool backend only). |
| list value | Memcache servers in the format of "host:port". (dogpile.cache.memcache and oslo_cache.memcache_pool backends only). |
| floating point value | Timeout in seconds for every call to a server. (dogpile.cache.memcache and oslo_cache.memcache_pool backends only). |
| list value | Proxy classes to import that will affect the way the dogpile.cache backend functions. See the dogpile.cache documentation on changing-backend-behavior. |
8.5. metering_agent.ini
This section contains options for the /etc/neutron/metering_agent.ini
file.
8.5.1. DEFAULT
The following table outlines the options available under the [DEFAULT]
group in the /etc/neutron/metering_agent.ini
file.
.
Configuration option = Default value | Type | Description |
---|---|---|
| boolean value | If set to true, the logging level will be set to DEBUG instead of the default INFO level. |
| list value | List of package logging levels in logger=LEVEL pairs. This option is ignored if log_config_append is set. |
| string value | Metering driver |
| boolean value | Enables or disables fatal status of deprecations. |
`instance_format = [instance: %(uuid)s] ` | string value | The format for an instance that is passed with the log message. |
`instance_uuid_format = [instance: %(uuid)s] ` | string value | The format for an instance UUID that is passed with the log message. |
| string value | The driver used to manage the virtual interface. |
| string value | 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. Note that when logging configuration files are used then all logging configuration is set in the configuration file and other logging configuration options are ignored (for example, log-date-format). |
| string value | Defines the format string for %%(asctime)s in log records. Default: %(default)s . This option is ignored if log_config_append is set. |
| string value | (Optional) The base directory used for relative log_file paths. This option is ignored if log_config_append is set. |
| string value | (Optional) Name of log file to send logging output to. If no default is set, logging will go to stderr as defined by use_stderr. This option is ignored if log_config_append is set. |
| integer value | The amount of time before the log files are rotated. This option is ignored unless log_rotation_type is setto "interval". |
| string value | Rotation interval type. The time of the last file change (or the time when the service was started) is used when scheduling the next rotation. |
| string value | Log rotation type. |
| string value | Format string to use for log messages with context. Used by oslo_log.formatters.ContextFormatter |
| string value | Additional data to append to log message when logging level for the message is DEBUG. Used by oslo_log.formatters.ContextFormatter |
| string value | Format string to use for log messages when context is undefined. Used by oslo_log.formatters.ContextFormatter |
| string value | Prefix each line of exception output with this format. Used by oslo_log.formatters.ContextFormatter |
| string value | Defines the format string for %(user_identity)s that is used in logging_context_format_string. Used by oslo_log.formatters.ContextFormatter |
| integer value | Maximum number of rotated log files. |
| integer value | Log file maximum size in MB. This option is ignored if "log_rotation_type" is not set to "size". |
| integer value | Interval between two metering measures |
| string value | Name of Open vSwitch bridge to use |
| boolean value | Uses veth for an OVS interface or not. Support kernels with limited namespace support (e.g. RHEL 6.5) and rate limiting on router’s gateway port so long as ovs_use_veth is set to True. |
| boolean value | Enables or disables publication of error events. |
| integer value | Maximum number of logged messages per rate_limit_interval. |
| string value | Log level name used by rate limiting: CRITICAL, ERROR, INFO, WARNING, DEBUG or empty string. Logs with level greater or equal to rate_limit_except_level are not filtered. An empty string means that all levels are filtered. |
| integer value | Interval, number of seconds, of log rate limiting. |
| integer value | Interval between two metering reports |
| integer value | Maximum seconds to wait for a response from an RPC call. |
| string value | Syslog facility to receive log lines. This option is ignored if log_config_append is set. |
| boolean value | Enable journald for logging. If running in a systemd environment you may wish to enable journal support. Doing so will use the journal native protocol which includes structured metadata in addition to log messages.This option is ignored if log_config_append is set. |
| boolean value | Use JSON formatting for logging. This option is ignored if log_config_append is set. |
| boolean value | Use syslog for logging. Existing syslog format is DEPRECATED and will be changed later to honor RFC5424. This option is ignored if log_config_append is set. |
| boolean value | Log output to Windows Event Log. |
| boolean value | Log output to standard error. This option is ignored if log_config_append is set. |
| boolean value | Uses logging handler designed to watch file system. When log file is moved or removed this handler will open a new log file with specified path instantaneously. It makes sense only if log_file option is specified and Linux platform is used. This option is ignored if log_config_append is set. |
8.5.2. agent
The following table outlines the options available under the [agent]
group in the /etc/neutron/metering_agent.ini
file.
Table 8.13. agent
Configuration option = Default value | Type | Description |
---|---|---|
| boolean value | Log agent heartbeats |
| floating point value | Seconds between nodes reporting state to server; should be less than agent_down_time, best if it is half or less than agent_down_time. |
8.5.3. ovs
The following table outlines the options available under the [ovs]
group in the /etc/neutron/metering_agent.ini
file.
Table 8.14. ovs
Configuration option = Default value | Type | Description |
---|---|---|
| integer value | The maximum number of MAC addresses to learn on a bridge managed by the Neutron OVS agent. Values outside a reasonable range (10 to 1,000,000) might be overridden by Open vSwitch according to the documentation. |
| boolean value | Enable IGMP snooping for integration bridge. If this option is set to True, support for Internet Group Management Protocol (IGMP) is enabled in integration bridge. Setting this option to True will also enable Open vSwitch mcast-snooping-disable-flood-unregistered flag. This option will disable flooding of unregistered multicast packets to all ports. The switch will send unregistered multicast packets only to ports connected to multicast routers. |
| string value | The connection string for the OVSDB backend. Will be used by ovsdb-client when monitoring and used for the all ovsdb commands when native ovsdb_interface is enabled |
| boolean value | Enable OVSDB debug logs |
| integer value | Timeout in seconds for ovsdb commands. If the timeout expires, ovsdb commands will fail with ALARMCLOCK error. |
| string value | The Certificate Authority (CA) certificate to use when interacting with OVSDB. Required when using an "ssl:" prefixed ovsdb_connection |
| string value | The SSL certificate file to use when interacting with OVSDB. Required when using an "ssl:" prefixed ovsdb_connection |
| string value | The SSL private key file to use when interacting with OVSDB. Required when using an "ssl:" prefixed ovsdb_connection |
8.6. ml2_conf.ini
This section contains options for the /etc/neutron/plugins/ml2/ml2_conf.ini
file.
8.6.1. DEFAULT
The following table outlines the options available under the [DEFAULT]
group in the /etc/neutron/plugins/ml2/ml2_conf.ini
file.
.
Configuration option = Default value | Type | Description |
---|---|---|
| boolean value | If set to true, the logging level will be set to DEBUG instead of the default INFO level. |
| list value | List of package logging levels in logger=LEVEL pairs. This option is ignored if log_config_append is set. |
| boolean value | Enables or disables fatal status of deprecations. |
`instance_format = [instance: %(uuid)s] ` | string value | The format for an instance that is passed with the log message. |
`instance_uuid_format = [instance: %(uuid)s] ` | string value | The format for an instance UUID that is passed with the log message. |
| string value | 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. Note that when logging configuration files are used then all logging configuration is set in the configuration file and other logging configuration options are ignored (for example, log-date-format). |
| string value | Defines the format string for %%(asctime)s in log records. Default: %(default)s . This option is ignored if log_config_append is set. |
| string value | (Optional) The base directory used for relative log_file paths. This option is ignored if log_config_append is set. |
| string value | (Optional) Name of log file to send logging output to. If no default is set, logging will go to stderr as defined by use_stderr. This option is ignored if log_config_append is set. |
| integer value | The amount of time before the log files are rotated. This option is ignored unless log_rotation_type is setto "interval". |
| string value | Rotation interval type. The time of the last file change (or the time when the service was started) is used when scheduling the next rotation. |
| string value | Log rotation type. |
| string value | Format string to use for log messages with context. Used by oslo_log.formatters.ContextFormatter |
| string value | Additional data to append to log message when logging level for the message is DEBUG. Used by oslo_log.formatters.ContextFormatter |
| string value | Format string to use for log messages when context is undefined. Used by oslo_log.formatters.ContextFormatter |
| string value | Prefix each line of exception output with this format. Used by oslo_log.formatters.ContextFormatter |
| string value | Defines the format string for %(user_identity)s that is used in logging_context_format_string. Used by oslo_log.formatters.ContextFormatter |
| integer value | Maximum number of rotated log files. |
| integer value | Log file maximum size in MB. This option is ignored if "log_rotation_type" is not set to "size". |
| boolean value | Enables or disables publication of error events. |
| integer value | Maximum number of logged messages per rate_limit_interval. |
| string value | Log level name used by rate limiting: CRITICAL, ERROR, INFO, WARNING, DEBUG or empty string. Logs with level greater or equal to rate_limit_except_level are not filtered. An empty string means that all levels are filtered. |
| integer value | Interval, number of seconds, of log rate limiting. |
| string value | Syslog facility to receive log lines. This option is ignored if log_config_append is set. |
| boolean value | Enable journald for logging. If running in a systemd environment you may wish to enable journal support. Doing so will use the journal native protocol which includes structured metadata in addition to log messages.This option is ignored if log_config_append is set. |
| boolean value | Use JSON formatting for logging. This option is ignored if log_config_append is set. |
| boolean value | Use syslog for logging. Existing syslog format is DEPRECATED and will be changed later to honor RFC5424. This option is ignored if log_config_append is set. |
| boolean value | Log output to Windows Event Log. |
| boolean value | Log output to standard error. This option is ignored if log_config_append is set. |
| boolean value | Uses logging handler designed to watch file system. When log file is moved or removed this handler will open a new log file with specified path instantaneously. It makes sense only if log_file option is specified and Linux platform is used. This option is ignored if log_config_append is set. |
8.6.2. ml2
The following table outlines the options available under the [ml2]
group in the /etc/neutron/plugins/ml2/ml2_conf.ini
file.
Table 8.15. ml2
Configuration option = Default value | Type | Description |
---|---|---|
| list value | An ordered list of extension driver entrypoints to be loaded from the neutron.ml2.extension_drivers namespace. For example: extension_drivers = port_security,qos |
| string value | Default network type for external networks when no provider attributes are specified. By default it is None, which means that if provider attributes are not specified while creating external networks then they will have the same type as tenant networks. Allowed values for external_network_type config option depend on the network type values configured in type_drivers config option. |
| list value | An ordered list of networking mechanism driver entrypoints to be loaded from the neutron.ml2.mechanism_drivers namespace. |
| integer value | IP version of all overlay (tunnel) network endpoints. Use a value of 4 for IPv4 or 6 for IPv6. |
| integer value | Maximum size of an IP packet (MTU) that can traverse the underlying physical network infrastructure without fragmentation when using an overlay/tunnel protocol. This option allows specifying a physical network MTU value that differs from the default global_physnet_mtu value. |
| list value | A list of mappings of physical networks to MTU values. The format of the mapping is <physnet>:<mtu val>. This mapping allows specifying a physical network MTU value that differs from the default global_physnet_mtu value. |
| list value | Ordered list of network_types to allocate as tenant networks. The default value local is useful for single-box testing but provides no connectivity between hosts. |
| list value | List of network type driver entrypoints to be loaded from the neutron.ml2.type_drivers namespace. |
8.6.3. ml2_type_flat
The following table outlines the options available under the [ml2_type_flat]
group in the /etc/neutron/plugins/ml2/ml2_conf.ini
file.
Table 8.16. ml2_type_flat
Configuration option = Default value | Type | Description |
---|---|---|
| list value | List of physical_network names with which flat networks can be created. Use default * to allow flat networks with arbitrary physical_network names. Use an empty list to disable flat networks. |
8.6.4. ml2_type_geneve
The following table outlines the options available under the [ml2_type_geneve]
group in the /etc/neutron/plugins/ml2/ml2_conf.ini
file.
Table 8.17. ml2_type_geneve
Configuration option = Default value | Type | Description |
---|---|---|
| integer value | Geneve encapsulation header size is dynamic, this value is used to calculate the maximum MTU for the driver. This is the sum of the sizes of the outer ETH + IP + UDP + GENEVE header sizes. The default size for this field is 50, which is the size of the Geneve header without any additional option headers. |
| list value | Comma-separated list of <vni_min>:<vni_max> tuples enumerating ranges of Geneve VNI IDs that are available for tenant network allocation |
8.6.5. ml2_type_gre
The following table outlines the options available under the [ml2_type_gre]
group in the /etc/neutron/plugins/ml2/ml2_conf.ini
file.
Table 8.18. ml2_type_gre
Configuration option = Default value | Type | Description |
---|---|---|
| list value | Comma-separated list of <tun_min>:<tun_max> tuples enumerating ranges of GRE tunnel IDs that are available for tenant network allocation |
8.6.6. ml2_type_vlan
The following table outlines the options available under the [ml2_type_vlan]
group in the /etc/neutron/plugins/ml2/ml2_conf.ini
file.
Table 8.19. ml2_type_vlan
Configuration option = Default value | Type | Description |
---|---|---|
| list value | List of <physical_network>:<vlan_min>:<vlan_max> or <physical_network> specifying physical_network names usable for VLAN provider and tenant networks, as well as ranges of VLAN tags on each available for allocation to tenant networks. |
8.6.7. ml2_type_vxlan
The following table outlines the options available under the [ml2_type_vxlan]
group in the /etc/neutron/plugins/ml2/ml2_conf.ini
file.
Table 8.20. ml2_type_vxlan
Configuration option = Default value | Type | Description |
---|---|---|
| list value | Comma-separated list of <vni_min>:<vni_max> tuples enumerating ranges of VXLAN VNI IDs that are available for tenant network allocation |
| string value | Multicast group for VXLAN. When configured, will enable sending all broadcast traffic to this multicast group. When left unconfigured, will disable multicast VXLAN mode. |
8.6.8. ovs_driver
The following table outlines the options available under the [ovs_driver]
group in the /etc/neutron/plugins/ml2/ml2_conf.ini
file.
Table 8.21. ovs_driver
Configuration option = Default value | Type | Description |
---|---|---|
| list value | Comma-separated list of VNIC types for which support is administratively prohibited by the mechanism driver. Please note that the supported vnic_types depend on your network interface card, on the kernel version of your operating system, and on other factors, like OVS version. In case of ovs mechanism driver the valid vnic types are normal and direct. Note that direct is supported only from kernel 4.8, and from ovs 2.8.0. Bind DIRECT (SR-IOV) port allows to offload the OVS flows using tc to the SR-IOV NIC. This allows to support hardware offload via tc and that allows us to manage the VF by OpenFlow control plane using representor net-device. |
8.6.9. securitygroup
The following table outlines the options available under the [securitygroup]
group in the /etc/neutron/plugins/ml2/ml2_conf.ini
file.
Table 8.22. securitygroup
Configuration option = Default value | Type | Description |
---|---|---|
| boolean value | Use ipset to speed-up the iptables based security groups. Enabling ipset support requires that ipset is installed on L2 agent node. |
| boolean value | Controls whether the neutron security group API is enabled in the server. It should be false when using no security groups or using the nova security group API. |
| string value | Driver for security groups firewall in the L2 agent |
| list value | Comma-separated list of ethertypes to be permitted, in hexadecimal (starting with "0x"). For example, "0x4008" to permit InfiniBand. |
8.6.10. sriov_driver
The following table outlines the options available under the [sriov_driver]
group in the /etc/neutron/plugins/ml2/ml2_conf.ini
file.
Table 8.23. sriov_driver
Configuration option = Default value | Type | Description |
---|---|---|
| list value | Comma-separated list of VNIC types for which support is administratively prohibited by the mechanism driver. Please note that the supported vnic_types depend on your network interface card, on the kernel version of your operating system, and on other factors. In case of sriov mechanism driver the valid VNIC types are direct, macvtap and direct-physical. |
8.7. neutron.conf
This section contains options for the /etc/neutron/neutron.conf
file.
8.7.1. DEFAULT
The following table outlines the options available under the [DEFAULT]
group in the /etc/neutron/neutron.conf
file.
.
Configuration option = Default value | Type | Description |
---|---|---|
| integer value | Seconds to regard the agent is down; should be at least twice report_interval, to be sure the agent is down for good. |
| boolean value | Automatically remove networks from offline DHCP agents. |
| boolean value | Automatically reschedule routers from offline L3 agents to online L3 agents. |
| boolean value | Allow the usage of the bulk API |
| boolean value | Allow overlapping IP support in Neutron. Attention: the following parameter MUST be set to False if Neutron is being used in conjunction with Nova security groups. |
| list value | Defines the allowed conntrack helpers, and conntack helper module protocol constraints. |
`api_extensions_path = ` | string value | The path for API extensions. Note that this can be a colon-separated list of paths. For example: api_extensions_path = extensions:/path/to/more/exts:/even/more/exts. The path of neutron.extensions is appended to this, so if your extensions are in there you don’t need to specify them here. |
| string value | File name for the paste.deploy config for api service |
| integer value | Number of separate API worker processes for service. If not specified, the default is equal to the number of CPUs available for best performance, capped by potential RAM usage. |
| string value | The type of authentication to use |
| integer value | Number of backlog requests to configure the socket with |
| string value | The base MAC address Neutron will use for VIFs. The first 3 octets will remain unchanged. If the 4th octet is not 00, it will also be used. The others will be randomly generated. |
| host address value | The host IP to bind to. |
| port value | The port to bind to |
| integer value | Timeout for client connections' socket operations. If an incoming connection is idle for this number of seconds it will be closed. A value of 0 means wait forever. |
| integer value | The pool size limit for connections expiration policy |
| integer value | The time-to-live in sec of idle connections in the pool |
| string value | The default exchange under which topics are scoped. May be overridden by an exchange name specified in the transport_url option. |
| string value | The core plugin Neutron will use |
| boolean value | If set to true, the logging level will be set to DEBUG instead of the default INFO level. |
| list value | Default value of availability zone hints. The availability zone aware schedulers use this when the resources availability_zone_hints is empty. Multiple availability zones can be specified by a comma separated string. This value can be empty. In this case, even if availability_zone_hints for a resource is empty, availability zone is considered for high availability while scheduling the resource. |
| list value | List of package logging levels in logger=LEVEL pairs. This option is ignored if log_config_append is set. |
| boolean value | Allow sending resource operation notification to DHCP agent |
| integer value | Number of DHCP agents scheduled to host a tenant network. If this number is greater than 1, the scheduler automatically assigns multiple DHCP agents for a given tenant network, providing high availability for DHCP service. |
| integer value | DHCP lease duration (in seconds). Use -1 to tell dnsmasq to use infinite lease times. |
| string value | Representing the resource type whose load is being reported by the agent. This can be "networks", "subnets" or "ports". When specified (Default is networks), the server will extract particular load sent as part of its agent configuration object from the agent report state, which is the number of resources being consumed, at every report_interval.dhcp_load_type can be used in combination with network_scheduler_driver = neutron.scheduler.dhcp_agent_scheduler.WeightScheduler When the network_scheduler_driver is WeightScheduler, dhcp_load_type can be configured to represent the choice for the resource being balanced. Example: dhcp_load_type=networks |
| string value | Domain to use for building the hostnames |
| string value | The base mac address used for unique DVR instances by Neutron. The first 3 octets will remain unchanged. If the 4th octet is not 00, it will also be used. The others will be randomly generated. The dvr_base_mac must be different from base_mac to avoid mixing them up with MAC’s allocated for tenant ports. A 4 octet example would be dvr_base_mac = fa:16:3f:4f:00:00. The default is 3 octet |
| boolean value | Determine if setup is configured for DVR. If False, DVR API extension will be disabled. |
| boolean value | Agent starts with admin_state_up=False when enable_new_agents=False. In the case, user’s resources will not be scheduled automatically to the agent until admin changes admin_state_up to True. |
| boolean value | Enable services on an agent with admin_state_up False. If this option is False, when admin_state_up of an agent is turned False, services on it will be disabled. Agents with admin_state_up False are not selected for automatic scheduling regardless of this option. But manual scheduling to such agents is available if this option is True. |
| boolean value | Define the default value of enable_snat if not provided in external_gateway_info. |
| integer value | Size of executor thread pool when executor is threading or eventlet. |
| string value | Driver for external DNS integration. |
| boolean value | Enables or disables fatal status of deprecations. |
| boolean value | If True, then allow plugins to decide whether to perform validations on filter parameters. Filter validation is enabled if this config is turned on and it is supported by all plugins |
| integer value | MTU of the underlying physical network. Neutron uses this value to calculate MTU for all virtual network components. For flat and VLAN networks, neutron uses this value without modification. For overlay networks such as VXLAN, neutron automatically subtracts the overlay protocol overhead from this value. Defaults to 1500, the standard value for Ethernet. |
| host address value | Hostname to be used by the Neutron server, agents and services running on this machine. All the agents and services running on this machine must use the same host value. |
| boolean value | Flag to determine if hosting a DVR local router to the DHCP agent is desired. If False, any L3 function supported by the DHCP agent instance will not be possible, for instance: DNS. |
| integer value | Number of times client connections (nova, ironic) should be retried on a failed HTTP call. 0 (zero) meansconnection is attempted only once (not retried). Setting to any positive integer means that on failure the connection is retried that many times. For example, setting to 3 means total attempts to connect will be 4. |
`instance_format = [instance: %(uuid)s] ` | string value | The format for an instance that is passed with the log message. |
`instance_uuid_format = [instance: %(uuid)s] ` | string value | The format for an instance UUID that is passed with the log message. |
| string value | The driver used to manage the virtual interface. |
| string value | Neutron IPAM (IP address management) driver to use. By default, the reference implementation of the Neutron IPAM driver is used. |
| boolean value | Enables IPv6 Prefix Delegation for automatic subnet CIDR allocation. Set to True to enable IPv6 Prefix Delegation for subnet allocation in a PD-capable environment. Users making subnet creation requests for IPv6 subnets without providing a CIDR or subnetpool ID will be given a CIDR via the Prefix Delegation mechanism. Note that enabling PD will override the behavior of the default IPv6 subnetpool. |
| boolean value | Enable HA mode for virtual routers. |
| string value | Subnet used for the l3 HA admin network. |
`l3_ha_network_physical_name = ` | string value | The physical network name with which the HA network can be created. |
`l3_ha_network_type = ` | string value | The network type to use when creating the HA network for an HA router. By default or if empty, the first tenant_network_types is used. This is helpful when the VRRP traffic should use a specific network which is not the default one. |
| string value | 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. Note that when logging configuration files are used then all logging configuration is set in the configuration file and other logging configuration options are ignored (for example, log-date-format). |
| string value | Defines the format string for %%(asctime)s in log records. Default: %(default)s . This option is ignored if log_config_append is set. |
| string value | (Optional) The base directory used for relative log_file paths. This option is ignored if log_config_append is set. |
| string value | (Optional) Name of log file to send logging output to. If no default is set, logging will go to stderr as defined by use_stderr. This option is ignored if log_config_append is set. |
| integer value | The amount of time before the log files are rotated. This option is ignored unless log_rotation_type is setto "interval". |
| string value | Rotation interval type. The time of the last file change (or the time when the service was started) is used when scheduling the next rotation. |
| string value | Log rotation type. |
| string value | Format string to use for log messages with context. Used by oslo_log.formatters.ContextFormatter |
| string value | Additional data to append to log message when logging level for the message is DEBUG. Used by oslo_log.formatters.ContextFormatter |
| string value | Format string to use for log messages when context is undefined. Used by oslo_log.formatters.ContextFormatter |
| string value | Prefix each line of exception output with this format. Used by oslo_log.formatters.ContextFormatter |
| string value | Defines the format string for %(user_identity)s that is used in logging_context_format_string. Used by oslo_log.formatters.ContextFormatter |
| integer value | Maximum number of allowed address pairs |
| integer value | Maximum number of DNS nameservers per subnet |
| integer value | Maximum line size of message headers to be accepted. max_header_line may need to be increased when using large tokens (typically those generated when keystone is configured to use PKI tokens with big service catalogs). |
| integer value | Maximum number of L3 agents which a HA router will be scheduled on. If it is set to 0 then the router will be scheduled on every agent. |
| integer value | Maximum number of rotated log files. |
| integer value | Log file maximum size in MB. This option is ignored if "log_rotation_type" is not set to "size". |
| integer value | Maximum number of routes per router |
| integer value | Maximum number of host routes per subnet |
`metadata_proxy_group = ` | string value | Group (gid or name) running metadata proxy after its initialization (if empty: agent effective group). |
| string value | Location for Metadata Proxy UNIX domain socket. |
`metadata_proxy_user = ` | string value | User (uid or name) running metadata proxy after its initialization (if empty: agent effective user). |
| boolean value | Allow auto scheduling networks to DHCP agent. |
| string value | This string is prepended to the normal URL that is returned in links to the OpenStack Network API. If it is empty (the default), the URLs are returned unchanged. |
| string value | Driver to use for scheduling network to DHCP agent |
| boolean value | Send notification to nova when port data (fixed_ips/floatingip) changes so nova can update its cache. |
| boolean value | Send notification to nova when port status changes |
| string value | The maximum number of items returned in a single response, value was infinite or negative integer means no limit |
| integer value | Range of seconds to randomly delay when starting the periodic task scheduler to reduce stampeding. (Disable by setting to 0) |
| integer value | Seconds between running periodic tasks. |
| boolean value | Enables or disables publication of error events. |
| integer value | Maximum number of logged messages per rate_limit_interval. |
| string value | Log level name used by rate limiting: CRITICAL, ERROR, INFO, WARNING, DEBUG or empty string. Logs with level greater or equal to rate_limit_except_level are not filtered. An empty string means that all levels are filtered. |
| integer value | Interval, number of seconds, of log rate limiting. |
| integer value | Number of seconds to keep retrying to listen |
| boolean value | Allow auto scheduling of routers to L3 agent. |
| boolean value | System-wide flag to determine the type of router that tenants can create. Only admin can override. |
| string value | Driver to use for scheduling router to a default L3 agent |
| integer value | Size of RPC connection pool. |
| integer value | Maximum seconds to wait for a response from an RPC call. |
| integer value | Seconds to wait for a response from a call. |
| integer value | Number of RPC worker processes dedicated to state reports queue. |
| integer value | Number of RPC worker processes for service. If not specified, the default is equal to half the number of API workers. |
| integer value | Number of seconds between sending events to nova if there are any events to send. |
| list value | The service plugins Neutron will use |
| string value | Set process name to match child worker role. Available options are: off - retains the previous behavior; on - renames processes to neutron-server: role (original string); brief - renames the same as on, but without the original string, such as neutron-server: role. |
| string value | Where to store Neutron state files. This directory must be writable by the agent. |
| string value | Syslog facility to receive log lines. This option is ignored if log_config_append is set. |
| integer value | Sets the value of TCP_KEEPIDLE in seconds for each server socket. Not supported on OS X. |
| string value | The network address and optional user credentials for connecting to the messaging backend, in URL format. The expected format is: driver://[user:pass@]host:port[,[userN:passN@]hostN:portN]/virtual_host?query Example: rabbit://rabbitmq:password@127.0.0.1:5672// For full details on the fields in the URL see the documentation of oslo_messaging.TransportURL at https://docs.openstack.org/oslo.messaging/latest/reference/transport.html |
| boolean value | Enable journald for logging. If running in a systemd environment you may wish to enable journal support. Doing so will use the journal native protocol which includes structured metadata in addition to log messages.This option is ignored if log_config_append is set. |
| boolean value | Use JSON formatting for logging. This option is ignored if log_config_append is set. |
| boolean value | Use syslog for logging. Existing syslog format is DEPRECATED and will be changed later to honor RFC5424. This option is ignored if log_config_append is set. |
| boolean value | Log output to Windows Event Log. |
| boolean value | Enable SSL on the API server |
| boolean value | Log output to standard error. This option is ignored if log_config_append is set. |
| boolean value | If True, then allow plugins that support it to create VLAN transparent networks. |
| boolean value | Uses logging handler designed to watch file system. When log file is moved or removed this handler will open a new log file with specified path instantaneously. It makes sense only if log_file option is specified and Linux platform is used. This option is ignored if log_config_append is set. |
| integer value | Size of the pool of greenthreads used by wsgi |
| boolean value | If False, closes the client socket connection explicitly. |
| string value | A python format string that is used as the template to generate log lines. The following values can beformatted into it: client_ip, date_time, request_line, status_code, body_length, wall_seconds. |
8.7.2. agent
The following table outlines the options available under the [agent]
group in the /etc/neutron/neutron.conf
file.
Table 8.24. agent
Configuration option = Default value | Type | Description |
---|---|---|
| string value | Availability zone of this node |
| string value | Action to be executed when a child process dies |
| integer value | Interval between checks of child process liveness (seconds), use 0 to disable |
| boolean value | Add comments to iptables rules. Set to false to disallow the addition of comments to generated iptables rules that describe each rule’s purpose. System must support the iptables comments module for addition of comments. |
| boolean value | Duplicate every iptables difference calculation to ensure the format being generated matches the format of iptables-save. This option should not be turned on for production systems because it imposes a performance penalty. |
| string value | Location of scripts used to kill external processes. Names of scripts here must follow the pattern: "<process-name>-kill" where <process-name> is name of the process which should be killed using this script. For example, kill script for dnsmasq process should be named "dnsmasq-kill". If path is set to None, then default "kill" command will be used to stop processes. |
| boolean value | Log agent heartbeats |
| floating point value | Seconds between nodes reporting state to server; should be less than agent_down_time, best if it is half or less than agent_down_time. |
| string value | Root helper application. Use sudo neutron-rootwrap /etc/neutron/rootwrap.conf to use the real root filter facility. Change to sudo to skip the filtering and just run the command directly. |
| string value | Root helper daemon application to use when possible. Use sudo neutron-rootwrap-daemon /etc/neutron/rootwrap.conf to run rootwrap in "daemon mode" which has been reported to improve performance at scale. For more information on running rootwrap in "daemon mode", see: https://docs.openstack.org/oslo.rootwrap/latest/user/usage.html#daemon-mode For the agent which needs to execute commands in Dom0 in the hypervisor of XenServer, this option should be set to xenapi_root_helper, so that it will keep a XenAPI session to pass commands to Dom0. |
| boolean value | Use the root helper when listing the namespaces on a system. This may not be required depending on the security configuration. If the root helper is not required, set this to False for a performance improvement. |
8.7.3. cors
The following table outlines the options available under the [cors]
group in the /etc/neutron/neutron.conf
file.
Table 8.25. cors
Configuration option = Default value | Type | Description |
---|---|---|
| boolean value | Indicate that the actual request can include user credentials |
| list value | Indicate which header field names may be used during the actual request. |
| list value | Indicate which methods can be used during the actual request. |
| list value | Indicate whether this resource may be shared with the domain received in the requests "origin" header. Format: "<protocol>://<host>[:<port>]", no trailing slash. Example: https://horizon.example.com |
| list value | Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers. |
| integer value | Maximum cache age of CORS preflight requests. |
8.7.4. database
The following table outlines the options available under the [database]
group in the /etc/neutron/neutron.conf
file.
Table 8.26. database
Configuration option = Default value | Type | Description |
---|---|---|
| string value | The back end to use for the database. |
| string value | The SQLAlchemy connection string to use to connect to the database. |
| integer value | Verbosity of SQL debugging information: 0=None, 100=Everything. |
`connection_parameters = ` | string value | Optional URL parameters to append onto the connection URL at connect time; specify as param1=value1¶m2=value2&… |
| integer value | Connections which have been present in the connection pool longer than this number of seconds will be replaced with a new one the next time they are checked out from the pool. |
| boolean value | Add Python stack traces to SQL as comment strings. |
| boolean value | If True, increases the interval between retries of a database operation up to db_max_retry_interval. |
| integer value | Maximum retries in case of connection error or deadlock error before error is raised. Set to -1 to specify an infinite retry count. |
| integer value | If db_inc_retry_interval is set, the maximum seconds between retries of a database operation. |
| integer value | Seconds between retries of a database transaction. |
`engine = ` | string value | Database engine for which script will be generated when using offline migration. |
| integer value | If set, use this value for max_overflow with SQLAlchemy. |
| integer value | Maximum number of SQL connections to keep open in a pool. Setting a value of 0 indicates no limit. |
| integer value | Maximum number of database connection retries during startup. Set to -1 to specify an infinite retry count. |
| boolean value | If True, transparently enables support for handling MySQL Cluster (NDB). |
| string value | The SQL mode to be used for MySQL sessions. This option, including the default, overrides any server-set SQL mode. To use whatever SQL mode is set by the server configuration, set this to no value. Example: mysql_sql_mode= |
| integer value | If set, use this value for pool_timeout with SQLAlchemy. |
| integer value | Interval between retries of opening a SQL connection. |
| string value | The SQLAlchemy connection string to use to connect to the slave database. |
| boolean value | If True, SQLite uses synchronous mode. |
| boolean value | Enable the experimental use of database reconnect on connection lost. |
8.7.5. ironic
The following table outlines the options available under the [ironic]
group in the /etc/neutron/neutron.conf
file.
Table 8.27. ironic
Configuration option = Default value | Type | Description |
---|---|---|
| string value | Authentication URL |
| string value | Authentication type to load |
| string value | PEM encoded Certificate Authority to use when verifying HTTPs connections. |
| string value | PEM encoded client certificate cert file |
| boolean value | Collect per-API call timing information. |
| string value | Optional domain ID to use with v3 and v2 parameters. It will be used for both the user and project domain in v3 and ignored in v2 authentication. |
| string value | Optional domain name to use with v3 API and v2 parameters. It will be used for both the user and project domain in v3 and ignored in v2 authentication. |
| string value | Domain ID to scope to |
| string value | Domain name to scope to |
| boolean value | Send notification events to ironic. (For example on relevant port status changes.) |
| boolean value | Verify HTTPS connections. |
| string value | PEM encoded client certificate key file |
| string value | User’s password |
| string value | Domain ID containing project |
| string value | Domain name containing project |
| string value | Project ID to scope to |
| string value | Project name to scope to |
| boolean value | Log requests to multiple loggers. |
| string value | Scope for system operations |
| string value | Tenant ID |
| string value | Tenant Name |
| integer value | Timeout value for http requests |
| string value | Trust ID |
| string value | User’s domain id |
| string value | User’s domain name |
| string value | User id |
| string value | Username |
8.7.6. keystone_authtoken
The following table outlines the options available under the [keystone_authtoken]
group in the /etc/neutron/neutron.conf
file.
Table 8.28. keystone_authtoken
Configuration option = Default value | Type | Description |
---|---|---|
| string value | Config Section from which to load plugin specific options |
| string value | Authentication type to load |
| string value | (DEPRECATED FOR REMOVAL) Complete "public" Identity API endpoint. This endpoint should not be an "admin" endpoint, as it should be accessible by all end users. Unauthenticated clients are redirected to this endpoint to authenticate. Although this endpoint should ideally be unversioned, client support in the wild varies. If you’re using a versioned v2 endpoint here, then this should not be the same endpoint the service user utilizes for validating tokens, because normal end users may not be able to reach that endpoint. This option is deprecated in favor of www_authenticate_uri and will be removed in the S release. |
| string value | API version of the Identity API endpoint. |
| string value |
Request environment key where the Swift cache object is stored. When auth_token middleware is deployed with a Swift cache, use this option to have the middleware share a caching backend with swift. Otherwise, use the |
| string value | A PEM encoded Certificate Authority to use when verifying HTTPs connections. Defaults to system CAs. |
| string value | Required if identity server requires client certificate |
| boolean value | Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components. |
| string value | Used to control the use and type of token binding. Can be set to: "disabled" to not check token binding. "permissive" (default) to validate binding information if the bind type is of a form known to the server and ignore it if not. "strict" like "permissive" but if the bind type is unknown the token will be rejected. "required" any form of token binding is needed to be allowed. Finally the name of a binding method that must be present in tokens. |
| integer value | Request timeout value for communicating with Identity API server. |
| integer value | How many times are we trying to reconnect when communicating with Identity API Server. |
| boolean value | (Optional) Indicate whether to set the X-Service-Catalog header. If False, middleware will not ask for service catalog on token validation and will not set the X-Service-Catalog header. |
| boolean value | Verify HTTPS connections. |
| string value | Interface to use for the Identity API endpoint. Valid values are "public", "internal" or "admin"(default). |
| string value | Required if identity server requires client certificate |
| integer value | (Optional) Number of seconds that an operation will wait to get a memcached client connection from the pool. |
| integer value | (Optional) Number of seconds memcached server is considered dead before it is tried again. |
| integer value | (Optional) Maximum total number of open connections to every memcached server. |
| integer value | (Optional) Socket timeout in seconds for communicating with a memcached server. |
| integer value | (Optional) Number of seconds a connection to memcached is held unused in the pool before it is closed. |
| string value | (Optional, mandatory if memcache_security_strategy is defined) This string is used for key derivation. |
| string value | (Optional) If defined, indicate whether token data should be authenticated or authenticated and encrypted. If MAC, token data is authenticated (with HMAC) in the cache. If ENCRYPT, token data is encrypted and authenticated in the cache. If the value is not one of these options or empty, auth_token will raise an exception on initialization. |
| boolean value | (Optional) Use the advanced (eventlet safe) memcached client pool. The advanced pool will only work under python 2.x. |
| list value | Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process. |
| string value | The region in which the identity server can be found. |
| list value | A choice of roles that must be present in a service token. Service tokens are allowed to request that an expired token can be used and so this check should tightly control that only actual services should be sending this token. Roles here are applied as an ANY check so any role in this list must be present. For backwards compatibility reasons this currently only affects the allow_expired check. |
| boolean value | For backwards compatibility reasons we must let valid service tokens pass that don’t pass the service_token_roles check as valid. Setting this true will become the default in a future release and should be enabled if possible. |
| string value | The name or type of the service as it appears in the service catalog. This is used to validate tokens that have restricted access rules. |
| integer value | In order to prevent excessive effort spent validating tokens, the middleware caches previously-seen tokens for a configurable duration (in seconds). Set to -1 to disable caching completely. |
| string value | Complete "public" Identity API endpoint. This endpoint should not be an "admin" endpoint, as it should be accessible by all end users. Unauthenticated clients are redirected to this endpoint to authenticate. Although this endpoint should ideally be unversioned, client support in the wild varies. If you’re using a versioned v2 endpoint here, then this should not be the same endpoint the service user utilizes for validating tokens, because normal end users may not be able to reach that endpoint. |
8.7.7. nova
The following table outlines the options available under the [nova]
group in the /etc/neutron/neutron.conf
file.
Table 8.29. nova
Configuration option = Default value | Type | Description |
---|---|---|
| string value | Authentication URL |
| string value | Authentication type to load |
| string value | PEM encoded Certificate Authority to use when verifying HTTPs connections. |
| string value | PEM encoded client certificate cert file |
| boolean value | Collect per-API call timing information. |
| string value | Optional domain ID to use with v3 and v2 parameters. It will be used for both the user and project domain in v3 and ignored in v2 authentication. |
| string value | Optional domain name to use with v3 API and v2 parameters. It will be used for both the user and project domain in v3 and ignored in v2 authentication. |
| string value | Domain ID to scope to |
| string value | Domain name to scope to |
| string value | Type of the nova endpoint to use. This endpoint will be looked up in the keystone catalog and should be one of public, internal or admin. |
| boolean value | Verify HTTPS connections. |
| string value | PEM encoded client certificate key file |
| string value | User’s password |
| string value | Domain ID containing project |
| string value | Domain name containing project |
| string value | Project ID to scope to |
| string value | Project name to scope to |
| string value | Name of nova region to use. Useful if keystone manages more than one region. |
| boolean value | Log requests to multiple loggers. |
| string value | Scope for system operations |
| string value | Tenant ID |
| string value | Tenant Name |
| integer value | Timeout value for http requests |
| string value | Trust ID |
| string value | User’s domain id |
| string value | User’s domain name |
| string value | User id |
| string value | Username |
8.7.8. oslo_concurrency
The following table outlines the options available under the [oslo_concurrency]
group in the /etc/neutron/neutron.conf
file.
Table 8.30. oslo_concurrency
Configuration option = Default value | Type | Description |
---|---|---|
| boolean value | Enables or disables inter-process locks. |
| string value | 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. |
8.7.9. oslo_messaging_amqp
The following table outlines the options available under the [oslo_messaging_amqp]
group in the /etc/neutron/neutron.conf
file.
Table 8.31. oslo_messaging_amqp
Configuration option = Default value | Type | Description |
---|---|---|
| string value | 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 |
| string value | 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. |
| string value | address prefix used when broadcasting to all servers |
| integer value | Increase the connection_retry_interval by this many seconds after each unsuccessful failover attempt. |
| integer value | Seconds to pause before attempting to re-connect. |
| integer value | Maximum limit for connection_retry_interval + connection_retry_backoff |
| string value | Name for the AMQP container. must be globally unique. Defaults to a generated UUID |
| string value | 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 |
| integer value | The deadline for a sent notification message delivery. Only used when caller does not provide a timeout expiry. |
| integer value | The maximum number of attempts to re-send a reply message which failed due to a recoverable error. |
| integer value | The deadline for an rpc reply message delivery. |
| string value | 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 |
| integer value | The deadline for an rpc cast or call message delivery. Only used when caller does not provide a timeout expiry. |
| integer value | The duration to schedule a purge of idle sender links. Detach link after expiry. |
| string value | address prefix when sending to any server in group |
| integer value | Timeout for inactive connections (in seconds) |
| integer value | Time to pause between re-connecting an AMQP 1.0 link that failed due to a recoverable error. |
| string value | Appended to the address prefix when sending a fanout message. Used by the message bus to identify fanout messages. |
| string value | Address prefix for all generated Notification addresses |
| integer value | Window size for incoming Notification messages |
| multi valued | Send messages of this type pre-settled. Pre-settled messages will not receive acknowledgement from the peer. Note well: pre-settled messages may be silently discarded if the delivery fails. Permitted values: rpc-call - send RPC Calls pre-settled rpc-reply- send RPC Replies pre-settled rpc-cast - Send RPC Casts pre-settled notify - Send Notifications pre-settled |
| boolean value | Enable virtual host support for those message buses that do not natively support virtual hosting (such as qpidd). When set to true the virtual host name will be added to all message bus addresses, effectively creating a private subnet per virtual host. Set to False if the message bus supports virtual hosting using the hostname field in the AMQP 1.0 Open performative as the name of the virtual host. |
| integer value | Window size for incoming RPC Reply messages. |
| string value | Address prefix for all generated RPC addresses |
| integer value | Window size for incoming RPC Request messages |
`sasl_config_dir = ` | string value | Path to directory that contains the SASL configuration |
`sasl_config_name = ` | string value | Name of configuration file (without .conf suffix) |
`sasl_default_realm = ` | string value | SASL realm to use if no realm present in username |
`sasl_mechanisms = ` | string value | Space separated list of acceptable SASL mechanisms |
| string value | address prefix used when sending to a specific server |
| boolean value | Attempt to connect via SSL. If no other ssl-related parameters are given, it will use the system’s CA-bundle to verify the server’s certificate. |
`ssl_ca_file = ` | string value | CA certificate PEM file used to verify the server’s certificate |
`ssl_cert_file = ` | string value | Self-identifying certificate PEM file for client authentication |
`ssl_key_file = ` | string value | Private key PEM file used to sign ssl_cert_file certificate (optional) |
| string value | Password for decrypting ssl_key_file (if encrypted) |
| boolean value | By default SSL checks that the name in the server’s certificate matches the hostname in the transport_url. In some configurations it may be preferable to use the virtual hostname instead, for example if the server uses the Server Name Indication TLS extension (rfc6066) to provide a certificate per virtual host. Set ssl_verify_vhost to True if the server’s SSL certificate uses the virtual host name instead of the DNS name. |
| boolean value | Debug: dump AMQP frames to stdout |
| string value | 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. |
8.7.10. oslo_messaging_kafka
The following table outlines the options available under the [oslo_messaging_kafka]
group in the /etc/neutron/neutron.conf
file.
Table 8.32. oslo_messaging_kafka
Configuration option = Default value | Type | Description |
---|---|---|
| string value | The compression codec for all data generated by the producer. If not set, compression will not be used. Note that the allowed values of this depend on the kafka version |
| integer value | (DEPRECATED FOR REMOVAL) The pool size limit for connections expiration policy |
| integer value | (DEPRECATED FOR REMOVAL) The time-to-live in sec of idle connections in the pool |
| string value | Group id for Kafka consumer. Consumers in one group will coordinate message consumption |
| boolean value | Enable asynchronous consumer commits |
| floating point value | Default timeout(s) for Kafka consumers |
| integer value | Max fetch bytes of Kafka consumer |
| integer value | The maximum number of records returned in a poll call |
| integer value | (DEPRECATED FOR REMOVAL) Pool Size for Kafka Consumers |
| integer value | Size of batch for the producer async send |
| floating point value | Upper bound on the delay for KafkaProducer batching in seconds |
| string value | Mechanism when security protocol is SASL |
| string value | Protocol used to communicate with brokers |
`ssl_cafile = ` | string value | CA certificate PEM file used to verify the server certificate |
8.7.11. oslo_messaging_notifications
The following table outlines the options available under the [oslo_messaging_notifications]
group in the /etc/neutron/neutron.conf
file.
Table 8.33. oslo_messaging_notifications
Configuration option = Default value | Type | Description |
---|---|---|
| multi valued | The Drivers(s) to handle sending notifications. Possible values are messaging, messagingv2, routing, log, test, noop |
| integer value | The maximum number of attempts to re-send a notification message which failed to be delivered due to a recoverable error. 0 - No retry, -1 - indefinite |
| list value | AMQP topic used for OpenStack notifications. |
| string value | A URL representing the messaging driver to use for notifications. If not set, we fall back to the same configuration used for RPC. |
8.7.12. oslo_messaging_rabbit
The following table outlines the options available under the [oslo_messaging_rabbit]
group in the /etc/neutron/neutron.conf
file.
Table 8.34. oslo_messaging_rabbit
Configuration option = Default value | Type | Description |
---|---|---|
| boolean value | Auto-delete queues in AMQP. |
| boolean value | Use durable queues in AMQP. |
| integer value | Enable/Disable the RabbitMQ mandatory flag for direct send. The direct send is used as reply,so the MessageUndeliverable exception is raised in case the client queue does not exist. |
| boolean value | EXPERIMENTAL: Run the health check heartbeat threadthrough a native python thread. By default if thisoption isn’t provided the health check heartbeat willinherit the execution model from the parent process. Byexample if the parent process have monkey patched thestdlib by using eventlet/greenlet then the heartbeatwill be run through a green thread. |
| integer value | How often times during the heartbeat_timeout_threshold we check the heartbeat. |
| integer value | Number of seconds after which the Rabbit broker is considered down if heartbeat’s keep-alive fails (0 disables heartbeat). |
| string value | EXPERIMENTAL: Possible values are: gzip, bz2. If not set compression will not be used. This option may not be available in future versions. |
| string value | 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. |
| integer value | How long to wait a missing client before abandoning to send it its replies. This value should not be longer than rpc_response_timeout. |
| floating point value | How long to wait before reconnecting in response to an AMQP consumer cancel notification. |
| boolean value | 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"} " |
| integer value | Maximum interval of RabbitMQ connection retries. Default is 30 seconds. |
| string value | The RabbitMQ login method. |
| integer value | Specifies the number of messages to prefetch. Setting to zero allows unlimited messages. |
| integer value | How long to backoff for between retries when connecting to RabbitMQ. |
| integer value | How frequently to retry connecting with RabbitMQ. |
| integer value | 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. |
| boolean value | Connect over SSL. |
`ssl_ca_file = ` | string value | SSL certification authority file (valid only if SSL enabled). |
`ssl_cert_file = ` | string value | SSL cert file (valid only if SSL enabled). |
`ssl_key_file = ` | string value | SSL key file (valid only if SSL enabled). |
`ssl_version = ` | string value | 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. |
8.7.13. oslo_middleware
The following table outlines the options available under the [oslo_middleware]
group in the /etc/neutron/neutron.conf
file.
Table 8.35. oslo_middleware
Configuration option = Default value | Type | Description |
---|---|---|
| boolean value | Whether the application is behind a proxy or not. This determines if the middleware should parse the headers or not. |
8.7.14. oslo_policy
The following table outlines the options available under the [oslo_policy]
group in the /etc/neutron/neutron.conf
file.
Table 8.36. oslo_policy
Configuration option = Default value | Type | Description |
---|---|---|
| boolean value |
This option controls whether or not to enforce scope when evaluating policies. If |
| string value | Default rule. Enforced when a requested rule is not found. |
| multi valued | 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. |
| string value | The relative or absolute path of a file that maps roles to permissions for a given service. Relative paths must be specified in relation to the configuration file setting this option. |
| string value | Content Type to send and receive data for REST based policy check |
| string value | Absolute path to ca cert file for REST based policy check |
| string value | Absolute path to client cert for REST based policy check |
| string value | Absolute path client key file REST based policy check |
| boolean value | server identity verification for REST based policy check |
8.7.15. privsep
The following table outlines the options available under the [privsep]
group in the /etc/neutron/neutron.conf
file.
Table 8.37. privsep
Configuration option = Default value | Type | Description |
---|---|---|
| list value | List of Linux capabilities retained by the privsep daemon. |
| string value | Group that the privsep daemon should run as. |
| string value | Command to invoke to start the privsep daemon if not using the "fork" method. If not specified, a default is generated using "sudo privsep-helper" and arguments designed to recreate the current configuration. This command must accept suitable --privsep_context and --privsep_sock_path arguments. |
| integer value | The number of threads available for privsep to concurrently run processes. Defaults to the number of CPU cores in the system. |
| string value | User that the privsep daemon should run as. |
8.7.16. quotas
The following table outlines the options available under the [quotas]
group in the /etc/neutron/neutron.conf
file.
Table 8.38. quotas
Configuration option = Default value | Type | Description |
---|---|---|
| integer value | Default number of resource allowed per tenant. A negative value means unlimited. |
| string value | Default driver to use for quota checks. |
| integer value | Number of floating IPs allowed per tenant. A negative value means unlimited. |
| integer value | Number of networks allowed per tenant. A negative value means unlimited. |
| integer value | Number of ports allowed per tenant. A negative value means unlimited. |
| integer value | Number of routers allowed per tenant. A negative value means unlimited. |
| integer value | Number of security groups allowed per tenant. A negative value means unlimited. |
| integer value | Number of security rules allowed per tenant. A negative value means unlimited. |
| integer value | Number of subnets allowed per tenant, A negative value means unlimited. |
| boolean value | Keep in track in the database of current resource quota usage. Plugins which do not leverage the neutron database should set this flag to False. |
8.7.17. ssl
The following table outlines the options available under the [ssl]
group in the /etc/neutron/neutron.conf
file.
Table 8.39. ssl
Configuration option = Default value | Type | Description |
---|---|---|
| string value | CA certificate file to use to verify connecting clients. |
| string value | Certificate file to use when starting the server securely. |
| string value | Sets the list of available ciphers. value should be a string in the OpenSSL cipher list format. |
| string value | Private key file to use when starting the server securely. |
| string value | 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. |
8.8. openvswitch_agent.ini
This section contains options for the /etc/neutron/plugins/ml2/openvswitch_agent.ini
file.
8.8.1. DEFAULT
The following table outlines the options available under the [DEFAULT]
group in the /etc/neutron/plugins/ml2/openvswitch_agent.ini
file.
.
Configuration option = Default value | Type | Description |
---|---|---|
| boolean value | If set to true, the logging level will be set to DEBUG instead of the default INFO level. |
| list value | List of package logging levels in logger=LEVEL pairs. This option is ignored if log_config_append is set. |
| boolean value | Enables or disables fatal status of deprecations. |
`instance_format = [instance: %(uuid)s] ` | string value | The format for an instance that is passed with the log message. |
`instance_uuid_format = [instance: %(uuid)s] ` | string value | The format for an instance UUID that is passed with the log message. |
| string value | 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. Note that when logging configuration files are used then all logging configuration is set in the configuration file and other logging configuration options are ignored (for example, log-date-format). |
| string value | Defines the format string for %%(asctime)s in log records. Default: %(default)s . This option is ignored if log_config_append is set. |
| string value | (Optional) The base directory used for relative log_file paths. This option is ignored if log_config_append is set. |
| string value | (Optional) Name of log file to send logging output to. If no default is set, logging will go to stderr as defined by use_stderr. This option is ignored if log_config_append is set. |
| integer value | The amount of time before the log files are rotated. This option is ignored unless log_rotation_type is setto "interval". |
| string value | Rotation interval type. The time of the last file change (or the time when the service was started) is used when scheduling the next rotation. |
| string value | Log rotation type. |
| string value | Format string to use for log messages with context. Used by oslo_log.formatters.ContextFormatter |
| string value | Additional data to append to log message when logging level for the message is DEBUG. Used by oslo_log.formatters.ContextFormatter |
| string value | Format string to use for log messages when context is undefined. Used by oslo_log.formatters.ContextFormatter |
| string value | Prefix each line of exception output with this format. Used by oslo_log.formatters.ContextFormatter |
| string value | Defines the format string for %(user_identity)s that is used in logging_context_format_string. Used by oslo_log.formatters.ContextFormatter |
| integer value | Maximum number of rotated log files. |
| integer value | Log file maximum size in MB. This option is ignored if "log_rotation_type" is not set to "size". |
| boolean value | Enables or disables publication of error events. |
| integer value | Maximum number of logged messages per rate_limit_interval. |
| string value | Log level name used by rate limiting: CRITICAL, ERROR, INFO, WARNING, DEBUG or empty string. Logs with level greater or equal to rate_limit_except_level are not filtered. An empty string means that all levels are filtered. |
| integer value | Interval, number of seconds, of log rate limiting. |
| integer value | Maximum seconds to wait for a response from an RPC call. |
| string value | Syslog facility to receive log lines. This option is ignored if log_config_append is set. |
| boolean value | Enable journald for logging. If running in a systemd environment you may wish to enable journal support. Doing so will use the journal native protocol which includes structured metadata in addition to log messages.This option is ignored if log_config_append is set. |
| boolean value | Use JSON formatting for logging. This option is ignored if log_config_append is set. |
| boolean value | Use syslog for logging. Existing syslog format is DEPRECATED and will be changed later to honor RFC5424. This option is ignored if log_config_append is set. |
| boolean value | Log output to Windows Event Log. |
| boolean value | Log output to standard error. This option is ignored if log_config_append is set. |
| boolean value | Uses logging handler designed to watch file system. When log file is moved or removed this handler will open a new log file with specified path instantaneously. It makes sense only if log_file option is specified and Linux platform is used. This option is ignored if log_config_append is set. |
8.8.2. agent
The following table outlines the options available under the [agent]
group in the /etc/neutron/plugins/ml2/openvswitch_agent.ini
file.
Table 8.40. agent
Configuration option = Default value | Type | Description |
---|---|---|
| string value | (DEPRECATED FOR REMOVAL) Selects the Agent Type reported. |
| boolean value | Enable local ARP responder if it is supported. Requires OVS 2.1 and ML2 l2population driver. Allows the switch (when supporting an overlay) to respond to an ARP request locally without performing a costly ARP broadcast into the overlay. NOTE: If enable_distributed_routing is set to True then arp_responder will automatically be set to True in the agent, regardless of the setting in the config file. |
| boolean value | Enable the agent to process Smart NIC ports. |
| boolean value | Set or un-set the don’t fragment (DF) bit on outgoing IP packet carrying GRE/VXLAN tunnel. |
| boolean value | Reset flow table on start. Setting this to True will cause brief traffic interruption. |
| boolean value | Make the l2 agent run in DVR mode. |
| boolean value | When set to True, the accepted egress unicast traffic will not use action NORMAL. The accepted egress packets will be taken care of in the final egress tables direct output flows for unicast traffic. |
| list value | Extensions list to use |
| boolean value | Use ML2 l2population mechanism driver to learn remote MAC and IPs and improve tunnel scalability. |
| boolean value | Minimize polling by monitoring ovsdb for interface changes. |
| integer value | The number of seconds to wait before respawning the ovsdb monitor after losing communication with it. |
| boolean value | Set or un-set the tunnel header checksum on outgoing IP packet carrying GRE/VXLAN tunnel. |
| list value | Network types supported by the agent (gre, vxlan and/or geneve). |
| integer value | MTU size of veth interfaces |
| port value | The UDP port to use for VXLAN tunnels. |
8.8.3. network_log
The following table outlines the options available under the [network_log]
group in the /etc/neutron/plugins/ml2/openvswitch_agent.ini
file.
Table 8.41. network_log
Configuration option = Default value | Type | Description |
---|---|---|
| integer value | Maximum number of packets per rate_limit. |
| string value | Output logfile path on agent side, default syslog file. |
| integer value | Maximum packets logging per second. |
8.8.4. ovs
The following table outlines the options available under the [ovs]
group in the /etc/neutron/plugins/ml2/openvswitch_agent.ini
file.
Table 8.42. ovs
Configuration option = Default value | Type | Description |
---|---|---|
| list value | Comma-separated list of <physical_network>:<bridge> tuples mapping physical network names to the agent’s node-specific Open vSwitch bridge names to be used for flat and VLAN networks. The length of bridge names should be no more than 11. Each bridge must exist, and should have a physical network interface configured as a port. All physical networks configured on the server should have mappings to appropriate bridges on each agent. Note: If you remove a bridge from this mapping, make sure to disconnect it from the integration bridge as it won’t be managed by the agent anymore. |
| string value | OVS datapath to use. system is the default value and corresponds to the kernel datapath. To enable the userspace datapath set this value to netdev. |
| string value | Peer patch port in integration bridge for tunnel bridge. |
| string value | Integration bridge to use. Do not change this parameter unless you have a good reason to. This is the name of the OVS integration bridge. There is one per hypervisor. The integration bridge acts as a virtual patch bay. All VM VIFs are attached to this bridge and then patched according to their network connectivity. |
| IP address value | IP address of local overlay (tunnel) network endpoint. Use either an IPv4 or IPv6 address that resides on one of the host network interfaces. The IP version of this value must match the value of the overlay_ip_version option in the ML2 plug-in configuration file on the neutron server node(s). |
| integer value | Timeout in seconds to wait for the local switch connecting the controller. |
| integer value | The inactivity_probe interval in seconds for the local switch connection to the controller. A value of 0 disables inactivity probes. |
| IP address value | Address to listen on for OpenFlow connections. |
| port value | Port to listen on for OpenFlow connections. |
| integer value | Timeout in seconds to wait for a single OpenFlow request. |
| string value | The connection string for the OVSDB backend. Will be used by ovsdb-client when monitoring and used for the all ovsdb commands when native ovsdb_interface is enabled |
| boolean value | Enable OVSDB debug logs |
| list value | Comma-separated list of <bridge>:<egress_bw>:<ingress_bw> tuples, showing the available bandwidth for the given bridge in the given direction. The direction is meant from VM perspective. Bandwidth is measured in kilobits per second (kbps). The bridge must appear in bridge_mappings as the value. But not all bridges in bridge_mappings must be listed here. For a bridge not listed here we neither create a resource provider in placement nor report inventories against. An omitted direction means we do not report an inventory for the corresponding class. |
| dict value | Mapping of bridges to hypervisors: <bridge>:<hypervisor>,… hypervisor name is used to locate the parent of the resource provider tree. Only needs to be set in the rare case when the hypervisor name is different from the DEFAULT.host config option value as known by the nova-compute managing that hypervisor. |
| dict value | Key:value pairs to specify defaults used while reporting resource provider inventories. Possible keys with their types: allocation_ratio:float, max_unit:int, min_unit:int, reserved:int, step_size:int, See also: https://docs.openstack.org/api-ref/placement/#update-resource-provider-inventories |
| string value | The Certificate Authority (CA) certificate to use when interacting with OVSDB. Required when using an "ssl:" prefixed ovsdb_connection |
| string value | The SSL certificate file to use when interacting with OVSDB. Required when using an "ssl:" prefixed ovsdb_connection |
| string value | The SSL private key file to use when interacting with OVSDB. Required when using an "ssl:" prefixed ovsdb_connection |
| string value | Peer patch port in tunnel bridge for integration bridge. |
| string value | Tunnel bridge to use. |
| boolean value | Use veths instead of patch ports to interconnect the integration bridge to physical networks. Support kernel without Open vSwitch patch port support so long as it is set to True. |
| string value | OVS vhost-user socket directory. |
8.8.5. securitygroup
The following table outlines the options available under the [securitygroup]
group in the /etc/neutron/plugins/ml2/openvswitch_agent.ini
file.
Table 8.43. securitygroup
Configuration option = Default value | Type | Description |
---|---|---|
| boolean value | Use ipset to speed-up the iptables based security groups. Enabling ipset support requires that ipset is installed on L2 agent node. |
| boolean value | Controls whether the neutron security group API is enabled in the server. It should be false when using no security groups or using the nova security group API. |
| string value | Driver for security groups firewall in the L2 agent |
| list value | Comma-separated list of ethertypes to be permitted, in hexadecimal (starting with "0x"). For example, "0x4008" to permit InfiniBand. |
8.8.6. xenapi
The following table outlines the options available under the [xenapi]
group in the /etc/neutron/plugins/ml2/openvswitch_agent.ini
file.
Table 8.44. xenapi
Configuration option = Default value | Type | Description |
---|---|---|
| string value | Password for connection to XenServer/Xen Cloud Platform. |
| string value | URL for connection to XenServer/Xen Cloud Platform. |
| string value | Username for connection to XenServer/Xen Cloud Platform. |
8.9. sriov_agent.ini
This section contains options for the /etc/neutron/plugins/ml2/sriov_agent.ini
file.
8.9.1. DEFAULT
The following table outlines the options available under the [DEFAULT]
group in the /etc/neutron/plugins/ml2/sriov_agent.ini
file.
.
Configuration option = Default value | Type | Description |
---|---|---|
| boolean value | If set to true, the logging level will be set to DEBUG instead of the default INFO level. |
| list value | List of package logging levels in logger=LEVEL pairs. This option is ignored if log_config_append is set. |
| boolean value | Enables or disables fatal status of deprecations. |
`instance_format = [instance: %(uuid)s] ` | string value | The format for an instance that is passed with the log message. |
`instance_uuid_format = [instance: %(uuid)s] ` | string value | The format for an instance UUID that is passed with the log message. |
| string value | 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. Note that when logging configuration files are used then all logging configuration is set in the configuration file and other logging configuration options are ignored (for example, log-date-format). |
| string value | Defines the format string for %%(asctime)s in log records. Default: %(default)s . This option is ignored if log_config_append is set. |
| string value | (Optional) The base directory used for relative log_file paths. This option is ignored if log_config_append is set. |
| string value | (Optional) Name of log file to send logging output to. If no default is set, logging will go to stderr as defined by use_stderr. This option is ignored if log_config_append is set. |
| integer value | The amount of time before the log files are rotated. This option is ignored unless log_rotation_type is setto "interval". |
| string value | Rotation interval type. The time of the last file change (or the time when the service was started) is used when scheduling the next rotation. |
| string value | Log rotation type. |
| string value | Format string to use for log messages with context. Used by oslo_log.formatters.ContextFormatter |
| string value | Additional data to append to log message when logging level for the message is DEBUG. Used by oslo_log.formatters.ContextFormatter |
| string value | Format string to use for log messages when context is undefined. Used by oslo_log.formatters.ContextFormatter |
| string value | Prefix each line of exception output with this format. Used by oslo_log.formatters.ContextFormatter |
| string value | Defines the format string for %(user_identity)s that is used in logging_context_format_string. Used by oslo_log.formatters.ContextFormatter |
| integer value | Maximum number of rotated log files. |
| integer value | Log file maximum size in MB. This option is ignored if "log_rotation_type" is not set to "size". |
| boolean value | Enables or disables publication of error events. |
| integer value | Maximum number of logged messages per rate_limit_interval. |
| string value | Log level name used by rate limiting: CRITICAL, ERROR, INFO, WARNING, DEBUG or empty string. Logs with level greater or equal to rate_limit_except_level are not filtered. An empty string means that all levels are filtered. |
| integer value | Interval, number of seconds, of log rate limiting. |
| string value | Syslog facility to receive log lines. This option is ignored if log_config_append is set. |
| boolean value | Enable journald for logging. If running in a systemd environment you may wish to enable journal support. Doing so will use the journal native protocol which includes structured metadata in addition to log messages.This option is ignored if log_config_append is set. |
| boolean value | Use JSON formatting for logging. This option is ignored if log_config_append is set. |
| boolean value | Use syslog for logging. Existing syslog format is DEPRECATED and will be changed later to honor RFC5424. This option is ignored if log_config_append is set. |
| boolean value | Log output to Windows Event Log. |
| boolean value | Log output to standard error. This option is ignored if log_config_append is set. |
| boolean value | Uses logging handler designed to watch file system. When log file is moved or removed this handler will open a new log file with specified path instantaneously. It makes sense only if log_file option is specified and Linux platform is used. This option is ignored if log_config_append is set. |
8.9.2. agent
The following table outlines the options available under the [agent]
group in the /etc/neutron/plugins/ml2/sriov_agent.ini
file.
Table 8.45. agent
Configuration option = Default value | Type | Description |
---|---|---|
| list value | Extensions list to use |
8.9.3. sriov_nic
The following table outlines the options available under the [sriov_nic]
group in the /etc/neutron/plugins/ml2/sriov_agent.ini
file.
Table 8.46. sriov_nic
Configuration option = Default value | Type | Description |
---|---|---|
| list value | Comma-separated list of <network_device>:<vfs_to_exclude> tuples, mapping network_device to the agent’s node-specific list of virtual functions that should not be used for virtual networking. vfs_to_exclude is a semicolon-separated list of virtual functions to exclude from network_device. The network_device in the mapping should appear in the physical_device_mappings list. |
| list value | Comma-separated list of <physical_network>:<network_device> tuples mapping physical network names to the agent’s node-specific physical network device interfaces of SR-IOV physical function to be used for VLAN networks. All physical networks listed in network_vlan_ranges on the server should have mappings to appropriate interfaces on each agent. |
| list value | Comma-separated list of <network_device>:<egress_bw>:<ingress_bw> tuples, showing the available bandwidth for the given device in the given direction. The direction is meant from VM perspective. Bandwidth is measured in kilobits per second (kbps). The device must appear in physical_device_mappings as the value. But not all devices in physical_device_mappings must be listed here. For a device not listed here we neither create a resource provider in placement nor report inventories against. An omitted direction means we do not report an inventory for the corresponding class. |
| dict value | Mapping of network devices to hypervisors: <network_device>:<hypervisor>,… hypervisor name is used to locate the parent of the resource provider tree. Only needs to be set in the rare case when the hypervisor name is different from the DEFAULT.host config option value as known by the nova-compute managing that hypervisor. |
| dict value | Key:value pairs to specify defaults used while reporting resource provider inventories. Possible keys with their types: allocation_ratio:float, max_unit:int, min_unit:int, reserved:int, step_size:int, See also: https://docs.openstack.org/api-ref/placement/#update-resource-provider-inventories |
Chapter 9. nova
The following chapter contains information about the configuration options in the nova
service.
9.1. nova.conf
This section contains options for the /etc/nova/nova.conf
file.
9.1.1. DEFAULT
The following table outlines the options available under the [DEFAULT]
group in the /etc/nova/nova.conf
file.
.
Configuration option = Default value | Type | Description |
---|---|---|
| boolean value | Allow destination machine to match source for resize. Useful when testing in single-host environments. By default it is not allowed to resize to the same host. Setting this option to true will add the same host to the destination options. Also set to true if you allow the ServerGroupAffinityFilter and need to resize. |
| boolean value | (DEPRECATED FOR REMOVAL) Determine whether to allow network traffic from same network. When set to true, hosts on the same subnet are not filtered and are allowed to pass all types of traffic between them. On a flat network, this allows all instances from all projects unfiltered communication. With VLAN networking, this allows access between instances within the same project.
This option only applies when using the Possible values:
Related options:
|
| boolean value | (DEPRECATED FOR REMOVAL) Autoassigning floating IP to VM When set to True, floating IP is auto allocated and associated to the VM upon creation. Related options:
|
| string value | Enable eventlet backdoor. Acceptable values are 0, <port>, and <start>:<end>, where 0 results in listening on a random tcp port number; <port> results in listening on the specified port number (and not enabling backdoor if that port is in use); and <start>:<end> results in listening on the smallest unused port number within the specified range of port numbers. The chosen port is displayed in the service’s log file. |
| string value | Enable eventlet backdoor, using the provided path as a unix socket that can receive connections. This option is mutually exclusive with backdoor_port in that only one should be provided. If both are provided then the existence of this option overrides the usage of that option. Inside the path {pid} will be replaced with the PID of the current process. |
| integer value | Interval to pull network bandwidth usage info. Not supported on all hypervisors. If a hypervisor doesn’t support bandwidth usage, it will not get the info in the usage events. Possible values:
|
| string value | The directory where the Nova binaries are installed. This option is only relevant if the networking capabilities from Nova are used (see services below). Nova’s networking capabilities are targeted to be fully replaced by Neutron in the future. It is very unlikely that you need to change this option from its default value. Possible values:
|
| integer value | The number of times to check for a volume to be "available" before attaching it during server create.
When creating a server with block device mappings where
If the operation times out, the volume will be deleted if the block device mapping It is recommended to configure the image cache in the block storage service to speed up this operation. See https://docs.openstack.org/cinder/latest/admin/blockstorage-image-volume-cache.html for details. Possible values:
Related options:
|
| integer value | Interval (in seconds) between block device allocation retries on failures.
This option allows the user to specify the time interval between consecutive retries. The Possible values:
Related options:
|
| string value | Path to SSL certificate file. |
| integer value |
(DEPRECATED FOR REMOVAL) This option represents the number of IP addresses to reserve at the top of the address range for VPN clients. It also will be ignored if the configuration option for Possible values:
Related options:
|
| string value | Defines which driver to use for controlling virtualization. Possible values:
|
| list value | A comma-separated list of monitors that can be used for getting compute metrics. You can use the alias/name from the setuptools entry points for nova.compute.monitors.* namespaces. If no namespace is supplied, the "cpu." namespace is assumed for backwards-compatibility. Note Only one monitor per namespace (For example: cpu) can be loaded at a time. Possible values:
|
| string value | (DEPRECATED FOR REMOVAL) Config drive format. Config drive format that will contain metadata attached to the instance when it boots. Related options:
|
| integer value | The pool size limit for connections expiration policy |
| integer value | The time-to-live in sec of idle connections in the pool |
| string value | Console proxy host to be used to connect to instances on this host. It is the publicly visible name for the console host. Possible values:
|
| string value | The default exchange under which topics are scoped. May be overridden by an exchange name specified in the transport_url option. |
| floating point value | Virtual CPU to physical CPU allocation ratio.
This option is used to influence the hosts selected by the Placement API by configuring the allocation ratio for
Possible values:
Related options:
|
| integer value |
(DEPRECATED FOR REMOVAL) This option determines how many times nova-network will attempt to create a unique MAC address before giving up and raising a Possible values:
Related options:
|
| boolean value | Run as a background process. |
| boolean value | If set to true, the logging level will be set to DEBUG instead of the default INFO level. |
| string value | Name of the network to be used to set access IPs for instances. If there are multiple IPs to choose from, an arbitrary one will be chosen. Possible values:
|
| string value | Default availability zone for compute services. This option determines the default availability zone for nova-compute services, which will be used if the service(s) do not belong to aggregates with availability zone metadata. Possible values:
|
| string value | The default format an ephemeral_volume will be formatted with on creation. Possible values:
|
| string value | (DEPRECATED FOR REMOVAL) Default pool for floating IPs. This option specifies the default floating IP pool for allocating floating IPs. While allocating a floating ip, users can optionally pass in the name of the pool they want to allocate from, otherwise it will be pulled from the default pool. If this option is not set, then nova is used as default floating pool. Possible values:
|
| list value | List of package logging levels in logger=LEVEL pairs. This option is ignored if log_config_append is set. |
| string value | Default availability zone for instances. This option determines the default availability zone for instances, which will be used when a user does not specify one when creating an instance. The instance(s) will be bound to this availability zone for their lifetime. Possible values:
|
| boolean value | (DEPRECATED FOR REMOVAL) Defer application of IPTables rules until after init phase. When a compute service is restarted each instance running on the host has its iptables rules built and applied sequentially during the host init stage. The impact of this, especially on a host running many instances, can be observed as a period where some instances are not accessible as the existing iptables rules have been torn down and not yet re-applied. This is a workaround that prevents the application of the iptables rules until all instances on the host had been initialised then the rules for all instances are applied all at once preventing a blackout period. |
| integer value | (DEPRECATED FOR REMOVAL) The lifetime of a DHCP lease, in seconds. The default is 86400 (one day). Possible values:
|
| string value | (DEPRECATED FOR REMOVAL) The location of the binary nova-dhcpbridge. By default it is the binary named nova-dhcpbridge that is installed with all the other nova binaries. Possible values:
|
| multi valued | (DEPRECATED FOR REMOVAL) This option is a list of full paths to one or more configuration files for dhcpbridge. In most cases the default path of /etc/nova/nova-dhcpbridge.conf should be sufficient, but if you have special needs for configuring dhcpbridge, you can change or add to this list. Possible values
|
| floating point value | Virtual disk to physical disk allocation ratio.
This option is used to influence the hosts selected by the Placement API by configuring the allocation ratio for When configured, a ratio greater than 1.0 will result in over-subscription of the available physical disk, which can be useful for more efficiently packing instances created with images that do not use the entire virtual disk, such as sparse or compressed images. It can be set to a value between 0.0 and 1.0 in order to preserve a percentage of the disk for uses other than instances.
Possible values:
Related options:
|
| list value | (DEPRECATED FOR REMOVAL) This option is a list of zero or more IP address ranges in your network’s DMZ that should be accepted. Possible values:
|
| multi valued | (DEPRECATED FOR REMOVAL) Despite the singular form of the name of this option, it is actually a list of zero or more server addresses that dnsmasq will use for DNS nameservers. If this is not empty, dnsmasq will not read /etc/resolv.conf, but will only use the servers specified in this option. If the option use_network_dns_servers is True, the dns1 and dns2 servers from the network will be appended to this list, and will be used as DNS servers, too. Possible values:
Related options:
|
| integer value | (DEPRECATED FOR REMOVAL) This option determines the time, in seconds, to wait between refreshing DNS entries for the network. Possible values:
Related options:
|
`dnsmasq_config_file = ` | string value | (DEPRECATED FOR REMOVAL) The path to the custom dnsmasq configuration file, if any. Possible values:
|
| integer value | (DEPRECATED FOR REMOVAL) This option determines the number of times to retry ebtables commands before giving up. The minimum number of retries is 1. Possible values:
Related options:
|
| floating point value | (DEPRECATED FOR REMOVAL) This option determines the time, in seconds, that the system will sleep in between ebtables retries. Note that each successive retry waits a multiple of this value, so for example, if this is set to the default of 1.0 seconds, and ebtables_exec_attempts is 4, after the first failure, the system will sleep for 1 * 1.0 seconds, after the second failure it will sleep 2 * 1.0 seconds, and after the third failure it will sleep 3 * 1.0 seconds. Possible values:
Related options:
|
| boolean value | (DEPRECATED FOR REMOVAL) This option is used to enable or disable quota checking for tenant networks. Related options:
|
| boolean value | Enable new nova-compute services on this host automatically. When a new nova-compute service starts up, it gets registered in the database as an enabled service. Sometimes it can be useful to register new compute services in disabled state and then enabled them at a later point in time. This option only sets this behavior for nova-compute services, it does not auto-disable other services like nova-conductor, nova-scheduler, or nova-osapi_compute. Possible values:
|
| list value | List of APIs to be enabled by default. |
| list value | List of APIs with enabled SSL. Nova provides SSL support for the API servers. enabled_ssl_apis option allows configuring the SSL support. |
| integer value | Size of executor thread pool when executor is threading or eventlet. |
| boolean value | (DEPRECATED FOR REMOVAL) This option is used mainly in testing to avoid calls to the underlying network utilities. |
| boolean value | Enables or disables fatal status of deprecations. |
| string value |
(DEPRECATED FOR REMOVAL) Firewall driver to use with
This option only applies when using the Possible values:
Related options:
|
| integer value | (DEPRECATED FOR REMOVAL) This is the number of seconds to wait before disassociating a deallocated fixed IP address. This is only used with the nova-network service, and has no effect when using neutron for networking. Possible values:
Related options:
|
| string value | (DEPRECATED FOR REMOVAL) This option determines the fixed IPv6 address block when creating a network. Please note that this option is only used when using nova-network instead of Neutron in your deployment. Possible values:
Related options:
|
| boolean value | This option determines whether the network setup information is injected into the VM before it is booted. While it was originally designed to be used only by nova-network, it is also used by the vmware and xenapi virt drivers to control whether network information is injected into a VM. The libvirt virt driver also uses it when we use config_drive to configure network to control whether network information is injected into a VM. |
| string value | (DEPRECATED FOR REMOVAL) This option is the name of the virtual interface of the VM on which the bridge will be built. While it was originally designed to be used only by nova-network, it is also used by libvirt for the bridge interface name. Possible values:
|
| string value | (DEPRECATED FOR REMOVAL) This option determines the bridge used for simple network interfaces when no bridge is specified in the VM creation request. Please note that this option is only used when using nova-network instead of Neutron in your deployment. Possible values:
Related options:
|
| string value | (DEPRECATED FOR REMOVAL) This is the address of the DNS server for a simple network. If this option is not specified, the default of 8.8.4.4 is used. Please note that this option is only used when using nova-network instead of Neutron in your deployment. Possible values:
Related options:
|
| string value | (DEPRECATED FOR REMOVAL) Full class name for the DNS Manager for floating IPs. This option specifies the class of the driver that provides functionality to manage DNS entries associated with floating IPs. When a user adds a DNS entry for a specified domain to a floating IP, nova will add a DNS entry using the specified floating DNS driver. When a floating IP is deallocated, its DNS entry will automatically be deleted. Possible values:
Related options:
|
| boolean value | Force injection to take place on a config drive When this option is set to true config drive functionality will be forced enabled by default, otherwise users can still enable config drives via the REST API or image metadata properties. Launched instances are not affected by this option. Possible values:
Related options:
|
| boolean value | (DEPRECATED FOR REMOVAL) When this option is True, a call is made to release the DHCP for the instance when that instance is terminated. Related options:
|
| boolean value | Force conversion of backing images to raw format. Possible values:
Related options:
|
| multi valued |
(DEPRECATED FOR REMOVAL) This is a list of zero or more IP ranges that traffic from the Possible values:
Related options:
|
| multi valued | (DEPRECATED FOR REMOVAL) One or more interfaces that bridges can forward traffic to. If any of the items in this list is the special keyword all, then all traffic will be forwarded. Possible values:
|
| string value | (DEPRECATED FOR REMOVAL) This is the default IPv4 gateway. It is used only in the testing suite. Please note that this option is only used when using nova-network instead of Neutron in your deployment. Possible values:
Related options:
|
| string value | (DEPRECATED FOR REMOVAL) This is the default IPv6 gateway. It is used only in the testing suite. Please note that this option is only used when using nova-network instead of Neutron in your deployment. Possible values:
Related options:
|
| integer value | Specify a timeout after which a gracefully shutdown server will exit. Zero value means endless wait. |
| integer value | Interval between instance network information cache updates. Number of seconds after which each compute node runs the task of querying Neutron for all of its instances networking information, then updates the Nova db with that information. Nova will never update it’s cache if this option is set to 0. If we don’t update the cache, the metadata service and nova-api endpoints will be proxying incorrect network data about the instance. So, it is not recommended to set this option to 0. Possible values:
|
| string value | Hostname, FQDN or IP address of this host. Used as:
Must be valid within AMQP key. Possible values:
|
| integer value | Number of seconds to wait between runs of the image cache manager. Possible values: * 0: run at the default rate. * -1: disable * Any other value |
| string value | Location of cached images. This is NOT the full path - just a folder name relative to $instances_path. For per-compute-host cached images, set to base$my_ip |
| floating point value | Initial virtual CPU to physical CPU allocation ratio.
This is only used when initially creating the See https://docs.openstack.org/nova/latest/admin/configuration/schedulers.html for more details and usage scenarios. Related options:
|
| floating point value | Initial virtual disk to physical disk allocation ratio.
This is only used when initially creating the See https://docs.openstack.org/nova/latest/admin/configuration/schedulers.html for more details and usage scenarios. Related options:
|
| floating point value | Initial virtual RAM to physical RAM allocation ratio.
This is only used when initially creating the See https://docs.openstack.org/nova/latest/admin/configuration/schedulers.html for more details and usage scenarios. Related options:
|
| string value | Path to /etc/network/interfaces template. The path to a template file for the /etc/network/interfaces-style file, which will be populated by nova and subsequently used by cloudinit. This provides a method to configure network connectivity in environments without a DHCP server.
The template will be rendered using Jinja2 template engine, and receive a top-level key called Refer to the cloudinit documentaion for more information: https://cloudinit.readthedocs.io/en/latest/topics/datasources.html Possible values:
Related options:
|
| integer value | Maximum time in seconds that an instance can take to build. If this timer expires, instance status will be changed to ERROR. Enabling this option will make sure an instance will not be stuck in BUILD state for a longer period. Possible values:
|
| integer value | Interval for retrying failed instance file deletes. This option depends on maximum_instance_delete_attempts. This option specifies how often to retry deletes whereas maximum_instance_delete_attempts specifies the maximum number of retry attempts that can be made. Possible values:
Related options:
|
`instance_dns_domain = ` | string value | (DEPRECATED FOR REMOVAL) If specified, Nova checks if the availability_zone of every instance matches what the database says the availability_zone should be for the specified dns_domain. Related options:
|
| string value | (DEPRECATED FOR REMOVAL) Full class name for the DNS Manager for instance IPs. This option specifies the class of the driver that provides functionality to manage DNS entries for instances. On instance creation, nova will add DNS entries for the instance name and id, using the specified instance DNS driver and domain. On instance deletion, nova will remove the DNS entries. Possible values:
Related options:
|
`instance_format = [instance: %(uuid)s] ` | string value | The format for an instance that is passed with the log message. |
| string value | Template string to be used to generate instance names.
This template controls the creation of the database name of an instance. This is not the display name you enter when creating an instance (via Horizon or CLI). For a new deployment it is advisable to change the default value (which uses the database autoincrement) to another value which makes use of the attributes of an instance, like Possible values:
|
| boolean value | This option enables periodic compute.instance.exists notifications. Each compute node must be configured to generate system usage data. These notifications are consumed by OpenStack Telemetry service. |
| string value | Time period to generate instance usages for. It is possible to define optional offset to given period by appending @ character followed by a number defining offset. Possible values:
|
`instance_uuid_format = [instance: %(uuid)s] ` | string value | The format for an instance UUID that is passed with the log message. |
| string value | Specifies where instances are stored on the hypervisor’s disk. It can point to locally attached storage or a directory on NFS. Possible values:
Related options:
|
| string value | Availability zone for internal services. This option determines the availability zone for the various internal nova services, such as nova-scheduler, nova-conductor, etc. Possible values:
|
`iptables_bottom_regex = ` | string value | (DEPRECATED FOR REMOVAL) This expression, if defined, will select any matching iptables rules and place them at the bottom when applying metadata changes to the rules. Possible values:
Related options:
|
| string value | (DEPRECATED FOR REMOVAL) By default, packets that do not pass the firewall are DROPped. In many cases, though, an operator may find it more useful to change this from DROP to REJECT, so that the user issuing those packets may have a better idea as to what’s going on, or LOGDROP in order to record the blocked traffic before DROPping. Possible values:
|
`iptables_top_regex = ` | string value | (DEPRECATED FOR REMOVAL) This expression, if defined, will select any matching iptables rules and place them at the top when applying metadata changes to the rules. Possible values:
Related options:
|
| string value | (DEPRECATED FOR REMOVAL) Abstracts out IPv6 address generation to pluggable backends. nova-network can be put into dual-stack mode, so that it uses both IPv4 and IPv6 addresses. In dual-stack mode, by default, instances acquire IPv6 global unicast addresses with the help of stateless address auto-configuration mechanism. Related options:
|
| string value | SSL key file (if separate from cert). |
| string value | (DEPRECATED FOR REMOVAL) This option allows you to specify the L3 management library to be used. Possible values:
Related options:
|
| string value | (DEPRECATED FOR REMOVAL) Base distinguished name for the LDAP search query This option helps to decide where to look up the host in LDAP. |
| string value | (DEPRECATED FOR REMOVAL) Bind user’s password for LDAP server |
| multi valued | (DEPRECATED FOR REMOVAL) DNS Servers for LDAP DNS driver Possible values:
|
| integer value | (DEPRECATED FOR REMOVAL) Expiry interval (in seconds) for LDAP DNS driver Start of Authority Time interval, a secondary/slave DNS server holds the information before it is no longer considered authoritative. |
| string value | (DEPRECATED FOR REMOVAL) Hostmaster for LDAP DNS driver Statement of Authority Possible values:
|
| integer value | (DEPRECATED FOR REMOVAL) Minimum interval (in seconds) for LDAP DNS driver Start of Authority It is Minimum time-to-live applies for all resource records in the zone file. This value is supplied to other servers how long they should keep the data in cache. |
| integer value | (DEPRECATED FOR REMOVAL) Refresh interval (in seconds) for LDAP DNS driver Start of Authority Time interval, a secondary/slave DNS server waits before requesting for primary DNS server’s current SOA record. If the records are different, secondary DNS server will request a zone transfer from primary. Note Lower values would cause more traffic. |
| integer value | (DEPRECATED FOR REMOVAL) Retry interval (in seconds) for LDAP DNS driver Start of Authority Time interval, a secondary/slave DNS server should wait, if an attempt to transfer zone failed during the previous refresh interval. |
| uri value | (DEPRECATED FOR REMOVAL) URL for LDAP server which will store DNS entries Possible values:
|
| string value | (DEPRECATED FOR REMOVAL) Bind user for LDAP server |
| string value | (DEPRECATED FOR REMOVAL) This is the class used as the ethernet device driver for linuxnet bridge operations. The default value should be all you need for most cases, but if you wish to use a customized class, set this option to the full dot-separated import path for that class. Possible values:
|
| string value | (DEPRECATED FOR REMOVAL) The name of the Open vSwitch bridge that is used with linuxnet when connecting with Open vSwitch." Possible values:
|
| integer value | Maximum number of 1 second retries in live_migration. It specifies number of retries to iptables when it complains. It happens when an user continuously sends live-migration request to same host leading to concurrent request to iptables. Possible values:
|
| string value | 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. Note that when logging configuration files are used then all logging configuration is set in the configuration file and other logging configuration options are ignored (for example, log-date-format). |
| string value | Defines the format string for %%(asctime)s in log records. Default: %(default)s . This option is ignored if log_config_append is set. |
| string value | (Optional) The base directory used for relative log_file paths. This option is ignored if log_config_append is set. |
| string value | (Optional) Name of log file to send logging output to. If no default is set, logging will go to stderr as defined by use_stderr. This option is ignored if log_config_append is set. |
| boolean value | Enables or disables logging values of all registered options when starting a service (at DEBUG level). |
| integer value | The amount of time before the log files are rotated. This option is ignored unless log_rotation_type is setto "interval". |
| string value | Rotation interval type. The time of the last file change (or the time when the service was started) is used when scheduling the next rotation. |
| string value | Log rotation type. |
| string value | Format string to use for log messages with context. Used by oslo_log.formatters.ContextFormatter |
| string value | Additional data to append to log message when logging level for the message is DEBUG. Used by oslo_log.formatters.ContextFormatter |
| string value | Format string to use for log messages when context is undefined. Used by oslo_log.formatters.ContextFormatter |
| string value | Prefix each line of exception output with this format. Used by oslo_log.formatters.ContextFormatter |
| string value | Defines the format string for %(user_identity)s that is used in logging_context_format_string. Used by oslo_log.formatters.ContextFormatter |
| integer value | This option allows setting an alternate timeout value for RPC calls that have the potential to take a long time. If set, RPC calls to other services will use this value for the timeout (in seconds) instead of the global rpc_response_timeout value. Operations with RPC calls that utilize this value:
Related options:
|
| integer value | Limits the maximum number of instance builds to run concurrently by nova-compute. Compute service can attempt to build an infinite number of instances, if asked to do so. This limit is enforced to avoid building unlimited instance concurrently on a compute node. This value can be set per compute node. Possible Values:
|
| integer value | Maximum number of live migrations to run concurrently. This limit is enforced to avoid outbound live migrations overwhelming the host/network and causing failures. It is not recommended that you change this unless you are very sure that doing so is safe and stable in your environment. Possible values:
|
| integer value | Maximum number of devices that will result in a local image being created on the hypervisor node.
A negative number means unlimited. Setting Possible values:
|
| integer value | Maximum number of rotated log files. |
| integer value | Log file maximum size in MB. This option is ignored if "log_rotation_type" is not set to "size". |
| integer value | The number of times to attempt to reap an instance’s files. This option specifies the maximum number of retry attempts that can be made. Possible values:
Related options:
|
| string value | This option determines the IP address for the network metadata API server. This is really the client side of the metadata host equation that allows nova-network to find the metadata server when doing a default multi host networking. Possible values:
Related options:
|
| string value | IP address on which the metadata API will listen. The metadata API service listens on this IP address for incoming requests. |
| port value | Port on which the metadata API will listen. The metadata API service listens on this port number for incoming requests. |
| port value | (DEPRECATED FOR REMOVAL) This option determines the port used for the metadata API server. Related options:
|
| integer value | Number of workers for metadata service. If not specified the number of available CPUs will be used. The metadata service can be configured to run as multi-process (workers). This overcomes the problem of reduction in throughput when API request concurrency increases. The metadata service will run in the specified number of processes. Possible Values:
|
| integer value | Number of times to retry live-migration before failing. Possible values:
|
| string value | Name or path of the tool used for ISO image creation.
Use the
To use a config drive with Hyper-V, you must set the Possible values:
Related options:
|
| boolean value | (DEPRECATED FOR REMOVAL) Default value for multi_host in networks. nova-network service can operate in a multi-host or single-host mode. In multi-host mode each compute node runs a copy of nova-network and the instances on that compute node use the compute node as a gateway to the Internet. Where as in single-host mode, a central server runs the nova-network service. All compute nodes forward traffic from the instances to the cloud controller which then forwards traffic to the Internet. If this options is set to true, some rpc network calls will be sent directly to host. Note that this option is only used when using nova-network instead of Neutron in your deployment. Related options:
|
| string value | The IP address which is used to connect to the block storage network. Possible values:
Related options:
|
| string value | The IP address which the host is using to connect to the management network. Possible values:
Related options:
|
| integer value | Number of times to retry network allocation. It is required to attempt network allocation retries if the virtual interface plug fails. Possible values:
|
| string value | (DEPRECATED FOR REMOVAL) Driver to use for network creation. Network driver initializes (creates bridges and so on) only when the first VM lands on a host node. All network managers configure the network using network drivers. The driver is not tied to any particular network manager. The default Linux driver implements vlans, bridges, and iptables rules using linux utilities. Note that this option is only used when using nova-network instead of Neutron in your deployment. Related options:
|
| string value | (DEPRECATED FOR REMOVAL) Full class name for the Manager for network |
| integer value | (DEPRECATED FOR REMOVAL) This option determines the number of addresses in each private subnet. Please note that this option is only used when using nova-network instead of Neutron in your deployment. Possible values:
Related options:
|
| string value | (DEPRECATED FOR REMOVAL) The location where the network configuration files will be kept. The default is the networks directory off of the location where nova’s Python module is installed. Possible values
|
| list value | Image properties that should not be inherited from the instance when taking a snapshot. This option gives an opportunity to select which image-properties should not be inherited by newly created snapshots. Possible values:
|
| integer value |
(DEPRECATED FOR REMOVAL) This option represents the number of networks to create if not explicitly specified when the network is created. The only time this is used is if a CIDR is specified, but an explicit network_size is not. In that case, the subnets are created by diving the IP address space of the CIDR by num_networks. The resulting subnet sizes cannot be larger than the configuration option Please note that this option is only used when using nova-network instead of Neutron in your deployment. Possible values:
Related options:
|
| string value | IP address on which the OpenStack API will listen. The OpenStack API service listens on this IP address for incoming requests. |
| port value | Port on which the OpenStack API will listen. The OpenStack API service listens on this port number for incoming requests. |
`osapi_compute_unique_server_name_scope = ` | string value | Sets the scope of the check for unique instance names. The default doesn’t check for unique names. If a scope for the name check is set, a launch of a new instance or an update of an existing instance with a duplicate name will result in an 'InstanceExists' error. The uniqueness is case-insensitive. Setting this option can increase the usability for end users as they don’t have to distinguish among instances with the same name by their IDs. |
| integer value | Number of workers for OpenStack API service. The default will be the number of CPUs available. OpenStack API services can be configured to run as multi-process (workers). This overcomes the problem of reduction in throughput when API request concurrency increases. OpenStack API service will run in the specified number of processes. Possible Values:
|
| integer value | (DEPRECATED FOR REMOVAL) This option represents the period of time, in seconds, that the ovs_vsctl calls will wait for a response from the database before timing out. A setting of 0 means that the utility should wait forever for a response. Possible values:
|
| integer value | Length of generated instance admin passwords. |
| boolean value | Enable periodic tasks. If set to true, this option allows services to periodically run tasks on the manager. In case of running multiple schedulers or conductors you may want to run periodic tasks on only one host - in this case disable this option for all hosts but one. |
| integer value | Number of seconds to randomly delay when starting the periodic task scheduler to reduce stampeding. When compute workers are restarted in unison across a cluster, they all end up running the periodic tasks at the same time causing problems for the external services. To mitigate this behavior, periodic_fuzzy_delay option allows you to introduce a random initial delay when starting the periodic task scheduler. Possible Values:
|
| string value | Generic property to specify the pointer type. Input devices allow interaction with a graphical framebuffer. For example to provide a graphic tablet for absolute cursor movement. If set, the hw_pointer_model image property takes precedence over this configuration option. Related options:
|
| string value | The image preallocation mode to use. Image preallocation allows storage for instance images to be allocated up front when the instance is initially provisioned. This ensures immediate feedback is given if enough space isn’t available. In addition, it should significantly improve performance on writes to new blocks and may even improve I/O performance to prewritten blocks due to reduced fragmentation. |
| string value | (DEPRECATED FOR REMOVAL) This is the name of the network interface for public IP addresses. The default is eth0. Possible values:
|
| boolean value | Enables or disables publication of error events. |
| string value | The directory where the Nova python modules are installed. This directory is used to store template files for networking and remote console access. It is also the default path for other config options which need to persist Nova internal data. It is very unlikely that you need to change this option from its default value. Possible values:
Related options:
|
| integer value | (DEPRECATED FOR REMOVAL) This option controls the number of private networks that can be created per project (or per tenant). Related options:
|
| floating point value | Virtual RAM to physical RAM allocation ratio.
This option is used to influence the hosts selected by the Placement API by configuring the allocation ratio for
Possible values:
Related options:
|
| integer value | Maximum number of logged messages per rate_limit_interval. |
| string value | Log level name used by rate limiting: CRITICAL, ERROR, INFO, WARNING, DEBUG or empty string. Logs with level greater or equal to rate_limit_except_level are not filtered. An empty string means that all levels are filtered. |
| integer value | Interval, number of seconds, of log rate limiting. |
| integer value | Time interval after which an instance is hard rebooted automatically. When doing a soft reboot, it is possible that a guest kernel is completely hung in a way that causes the soft reboot task to not ever finish. Setting this option to a time period in seconds will automatically hard reboot an instance if it has been stuck in a rebooting state longer than N seconds. Possible values:
|
| integer value | Interval for reclaiming deleted instances. A value greater than 0 will enable SOFT_DELETE of instances. This option decides whether the server to be deleted will be put into the SOFT_DELETED state. If this value is greater than 0, the deleted server will not be deleted immediately, instead it will be put into a queue until it’s too old (deleted time greater than the value of reclaim_instance_interval). The server can be recovered from the delete queue by using the restore action. If the deleted server remains longer than the value of reclaim_instance_interval, it will be deleted by a periodic task in the compute service automatically. Note that this option is read from both the API and compute nodes, and must be set globally otherwise servers could be put into a soft deleted state in the API and never actually reclaimed (deleted) on the compute node. Possible values:
|
| string value | Filename that will be used for storing websocket frames received and sent by a proxy service (like VNC, spice, serial) running on this host. If this is not set, no recording will be done. |
| boolean value | Should unused base images be removed? |
| integer value | Unused unresized base images younger than this will not be removed. |
| integer value | Number of seconds indicating how frequently the state of services on a given hypervisor is reported. Nova needs to know this to determine the overall health of the deployment. Related Options:
|
| integer value | Interval to wait before un-rescuing an instance stuck in RESCUE. Possible values:
|
| integer value | Number of host CPUs to reserve for host processes.
The host resources usage is reported back to the scheduler continuously from nova-compute running on the compute node. This value is used to determine the
This option cannot be set if the Possible values:
Related options:
|
| integer value | Amount of disk resources in MB to make them always available to host. The disk usage gets reported back to the scheduler from nova-compute running on the compute nodes. To prevent the disk resources from being considered as available, this option can be used to reserve disk space for that host. Possible values:
|
| integer value | Amount of memory in MB to reserve for the host so that it is always available to host processes. The host resources usage is reported back to the scheduler continuously from nova-compute running on the compute node. To prevent the host memory from being considered as available, this option is used to reserve memory for the host. Possible values:
|
| dict value | Number of huge/large memory pages to reserved per NUMA host cell. Possible values:
|
| integer value | Automatically confirm resizes after N seconds. Resize functionality will save the existing server before resizing. After the resize completes, user is requested to confirm the resize. The user has the opportunity to either confirm or revert all changes. Confirm resize removes the original server and changes server status from resized to active. Setting this option to a time period (in seconds) will automatically confirm the resize if the server is in resized state longer than that time. Possible values:
|
| boolean value | Enable resizing of filesystems via a block device. If enabled, attempt to resize the filesystem by accessing the image over a block device. This is done by the host and may not be necessary if the image contains a recent version of cloud-init. Possible mechanisms require the nbd driver (for qcow and raw), or loop (for raw). |
| boolean value | This option specifies whether to start guests that were running before the host rebooted. It ensures that all of the instances on a Nova compute node resume their state each time the compute node boots or restarts. |
| string value | Path to the rootwrap configuration file. Goal of the root wrapper is to allow a service-specific unprivileged user to run a number of actions as the root user in the safest manner possible. The configuration file used here must match the one defined in the sudoers entry. |
| string value | (DEPRECATED FOR REMOVAL) The public IP address of the network host. This is used when creating an SNAT rule. Possible values:
Related options:
|
| integer value | Size of RPC connection pool. |
| integer value | Seconds to wait for a response from a call. |
| boolean value | Some periodic tasks can be run in a separate process. Should we run them here? |
| string value | The compute service periodically checks for instances that have been deleted in the database but remain running on the compute node. The above option enables action to be taken when such instances are identified. Related options:
|
| integer value | Time interval in seconds to wait between runs for the clean up action. If set to 0, above check will be disabled. If "running_deleted_instance _action" is set to "log" or "reap", a value greater than 0 must be set. Possible values:
Related options:
|
| integer value | Time interval in seconds to wait for the instances that have been marked as deleted in database to be eligible for cleanup. Possible values:
Related options:
|
| integer value | Interval between sending the scheduler a list of current instance UUIDs to verify that its view of instances is in sync with nova. If the CONF option scheduler_tracks_instance_changes is False, the sync calls will not be made. So, changing this option will have no effect. If the out of sync situations are not very common, this interval can be increased to lower the number of RPC messages being sent. Likewise, if sync issues turn out to be a problem, the interval can be lowered to check more frequently. Possible values:
Related options:
|
| boolean value | When True, when a device starts up, and upon binding floating IP addresses, arp messages will be sent to ensure that the arp caches on the compute hosts are up-to-date. Related options:
|
| integer value | When arp messages are configured to be sent, they will be sent with the count set to the value of this option. Of course, if this is set to zero, no arp messages will be sent. Possible values:
Related options:
|
| integer value | Maximum time in seconds since last check-in for up service Each compute node periodically updates their database status based on the specified report interval. If the compute node hasn’t updated the status for more than service_down_time, then the compute node is considered down. Related Options:
|
| string value | This option specifies the driver to be used for the servicegroup service. ServiceGroup API in nova enables checking status of a compute node. When a compute worker running the nova-compute daemon starts, it calls the join API to join the compute group. Services like nova scheduler can query the ServiceGroup API to check if a node is alive. Internally, the ServiceGroup client driver automatically updates the compute worker status. There are multiple backend implementations for this service: Database ServiceGroup driver and Memcache ServiceGroup driver. Related Options:
|
| boolean value | (DEPRECATED FOR REMOVAL) THIS VALUE SHOULD BE SET WHEN CREATING THE NETWORK. If True in multi_host mode, all compute hosts share the same dhcp address. The same IP address used for DHCP will be added on each nova-network node which is only visible to the VMs on the same host. The use of this configuration has been deprecated and may be removed in any release after Mitaka. It is recommended that instead of relying on this option, an explicit value should be passed to create_networks() as a keyword argument with the name share_address. |
| integer value | Time before a shelved instance is eligible for removal from a host. By default this option is set to 0 and the shelved instance will be removed from the hypervisor immediately after shelve operation. Otherwise, the instance will be kept for the value of shelved_offload_time(in seconds) so that during the time period the unshelve action will be faster, then the periodic task will remove the instance from hypervisor after shelved_offload_time passes. Possible values:
|
| integer value | Interval for polling shelved instances to offload. The periodic task runs for every shelved_poll_interval number of seconds and checks if there are any shelved instances. If it finds a shelved instance, based on the shelved_offload_time config value it offloads the shelved instances. Check shelved_offload_time config option description for details. Possible values:
Related options:
|
| integer value | Total time to wait in seconds for an instance to perform a clean shutdown. It determines the overall period (in seconds) a VM is allowed to perform a clean shutdown. While performing stop, rescue and shelve, rebuild operations, configuring this option gives the VM a chance to perform a controlled shutdown before the instance is powered off. The default timeout is 60 seconds. A value of 0 (zero) means the guest will be powered off immediately with no opportunity for guest OS clean-up. The timeout value can be overridden on a per image basis by means of os_shutdown_timeout that is an image metadata setting allowing different types of operating systems to specify how much time they need to shut down cleanly. Possible values:
|
| boolean value | Set to True if source host is addressed with IPv6. |
| boolean value | Disallow non-encrypted connections. |
| string value | The top-level directory for maintaining Nova’s state.
This directory is used to store Nova’s internal state. It is used by a variety of other config options which derive from this. In some scenarios (for example migrations) it makes sense to use a storage location which is shared between multiple compute hosts (for example via NFS). Unless the option Possible values:
|
| integer value | Interval to sync power states between the database and the hypervisor. The interval that Nova checks the actual virtual machine power state and the power state that Nova has in its database. If a user powers down their VM, Nova updates the API to report the VM has been powered down. Should something turn on the VM unexpectedly, Nova will turn the VM back off to keep the system in the expected state. Possible values:
Related options:
|
| integer value | Number of greenthreads available for use to sync power states. This option can be used to reduce the number of concurrent requests made to the hypervisor or system with real instance power states for performance reasons, for example, with Ironic. Possible values:
|
| string value | Syslog facility to receive log lines. This option is ignored if log_config_append is set. |
| boolean value | (DEPRECATED FOR REMOVAL) Determines whether unused gateway devices, both VLAN and bridge, are deleted if the network is in nova-network VLAN mode and is multi-hosted. Related options:
|
| string value | Explicitly specify the temporary working directory. |
| integer value | Amount of time, in seconds, to wait for NBD device start up. |
| string value | The network address and optional user credentials for connecting to the messaging backend, in URL format. The expected format is: driver://[user:pass@]host:port[,[userN:passN@]hostN:portN]/virtual_host?query Example: rabbit://rabbitmq:password@127.0.0.1:5672// For full details on the fields in the URL see the documentation of oslo_messaging.TransportURL at https://docs.openstack.org/oslo.messaging/latest/reference/transport.html |
| boolean value | (DEPRECATED FOR REMOVAL) When this option is True, whenever a DNS entry must be updated, a fanout cast message is sent to all network hosts to update their DNS entries in multi-host mode. Related options:
|
| integer value | Interval for updating compute resources. This option specifies how often the update_available_resources periodic task should run. A number less than 0 means to disable the task completely. Leaving this at the default of 0 will cause this to run at the default periodic interval. Setting it to any positive value will cause it to run at approximately that number of seconds. Possible values:
|
| boolean value | Enable journald for logging. If running in a systemd environment you may wish to enable journal support. Doing so will use the journal native protocol which includes structured metadata in addition to log messages.This option is ignored if log_config_append is set. |
| boolean value | Use JSON formatting for logging. This option is ignored if log_config_append is set. |
| boolean value | Use syslog for logging. Existing syslog format is DEPRECATED and will be changed later to honor RFC5424. This option is ignored if log_config_append is set. |
| boolean value | Enable use of copy-on-write (cow) images. QEMU/KVM allow the use of qcow2 as backing files. By disabling this, backing files will not be used. |
| boolean value | Log output to Windows Event Log. |
| boolean value | (DEPRECATED FOR REMOVAL) Assign IPv6 and IPv4 addresses when creating instances. Related options:
|
| boolean value |
(DEPRECATED FOR REMOVAL) When this option is set to True, the dns1 and dns2 servers for the network specified by the user on boot will be used for DNS, as well as any specified in the Related options:
|
| boolean value | (DEPRECATED FOR REMOVAL) Enable neutron as the backend for networking. Determine whether to use Neutron or Nova Network as the back end. Set to true to use neutron. |
| boolean value | Start and use a daemon that can run the commands that need to be run with root privileges. This option is usually enabled on nodes that run nova compute processes. |
| boolean value | (DEPRECATED FOR REMOVAL) When set to True, only the firt nic of a VM will get its default gateway from the DHCP server. |
| boolean value | Log output to standard error. This option is ignored if log_config_append is set. |
| string value |
(DEPRECATED FOR REMOVAL) Mask of host CPUs that can be used for
The behavior of this option depends on the definition of the
Possible values:
Related options:
|
| boolean value | Determine if instance should boot or fail on VIF plugging timeout. Nova sends a port update to Neutron after an instance has been scheduled, providing Neutron with the necessary information to finish setup of the port. Once completed, Neutron notifies Nova that it has finished setting up the port, at which point Nova resumes the boot of the instance since network connectivity is now supposed to be present. A timeout will occur if the reply is not received after a given interval. This option determines what Nova does when the VIF plugging timeout event happens. When enabled, the instance will error out. When disabled, the instance will continue to boot on the assumption that the port is ready. Possible values:
|
| integer value | Timeout for Neutron VIF plugging event message arrival. Number of seconds to wait for Neutron vif plugging events to arrive before continuing or failing (see vif_plugging_is_fatal).
If you are hitting timeout failures at scale, consider running rootwrap in "daemon mode" in the neutron agent via the Related options:
|
| multi valued | Name of the mkfs commands for ephemeral device. The format is <os_type>=<mkfs command> |
| string value | (DEPRECATED FOR REMOVAL) This option is the name of the virtual interface of the VM on which the VLAN bridge will be built. While it was originally designed to be used only by nova-network, it is also used by libvirt and xenapi for the bridge interface name.
Please note that this setting will be ignored in nova-network if the configuration option for Possible values:
|
| integer value | (DEPRECATED FOR REMOVAL) This is the VLAN number used for private networks. Note that the when creating the networks, if the specified number has already been assigned, nova-network will increment this number until it finds an available VLAN.
Please note that this option is only used when using nova-network instead of Neutron in your deployment. It also will be ignored if the configuration option for Possible values:
Related options:
|
| integer value | Interval for gathering volume usages. This option updates the volume usage cache for every volume_usage_poll_interval number of seconds. Possible values:
|
| string value | (DEPRECATED FOR REMOVAL) This option is no longer used since the /os-cloudpipe API was removed in the 16.0.0 Pike release. This is the public IP address for the cloudpipe VPN servers. It defaults to the IP address of the host.
Please note that this option is only used when using nova-network instead of Neutron in your deployment. It also will be ignored if the configuration option for Possible values:
Related options:
|
| port value | (DEPRECATED FOR REMOVAL) This is the port number to use as the first VPN port for private networks.
Please note that this option is only used when using nova-network instead of Neutron in your deployment. It also will be ignored if the configuration option for Possible values:
Related options:
|
| boolean value | Uses logging handler designed to watch file system. When log file is moved or removed this handler will open a new log file with specified path instantaneously. It makes sense only if log_file option is specified and Linux platform is used. This option is ignored if log_config_append is set. |
| string value | Path to directory with content which will be served by a web server. |
9.1.2. api
The following table outlines the options available under the [api]
group in the /etc/nova/nova.conf
file.
Table 9.1. api
Configuration option = Default value | Type | Description |
---|---|---|
| string value | Determine the strategy to use for authentication. |
| string value | This string is prepended to the normal URL that is returned in links to the OpenStack Compute API. If it is empty (the default), the URLs are returned unchanged. Possible values:
|
| string value | When gathering the existing metadata for a config drive, the EC2-style metadata is returned for all versions that don’t appear in this option. As of the Liberty release, the available versions are:
The option is in the format of a single string, with each version separated by a space. Possible values:
|
| string value | Domain name used to configure FQDN for instances. This option has two purposes:
#. For neutron and nova-network users, it is used to configure a fully-qualified domain name for instance hostnames. If unset, only the hostname without a domain will be configured. #. (Deprecated) For nova-network users, this option configures the DNS domains used for the DHCP server. Refer to the Possible values:
Related options:
|
| boolean value | Enables returning of the instance password by the relevant server API calls such as create, rebuild, evacuate, or rescue. If the hypervisor does not support password injection, then the password returned will not be correct, so if your hypervisor does not support password injection, set this to False. |
| string value | This string is prepended to the normal URL that is returned in links to Glance resources. If it is empty (the default), the URLs are returned unchanged. Possible values:
|
| integer value |
This controls the batch size of instances requested from each cell database if Related options:
|
| string value | This controls the method by which the API queries cell databases in smaller batches during large instance list operations. If batching is performed, a large instance list operation will request some fraction of the overall API limit from each cell database initially, and will re-request that same batch size as records are consumed (returned) from each cell as necessary. Larger batches mean less chattiness between the API and the database, but potentially more wasted effort processing the results from the database which will not be returned to the user. Any strategy will yield a batch size of at least 100 records, to avoid a user causing many tiny database queries in their request. Related options:
|
| boolean value | When enabled, this will cause the API to only query cell databases in which the tenant has mapped instances. This requires an additional (fast) query in the API database before each list, but also (potentially) limits the number of cell databases that must be queried to provide the result. If you have a small number of cells, or tenants are likely to have instances in all cells, then this should be False. If you have many cells, especially if you confine tenants to a small subset of those cells, this should be True. |
| boolean value | When set to False, this will cause the API to return a 500 error if there is an infrastructure failure like non-responsive cells. If you want the API to skip the down cells and return the results from the up cells set this option to True. Note that from API microversion 2.69 there could be transient conditions in the deployment where certain records are not available and the results could be partial for certain requests containing those records. In those cases this option will be ignored. See "Handling Down Cells" section of the Compute API guide (https://docs.openstack.org/api-guide/compute/down_cells.html) for more information. |
| boolean value | Indicates that the nova-metadata API service has been deployed per-cell, so that we can have better performance and data isolation in a multi-cell deployment. Users should consider the use of this configuration depending on how neutron is setup. If you have networks that span cells, you might need to run nova-metadata API service globally. If your networks are segmented along cell boundaries, then you can run nova-metadata API service per cell. When running nova-metadata API service per cell, you should also configure each Neutron metadata-agent to point to the corresponding nova-metadata API service. |
| integer value | As a query can potentially return many thousands of items, you can limit the maximum number of items in a single response by setting this option. |
| integer value | This option is the time (in seconds) to cache metadata. When set to 0, metadata caching is disabled entirely; this is generally not recommended for performance reasons. Increasing this setting should improve response times of the metadata API when under heavy load. Higher values may increase memory usage, and result in longer times for host metadata changes to take effect. |
| string value | Tenant ID for getting the default network from Neutron API (also referred in some places as the project ID) to use. Related options:
|
| boolean value | When True, the X-Forwarded-For header is treated as the canonical remote address. When False (the default), the remote_address header is used. You should only enable this if you have an HTML sanitizing proxy. |
| boolean value | When True, the TenantNetworkController will query the Neutron API to get the default networks to use. Related options:
|
| integer value | Maximum wait time for an external REST service to connect. Possible values:
Related options:
|
| boolean value | Should failures to fetch dynamic vendordata be fatal to instance boot? Related options:
|
| integer value | Maximum wait time for an external REST service to return data once connected. Possible values:
Related options:
|
`vendordata_dynamic_ssl_certfile = ` | string value | Path to an optional certificate file or CA bundle to verify dynamic vendordata REST services ssl certificates against. Possible values:
Related options:
|
| list value |
A list of targets for the dynamic vendordata provider. These targets are of the form The dynamic vendordata provider collects metadata by contacting external REST services and querying them for information about the instance. This behaviour is documented in the vendordata.rst file in the nova developer reference. |
| string value | Cloud providers may store custom data in vendor data file that will then be available to the instances via the metadata service, and to the rendering of config-drive. The default class for this, JsonFileVendorData, loads this information from a JSON file, whose path is configured by this option. If there is no path set by this option, the class returns an empty dictionary. Note that when using this to provide static vendor data to a configuration drive, the nova-compute service must be configured with this option and the file must be accessible from the nova-compute host. Possible values:
|
| list value | A list of vendordata providers. vendordata providers are how deployers can provide metadata via configdrive and metadata that is specific to their deployment. For more information on the requirements for implementing a vendordata dynamic endpoint, please see the vendordata.rst file in the nova developer reference. Related options:
|
9.1.3. api_database
The following table outlines the options available under the [api_database]
group in the /etc/nova/nova.conf
file.
Table 9.2. api_database
Configuration option = Default value | Type | Description |
---|---|---|
| string value |
The SQLAlchemy connection string to use to connect to the database. Do not set this for the |
| integer value | Verbosity of SQL debugging information: 0=None, 100=Everything. |
`connection_parameters = ` | string value | Optional URL parameters to append onto the connection URL at connect time; specify as param1=value1¶m2=value2&… |
| integer value | Connections which have been present in the connection pool longer than this number of seconds will be replaced with a new one the next time they are checked out from the pool. |
| boolean value | Add Python stack traces to SQL as comment strings. |
| integer value | If set, use this value for max_overflow with SQLAlchemy. |
| integer value | Maximum number of SQL connections to keep open in a pool. Setting a value of 0 indicates no limit. |
| integer value | Maximum number of database connection retries during startup. Set to -1 to specify an infinite retry count. |
| string value | The SQL mode to be used for MySQL sessions. This option, including the default, overrides any server-set SQL mode. To use whatever SQL mode is set by the server configuration, set this to no value. Example: mysql_sql_mode= |
| integer value | If set, use this value for pool_timeout with SQLAlchemy. |
| integer value | Interval between retries of opening a SQL connection. |
| string value | The SQLAlchemy connection string to use to connect to the slave database. |
| boolean value | If True, SQLite uses synchronous mode. |
9.1.4. barbican
The following table outlines the options available under the [barbican]
group in the /etc/nova/nova.conf
file.
Table 9.3. barbican
Configuration option = Default value | Type | Description |
---|---|---|
| string value | Use this endpoint to connect to Keystone |
| string value | Version of the Barbican API, for example: "v1" |
| string value | Use this endpoint to connect to Barbican, for example: "http://localhost:9311/" |
| string value | Specifies the type of endpoint. Allowed values are: public, private, and admin |
| integer value | Number of times to retry poll for key creation completion |
| integer value | Number of seconds to wait before retrying poll for key creation completion |
| boolean value | Specifies if insecure TLS (https) requests. If False, the server’s certificate will not be validated, if True, we can set the verify_ssl_path config meanwhile. |
| string value | A path to a bundle or CA certs to check against, or None for requests to attempt to locate and use certificates which verify_ssh is True. If verify_ssl is False, this is ignored. |
9.1.5. cache
The following table outlines the options available under the [cache]
group in the /etc/nova/nova.conf
file.
Table 9.4. cache
Configuration option = Default value | Type | Description |
---|---|---|
| string value | Cache backend module. For eventlet-based or environments with hundreds of threaded servers, Memcache with pooling (oslo_cache.memcache_pool) is recommended. For environments with less than 100 threaded servers, Memcached (dogpile.cache.memcached) or Redis (dogpile.cache.redis) is recommended. Test environments with a single instance of the server can use the dogpile.cache.memory backend. |
| multi valued | Arguments supplied to the backend module. Specify this option once per argument to be passed to the dogpile.cache backend. Example format: "<argname>:<value>". |
| string value | Prefix for building the configuration dictionary for the cache region. This should not need to be changed unless there is another dogpile.cache region with the same configuration name. |
| boolean value | Extra debugging from the cache backend (cache keys, get/set/delete/etc calls). This is only really useful if you need to see the specific cache-backend get/set/delete calls with the keys/values. Typically this should be left set to false. |
| boolean value | Global toggle for caching. |
| integer value | Default TTL, in seconds, for any cached item in the dogpile.cache region. This applies to any cached method that doesn’t have an explicit cache expiration time defined for it. |
| integer value | Number of seconds memcached server is considered dead before it is tried again. (dogpile.cache.memcache and oslo_cache.memcache_pool backends only). |
| integer value | Number of seconds that an operation will wait to get a memcache client connection. |
| integer value | Max total number of open connections to every memcached server. (oslo_cache.memcache_pool backend only). |
| integer value | Number of seconds a connection to memcached is held unused in the pool before it is closed. (oslo_cache.memcache_pool backend only). |
| list value | Memcache servers in the format of "host:port". (dogpile.cache.memcache and oslo_cache.memcache_pool backends only). |
| floating point value | Timeout in seconds for every call to a server. (dogpile.cache.memcache and oslo_cache.memcache_pool backends only). |
| list value | Proxy classes to import that will affect the way the dogpile.cache backend functions. See the dogpile.cache documentation on changing-backend-behavior. |
9.1.6. cinder
The following table outlines the options available under the [cinder]
group in the /etc/nova/nova.conf
file.
Table 9.5. cinder
Configuration option = Default value | Type | Description |
---|---|---|
| string value | Authentication URL |
| string value | Config Section from which to load plugin specific options |
| string value | Authentication type to load |
| string value | PEM encoded Certificate Authority to use when verifying HTTPs connections. |
| string value | Info to match when looking for cinder in the service catalog.
The Possible values:
Note: Nova does not support the Cinder v2 API since the Nova 17.0.0 Queens release. Related options:
|
| string value | PEM encoded client certificate cert file |
| boolean value | Collect per-API call timing information. |
| boolean value | Allow attach between instance and volume in different availability zones. If False, volumes attached to an instance must be in the same availability zone in Cinder as the instance availability zone in Nova. This also means care should be taken when booting an instance from a volume where source is not "volume" because Nova will attempt to create a volume using the same availability zone as what is assigned to the instance. If that AZ is not in Cinder (or allow_availability_zone_fallback=False in cinder.conf), the volume create request will fail and the instance will fail the build request. By default there is no availability zone restriction on volume attach. |
| string value | Optional domain ID to use with v3 and v2 parameters. It will be used for both the user and project domain in v3 and ignored in v2 authentication. |
| string value | Optional domain name to use with v3 API and v2 parameters. It will be used for both the user and project domain in v3 and ignored in v2 authentication. |
| string value | Domain ID to scope to |
| string value | Domain name to scope to |
| string value | If this option is set then it will override service catalog lookup with this template for cinder endpoint Possible values:
Note: Nova does not support the Cinder v2 API since the Nova 17.0.0 Queens release. Related options:
|
| integer value | Number of times cinderclient should retry on any failed http call. 0 means connection is attempted only once. Setting it to any positive integer means that on failure connection is retried that many times e.g. setting it to 3 means total attempts to connect will be 4. Possible values:
|
| boolean value | Verify HTTPS connections. |
| string value | PEM encoded client certificate key file |
| string value | Region name of this node. This is used when picking the URL in the service catalog. Possible values:
|
| string value | User’s password |
| string value | Domain ID containing project |
| string value | Domain name containing project |
| string value | Project ID to scope to |
| string value | Project name to scope to |
| boolean value | Log requests to multiple loggers. |
| string value | Scope for system operations |
| string value | Tenant ID |
| string value | Tenant Name |
| integer value | Timeout value for http requests |
| string value | Trust ID |
| string value | User’s domain id |
| string value | User’s domain name |
| string value | User ID |
| string value | Username |
9.1.7. compute
The following table outlines the options available under the [compute]
group in the /etc/nova/nova.conf
file.
Table 9.6. compute
Configuration option = Default value | Type | Description |
---|---|---|
| integer value | Enables reporting of build failures to the scheduler. Any nonzero value will enable sending build failure statistics to the scheduler for use by the BuildFailureWeigher. Possible values:
Related options:
|
| string value |
Mask of host CPUs that can be used for
The behavior of this option affects the behavior of the deprecated
This behavior will be simplified in a future release when Possible values:
Related options:
|
| string value |
Mask of host CPUs that can be used for
The behavior of this option depends on the definition of the deprecated
This behavior will be simplified in a future release when Possible values:
Related options:
|
| boolean value |
Determine if the source compute host should wait for a Note that this option is read on the destination host of a live migration. If you set this option the same on all of your compute hosts, which you should do if you use the same networking backend universally, you do not have to worry about this.
Before starting the transfer of the guest, some setup occurs on the destination compute host, including plugging virtual interfaces. Depending on the networking backend on the destination host, a
Possible values:
Related options:
|
| integer value | Number of concurrent disk-IO-intensive operations (glance image downloads, image format conversions, etc.) that we will do in parallel. If this is set too high then response time suffers. The default value of 0 means no limit. |
| integer value |
Maximum number of disk devices allowed to attach to a single server. Note that the number of disks supported by an server depends on the bus used. For example, the
Usually, disk bus is determined automatically from the device type or disk device, and the virtualization type. However, disk bus can also be specified via a block device mapping or an image property. See the
Operators changing the
Operators setting The configured maximum is not enforced on shelved offloaded servers, as they have no compute host. Possible values:
|
| integer value | Interval for updating nova-compute-side cache of the compute node resource provider’s inventories, aggregates, and traits. This option specifies the number of seconds between attempts to update a provider’s inventories, aggregates and traits in the local cache of the compute node. A value of zero disables cache refresh completely. The cache can be cleared manually at any time by sending SIGHUP to the compute process, causing it to be repopulated the next time the data is accessed. Possible values:
|
| integer value | Time to wait in seconds before resending an ACPI shutdown signal to instances.
The overall time to wait is set by Possible values:
Related options:
|
9.1.8. conductor
The following table outlines the options available under the [conductor]
group in the /etc/nova/nova.conf
file.
Table 9.7. conductor
Configuration option = Default value | Type | Description |
---|---|---|
| integer value | Number of workers for OpenStack Conductor service. The default will be the number of CPUs available. |
9.1.9. console
The following table outlines the options available under the [console]
group in the /etc/nova/nova.conf
file.
Table 9.8. console
Configuration option = Default value | Type | Description |
---|---|---|
| list value | Adds list of allowed origins to the console websocket proxy to allow connections from other origin hostnames. Websocket proxy matches the host header with the origin header to prevent cross-site requests. This list specifies if any there are values other than host are allowed in the origin header. Possible values:
|
9.1.10. consoleauth
The following table outlines the options available under the [consoleauth]
group in the /etc/nova/nova.conf
file.
Table 9.9. consoleauth
Configuration option = Default value | Type | Description |
---|---|---|
| integer value | The lifetime of a console auth token (in seconds). A console auth token is used in authorizing console access for a user. Once the auth token time to live count has elapsed, the token is considered expired. Expired tokens are then deleted. |
9.1.11. cors
The following table outlines the options available under the [cors]
group in the /etc/nova/nova.conf
file.
Table 9.10. cors
Configuration option = Default value | Type | Description |
---|---|---|
| boolean value | Indicate that the actual request can include user credentials |
| list value | Indicate which header field names may be used during the actual request. |
| list value | Indicate which methods can be used during the actual request. |
| list value | Indicate whether this resource may be shared with the domain received in the requests "origin" header. Format: "<protocol>://<host>[:<port>]", no trailing slash. Example: https://horizon.example.com |
| list value | Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers. |
| integer value | Maximum cache age of CORS preflight requests. |
9.1.12. database
The following table outlines the options available under the [database]
group in the /etc/nova/nova.conf
file.
Table 9.11. database
Configuration option = Default value | Type | Description |
---|---|---|
| string value | The back end to use for the database. |
| string value | The SQLAlchemy connection string to use to connect to the database. |
| integer value | Verbosity of SQL debugging information: 0=None, 100=Everything. |
`connection_parameters = ` | string value | Optional URL parameters to append onto the connection URL at connect time; specify as param1=value1¶m2=value2&… |
| integer value | Connections which have been present in the connection pool longer than this number of seconds will be replaced with a new one the next time they are checked out from the pool. |
| boolean value | Add Python stack traces to SQL as comment strings. |
| boolean value | If True, increases the interval between retries of a database operation up to db_max_retry_interval. |
| integer value | Maximum retries in case of connection error or deadlock error before error is raised. Set to -1 to specify an infinite retry count. |
| integer value | If db_inc_retry_interval is set, the maximum seconds between retries of a database operation. |
| integer value | Seconds between retries of a database transaction. |
| integer value | If set, use this value for max_overflow with SQLAlchemy. |
| integer value | Maximum number of SQL connections to keep open in a pool. Setting a value of 0 indicates no limit. |
| integer value | Maximum number of database connection retries during startup. Set to -1 to specify an infinite retry count. |
| boolean value | If True, transparently enables support for handling MySQL Cluster (NDB). |
| string value | The SQL mode to be used for MySQL sessions. This option, including the default, overrides any server-set SQL mode. To use whatever SQL mode is set by the server configuration, set this to no value. Example: mysql_sql_mode= |
| integer value | If set, use this value for pool_timeout with SQLAlchemy. |
| integer value | Interval between retries of opening a SQL connection. |
| string value | The SQLAlchemy connection string to use to connect to the slave database. |
| boolean value | If True, SQLite uses synchronous mode. |
| boolean value | Enable the experimental use of database reconnect on connection lost. |
| boolean value | Enable the experimental use of thread pooling for all DB API calls |
9.1.13. devices
The following table outlines the options available under the [devices]
group in the /etc/nova/nova.conf
file.
Table 9.12. devices
Configuration option = Default value | Type | Description |
---|---|---|
| list value | The vGPU types enabled in the compute node. Some pGPUs (e.g. NVIDIA GRID K1) support different vGPU types. User can use this option to specify a list of enabled vGPU types that may be assigned to a guest instance. But please note that Nova only supports a single type in the Queens release. If more than one vGPU type is specified (as a comma-separated list), only the first one will be used. An example is as the following:: [devices] enabled_vgpu_types = GRID K100,Intel GVT-g,MxGPU.2,nvidia-11 |
9.1.14. ephemeral_storage_encryption
The following table outlines the options available under the [ephemeral_storage_encryption]
group in the /etc/nova/nova.conf
file.
Table 9.13. ephemeral_storage_encryption
Configuration option = Default value | Type | Description |
---|---|---|
| string value | Cipher-mode string to be used. The cipher and mode to be used to encrypt ephemeral storage. The set of cipher-mode combinations available depends on kernel support. According to the dm-crypt documentation, the cipher is expected to be in the format: "<cipher>-<chainmode>-<ivmode>". Possible values:
|
| boolean value | Enables/disables LVM ephemeral storage encryption. |
| integer value | Encryption key length in bits. The bit length of the encryption key to be used to encrypt ephemeral storage. In XTS mode only half of the bits are used for encryption key. |
9.1.15. filter_scheduler
The following table outlines the options available under the [filter_scheduler]
group in the /etc/nova/nova.conf
file.
Table 9.14. filter_scheduler
Configuration option = Default value | Type | Description |
---|---|---|
| string value | Image property namespace for use in the host aggregate. Images and hosts can be configured so that certain images can only be scheduled to hosts in a particular aggregate. This is done with metadata values set on the host aggregate that are identified by beginning with the value of this option. If the host is part of an aggregate with such a metadata key, the image in the request spec must have the value of that metadata in its properties in order for the scheduler to consider the host as acceptable. This option is only used by the FilterScheduler and its subclasses; if you use a different scheduler, this option has no effect. Also note that this setting only affects scheduling if the aggregate_image_properties_isolation filter is enabled. Possible values:
Related options:
|
| string value | Separator character(s) for image property namespace and name. When using the aggregate_image_properties_isolation filter, the relevant metadata keys are prefixed with the namespace defined in the aggregate_image_properties_isolation_namespace configuration option plus a separator. This option defines the separator to be used. This option is only used by the FilterScheduler and its subclasses; if you use a different scheduler, this option has no effect. Also note that this setting only affects scheduling if the aggregate_image_properties_isolation filter is enabled. Possible values:
Related options:
|
| multi valued | Filters that the scheduler can use. An unordered list of the filter classes the nova scheduler may apply. Only the filters specified in the enabled_filters option will be used, but any filter appearing in that option must also be included in this list. By default, this is set to all filters that are included with nova. This option is only used by the FilterScheduler and its subclasses; if you use a different scheduler, this option has no effect. Possible values:
Related options:
|
| floating point value | Multiplier used for weighing hosts that have had recent build failures. This option determines how much weight is placed on a compute node with recent build failures. Build failures may indicate a failing, misconfigured, or otherwise ailing compute node, and avoiding it during scheduling may be beneficial. The weight is inversely proportional to the number of recent build failures the compute node has experienced. This value should be set to some high value to offset weight given by other enabled weighers due to available resources. To disable weighing compute hosts by the number of recent failures, set this to zero. This option is only used by the FilterScheduler and its subclasses; if you use a different scheduler, this option has no effect. Possible values:
Related options:
|
| floating point value | CPU weight multiplier ratio. Multiplier used for weighting free vCPUs. Negative numbers indicate stacking rather than spreading. This option is only used by the FilterScheduler and its subclasses; if you use a different scheduler, this option has no effect. Also note that this setting only affects scheduling if the cpu weigher is enabled. Possible values:
Related options:
|
| floating point value | Disk weight multipler ratio. Multiplier used for weighing free disk space. Negative numbers mean to stack vs spread. This option is only used by the FilterScheduler and its subclasses; if you use a different scheduler, this option has no effect. Also note that this setting only affects scheduling if the disk weigher is enabled. Possible values:
|
| list value | Filters that the scheduler will use. An ordered list of filter class names that will be used for filtering hosts. These filters will be applied in the order they are listed so place your most restrictive filters first to make the filtering process more efficient. This option is only used by the FilterScheduler and its subclasses; if you use a different scheduler, this option has no effect. Possible values:
Related options:
|
| integer value | Size of subset of best hosts selected by scheduler. New instances will be scheduled on a host chosen randomly from a subset of the N best hosts, where N is the value set by this option. Setting this to a value greater than 1 will reduce the chance that multiple scheduler processes handling similar requests will select the same host, creating a potential race condition. By selecting a host randomly from the N hosts that best fit the request, the chance of a conflict is reduced. However, the higher you set this value, the less optimal the chosen host may be for a given request. This option is only used by the FilterScheduler and its subclasses; if you use a different scheduler, this option has no effect. Possible values:
|
| string value | The default architecture to be used when using the image properties filter. When using the ImagePropertiesFilter, it is possible that you want to define a default architecture to make the user experience easier and avoid having something like x86_64 images landing on aarch64 compute nodes because the user did not specify the hw_architecture property in Glance. Possible values:
|
| floating point value | IO operations weight multipler ratio. This option determines how hosts with differing workloads are weighed. Negative values, such as the default, will result in the scheduler preferring hosts with lighter workloads whereas positive values will prefer hosts with heavier workloads. Another way to look at it is that positive values for this option will tend to schedule instances onto hosts that are already busy, while negative values will tend to distribute the workload across more hosts. The absolute value, whether positive or negative, controls how strong the io_ops weigher is relative to other weighers. This option is only used by the FilterScheduler and its subclasses; if you use a different scheduler, this option has no effect. Also note that this setting only affects scheduling if the io_ops weigher is enabled. Possible values:
|
| list value | List of hosts that can only run certain images. If there is a need to restrict some images to only run on certain designated hosts, list those host names here. This option is only used by the FilterScheduler and its subclasses; if you use a different scheduler, this option has no effect. Also note that this setting only affects scheduling if the IsolatedHostsFilter filter is enabled. Possible values:
Related options:
|
| list value | List of UUIDs for images that can only be run on certain hosts. If there is a need to restrict some images to only run on certain designated hosts, list those image UUIDs here. This option is only used by the FilterScheduler and its subclasses; if you use a different scheduler, this option has no effect. Also note that this setting only affects scheduling if the IsolatedHostsFilter filter is enabled. Possible values:
Related options:
|
| integer value | Maximum number of instances that can exist on a host. If you need to limit the number of instances on any given host, set this option to the maximum number of instances you want to allow. The NumInstancesFilter and AggregateNumInstancesFilter will reject any host that has at least as many instances as this option’s value.
This option is only used by the FilterScheduler and its subclasses; if you use a different scheduler, this option has no effect. Also note that this setting only affects scheduling if the Possible values:
|
| integer value | The number of instances that can be actively performing IO on a host. Instances performing IO includes those in the following states: build, resize, snapshot, migrate, rescue, unshelve. This option is only used by the FilterScheduler and its subclasses; if you use a different scheduler, this option has no effect. Also note that this setting only affects scheduling if the io_ops_filter filter is enabled. Possible values:
|
| floating point value | PCI device affinity weight multiplier.
The PCI device affinity weighter computes a weighting based on the number of PCI devices on the host and the number of PCI devices requested by the instance. The https://docs.openstack.org/nova/latest/user/filter-scheduler.html Possible values:
|
| floating point value | RAM weight multipler ratio. This option determines how hosts with more or less available RAM are weighed. A positive value will result in the scheduler preferring hosts with more available RAM, and a negative number will result in the scheduler preferring hosts with less available RAM. Another way to look at it is that positive values for this option will tend to spread instances across many hosts, while negative values will tend to fill up (stack) hosts as much as possible before scheduling to a less-used host. The absolute value, whether positive or negative, controls how strong the RAM weigher is relative to other weighers. This option is only used by the FilterScheduler and its subclasses; if you use a different scheduler, this option has no effect. Also note that this setting only affects scheduling if the ram weigher is enabled. Possible values:
|
| boolean value | Prevent non-isolated images from being built on isolated hosts. This option is only used by the FilterScheduler and its subclasses; if you use a different scheduler, this option has no effect. Also note that this setting only affects scheduling if the IsolatedHostsFilter filter is enabled. Even then, this option doesn’t affect the behavior of requests for isolated images, which will always be restricted to isolated hosts. Related options:
|
| boolean value | Enable spreading the instances between hosts with the same best weight. Enabling it is beneficial for cases when host_subset_size is 1 (default), but there is a large number of hosts with same maximal weight. This scenario is common in Ironic deployments where there are typically many baremetal nodes with identical weights returned to the scheduler. In such case enabling this option will reduce contention and chances for rescheduling events. At the same time it will make the instance packing (even in unweighed case) less dense. |
| floating point value | Multiplier used for weighing hosts for group soft-affinity. Possible values:
|
| floating point value | Multiplier used for weighing hosts for group soft-anti-affinity. Possible values:
|
| boolean value | Enable querying of individual hosts for instance information. The scheduler may need information about the instances on a host in order to evaluate its filters and weighers. The most common need for this information is for the (anti-)affinity filters, which need to choose a host based on the instances already running on a host. If the configured filters and weighers do not need this information, disabling this option will improve performance. It may also be disabled when the tracking overhead proves too heavy, although this will cause classes requiring host usage data to query the database on each request instead. This option is only used by the FilterScheduler and its subclasses; if you use a different scheduler, this option has no effect. Note In a multi-cell (v2) setup where the cell MQ is separated from the top-level, computes cannot directly communicate with the scheduler. Thus, this option cannot be enabled in that scenario. See also the [workarounds]/disable_group_policy_check_upcall option. |
| list value | Weighers that the scheduler will use. Only hosts which pass the filters are weighed. The weight for any host starts at 0, and the weighers order these hosts by adding to or subtracting from the weight assigned by the previous weigher. Weights may become negative. An instance will be scheduled to one of the N most-weighted hosts, where N is scheduler_host_subset_size. By default, this is set to all weighers that are included with Nova. This option is only used by the FilterScheduler and its subclasses; if you use a different scheduler, this option has no effect. Possible values:
|
9.1.16. glance
The following table outlines the options available under the [glance]
group in the /etc/nova/nova.conf
file.
Table 9.15. glance
Configuration option = Default value | Type | Description |
---|---|---|
| list value | (DEPRECATED FOR REMOVAL) List of url schemes that can be directly accessed. This option specifies a list of url schemes that can be downloaded directly via the direct_url. This direct_URL can be fetched from Image metadata which can be used by nova to get the image more efficiently. nova-compute could benefit from this by invoking a copy when it has access to the same file system as glance. Possible values:
|
| list value | List of glance api servers endpoints available to nova. https is used for ssl-based glance api servers. Note The preferred mechanism for endpoint discovery is via keystoneauth1 loading options. Only use api_servers if you need multiple endpoints and are unable to use a load balancer for some reason. Possible values:
|
| string value | PEM encoded Certificate Authority to use when verifying HTTPs connections. |
| string value | PEM encoded client certificate cert file |
| boolean value | Collect per-API call timing information. |
| integer value | The maximum number of retries that should be attempted for connection errors. |
| floating point value | Delay (in seconds) between two retries for connection errors. If not set, exponential retry starting with 0.5 seconds up to a maximum of 60 seconds is used. |
| boolean value | Enable or disable debug logging with glanceclient. |
| list value | List of certificate IDs for certificates that should be trusted. May be used as a default list of trusted certificate IDs for certificate validation. The value of this option will be ignored if the user provides a list of trusted certificate IDs with an instance API request. The value of this option will be persisted with the instance data if signature verification and certificate validation are enabled and if the user did not provide an alternative list. If left empty when certificate validation is enabled the user must provide a list of trusted certificate IDs otherwise certificate validation will fail. Related options:
|
| boolean value | (DEPRECATED FOR REMOVAL) Enable certificate validation for image signature verification. During image signature verification nova will first verify the validity of the image’s signing certificate using the set of trusted certificates associated with the instance. If certificate validation fails, signature verification will not be performed and the instance will be placed into an error state. This provides end users with stronger assurances that the image data is unmodified and trustworthy. If left disabled, image signature verification can still occur but the end user will not have any assurance that the signing certificate used to generate the image signature is still trustworthy. Related options:
|
| string value |
Always use this endpoint URL for requests for this client. NOTE: The unversioned endpoint should be specified here; to request a particular API version, use the |
| boolean value | Verify HTTPS connections. |
| string value | PEM encoded client certificate key file |
| integer value | Enable glance operation retries. Specifies the number of retries when uploading / downloading an image to / from glance. 0 means no retries. |
| string value | The default region_name for endpoint URL discovery. |
| string value | The default service_name for endpoint URL discovery. |
| string value | The default service_type for endpoint URL discovery. |
| boolean value | Log requests to multiple loggers. |
| integer value | The maximum number of retries that should be attempted for retriable HTTP status codes. |
| floating point value | Delay (in seconds) between two retries for retriable status codes. If not set, exponential retry starting with 0.5 seconds up to a maximum of 60 seconds is used. |
| integer value | Timeout value for http requests |
| list value | List of interfaces, in order of preference, for endpoint URL. |
| boolean value | Enable image signature verification. nova uses the image signature metadata from glance and verifies the signature of a signed image while downloading that image. If the image signature cannot be verified or if the image signature metadata is either incomplete or unavailable, then nova will not boot the image and instead will place the instance into an error state. This provides end users with stronger assurances of the integrity of the image data they are using to create servers. Related options:
|
9.1.17. guestfs
The following table outlines the options available under the [guestfs]
group in the /etc/nova/nova.conf
file.
Table 9.16. guestfs
Configuration option = Default value | Type | Description |
---|---|---|
| boolean value | Enable/disables guestfs logging. This configures guestfs to debug messages and push them to OpenStack logging system. When set to True, it traces libguestfs API calls and enable verbose debug messages. In order to use the above feature, "libguestfs" package must be installed. Related options: Since libguestfs access and modifies VM’s managed by libvirt, below options should be set to give access to those VM’s.
|
9.1.18. healthcheck
The following table outlines the options available under the [healthcheck]
group in the /etc/nova/nova.conf
file.
Table 9.17. healthcheck
Configuration option = Default value | Type | Description |
---|---|---|
| list value | Additional backends that can perform health checks and report that information back as part of a request. |
| boolean value | Show more detailed information as part of the response. Security note: Enabling this option may expose sensitive details about the service being monitored. Be sure to verify that it will not violate your security policies. |
| string value | Check the presence of a file to determine if an application is running on a port. Used by DisableByFileHealthcheck plugin. |
| list value | Check the presence of a file based on a port to determine if an application is running on a port. Expects a "port:path" list of strings. Used by DisableByFilesPortsHealthcheck plugin. |
| string value | (DEPRECATED FOR REMOVAL) The path to respond to healtcheck requests on. |
9.1.19. hyperv
The following table outlines the options available under the [hyperv]
group in the /etc/nova/nova.conf
file.
Table 9.18. hyperv
Configuration option = Default value | Type | Description |
---|---|---|
| boolean value | Mount config drive as a CD drive. OpenStack can be configured to write instance metadata to a config drive, which is then attached to the instance before it boots. The config drive can be attached as a disk drive (default) or as a CD drive. Related options:
|
| boolean value | Inject password to config drive. When enabled, the admin password will be available from the config drive image. Related options:
|
| floating point value | Dynamic memory ratio Enables dynamic memory allocation (ballooning) when set to a value greater than 1. The value expresses the ratio between the total RAM assigned to an instance and its startup RAM amount. For example a ratio of 2.0 for an instance with 1024MB of RAM implies 512MB of RAM allocated at startup. Possible values:
|
| boolean value | Enable instance metrics collection Enables metrics collections for an instance by using Hyper-V’s metric APIs. Collected data can be retrieved by other apps and services, e.g.: Ceilometer. |
| boolean value | Enable RemoteFX feature This requires at least one DirectX 11 capable graphics adapter for Windows / Hyper-V Server 2012 R2 or newer and RDS-Virtualization feature has to be enabled. Instances with RemoteFX can be requested with the following flavor extra specs:
os:vram. Guest VM VRAM amount. Only available on Windows / Hyper-V Server 2016. Acceptable values:: 64, 128, 256, 512, 1024 |
`instances_path_share = ` | string value | Instances path share The name of a Windows share mapped to the "instances_path" dir and used by the resize feature to copy files to the target host. If left blank, an administrative share (hidden network share) will be used, looking for the same "instances_path" used locally. Possible values:
Related options:
|
| list value | List of iSCSI initiators that will be used for estabilishing iSCSI sessions. If none are specified, the Microsoft iSCSI initiator service will choose the initiator. |
| boolean value | Limit CPU features This flag is needed to support live migration to hosts with different CPU features and checked during instance creation in order to limit the CPU features used by the instance. |
| integer value | Mounted disk query retry count The number of times to retry checking for a mounted disk. The query runs until the device can be found or the retry count is reached. Possible values:
Related options:
|
| integer value | Mounted disk query retry interval Interval between checks for a mounted disk, in seconds. Possible values:
Related options:
|
| integer value | Power state check timeframe The timeframe to be checked for instance power state changes. This option is used to fetch the state of the instance from Hyper-V through the WMI interface, within the specified timeframe. Possible values:
|
| integer value | Power state event polling interval Instance power state change event polling frequency. Sets the listener interval for power state events to the given value. This option enhances the internal lifecycle notifications of instances that reboot themselves. It is unlikely that an operator has to change this value. Possible values:
|
| string value | qemu-img command qemu-img is required for some of the image related operations like converting between different image types. You can get it from here: (http://qemu.weilnetz.de/) or you can install the Cloudbase OpenStack Hyper-V Compute Driver (https://cloudbase.it/openstack-hyperv-driver/) which automatically sets the proper path for this config option. You can either give the full path of qemu-img.exe or set its path in the PATH environment variable and leave this option to the default value. Possible values:
Related options:
|
| boolean value | Use multipath connections when attaching iSCSI or FC disks. This requires the Multipath IO Windows feature to be enabled. MPIO must be configured to claim such devices. |
| integer value | Volume attach retry count The number of times to retry attaching a volume. Volume attachment is retried until success or the given retry count is reached. Possible values:
Related options:
|
| integer value | Volume attach retry interval Interval between volume attachment attempts, in seconds. Possible values:
Related options:
|
| string value | External virtual switch name The Hyper-V Virtual Switch is a software-based layer-2 Ethernet network switch that is available with the installation of the Hyper-V server role. The switch includes programmatically managed and extensible capabilities to connect virtual machines to both virtual networks and the physical network. In addition, Hyper-V Virtual Switch provides policy enforcement for security, isolation, and service levels. The vSwitch represented by this config option must be an external one (not internal or private). Possible values:
|
| integer value | Wait soft reboot seconds Number of seconds to wait for instance to shut down after soft reboot request is made. We fall back to hard reboot if instance does not shutdown within this window. Possible values:
|
9.1.20. ironic
The following table outlines the options available under the [ironic]
group in the /etc/nova/nova.conf
file.
Table 9.19. ironic
Configuration option = Default value | Type | Description |
---|---|---|
| integer value | The number of times to retry when a request conflicts. If set to 0, only try once, no retries. Related options:
|
| integer value | The number of seconds to wait before retrying the request. Related options:
|
| string value | Authentication URL |
| string value | Config Section from which to load plugin specific options |
| string value | Authentication type to load |
| string value | PEM encoded Certificate Authority to use when verifying HTTPs connections. |
| string value | PEM encoded client certificate cert file |
| boolean value | Collect per-API call timing information. |
| integer value | The maximum number of retries that should be attempted for connection errors. |
| floating point value | Delay (in seconds) between two retries for connection errors. If not set, exponential retry starting with 0.5 seconds up to a maximum of 60 seconds is used. |
| string value | Domain ID to scope to |
| string value | Domain name to scope to |
| string value |
Always use this endpoint URL for requests for this client. NOTE: The unversioned endpoint should be specified here; to request a particular API version, use the |
| boolean value | Verify HTTPS connections. |
| string value | PEM encoded client certificate key file |
| string value |
Case-insensitive key to limit the set of nodes that may be managed by this service to the set of nodes in Ironic which have a matching conductor_group property. If unset, all available nodes will be eligible to be managed by this service. Note that setting this to the empty string ( |
| string value | User’s password |
| list value | List of hostnames for all nova-compute services (including this host) with this partition_key config value. Nodes matching the partition_key value will be distributed between all services specified here. If partition_key is unset, this option is ignored. |
| string value | Domain ID containing project |
| string value | Domain name containing project |
| string value | Project ID to scope to |
| string value | Project name to scope to |
| string value | The default region_name for endpoint URL discovery. |
| integer value | Timeout (seconds) to wait for node serial console state changed. Set to 0 to disable timeout. |
| string value | The default service_name for endpoint URL discovery. |
| string value | The default service_type for endpoint URL discovery. |
| boolean value | Log requests to multiple loggers. |
| integer value | The maximum number of retries that should be attempted for retriable HTTP status codes. |
| floating point value | Delay (in seconds) between two retries for retriable status codes. If not set, exponential retry starting with 0.5 seconds up to a maximum of 60 seconds is used. |
| string value | Scope for system operations |
| integer value | Timeout value for http requests |
| string value | Trust ID |
| string value | User’s domain id |
| string value | User’s domain name |
| string value | User ID |
| string value | Username |
| list value | List of interfaces, in order of preference, for endpoint URL. |
9.1.21. key_manager
The following table outlines the options available under the [key_manager]
group in the /etc/nova/nova.conf
file.
Table 9.20. key_manager
Configuration option = Default value | Type | Description |
---|---|---|
| string value | The type of authentication credential to create. Possible values are token, password, keystone_token, and keystone_password. Required if no context is passed to the credential factory. |
| string value | Use this endpoint to connect to Keystone. |
| string value | Specify the key manager implementation. Options are "barbican" and "vault". Default is "barbican". Will support the values earlier set using [key_manager]/api_class for some time. |
| string value | Domain ID for domain scoping. Optional for keystone_token and keystone_password auth_type. |
| string value | Domain name for domain scoping. Optional for keystone_token and keystone_password auth_type. |
| string value | Fixed key returned by key manager, specified in hex. Possible values:
|
| string value | Password for authentication. Required for password and keystone_password auth_type. |
| string value | Project’s domain ID for project. Optional for keystone_token and keystone_password auth_type. |
| string value | Project’s domain name for project. Optional for keystone_token and keystone_password auth_type. |
| string value | Project ID for project scoping. Optional for keystone_token and keystone_password auth_type. |
| string value | Project name for project scoping. Optional for keystone_token and keystone_password auth_type. |
| boolean value | Allow fetching a new token if the current one is going to expire. Optional for keystone_token and keystone_password auth_type. |
| string value | Token for authentication. Required for token and keystone_token auth_type if no context is passed to the credential factory. |
| string value | Trust ID for trust scoping. Optional for keystone_token and keystone_password auth_type. |
| string value | User’s domain ID for authentication. Optional for keystone_token and keystone_password auth_type. |
| string value | User’s domain name for authentication. Optional for keystone_token and keystone_password auth_type. |
| string value | User ID for authentication. Optional for keystone_token and keystone_password auth_type. |
| string value | Username for authentication. Required for password auth_type. Optional for the keystone_password auth_type. |
9.1.22. keystone
The following table outlines the options available under the [keystone]
group in the /etc/nova/nova.conf
file.
Table 9.21. keystone
Configuration option = Default value | Type | Description |
---|---|---|
| string value | PEM encoded Certificate Authority to use when verifying HTTPs connections. |
| string value | PEM encoded client certificate cert file |
| boolean value | Collect per-API call timing information. |
| integer value | The maximum number of retries that should be attempted for connection errors. |
| floating point value | Delay (in seconds) between two retries for connection errors. If not set, exponential retry starting with 0.5 seconds up to a maximum of 60 seconds is used. |
| string value |
Always use this endpoint URL for requests for this client. NOTE: The unversioned endpoint should be specified here; to request a particular API version, use the |
| boolean value | Verify HTTPS connections. |
| string value | PEM encoded client certificate key file |
| string value | The default region_name for endpoint URL discovery. |
| string value | The default service_name for endpoint URL discovery. |
| string value | The default service_type for endpoint URL discovery. |
| boolean value | Log requests to multiple loggers. |
| integer value | The maximum number of retries that should be attempted for retriable HTTP status codes. |
| floating point value | Delay (in seconds) between two retries for retriable status codes. If not set, exponential retry starting with 0.5 seconds up to a maximum of 60 seconds is used. |
| integer value | Timeout value for http requests |
| list value | List of interfaces, in order of preference, for endpoint URL. |
9.1.23. keystone_authtoken
The following table outlines the options available under the [keystone_authtoken]
group in the /etc/nova/nova.conf
file.
Table 9.22. keystone_authtoken
Configuration option = Default value | Type | Description |
---|---|---|
| string value | Config Section from which to load plugin specific options |
| string value | Authentication type to load |
| string value | (DEPRECATED FOR REMOVAL) Complete "public" Identity API endpoint. This endpoint should not be an "admin" endpoint, as it should be accessible by all end users. Unauthenticated clients are redirected to this endpoint to authenticate. Although this endpoint should ideally be unversioned, client support in the wild varies. If you’re using a versioned v2 endpoint here, then this should not be the same endpoint the service user utilizes for validating tokens, because normal end users may not be able to reach that endpoint. This option is deprecated in favor of www_authenticate_uri and will be removed in the S release. |
| string value | API version of the Identity API endpoint. |
| string value |
Request environment key where the Swift cache object is stored. When auth_token middleware is deployed with a Swift cache, use this option to have the middleware share a caching backend with swift. Otherwise, use the |
| string value | A PEM encoded Certificate Authority to use when verifying HTTPs connections. Defaults to system CAs. |
| string value | Required if identity server requires client certificate |
| boolean value | Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components. |
| string value | Used to control the use and type of token binding. Can be set to: "disabled" to not check token binding. "permissive" (default) to validate binding information if the bind type is of a form known to the server and ignore it if not. "strict" like "permissive" but if the bind type is unknown the token will be rejected. "required" any form of token binding is needed to be allowed. Finally the name of a binding method that must be present in tokens. |
| integer value | Request timeout value for communicating with Identity API server. |
| integer value | How many times are we trying to reconnect when communicating with Identity API Server. |
| boolean value | (Optional) Indicate whether to set the X-Service-Catalog header. If False, middleware will not ask for service catalog on token validation and will not set the X-Service-Catalog header. |
| boolean value | Verify HTTPS connections. |
| string value | Interface to use for the Identity API endpoint. Valid values are "public", "internal" or "admin"(default). |
| string value | Required if identity server requires client certificate |
| integer value | (Optional) Number of seconds that an operation will wait to get a memcached client connection from the pool. |
| integer value | (Optional) Number of seconds memcached server is considered dead before it is tried again. |
| integer value | (Optional) Maximum total number of open connections to every memcached server. |
| integer value | (Optional) Socket timeout in seconds for communicating with a memcached server. |
| integer value | (Optional) Number of seconds a connection to memcached is held unused in the pool before it is closed. |
| string value | (Optional, mandatory if memcache_security_strategy is defined) This string is used for key derivation. |
| string value | (Optional) If defined, indicate whether token data should be authenticated or authenticated and encrypted. If MAC, token data is authenticated (with HMAC) in the cache. If ENCRYPT, token data is encrypted and authenticated in the cache. If the value is not one of these options or empty, auth_token will raise an exception on initialization. |
| boolean value | (Optional) Use the advanced (eventlet safe) memcached client pool. The advanced pool will only work under python 2.x. |
| list value | Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process. |
| string value | The region in which the identity server can be found. |
| list value | A choice of roles that must be present in a service token. Service tokens are allowed to request that an expired token can be used and so this check should tightly control that only actual services should be sending this token. Roles here are applied as an ANY check so any role in this list must be present. For backwards compatibility reasons this currently only affects the allow_expired check. |
| boolean value | For backwards compatibility reasons we must let valid service tokens pass that don’t pass the service_token_roles check as valid. Setting this true will become the default in a future release and should be enabled if possible. |
| string value | The name or type of the service as it appears in the service catalog. This is used to validate tokens that have restricted access rules. |
| integer value | In order to prevent excessive effort spent validating tokens, the middleware caches previously-seen tokens for a configurable duration (in seconds). Set to -1 to disable caching completely. |
| string value | Complete "public" Identity API endpoint. This endpoint should not be an "admin" endpoint, as it should be accessible by all end users. Unauthenticated clients are redirected to this endpoint to authenticate. Although this endpoint should ideally be unversioned, client support in the wild varies. If you’re using a versioned v2 endpoint here, then this should not be the same endpoint the service user utilizes for validating tokens, because normal end users may not be able to reach that endpoint. |
9.1.24. libvirt
The following table outlines the options available under the [libvirt]
group in the /etc/nova/nova.conf
file.
Table 9.23. libvirt
Configuration option = Default value | Type | Description |
---|---|---|
`connection_uri = ` | string value | Overrides the default libvirt URI of the chosen virtualization type. If set, Nova will use this URI to connect to libvirt. Possible values:
Related options:
|
| string value | Is used to set the CPU mode an instance should have.
If Related options:
|
| list value |
This allows specifying granular CPU feature flags when configuring CPU models. For example, to explicitly specify the [libvirt] cpu_mode = custom cpu_models = IvyBridge cpu_model_extra_flags = pcid
To specify multiple CPU flags (e.g. the Intel [libvirt] cpu_mode = custom cpu_models = Haswell-noTSX-IBRS cpu_model_extra_flags = PCID, VMX, pdpe1gb
As it can be noticed from above, the
The possible values for
Note that when using this config attribute to set the PCID CPU flag with the
The libvirt driver’s default CPU mode, Related options:
|
| list value | An ordered list of CPU models the host supports.
It is expected that the list is ordered so that the more common and less advanced CPU models are listed earlier. Here is an example: Possible values:
Related options:
|
| list value | Specific cache modes to use for different disk types. For example: file=directsync,block=none,network=writeback For local or direct-attached storage, it is recommended that you use writethrough (default) mode, as it ensures data integrity and has acceptable I/O performance for applications running in the guest, especially for read operations. However, caching mode none is recommended for remote NFS storage, because direct I/O operations (O_DIRECT) perform better than synchronous I/O operations (with O_SYNC). Caching mode none effectively turns all guest I/O operations into direct I/O operations on the host, which is the NFS client in this environment. Possible cache modes:
|
| string value | Override the default disk prefix for the devices attached to an instance. If set, this is used to identify a free disk device name for a bus. Possible values:
Related options:
|
| list value |
This will allow you to specify a list of events to monitor low-level performance of guests, and collect related statsitics via the libvirt driver, which in turn uses the Linux kernel’s For example, to monitor the count of CPU cycles (total/elapsed) and the count of cache misses, enable them as follows:: [libvirt] enabled_perf_events = cpu_clock, cache_misses Possible values: A string list. The list of supported events can be found here: https://libvirt.org/formatdomain.html#elementsPerf.
Note that support for Intel CMT events ( |
| integer value | Available capacity in MiB for file-backed memory. Set to 0 to disable file-backed memory.
When enabled, instances will create memory files in the directory specified in When enabled, the value defined for this option is reported as the node memory capacity. Compute node system memory will be used as a cache for file-backed memory, via the kernel’s pagecache mechanism.
Related options:
|
| list value | List of guid targets and ranges.Syntax is guest-gid:host-gid:count. Maximum of 5 allowed. |
| string value | Discard option for nova managed disks. Requires:
|
| list value |
For qemu or KVM guests, set this option to specify a default machine type per host architecture. You can find a list of supported machine types in your environment by checking the output of the :command: |
`images_rbd_ceph_conf = ` | string value | Path to the ceph configuration file to use |
| string value | The RADOS pool in which rbd volumes are stored |
| string value | VM Images format. If default is specified, then use_cow_images flag is used instead of this one. Related options:
|
| string value | LVM Volume Group that is used for VM images, when you specify images_type=lvm Related options:
|
| boolean value | Allow the injection of an SSH key at boot time.
There is no agent needed within the image to do this. If libguestfs is available on the host, it will be used. Otherwise nbd is used. The file system of the image will be mounted and the SSH key, which is provided in the REST API call will be injected as SSH key for the root user and appended to the This config option will enable directly modifying the instance disk and does not affect what cloud-init may do using data from config_drive option or the metadata service. Linux distribution guest only. Related options:
|
| integer value | Determines the way how the file system is chosen to inject data into it. libguestfs will be used a first solution to inject data. If that’s not available on the host, the image will be locally mounted on the host as a fallback solution. If libguestfs is not able to determine the root partition (because there are more or less than one root partition) or cannot mount the file system it will result in an error and the instance won’t be boot. Possible values:
Linux distribution guest only. Related options:
|
| boolean value |
Allow the injection of an admin password for instance only at There is no agent needed within the image to do this. If libguestfs is available on the host, it will be used. Otherwise nbd is used. The file system of the image will be mounted and the admin password, which is provided in the REST API call will be injected as password for the root user. If no root user is available, the instance won’t be launched and an error is thrown. Be aware that the injection is not possible when the instance gets launched from a volume. Linux distribution guest only. Possible values:
Related options:
|
| string value | The iSCSI transport iface to use to connect to target in case offload support is desired. Default format is of the form <transport_name>.<hwaddress> where <transport_name> is one of (be2iscsi, bnx2i, cxgb3i, cxgb4i, qla4xxx, ocs) and <hwaddress> is the MAC address of the interface and can be generated via the iscsiadm -m iface command. Do not confuse the iscsi_iface parameter to be provided here with the actual transport name. |
| boolean value | Use multipath connection of the iSER volume. iSER volumes can be connected as multipath devices. This will provide high availability and fault tolerance. |
| integer value | Maximum bandwidth(in MiB/s) to be used during migration. If set to 0, the hypervisor will choose a suitable default. Some hypervisors do not support this feature and will return an error if bandwidth is not 0. Please refer to the libvirt documentation for further details. |
| integer value | Time to wait, in seconds, for migration to successfully complete transferring data before aborting the operation. Value is per GiB of guest RAM + disk to be transferred, with lower bound of a minimum of 2 GiB. Should usually be larger than downtime delay * downtime steps. Set to 0 to disable timeouts. Related options:
|
| integer value | Maximum permitted downtime, in milliseconds, for live migration switchover. Will be rounded up to a minimum of 100ms. You can increase this value if you want to allow live-migrations to complete faster, or avoid live-migration timeout errors by allowing the guest to be paused for longer during the live-migration switch over. Related options:
|
| integer value | Time to wait, in seconds, between each step increase of the migration downtime. Minimum delay is 3 seconds. Value is per GiB of guest RAM + disk to be transferred, with lower bound of a minimum of 2 GiB per device. |
| integer value | Number of incremental steps to reach max downtime value. Will be rounded up to a minimum of 3 steps. |
| host address value | Target used for live migration traffic. If this option is set to None, the hostname of the migration target compute node will be used. This option is useful in environments where the live-migration traffic can impact the network plane significantly. A separate network for live-migration traffic can then use this config option and avoids the impact on the management network. Related options:
|
| boolean value | This option allows nova to start live migration with auto converge on. Auto converge throttles down CPU if a progress of on-going live migration is slow. Auto converge will only be used if this flag is set to True and post copy is not permitted or post copy is unavailable due to the version of libvirt and QEMU in use. Related options:
|
| boolean value | This option allows nova to switch an on-going live migration to post-copy mode, i.e., switch the active VM to the one on the destination node before the migration is complete, therefore ensuring an upper bound on the memory that needs to be transferred. Post-copy requires libvirt>=1.3.3 and QEMU>=2.5.0.
When permitted, post-copy mode will be automatically activated if we reach the timeout defined by The live-migration force complete API also uses post-copy when permitted. If post-copy mode is not available, force complete falls back to pausing the VM to ensure the live-migration operation will complete. When using post-copy mode, if the source and destination hosts lose network connectivity, the VM being live-migrated will need to be rebooted. For more details, please see the Administration guide. Related options:
|
| string value | URI scheme used for live migration. Override the default libvirt live migration scheme (which is dependent on virt_type). If this option is set to None, nova will automatically choose a sensible default based on the hypervisor. It is not recommended that you change this unless you are very sure that hypervisor supports a particular scheme. Related options:
|
| string value |
This option will be used to determine what action will be taken against a VM after Related options:
|
| boolean value | Enable tunnelled migration. This option enables the tunnelled migration feature, where migration data is transported over the libvirtd connection. If enabled, we use the VIR_MIGRATE_TUNNELLED migration flag, avoiding the need to configure the network to allow direct hypervisor to hypervisor communication. If False, use the native transport. If not set, Nova will choose a sensible default based on, for example the availability of native encryption support in the hypervisor. Enabling this option will definitely impact performance massively. Note that this option is NOT compatible with use of block migration. Related options:
|
| string value | (DEPRECATED FOR REMOVAL) Live migration target URI to use. Override the default libvirt live migration target URI (which is dependent on virt_type). Any included "%s" is replaced with the migration target hostname.
If this option is set to None (which is the default), Nova will automatically generate the
Related options:
|
| boolean value | Use QEMU-native TLS encryption when live migrating. This option will allow both migration stream (guest RAM plus device state) and disk stream to be transported over native TLS, i.e. TLS support built into QEMU. Prerequisite: TLS environment is configured correctly on all relevant Compute nodes. This means, Certificate Authority (CA), server, client certificates, their corresponding keys, and their file permisssions are in place, and are validated. Notes:
Related options:
|
| integer value | A number of seconds to memory usage statistics period. Zero or negative value mean to disable memory usage statistics. |
| string value | Mount options passed to the NFS client. See section of the nfs man page for details. Mount options controls the way the filesystem is mounted and how the NFS client behaves when accessing files on this mount point. Possible values:
|
| string value | Directory where the NFS volume is mounted on the compute node. The default is mnt directory of the location where nova’s Python module is installed. NFS provides shared storage for the OpenStack Block Storage service. Possible values:
|
| integer value | Number of times to rediscover AoE target to find volume. Nova provides support for block storage attaching to hosts via AOE (ATA over Ethernet). This option allows the user to specify the maximum number of retry attempts that can be made to discover the AoE device. |
| integer value | Number of times to scan iSER target to find volume. iSER is a server network protocol that extends iSCSI protocol to use Remote Direct Memory Access (RDMA). This option allows the user to specify the maximum number of scan attempts that can be made to find iSER volume. |
| integer value | Maximum number of guests with encrypted memory which can run concurrently on this compute host. For now this is only relevant for AMD machines which support SEV (Secure Encrypted Virtualization). Such machines have a limited number of slots in their memory controller for storing encryption keys. Each running guest with encrypted memory will consume one of these slots. The option may be reused for other equivalent technologies in the future. If the machine does not support memory encryption, the option will be ignored and inventory will be set to 0.
If the machine does support memory encryption, for now a value of
Related options:
|
| integer value | Number of times to rediscover NVMe target to find volume Nova provides support for block storage attaching to hosts via NVMe (Non-Volatile Memory Express). This option allows the user to specify the maximum number of retry attempts that can be made to discover the NVMe device. |
| integer value | The number of PCIe ports an instance will get. Libvirt allows a custom number of PCIe ports (pcie-root-port controllers) a target instance will get. Some will be used by default, rest will be available for hotplug use. By default we have just 1-2 free ports which limits hotplug. More info: https://github.com/qemu/qemu/blob/master/docs/pcie.txt Due to QEMU limitations for aarch64/virt maximum value is set to 28. Default value 0 moves calculating amount of ports to libvirt. |
| integer value | Number of times to scan given storage protocol to find volume. |
| list value | Configure persistent memory(pmem) namespaces. These namespaces must have been already created on the host. This config option is in the following format:: "$LABEL:$NSNAME[|$NSNAME][,$LABEL:$NSNAME[|$NSNAME]]"
|
| string value | Path to a Quobyte Client configuration file. |
| string value | Directory where the Quobyte volume is mounted on the compute node. Nova supports Quobyte volume driver that enables storing Block Storage service volumes on a Quobyte storage back end. This Option specifies the path of the directory where Quobyte volume is mounted. Possible values:
|
| integer value | The RADOS client timeout in seconds when initially connecting to the cluster. |
| string value | The libvirt UUID of the secret for the rbd_user volumes. |
| string value | The RADOS client name for accessing rbd(RADOS Block Devices) volumes. Libvirt will refer to this user when connecting and authenticating with the Ceph RBD server. |
| integer value | In a realtime host context vCPUs for guest will run in that scheduling priority. Priority depends on the host kernel (usually 1-99) |
| string value | libvirt’s transport method for remote file operations. Because libvirt cannot use RPC to copy files over network to/from other compute nodes, other method must be used for:
|
| integer value | Unused resized base images younger than this will not be removed |
| string value | The ID of the image to boot from to rescue data from a corrupted instance. If the rescue REST API operation doesn’t provide an ID of an image to use, the image which is referenced by this ID is used. If this option is not set, the image from the instance is used. Possible values:
Related options:
|
| string value | The ID of the kernel (AKI) image to use with the rescue image. If the chosen rescue image allows the separate definition of its kernel disk, the value of this option is used, if specified. This is the case when Amazon's AMI/AKI/ARI image format is used for the rescue image. Possible values:
Related options:
|
| string value | The ID of the RAM disk (ARI) image to use with the rescue image. If the chosen rescue image allows the separate definition of its RAM disk, the value of this option is used, if specified. This is the case when Amazon's AMI/AKI/ARI image format is used for the rescue image. Possible values:
Related options:
|
| string value |
The path to an RNG (Random Number Generator) device that will be used as the source of entropy on the host. Since libvirt 1.3.4, any path (that returns random numbers when read) is accepted. The recommended source of entropy is |
| integer value | Configure virtio rx queue size. This option is only usable for virtio-net device with vhost and vhost-user backend. Available only with QEMU/KVM. Requires libvirt v2.3 QEMU v2.7. |
`smbfs_mount_options = ` | string value | Mount options passed to the SMBFS client.
Provide SMBFS options as a single string containing all parameters. See mount.cifs man page for details. Note that the libvirt-qemu |
| string value | Directory where the SMBFS shares are mounted on the compute node. |
| boolean value |
Enable snapshot compression for
Note: you can set Related options:
|
| string value | Determine the snapshot image format when sending to the image service. If set, this decides what format is used when sending the snapshot to the image service. If not set, defaults to same type as source image. |
| string value | Location where libvirt driver will store snapshots before uploading them to image service |
| boolean value | (DEPRECATED FOR REMOVAL) Create sparse logical volumes (with virtualsize) if this flag is set to True. |
| string value |
The data source used to the populate the host "serial" UUID exposed to guest in the virtual BIOS. All choices except |
| integer value | Configure virtio tx queue size. This option is only usable for virtio-net device with vhost-user backend. Available only with QEMU/KVM. Requires libvirt v3.7 QEMU v2.10. |
| list value | List of uid targets and ranges.Syntax is guest-uid:host-uid:count. Maximum of 5 allowed. |
| boolean value | (DEPRECATED FOR REMOVAL) Enable a mouse cursor within a graphical VNC or SPICE sessions. This will only be taken into account if the VM is fully virtualized and VNC and/or SPICE is enabled. If the node doesn’t support a graphical framebuffer, then it is valid to set this to False. Related options:
|
| boolean value | Use virtio for bridge interfaces with KVM/QEMU |
| string value | Describes the virtualization type (or so called domain type) libvirt should use. The choice of this type must match the underlying virtualization strategy you have chosen for this host. Related options:
|
| string value | Method used to wipe ephemeral disks when they are deleted. Only takes effect if LVM is set as backing storage. Related options:
|
| integer value |
Size of area in MiB, counting from the beginning of the allocated volume, that will be cleared using method set in Possible values:
Related options:
|
| boolean value | Use multipath connection of the iSCSI or FC volume Volumes can be connected in the LibVirt as multipath devices. This will provide high availability and fault tolerance. |
| string value | Path to the SSD cache file. You can attach an SSD drive to a client and configure the drive to store a local cache of frequently accessed data. By having a local cache on a client’s SSD drive, you can increase the overall cluster performance by up to 10 and more times. WARNING! There is a lot of SSD models which are not server grade and may loose arbitrary set of data changes on power loss. Such SSDs should not be used in Vstorage and are dangerous as may lead to data corruptions and inconsistencies. Please consult with the manual on which SSD models are known to be safe or verify it using vstorage-hwflush-check(1) utility. This option defines the path which should include "%(cluster_name)s" template to separate caches from multiple shares. Related options:
|
| string value | Path to vzstorage client log. This option defines the log of cluster operations, it should include "%(cluster_name)s" template to separate logs from multiple shares. Related options:
|
| string value | Mount owner group name. This option defines the owner group of Vzstorage cluster mountpoint. Related options:
|
| list value | Extra mount options for pstorage-mount For full description of them, see https://static.openvz.org/vz-man/man1/pstorage-mount.1.gz.html Format is a python string representation of arguments list, like: "[-v, -R, 500]" Shouldn’t include -c, -l, -C, -u, -g and -m as those have explicit vzstorage_* options. Related options:
|
| string value | Mount access mode. This option defines the access bits of Vzstorage cluster mountpoint, in the format similar to one of chmod(1) utility, like this: 0770. It consists of one to four digits ranging from 0 to 7, with missing lead digits assumed to be 0’s. Related options:
|
| string value | Directory where the Virtuozzo Storage clusters are mounted on the compute node. This option defines non-standard mountpoint for Vzstorage cluster. Related options:
|
| string value | Mount owner user name. This option defines the owner user of Vzstorage cluster mountpoint. Related options:
|
| integer value | Number of seconds to wait for instance to shut down after soft reboot request is made. We fall back to hard reboot if instance does not shutdown within this window. |
| string value | Location where the Xen hvmloader is kept |
9.1.25. metrics
The following table outlines the options available under the [metrics]
group in the /etc/nova/nova.conf
file.
Table 9.24. metrics
Configuration option = Default value | Type | Description |
---|---|---|
| boolean value | This setting determines how any unavailable metrics are treated. If this option is set to True, any hosts for which a metric is unavailable will raise an exception, so it is recommended to also use the MetricFilter to filter out those hosts before weighing. This option is only used by the FilterScheduler and its subclasses; if you use a different scheduler, this option has no effect. Possible values:
Related options:
|
| floating point value | When using metrics to weight the suitability of a host, you can use this option to change how the calculated weight influences the weight assigned to a host as follows:
This option is only used by the FilterScheduler and its subclasses; if you use a different scheduler, this option has no effect. Possible values:
Related options:
|
| floating point value | When any of the following conditions are met, this value will be used in place of any actual metric value:
This option is only used by the FilterScheduler and its subclasses; if you use a different scheduler, this option has no effect. Possible values:
Related options:
|
| list value | This setting specifies the metrics to be weighed and the relative ratios for each metric. This should be a single string value, consisting of a series of one or more name=ratio pairs, separated by commas, where name is the name of the metric to be weighed, and ratio is the relative weight for that metric. Note that if the ratio is set to 0, the metric value is ignored, and instead the weight will be set to the value of the weight_of_unavailable option. As an example, let’s consider the case where this option is set to: `name1=1.0, name2=-1.3` The final weight will be: `(name1.value * 1.0) + (name2.value * -1.3)` This option is only used by the FilterScheduler and its subclasses; if you use a different scheduler, this option has no effect. Possible values:
Related options:
|
9.1.26. mks
The following table outlines the options available under the [mks]
group in the /etc/nova/nova.conf
file.
Table 9.25. mks
Configuration option = Default value | Type | Description |
---|---|---|
| boolean value | Enables graphical console access for virtual machines. |
| uri value | Location of MKS web console proxy The URL in the response points to a WebMKS proxy which starts proxying between client and corresponding vCenter server where instance runs. In order to use the web based console access, WebMKS proxy should be installed and configured Possible values:
|
9.1.27. neutron
The following table outlines the options available under the [neutron]
group in the /etc/nova/nova.conf
file.
Table 9.26. neutron
Configuration option = Default value | Type | Description |
---|---|---|
| string value | Authentication URL |
| string value | Config Section from which to load plugin specific options |
| string value | Authentication type to load |
| string value | PEM encoded Certificate Authority to use when verifying HTTPs connections. |
| string value | PEM encoded client certificate cert file |
| boolean value | Collect per-API call timing information. |
| integer value | The maximum number of retries that should be attempted for connection errors. |
| floating point value | Delay (in seconds) between two retries for connection errors. If not set, exponential retry starting with 0.5 seconds up to a maximum of 60 seconds is used. |
| string value | Optional domain ID to use with v3 and v2 parameters. It will be used for both the user and project domain in v3 and ignored in v2 authentication. |
| string value | Optional domain name to use with v3 API and v2 parameters. It will be used for both the user and project domain in v3 and ignored in v2 authentication. |
| string value | Default name for the floating IP pool. Specifies the name of floating IP pool used for allocating floating IPs. This option is only used if Neutron does not specify the floating IP pool name in port binding reponses. |
| string value | Domain ID to scope to |
| string value | Domain name to scope to |
| string value |
Always use this endpoint URL for requests for this client. NOTE: The unversioned endpoint should be specified here; to request a particular API version, use the |
| integer value | Integer value representing the number of seconds to wait before querying Neutron for extensions. After this number of seconds the next time Nova needs to create a resource in Neutron it will requery Neutron for the extensions that it has loaded. Setting value to 0 will refresh the extensions with no wait. |
| integer value | Number of times neutronclient should retry on any failed http call. 0 means connection is attempted only once. Setting it to any positive integer means that on failure connection is retried that many times e.g. setting it to 3 means total attempts to connect will be 4. Possible values:
|
| boolean value | Verify HTTPS connections. |
| string value | PEM encoded client certificate key file |
`metadata_proxy_shared_secret = ` | string value | This option holds the shared secret string used to validate proxy requests to Neutron metadata requests. In order to be used, the X-Metadata-Provider-Signature header must be supplied in the request. Related options:
|
| string value | Default name for the Open vSwitch integration bridge. Specifies the name of an integration bridge interface used by OpenvSwitch. This option is only used if Neutron does not specify the OVS bridge name in port binding responses. |
| string value | User’s password |
| list value | List of physnets present on this host.
For each physnet listed, an additional section, [neutron] physnets = foo, bar [neutron_physnet_foo] numa_nodes = 0 [neutron_physnet_bar] numa_nodes = 0,1 Any physnet that is not listed using this option will be treated as having no particular NUMA node affinity.
Tunnelled networks (VXLAN, GRE, …) cannot be accounted for in this way and are instead configured using the [neutron_tunnel] numa_nodes = 1 Related options:
|
| string value | Domain ID containing project |
| string value | Domain name containing project |
| string value | Project ID to scope to |
| string value | Project name to scope to |
| string value | The default region_name for endpoint URL discovery. |
| string value | The default service_name for endpoint URL discovery. |
| string value | The default service_type for endpoint URL discovery. |
| boolean value | When set to True, this option indicates that Neutron will be used to proxy metadata requests and resolve instance ids. Otherwise, the instance ID must be passed to the metadata request in the X-Instance-ID header. Related options:
|
| boolean value | Log requests to multiple loggers. |
| integer value | The maximum number of retries that should be attempted for retriable HTTP status codes. |
| floating point value | Delay (in seconds) between two retries for retriable status codes. If not set, exponential retry starting with 0.5 seconds up to a maximum of 60 seconds is used. |
| string value | Scope for system operations |
| string value | Tenant ID |
| string value | Tenant Name |
| integer value | Timeout value for http requests |
| string value | Trust ID |
| string value | User’s domain id |
| string value | User’s domain name |
| string value | User ID |
| string value | Username |
| list value | List of interfaces, in order of preference, for endpoint URL. |
9.1.28. notifications
The following table outlines the options available under the [notifications]
group in the /etc/nova/nova.conf
file.
Table 9.27. notifications
Configuration option = Default value | Type | Description |
---|---|---|
| boolean value | If enabled, include block device information in the versioned notification payload. Sending block device information is disabled by default as providing that information can incur some overhead on the system since the information may need to be loaded from the database. |
| string value | Default notification level for outgoing notifications. |
| string value | Specifies which notification format shall be emitted by nova. The versioned notification interface are in feature parity with the legacy interface and the versioned interface is actively developed so new consumers should used the versioned interface. However, the legacy interface is heavily used by ceilometer and other mature OpenStack components so it remains the default.
Note that notifications can be completely disabled by setting The list of versioned notifications is visible in https://docs.openstack.org/nova/latest/reference/notifications.html |
| string value | If set, send compute.instance.update notifications on instance state changes. Please refer to https://docs.openstack.org/nova/latest/reference/notifications.html for additional information on notifications. |
| list value | Specifies the topics for the versioned notifications issued by nova. The default value is fine for most deployments and rarely needs to be changed. However, if you have a third-party service that consumes versioned notifications, it might be worth getting a topic for that service. Nova will send a message containing a versioned notification payload to each topic queue in this list. The list of versioned notifications is visible in https://docs.openstack.org/nova/latest/reference/notifications.html |
9.1.29. osapi_v21
The following table outlines the options available under the [osapi_v21]
group in the /etc/nova/nova.conf
file.
Table 9.28. osapi_v21
Configuration option = Default value | Type | Description |
---|---|---|
| string value | (DEPRECATED FOR REMOVAL) This option is a string representing a regular expression (regex) that matches the project_id as contained in URLs. If not set, it will match normal UUIDs created by keystone. Possible values:
|
9.1.30. oslo_concurrency
The following table outlines the options available under the [oslo_concurrency]
group in the /etc/nova/nova.conf
file.
Table 9.29. oslo_concurrency
Configuration option = Default value | Type | Description |
---|---|---|
| boolean value | Enables or disables inter-process locks. |
| string value | 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. |
9.1.31. oslo_messaging_amqp
The following table outlines the options available under the [oslo_messaging_amqp]
group in the /etc/nova/nova.conf
file.
Table 9.30. oslo_messaging_amqp
Configuration option = Default value | Type | Description |
---|---|---|
| string value | 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 |
| string value | 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. |
| string value | address prefix used when broadcasting to all servers |
| integer value | Increase the connection_retry_interval by this many seconds after each unsuccessful failover attempt. |
| integer value | Seconds to pause before attempting to re-connect. |
| integer value | Maximum limit for connection_retry_interval + connection_retry_backoff |
| string value | Name for the AMQP container. must be globally unique. Defaults to a generated UUID |
| string value | 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 |
| integer value | The deadline for a sent notification message delivery. Only used when caller does not provide a timeout expiry. |
| integer value | The maximum number of attempts to re-send a reply message which failed due to a recoverable error. |
| integer value | The deadline for an rpc reply message delivery. |
| string value | 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 |
| integer value | The deadline for an rpc cast or call message delivery. Only used when caller does not provide a timeout expiry. |
| integer value | The duration to schedule a purge of idle sender links. Detach link after expiry. |
| string value | address prefix when sending to any server in group |
| integer value | Timeout for inactive connections (in seconds) |
| integer value | Time to pause between re-connecting an AMQP 1.0 link that failed due to a recoverable error. |
| string value | Appended to the address prefix when sending a fanout message. Used by the message bus to identify fanout messages. |
| string value | Address prefix for all generated Notification addresses |
| integer value | Window size for incoming Notification messages |
| multi valued | Send messages of this type pre-settled. Pre-settled messages will not receive acknowledgement from the peer. Note well: pre-settled messages may be silently discarded if the delivery fails. Permitted values: rpc-call - send RPC Calls pre-settled rpc-reply- send RPC Replies pre-settled rpc-cast - Send RPC Casts pre-settled notify - Send Notifications pre-settled |
| boolean value | Enable virtual host support for those message buses that do not natively support virtual hosting (such as qpidd). When set to true the virtual host name will be added to all message bus addresses, effectively creating a private subnet per virtual host. Set to False if the message bus supports virtual hosting using the hostname field in the AMQP 1.0 Open performative as the name of the virtual host. |
| integer value | Window size for incoming RPC Reply messages. |
| string value | Address prefix for all generated RPC addresses |
| integer value | Window size for incoming RPC Request messages |
`sasl_config_dir = ` | string value | Path to directory that contains the SASL configuration |
`sasl_config_name = ` | string value | Name of configuration file (without .conf suffix) |
`sasl_default_realm = ` | string value | SASL realm to use if no realm present in username |
`sasl_mechanisms = ` | string value | Space separated list of acceptable SASL mechanisms |
| string value | address prefix used when sending to a specific server |
| boolean value | Attempt to connect via SSL. If no other ssl-related parameters are given, it will use the system’s CA-bundle to verify the server’s certificate. |
`ssl_ca_file = ` | string value | CA certificate PEM file used to verify the server’s certificate |
`ssl_cert_file = ` | string value | Self-identifying certificate PEM file for client authentication |
`ssl_key_file = ` | string value | Private key PEM file used to sign ssl_cert_file certificate (optional) |
| string value | Password for decrypting ssl_key_file (if encrypted) |
| boolean value | By default SSL checks that the name in the server’s certificate matches the hostname in the transport_url. In some configurations it may be preferable to use the virtual hostname instead, for example if the server uses the Server Name Indication TLS extension (rfc6066) to provide a certificate per virtual host. Set ssl_verify_vhost to True if the server’s SSL certificate uses the virtual host name instead of the DNS name. |
| boolean value | Debug: dump AMQP frames to stdout |
| string value | 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. |
9.1.32. oslo_messaging_kafka
The following table outlines the options available under the [oslo_messaging_kafka]
group in the /etc/nova/nova.conf
file.
Table 9.31. oslo_messaging_kafka
Configuration option = Default value | Type | Description |
---|---|---|
| string value | The compression codec for all data generated by the producer. If not set, compression will not be used. Note that the allowed values of this depend on the kafka version |
| integer value | (DEPRECATED FOR REMOVAL) The pool size limit for connections expiration policy |
| integer value | (DEPRECATED FOR REMOVAL) The time-to-live in sec of idle connections in the pool |
| string value | Group id for Kafka consumer. Consumers in one group will coordinate message consumption |
| boolean value | Enable asynchronous consumer commits |
| floating point value | Default timeout(s) for Kafka consumers |
| integer value | Max fetch bytes of Kafka consumer |
| integer value | The maximum number of records returned in a poll call |
| integer value | (DEPRECATED FOR REMOVAL) Pool Size for Kafka Consumers |
| integer value | Size of batch for the producer async send |
| floating point value | Upper bound on the delay for KafkaProducer batching in seconds |
| string value | Mechanism when security protocol is SASL |
| string value | Protocol used to communicate with brokers |
`ssl_cafile = ` | string value | CA certificate PEM file used to verify the server certificate |
9.1.33. oslo_messaging_notifications
The following table outlines the options available under the [oslo_messaging_notifications]
group in the /etc/nova/nova.conf
file.
Table 9.32. oslo_messaging_notifications
Configuration option = Default value | Type | Description |
---|---|---|
| multi valued | The Drivers(s) to handle sending notifications. Possible values are messaging, messagingv2, routing, log, test, noop |
| integer value | The maximum number of attempts to re-send a notification message which failed to be delivered due to a recoverable error. 0 - No retry, -1 - indefinite |
| list value | AMQP topic used for OpenStack notifications. |
| string value | A URL representing the messaging driver to use for notifications. If not set, we fall back to the same configuration used for RPC. |
9.1.34. oslo_messaging_rabbit
The following table outlines the options available under the [oslo_messaging_rabbit]
group in the /etc/nova/nova.conf
file.
Table 9.33. oslo_messaging_rabbit
Configuration option = Default value | Type | Description |
---|---|---|
| boolean value | Auto-delete queues in AMQP. |
| boolean value | Use durable queues in AMQP. |
| integer value | Enable/Disable the RabbitMQ mandatory flag for direct send. The direct send is used as reply,so the MessageUndeliverable exception is raised in case the client queue does not exist. |
| boolean value | EXPERIMENTAL: Run the health check heartbeat threadthrough a native python thread. By default if thisoption isn’t provided the health check heartbeat willinherit the execution model from the parent process. Byexample if the parent process have monkey patched thestdlib by using eventlet/greenlet then the heartbeatwill be run through a green thread. |
| integer value | How often times during the heartbeat_timeout_threshold we check the heartbeat. |
| integer value | Number of seconds after which the Rabbit broker is considered down if heartbeat’s keep-alive fails (0 disables heartbeat). |
| string value | EXPERIMENTAL: Possible values are: gzip, bz2. If not set compression will not be used. This option may not be available in future versions. |
| string value | 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. |
| integer value | How long to wait a missing client before abandoning to send it its replies. This value should not be longer than rpc_response_timeout. |
| floating point value | How long to wait before reconnecting in response to an AMQP consumer cancel notification. |
| boolean value | 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"} " |
| integer value | Maximum interval of RabbitMQ connection retries. Default is 30 seconds. |
| string value | The RabbitMQ login method. |
| integer value | Specifies the number of messages to prefetch. Setting to zero allows unlimited messages. |
| integer value | How long to backoff for between retries when connecting to RabbitMQ. |
| integer value | How frequently to retry connecting with RabbitMQ. |
| integer value | 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. |
| boolean value | Connect over SSL. |
`ssl_ca_file = ` | string value | SSL certification authority file (valid only if SSL enabled). |
`ssl_cert_file = ` | string value | SSL cert file (valid only if SSL enabled). |
`ssl_key_file = ` | string value | SSL key file (valid only if SSL enabled). |
`ssl_version = ` | string value | 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. |
9.1.35. oslo_middleware
The following table outlines the options available under the [oslo_middleware]
group in the /etc/nova/nova.conf
file.
Table 9.34. oslo_middleware
Configuration option = Default value | Type | Description |
---|---|---|
| boolean value | Whether the application is behind a proxy or not. This determines if the middleware should parse the headers or not. |
| integer value | The maximum body size for each request, in bytes. |
| string value | (DEPRECATED FOR REMOVAL) 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. |
9.1.36. oslo_policy
The following table outlines the options available under the [oslo_policy]
group in the /etc/nova/nova.conf
file.
Table 9.35. oslo_policy
Configuration option = Default value | Type | Description |
---|---|---|
| boolean value |
This option controls whether or not to enforce scope when evaluating policies. If |
| string value | Default rule. Enforced when a requested rule is not found. |
| multi valued | 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. |
| string value | The relative or absolute path of a file that maps roles to permissions for a given service. Relative paths must be specified in relation to the configuration file setting this option. |
| string value | Content Type to send and receive data for REST based policy check |
| string value | Absolute path to ca cert file for REST based policy check |
| string value | Absolute path to client cert for REST based policy check |
| string value | Absolute path client key file REST based policy check |
| boolean value | server identity verification for REST based policy check |
9.1.37. pci
The following table outlines the options available under the [pci]
group in the /etc/nova/nova.conf
file.
Table 9.36. pci
Configuration option = Default value | Type | Description |
---|---|---|
| multi valued | An alias for a PCI passthrough device requirement. This allows users to specify the alias in the extra specs for a flavor, without needing to repeat all the PCI property requirements.
This should be configured for the Possible Values:
|
| multi valued | White list of PCI devices available to VMs. Possible values:
|
9.1.38. placement
The following table outlines the options available under the [placement]
group in the /etc/nova/nova.conf
file.
Table 9.37. placement
Configuration option = Default value | Type | Description |
---|---|---|
| string value | Authentication URL |
| string value | Config Section from which to load plugin specific options |
| string value | Authentication type to load |
| string value | PEM encoded Certificate Authority to use when verifying HTTPs connections. |
| string value | PEM encoded client certificate cert file |
| boolean value | Collect per-API call timing information. |
| integer value | The maximum number of retries that should be attempted for connection errors. |
| floating point value | Delay (in seconds) between two retries for connection errors. If not set, exponential retry starting with 0.5 seconds up to a maximum of 60 seconds is used. |
| string value | Optional domain ID to use with v3 and v2 parameters. It will be used for both the user and project domain in v3 and ignored in v2 authentication. |
| string value | Optional domain name to use with v3 API and v2 parameters. It will be used for both the user and project domain in v3 and ignored in v2 authentication. |
| string value | Domain ID to scope to |
| string value | Domain name to scope to |
| string value |
Always use this endpoint URL for requests for this client. NOTE: The unversioned endpoint should be specified here; to request a particular API version, use the |
| boolean value | Verify HTTPS connections. |
| string value | PEM encoded client certificate key file |
| string value | User’s password |
| string value | Domain ID containing project |
| string value | Domain name containing project |
| string value | Project ID to scope to |
| string value | Project name to scope to |
| string value | The default region_name for endpoint URL discovery. |
| string value | The default service_name for endpoint URL discovery. |
| string value | The default service_type for endpoint URL discovery. |
| boolean value | Log requests to multiple loggers. |
| integer value | The maximum number of retries that should be attempted for retriable HTTP status codes. |
| floating point value | Delay (in seconds) between two retries for retriable status codes. If not set, exponential retry starting with 0.5 seconds up to a maximum of 60 seconds is used. |
| string value | Scope for system operations |
| string value | Tenant ID |
| string value | Tenant Name |
| integer value | Timeout value for http requests |
| string value | Trust ID |
| string value | User’s domain id |
| string value | User’s domain name |
| string value | User ID |
| string value | Username |
| list value | List of interfaces, in order of preference, for endpoint URL. |
9.1.39. powervm
The following table outlines the options available under the [powervm]
group in the /etc/nova/nova.conf
file.
Table 9.38. powervm
Configuration option = Default value | Type | Description |
---|---|---|
| string value | The disk driver to use for PowerVM disks. PowerVM provides support for localdisk and PowerVM Shared Storage Pool disk drivers. Related options:
|
| floating point value | Factor used to calculate the amount of physical processor compute power given to each vCPU. E.g. A value of 1.0 means a whole physical processor, whereas 0.05 means 1/20th of a physical processor. |
`volume_group_name = ` | string value | Volume Group to use for block device operations. If disk_driver is localdisk, then this attribute must be specified. It is strongly recommended NOT to use rootvg since that is used by the management partition and filling it will cause failures. |
9.1.40. privsep
The following table outlines the options available under the [privsep]
group in the /etc/nova/nova.conf
file.
Table 9.39. privsep
Configuration option = Default value | Type | Description |
---|---|---|
| list value | List of Linux capabilities retained by the privsep daemon. |
| string value | Group that the privsep daemon should run as. |
| string value | Command to invoke to start the privsep daemon if not using the "fork" method. If not specified, a default is generated using "sudo privsep-helper" and arguments designed to recreate the current configuration. This command must accept suitable --privsep_context and --privsep_sock_path arguments. |
| integer value | The number of threads available for privsep to concurrently run processes. Defaults to the number of CPU cores in the system. |
| string value | User that the privsep daemon should run as. |
9.1.41. profiler
The following table outlines the options available under the [profiler]
group in the /etc/nova/nova.conf
file.
Table 9.40. profiler
Configuration option = Default value | Type | Description |
---|---|---|
| string value | Connection string for a notifier backend.
Default value is Examples of possible values:
|
| boolean value | Enable the profiling for all services on this node. Default value is False (fully disable the profiling feature). Possible values:
|
| string value | Document type for notification indexing in elasticsearch. |
| integer value | Elasticsearch splits large requests in batches. This parameter defines maximum size of each batch (for example: es_scroll_size=10000). |
| string value | 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. |
| boolean value | Enable filter traces that contain error/exception to a separated place. Default value is set to False. Possible values:
|
| string value | 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 value |
Redissentinel uses a service name to identify a master redis service. This parameter defines the name (for example: |
| floating point value | Redissentinel provides a timeout option on the connections. This parameter defines that timeout (for example: socket_timeout=0.1). |
| boolean value | Enable SQL requests profiling in services. Default value is False (SQL requests won’t be traced). Possible values:
|
9.1.42. quota
The following table outlines the options available under the [quota]
group in the /etc/nova/nova.conf
file.
Table 9.41. quota
Configuration option = Default value | Type | Description |
---|---|---|
| integer value | The number of instance cores or vCPUs allowed per project. Possible values:
|
| boolean value | Enable the counting of quota usage from the placement service. Starting in Train, it is possible to count quota usage for cores and ram from the placement service and instances from the API database instead of counting from cell databases. This works well if there is only one Nova deployment running per placement deployment. However, if an operator is running more than one Nova deployment sharing a placement deployment, they should not set this option to True because currently the placement service has no way to partition resource providers per Nova deployment. When this option is left as the default or set to False, Nova will use the legacy counting method to count quota usage for instances, cores, and ram from its cell databases. Note that quota usage behavior related to resizes will be affected if this option is set to True. Placement resource allocations are claimed on the destination while holding allocations on the source during a resize, until the resize is confirmed or reverted. During this time, when the server is in VERIFY_RESIZE state, quota usage will reflect resource consumption on both the source and the destination. This can be beneficial as it reserves space for a revert of a downsize, but it also means quota usage will be inflated until a resize is confirmed or reverted. Behavior will also be different for unscheduled servers in ERROR state. A server in ERROR state that has never been scheduled to a compute host will not have placement allocations, so it will not consume quota usage for cores and ram. Behavior will be different for servers in SHELVED_OFFLOADED state. A server in SHELVED_OFFLOADED state will not have placement allocations, so it will not consume quota usage for cores and ram. Note that because of this, it will be possible for a request to unshelve a server to be rejected if the user does not have enough quota available to support the cores and ram needed by the server to be unshelved.
The |
| string value | Provides abstraction for quota checks. Users can configure a specific driver to use for quota checks. |
| integer value | (DEPRECATED FOR REMOVAL) The number of fixed IPs allowed per project. Unlike floating IPs, fixed IPs are allocated dynamically by the network component when instances boot up. This quota value should be at least the number of instances allowed Possible values:
|
| integer value | (DEPRECATED FOR REMOVAL) The number of floating IPs allowed per project. Floating IPs are not allocated to instances by default. Users need to select them from the pool configured by the OpenStack administrator to attach to their instances. Possible values:
|
| integer value | The number of bytes allowed per injected file. Possible values:
|
| integer value | The maximum allowed injected file path length. Possible values:
|
| integer value | The number of injected files allowed.
File injection allows users to customize the personality of an instance by injecting data into it upon boot. Only text file injection is permitted: binary or ZIP files are not accepted. During file injection, any existing files that match specified files are renamed to include Possible values:
|
| integer value | The number of instances allowed per project. Possible Values
|
| integer value | The maximum number of key pairs allowed per user. Users can create at least one key pair for each project and use the key pair for multiple instances that belong to that project. Possible values:
|
| integer value | The number of metadata items allowed per instance. Users can associate metadata with an instance during instance creation. This metadata takes the form of key-value pairs. Possible values:
|
| integer value | The number of megabytes of instance RAM allowed per project. Possible values:
|
| boolean value | Recheck quota after resource creation to prevent allowing quota to be exceeded. This defaults to True (recheck quota after resource creation) but can be set to False to avoid additional load if allowing quota to be exceeded because of racing requests is considered acceptable. For example, when set to False, if a user makes highly parallel REST API requests to create servers, it will be possible for them to create more servers than their allowed quota during the race. If their quota is 10 servers, they might be able to create 50 during the burst. After the burst, they will not be able to create any more servers but they will be able to keep their 50 servers until they delete them. The initial quota check is done before resources are created, so if multiple parallel requests arrive at the same time, all could pass the quota check and create resources, potentially exceeding quota. When recheck_quota is True, quota will be checked a second time after resources have been created and if the resource is over quota, it will be deleted and OverQuota will be raised, usually resulting in a 403 response to the REST API user. This makes it impossible for a user to exceed their quota with the caveat that it will, however, be possible for a REST API user to be rejected with a 403 response in the event of a collision close to reaching their quota limit, even if the user has enough quota available when they made the request. |
| integer value | (DEPRECATED FOR REMOVAL) The number of security rules per security group. The associated rules in each security group control the traffic to instances in the group. Possible values:
|
| integer value | (DEPRECATED FOR REMOVAL) The number of security groups per project. Possible values:
|
| integer value | The maximum number of servers per server group. Possible values:
|
| integer value | The maxiumum number of server groups per project. Server groups are used to control the affinity and anti-affinity scheduling policy for a group of servers or instances. Reducing the quota will not affect any existing group, but new servers will not be allowed into groups that have become over quota. Possible values:
|
9.1.43. rdp
The following table outlines the options available under the [rdp]
group in the /etc/nova/nova.conf
file.
Table 9.42. rdp
Configuration option = Default value | Type | Description |
---|---|---|
| boolean value | Enable Remote Desktop Protocol (RDP) related features. Hyper-V, unlike the majority of the hypervisors employed on Nova compute nodes, uses RDP instead of VNC and SPICE as a desktop sharing protocol to provide instance console access. This option enables RDP for graphical console access for virtual machines created by Hyper-V. Note: RDP should only be enabled on compute nodes that support the Hyper-V virtualization platform. Related options:
|
| uri value | The URL an end user would use to connect to the RDP HTML5 console proxy. The console proxy service is called with this token-embedded URL and establishes the connection to the proper instance. An RDP HTML5 console proxy service will need to be configured to listen on the address configured here. Typically the console proxy service would be run on a controller node. The localhost address used as default would only work in a single node environment i.e. devstack. An RDP HTML5 proxy allows a user to access via the web the text or graphical console of any Windows server or workstation using RDP. RDP HTML5 console proxy services include FreeRDP, wsgate. See https://github.com/FreeRDP/FreeRDP-WebConnect Possible values:
Related options:
|
9.1.44. remote_debug
The following table outlines the options available under the [remote_debug]
group in the /etc/nova/nova.conf
file.
Table 9.43. remote_debug
Configuration option = Default value | Type | Description |
---|---|---|
| host address value | Debug host (IP or name) to connect to. This command line parameter is used when you want to connect to a nova service via a debugger running on a different host. Note that using the remote debug option changes how Nova uses the eventlet library to support async IO. This could result in failures that do not occur under normal operation. Use at your own risk. Possible Values:
|
| port value | Debug port to connect to. This command line parameter allows you to specify the port you want to use to connect to a nova service via a debugger running on different host. Note that using the remote debug option changes how Nova uses the eventlet library to support async IO. This could result in failures that do not occur under normal operation. Use at your own risk. Possible Values:
|
9.1.45. scheduler
The following table outlines the options available under the [scheduler]
group in the /etc/nova/nova.conf
file.
Table 9.44. scheduler
Configuration option = Default value | Type | Description |
---|---|---|
| integer value | Periodic task interval. This value controls how often (in seconds) the scheduler should attempt to discover new hosts that have been added to cells. If negative (the default), no automatic discovery will occur. Deployments where compute nodes come and go frequently may want this enabled, where others may prefer to manually discover hosts when one is added to avoid any overhead from constantly checking. If enabled, every time this runs, we will select any unmapped hosts out of each cell database on every run. |
| string value | The class of the driver used by the scheduler. This should be chosen from one of the entrypoints under the namespace nova.scheduler.driver of file setup.cfg. If nothing is specified in this option, the filter_scheduler is used. Other options are:
Possible values:
Related options:
|
| boolean value |
This setting allows the scheduler to restrict hosts in aggregates based on matching required traits in the aggregate metadata and the instance flavor/image. If an aggregate is configured with a property with key |
| boolean value |
This setting causes the scheduler to look up a host aggregate with the metadata key of The matching aggregate UUID must be mirrored in placement for proper operation. If no host aggregate with the tenant id is found, or that aggregate does not match one in placement, the result will be the same as not finding any suitable hosts for the request. See also the placement_aggregate_required_for_tenants option. |
| integer value | This is the maximum number of attempts that will be made for a given instance build/move operation. It limits the number of alternate hosts returned by the scheduler. When that list of hosts is exhausted, a MaxRetriesExceeded exception is raised and the instance is set to an error state. Possible values:
|
| integer value | This setting determines the maximum limit on results received from the placement service during a scheduling operation. It effectively limits the number of hosts that may be considered for scheduling requests that match a large number of candidates. A value of 1 (the minimum) will effectively defer scheduling to the placement service strictly on "will it fit" grounds. A higher value will put an upper cap on the number of results the scheduler will consider during the filtering and weighing process. Large deployments may need to set this lower than the total number of hosts available to limit memory consumption, network traffic, etc. of the scheduler. This option is only used by the FilterScheduler; if you use a different scheduler, this option has no effect. |
| integer value | Periodic task interval. This value controls how often (in seconds) to run periodic tasks in the scheduler. The specific tasks that are run for each period are determined by the particular scheduler being used. Currently there are no in-tree scheduler driver that use this option. If this is larger than the nova-service service_down_time setting, the ComputeFilter (if enabled) may think the compute service is down. As each scheduler can work a little differently than the others, be sure to test this with your selected scheduler. Possible values:
Related options:
|
| boolean value | This setting, when limit_tenants_to_placement_aggregate=True, will control whether or not a tenant with no aggregate affinity will be allowed to schedule to any available node. If aggregates are used to limit some tenants but not all, then this should be False. If all tenants should be confined via aggregate, then this should be True to prevent them from receiving unrestricted scheduling to any available node. See also the limit_tenants_to_placement_aggregate option. |
| boolean value |
This setting causes the scheduler to look up a host aggregate with the metadata key of
The matching aggregate UUID must be mirrored in placement for proper operation. If no host aggregate with the Note that if you enable this flag, you can disable the (less efficient) AvailabilityZoneFilter in the scheduler. |
| boolean value |
This setting causes the scheduler to ask placement only for compute hosts that support the |
| integer value | Number of workers for the nova-scheduler service. The default will be the number of CPUs available if using the "filter_scheduler" scheduler driver, otherwise the default will be 1. |
9.1.46. serial_console
The following table outlines the options available under the [serial_console]
group in the /etc/nova/nova.conf
file.
Table 9.45. serial_console
Configuration option = Default value | Type | Description |
---|---|---|
| uri value |
The URL an end user would use to connect to the
The Related options:
|
| boolean value | Enable the serial console feature.
In order to use this feature, the service |
| string value | A range of TCP ports a guest can use for its backend. Each instance which gets created will use one port out of this range. If the range is not big enough to provide another port for an new instance, this instance won’t get launched. Possible values:
|
| string value |
The IP address to which proxy clients (like
This is typically the IP address of the host of a |
| string value |
The IP address which is used by the
The Related options:
|
| port value |
The port number which is used by the
The Related options:
|
9.1.47. service_user
The following table outlines the options available under the [service_user]
group in the /etc/nova/nova.conf
file.
Table 9.46. service_user
Configuration option = Default value | Type | Description |
---|---|---|
| string value | Authentication URL |
| string value | Config Section from which to load plugin specific options |
| string value | Authentication type to load |
| string value | PEM encoded Certificate Authority to use when verifying HTTPs connections. |
| string value | PEM encoded client certificate cert file |
| boolean value | Collect per-API call timing information. |
| string value | Optional domain ID to use with v3 and v2 parameters. It will be used for both the user and project domain in v3 and ignored in v2 authentication. |
| string value | Optional domain name to use with v3 API and v2 parameters. It will be used for both the user and project domain in v3 and ignored in v2 authentication. |
| string value | Domain ID to scope to |
| string value | Domain name to scope to |
| boolean value | Verify HTTPS connections. |
| string value | PEM encoded client certificate key file |
| string value | User’s password |
| string value | Domain ID containing project |
| string value | Domain name containing project |
| string value | Project ID to scope to |
| string value | Project name to scope to |
| boolean value | When True, if sending a user token to a REST API, also send a service token. Nova often reuses the user token provided to the nova-api to talk to other REST APIs, such as Cinder, Glance and Neutron. It is possible that while the user token was valid when the request was made to Nova, the token may expire before it reaches the other service. To avoid any failures, and to make it clear it is Nova calling the service on the user’s behalf, we include a service token along with the user token. Should the user’s token have expired, a valid service token ensures the REST API request will still be accepted by the keystone middleware. |
| boolean value | Log requests to multiple loggers. |
| string value | Scope for system operations |
| string value | Tenant ID |
| string value | Tenant Name |
| integer value | Timeout value for http requests |
| string value | Trust ID |
| string value | User’s domain id |
| string value | User’s domain name |
| string value | User ID |
| string value | Username |
9.1.48. spice
The following table outlines the options available under the [spice]
group in the /etc/nova/nova.conf
file.
Table 9.47. spice
Configuration option = Default value | Type | Description |
---|---|---|
| boolean value | Enable the SPICE guest agent support on the instances. The Spice agent works with the Spice protocol to offer a better guest console experience. However, the Spice console can still be used without the Spice Agent. With the Spice agent installed the following features are enabled:
|
| boolean value | Enable SPICE related features. Related options:
|
| uri value | Location of the SPICE HTML5 console proxy.
End user would use this URL to connect to the
In order to use SPICE console, the service Possible values:
Related options:
|
| host address value |
IP address or a hostname on which the Related options:
|
| port value |
Port on which the Related options:
|
| string value | (DEPRECATED FOR REMOVAL) A keyboard layout which is supported by the underlying hypervisor on this node. Possible values:
|
| string value | The address where the SPICE server running on the instances should listen.
Typically, the Possible values:
|
| string value |
The address used by
Typically, the Possible values:
Related options:
|
9.1.49. upgrade_levels
The following table outlines the options available under the [upgrade_levels]
group in the /etc/nova/nova.conf
file.
Table 9.48. upgrade_levels
Configuration option = Default value | Type | Description |
---|---|---|
| string value | Base API RPC API version cap. Possible values:
|
| string value | (DEPRECATED FOR REMOVAL) Cert RPC API version cap. Possible values:
|
| string value | Compute RPC API version cap. By default, we always send messages using the most recent version the client knows about. Where you have old and new compute services running, you should set this to the lowest deployed version. This is to guarantee that all services never send messages that one of the compute nodes can’t understand. Note that we only support upgrading from release N to release N+1. Set this option to "auto" if you want to let the compute RPC module automatically determine what version to use based on the service versions in the deployment. Possible values:
|
| string value | Conductor RPC API version cap. Possible values:
|
| string value | Console RPC API version cap. Possible values:
|
| string value | (DEPRECATED FOR REMOVAL) Network RPC API version cap. Possible values:
|
| string value | Scheduler RPC API version cap. Possible values:
|
9.1.50. vault
The following table outlines the options available under the [vault]
group in the /etc/nova/nova.conf
file.
Table 9.49. vault
Configuration option = Default value | Type | Description |
---|---|---|
| string value | AppRole role_id for authentication with vault |
| string value | AppRole secret_id for authentication with vault |
| string value | Mountpoint of KV store in Vault to use, for example: secret |
| string value | root token for vault |
| string value | Absolute path to ca cert file |
| boolean value | SSL Enabled/Disabled |
| string value | Use this endpoint to connect to Vault, for example: "http://127.0.0.1:8200" |
9.1.51. vendordata_dynamic_auth
The following table outlines the options available under the [vendordata_dynamic_auth]
group in the /etc/nova/nova.conf
file.
Table 9.50. vendordata_dynamic_auth
Configuration option = Default value | Type | Description |
---|---|---|
| string value | Authentication URL |
| string value | Config Section from which to load plugin specific options |
| string value | Authentication type to load |
| string value | PEM encoded Certificate Authority to use when verifying HTTPs connections. |
| string value | PEM encoded client certificate cert file |
| boolean value | Collect per-API call timing information. |
| string value | Optional domain ID to use with v3 and v2 parameters. It will be used for both the user and project domain in v3 and ignored in v2 authentication. |
| string value | Optional domain name to use with v3 API and v2 parameters. It will be used for both the user and project domain in v3 and ignored in v2 authentication. |
| string value | Domain ID to scope to |
| string value | Domain name to scope to |
| boolean value | Verify HTTPS connections. |
| string value | PEM encoded client certificate key file |
| string value | User’s password |
| string value | Domain ID containing project |
| string value | Domain name containing project |
| string value | Project ID to scope to |
| string value | Project name to scope to |
| boolean value | Log requests to multiple loggers. |
| string value | Scope for system operations |
| string value | Tenant ID |
| string value | Tenant Name |
| integer value | Timeout value for http requests |
| string value | Trust ID |
| string value | User’s domain id |
| string value | User’s domain name |
| string value | User ID |
| string value | Username |
9.1.52. vmware
The following table outlines the options available under the [vmware]
group in the /etc/nova/nova.conf
file.
Table 9.51. vmware
Configuration option = Default value | Type | Description |
---|---|---|
| integer value | Number of times VMware vCenter server API must be retried on connection failures, e.g. socket error, etc. |
| string value | Specifies the CA bundle file to be used in verifying the vCenter server certificate. |
| string value | This option adds a prefix to the folder where cached images are stored This is not the full path - just a folder prefix. This should only be used when a datastore cache is shared between compute nodes. Note: This should only be used when the compute nodes are running on same host or they have a shared file system. Possible values:
|
| string value | Name of a VMware Cluster ComputeResource. |
| integer value | This option sets the http connection pool size The connection pool size is the maximum number of connections from nova to vSphere. It should only be increased if there are warnings indicating that the connection pool is full, otherwise, the default should suffice. |
| integer value | Set this value if affected by an increased network latency causing repeated characters when typing in a remote console. |
| string value | Regular expression pattern to match the name of datastore. The datastore_regex setting specifies the datastores to use with Compute. For example, datastore_regex="nas.*" selects all the data stores that have a name starting with "nas". Note If no regex is given, it just picks the datastore with the most freespace. Possible values:
|
| host address value | Hostname or IP address for connection to VMware vCenter host. |
| string value | Password for connection to VMware vCenter host. |
| port value | Port for connection to VMware vCenter host. |
| string value | Username for connection to VMware vCenter host. |
| boolean value | If true, the vCenter server certificate is not verified. If false, then the default CA truststore is used for verification. Related options: * ca_file: This option is ignored if "ca_file" is set. |
| string value | This option should be configured only when using the NSX-MH Neutron plugin. This is the name of the integration bridge on the ESXi server or host. This should not be set for any other Neutron plugin. Hence the default value is not set. Possible values:
|
| integer value | This option specifies the limit on the maximum number of objects to return in a single result. A positive value will cause the operation to suspend the retrieval when the count of objects reaches the specified limit. The server may still limit the count to something less than the configured value. Any remaining objects may be retrieved with additional requests. |
| string value | This option specifies the default policy to be used. If pbm_enabled is set and there is no defined storage policy for the specific request, then this policy will be used. Possible values:
Related options:
|
| boolean value | This option enables or disables storage policy based placement of instances. Related options:
|
| string value | This option specifies the PBM service WSDL file location URL. Setting this will disable storage policy based placement of instances. Possible values:
|
| string value | Specifies the directory where the Virtual Serial Port Concentrator is storing console log files. It should match the serial_log_dir config value of VSPC. |
| uri value | Identifies a proxy service that provides network access to the serial_port_service_uri. Possible values:
Related options: This option is ignored if serial_port_service_uri is not specified. * serial_port_service_uri |
| string value | Identifies the remote system where the serial port traffic will be sent. This option adds a virtual serial port which sends console output to a configurable service URI. At the service URI address there will be virtual serial port concentrator that will collect console logs. If this is not set, no serial ports will be added to the created VMs. Possible values:
|
| floating point value | Time interval in seconds to poll remote tasks invoked on VMware VC server. |
| boolean value | This option enables/disables the use of linked clone. The ESX hypervisor requires a copy of the VMDK file in order to boot up a virtual machine. The compute driver must download the VMDK via HTTP from the OpenStack Image service to a datastore that is visible to the hypervisor and cache it. Subsequent virtual machines that need the VMDK use the cached version and don’t have to copy the file again from the OpenStack Image service. If set to false, even with a cached VMDK, there is still a copy operation from the cache location to the hypervisor file directory in the shared datastore. If set to true, the above copy operation is avoided as it creates copy of the virtual machine that shares virtual disks with its parent VM. |
| string value | This option specifies the physical ethernet adapter name for VLAN networking. Set the vlan_interface configuration option to match the ESX host interface that handles VLAN-tagged VM traffic. Possible values:
|
| string value | Keymap for VNC. The keyboard mapping (keymap) determines which keyboard layout a VNC session should use by default. Possible values:
|
| port value | This option specifies VNC starting port. Every VM created by ESX host has an option of enabling VNC client for remote connection. Above option vnc_port helps you to set default starting port for the VNC client. Possible values:
Related options: Below options should be set to enable VNC client. * vnc.enabled = True * vnc_port_total |
| integer value | Total number of VNC ports. |
9.1.53. vnc
The following table outlines the options available under the [vnc]
group in the /etc/nova/nova.conf
file.
Table 9.52. vnc
Configuration option = Default value | Type | Description |
---|---|---|
| list value | The authentication schemes to use with the compute node. Control what RFB authentication schemes are permitted for connections between the proxy and the compute host. If multiple schemes are enabled, the first matching scheme will be used, thus the strongest schemes should be listed first. Related options:
|
| boolean value | Enable VNC related features. Guests will get created with graphical devices to support this. Clients (for example Horizon) can then establish a VNC connection to the guest. |
| string value | (DEPRECATED FOR REMOVAL) Keymap for VNC. The keyboard mapping (keymap) determines which keyboard layout a VNC session should use by default. Possible values:
|
| uri value | Public address of noVNC VNC console proxy. The VNC proxy is an OpenStack component that enables compute service users to access their instances through VNC clients. noVNC provides VNC support through a websocket-based client. This option sets the public base URL to which client systems will connect. noVNC clients can use this address to connect to the noVNC instance and, by extension, the VNC sessions.
If using noVNC >= 1.0.0, you should use Related options:
|
| string value | IP address that the noVNC console proxy should bind to. The VNC proxy is an OpenStack component that enables compute service users to access their instances through VNC clients. noVNC provides VNC support through a websocket-based client. This option sets the private address to which the noVNC console proxy service should bind to. Related options:
|
| port value | Port that the noVNC console proxy should bind to. The VNC proxy is an OpenStack component that enables compute service users to access their instances through VNC clients. noVNC provides VNC support through a websocket-based client. This option sets the private port to which the noVNC console proxy service should bind to. Related options:
|
| host address value | The IP address or hostname on which an instance should listen to for incoming VNC connection requests on this node. |
| host address value | Private, internal IP address or hostname of VNC console proxy. The VNC proxy is an OpenStack component that enables compute service users to access their instances through VNC clients.
This option sets the private address to which proxy clients, such as |
| string value | The path to the CA certificate PEM file The fully qualified path to a PEM file containing one or more x509 certificates for the certificate authorities used by the compute node VNC server. Related options:
|
| string value | The path to the client key file (for x509) The fully qualified path to a PEM file containing the x509 certificate which the VNC proxy server presents to the compute node during VNC authentication. Realted options:
|
| string value | The path to the client certificate PEM file (for x509) The fully qualified path to a PEM file containing the private key which the VNC proxy server presents to the compute node during VNC authentication. Related options:
|
| uri value | (DEPRECATED FOR REMOVAL) Public URL address of XVP VNC console proxy. The VNC proxy is an OpenStack component that enables compute service users to access their instances through VNC clients. Xen provides the Xenserver VNC Proxy, or XVP, as an alternative to the websocket-based noVNC proxy used by Libvirt. In contrast to noVNC, XVP clients are Java-based. This option sets the public base URL to which client systems will connect. XVP clients can use this address to connect to the XVP instance and, by extension, the VNC sessions. Related options:
|
| host address value | (DEPRECATED FOR REMOVAL) IP address or hostname that the XVP VNC console proxy should bind to. The VNC proxy is an OpenStack component that enables compute service users to access their instances through VNC clients. Xen provides the Xenserver VNC Proxy, or XVP, as an alternative to the websocket-based noVNC proxy used by Libvirt. In contrast to noVNC, XVP clients are Java-based. This option sets the private address to which the XVP VNC console proxy service should bind to. Related options:
|
| port value | (DEPRECATED FOR REMOVAL) Port that the XVP VNC console proxy should bind to. The VNC proxy is an OpenStack component that enables compute service users to access their instances through VNC clients. Xen provides the Xenserver VNC Proxy, or XVP, as an alternative to the websocket-based noVNC proxy used by Libvirt. In contrast to noVNC, XVP clients are Java-based. This option sets the private port to which the XVP VNC console proxy service should bind to. Related options:
|
9.1.54. workarounds
The following table outlines the options available under the [workarounds]
group in the /etc/nova/nova.conf
file.
Table 9.53. workarounds
Configuration option = Default value | Type | Description |
---|---|---|
| boolean value | (DEPRECATED FOR REMOVAL) Disable fallback request for VCPU allocations when using pinned instances.
Starting in Train, compute nodes using the libvirt virt driver can report |
| boolean value | Disable the server group policy check upcall in compute. In order to detect races with server group affinity policy, the compute service attempts to validate that the policy was not violated by the scheduler. It does this by making an upcall to the API database to list the instances in the server group for one that it is booting, which violates our api/cell isolation goals. Eventually this will be solved by proper affinity guarantees in the scheduler and placement service, but until then, this late check is needed to ensure proper affinity policy. Operators that desire api/cell isolation over this check should enable this flag, which will avoid making that upcall from compute. Related options:
|
| boolean value | (DEPRECATED FOR REMOVAL) Disable live snapshots when using the libvirt driver. Live snapshots allow the snapshot of the disk to happen without an interruption to the guest, using coordination with a guest agent to quiesce the filesystem. When using libvirt 1.2.2 live snapshots fail intermittently under load (likely related to concurrent libvirt/qemu operations). This config option provides a mechanism to disable live snapshot, in favor of cold snapshot, while this is resolved. Cold snapshot causes an instance outage while the guest is going through the snapshotting process. For more information, refer to the bug report: https://bugs.launchpad.net/nova/+bug/1334398 Possible values:
|
| boolean value | When attaching encrypted LUKSv1 Cinder volumes to instances the Libvirt driver configures the encrypted disks to be natively decrypted by QEMU. A performance issue has been discovered in the libgcrypt library used by QEMU that serverly limits the I/O performance in this scenario. For more information please refer to the following bug report: RFE: hardware accelerated AES-XTS mode https://bugzilla.redhat.com/show_bug.cgi?id=1762765 Enabling this workaround option will cause Nova to use the legacy dm-crypt based os-brick encryptor to decrypt the LUKSv1 volume.
Note that enabling this option while using volumes that do not provide a host block device such as Ceph will result in a failure to boot from or attach the volume to an instance. See the Related options:
|
| boolean value | Use sudo instead of rootwrap. Allow fallback to sudo for performance reasons. For more information, refer to the bug report: https://bugs.launchpad.net/nova/+bug/1415106 Possible values:
Interdependencies to other options:
|
| boolean value | (DEPRECATED FOR REMOVAL) Enable live migration of instances with NUMA topologies. Live migration of instances with NUMA topologies when using the libvirt driver is only supported in deployments that have been fully upgraded to Train. In previous versions, or in mixed Stein/Train deployments with a rolling upgrade in progress, live migration of instances with NUMA topologies is disabled by default when using the libvirt driver. This includes live migration of instances with CPU pinning or hugepages. CPU pinning and huge page information for such instances is not currently re-calculated, as noted in `bug #1289064`_. This means that if instances were already present on the destination host, the migrated instance could be placed on the same dedicated cores as these instances or use hugepages allocated for another instance. Alternately, if the host platforms were not homogeneous, the instance could be assigned to non-existent cores or be inadvertently split across host NUMA nodes. Despite these known issues, there may be cases where live migration is necessary. By enabling this option, operators that are aware of the issues and are willing to manually work around them can enable live migration support for these instances. Related options:
|
| boolean value | Ensure the instance directory is removed during clean up when using rbd.
When enabled this workaround will ensure that the instance directory is always removed during cleanup on hosts using https://bugs.launchpad.net/nova/+bug/1414895 https://bugs.launchpad.net/nova/+bug/1761062
Both of these bugs can then result in
Related options:
|
| boolean value | Enable handling of events emitted from compute drivers. Many compute drivers emit lifecycle events, which are events that occur when, for example, an instance is starting or stopping. If the instance is going through task state changes due to an API operation, like resize, the events are ignored. This is an advanced feature which allows the hypervisor to signal to the compute service that an unexpected state change has occurred in an instance and that the instance can be shutdown automatically. Unfortunately, this can race in some conditions, for example in reboot operations or when the compute service or when host is rebooted (planned or due to an outage). If such races are common, then it is advisable to disable this feature. Care should be taken when this feature is disabled and sync_power_state_interval is set to a negative value. In this case, any instances that get out of sync between the hypervisor and the Nova database will have to be synchronized manually. For more information, refer to the bug report: https://bugs.launchpad.net/bugs/1444630 Interdependencies to other options:
|
| boolean value | When booting from an image on a ceph-backed compute node, if the image does not already reside on the ceph cluster (as would be the case if glance is also using the same cluster), nova will download the image from glance and upload it to ceph itself. If using multiple ceph clusters, this may cause nova to unintentionally duplicate the image in a non-COW-able way in the local ceph deployment, wasting space. For more information, refer to the bug report: https://bugs.launchpad.net/nova/+bug/1858877 Enabling this option will cause nova to refuse to boot an instance if it would require downloading the image from glance and uploading it to ceph itself. Related options:
|
| boolean value | Attach RBD Cinder volumes to the compute as host block devices. When enabled this option instructs os-brick to connect RBD volumes locally on the compute host as block devices instead of natively through QEMU. This workaround does not currently support extending attached volumes. This can be used with the disable_native_luksv1 workaround configuration option to avoid the recently discovered performance issues found within the libgcrypt library. This workaround is temporary and will be removed during the W release once all impacted distributions have been able to update their versions of the libgcrypt library.
Related options: * |
| boolean value |
If it is set to True then the libvirt driver will reserve DISK_GB resource for the images stored in the image cache. If the :oslo.config:option:
Such disk reservation is done by a periodic task in the resource tracker that runs every :oslo.config:option: Related options:
|
9.1.55. wsgi
The following table outlines the options available under the [wsgi]
group in the /etc/nova/nova.conf
file.
Table 9.54. wsgi
Configuration option = Default value | Type | Description |
---|---|---|
| string value | This option represents a file name for the paste.deploy config for nova-api. Possible values:
|
| integer value | This option specifies the timeout for client connections' socket operations. If an incoming connection is idle for this number of seconds it will be closed. It indicates timeout on individual read/writes on the socket connection. To wait forever set to 0. |
| integer value | This option specifies the size of the pool of greenthreads used by wsgi. It is possible to limit the number of concurrent connections using this option. |
| boolean value | This option allows using the same TCP connection to send and receive multiple HTTP requests/responses, as opposed to opening a new one for every single request/response pair. HTTP keep-alive indicates HTTP connection reuse. Possible values:
Related options:
|
| integer value | This option specifies the 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). Since TCP is a stream based protocol, in order to reuse a connection, the HTTP has to have a way to indicate the end of the previous response and beginning of the next. Hence, in a keep_alive case, all messages must have a self-defined message length. |
| string value | This option specifies the HTTP header used to determine the protocol scheme for the original request, even if it was removed by a SSL terminating proxy. Possible values:
Warning Do not set this unless you know what you are doing. Make sure ALL of the following are true before setting this (assuming the values from the example above):
If any of those are not true, you should keep this setting set to None. |
| string value | This option allows setting path to the CA certificate file that should be used to verify connecting clients. Possible values:
Related options:
|
| string value | This option allows setting path to the SSL certificate of API server. Possible values:
Related options:
|
| string value | This option specifies the path to the file where SSL private key of API server is stored when SSL is in effect. Possible values:
Related options:
|
| integer value | This option sets the value of TCP_KEEPIDLE in seconds for each server socket. It specifies the duration of time to keep connection active. TCP generates a KEEPALIVE transmission for an application that requests to keep connection active. Not supported on OS X. Related options:
|
| string value | (DEPRECATED FOR REMOVAL) It represents a python format string that is used as the template to generate log lines. The following values can be formatted into it: client_ip, date_time, request_line, status_code, body_length, wall_seconds. This option is used for building custom request loglines when running nova-api under eventlet. If used under uwsgi or apache, this option has no effect. Possible values:
|
9.1.56. xenserver
The following table outlines the options available under the [xenserver]
group in the /etc/nova/nova.conf
file.
Table 9.55. xenserver
Configuration option = Default value | Type | Description |
---|---|---|
| string value | Path to locate guest agent on the server. Specifies the path in which the XenAPI guest agent should be located. If the agent is present, network configuration is not injected into the image. Related options:
For this option to have an effect: * |
| integer value | Number of seconds to wait for agent’s reply to resetnetwork request.
This indicates the amount of time xapi agent plugin waits for the agent to respond to the resetnetwork request specifically. The generic timeout for agent communication |
| integer value | Number of seconds to wait for agent’s reply to a request. Nova configures/performs certain administrative actions on a server with the help of an agent that’s installed on the server. The communication between Nova and the agent is achieved via sharing messages, called records, over xenstore, a shared storage across all the domains on a Xenserver host. Operations performed by the agent on behalf of nova are: version,' key_init', password,resetnetwork,inject_file, and agentupdate. To perform one of the above operations, the xapi agent plugin writes the command and its associated parameters to a certain location known to the domain and awaits response. On being notified of the message, the agent performs appropriate actions on the server and writes the result back to xenstore. This result is then read by the xapi agent plugin to determine the success/failure of the operation. This config option determines how long the xapi agent plugin shall wait to read the response off of xenstore for a given request/command. If the agent on the instance fails to write the result in this time period, the operation is considered to have timed out. Related options:
|
| integer value | Number of seconds to wait for agent’t reply to version request.
This indicates the amount of time xapi agent plugin waits for the agent to respond to the version request specifically. The generic timeout for agent communication During the build process the version request is used to determine if the agent is available/operational to perform other requests such as resetnetwork, password, key_init and inject_file. If the version call fails, the other configuration is skipped. So, this configuration option can also be interpreted as time in which agent is expected to be fully operational. |
| integer value | Time in secs to wait for a block device to be created |
| string value | Cache glance images locally. The value for this option must be chosen from the choices listed here. Configuring a value other than these will default to all. Note: There is nothing that deletes these images. |
| boolean value | Ensure compute service is running on host XenAPI connects to. This option must be set to false if the independent_compute option is set to true. Possible values:
Related options:
|
| integer value | Maximum number of concurrent XenAPI connections. In nova, multiple XenAPI requests can happen at a time. Configuring this option will parallelize access to the XenAPI session, which allows you to make concurrent XenAPI connections. |
| string value | Password for connection to XenServer/Xen Cloud Platform |
| string value | URL for connection to XenServer/Xen Cloud Platform. A special value of unix://local can be used to connect to the local unix socket. Possible values:
|
| string value | Username for connection to XenServer/Xen Cloud Platform |
| string value | Publicly visible name for this console host. Possible values:
|
| string value | Default OS type used when uploading an image to glance |
| boolean value | Disables the use of XenAPI agent.
This configuration option suggests whether the use of agent should be enabled or not regardless of what image properties are present. Image properties have an effect only when this is set to Related options:
|
| integer value | Compression level for images. By setting this option we can configure the gzip compression level. This option sets GZIP environment variable before spawning tar -cz to force the compression level. It defaults to none, which means the GZIP environment variable is not set and the default (usually -6) is used. Possible values:
|
| string value | The plugin used to handle image uploads and downloads. Provide a short name representing an image driver required to handle the image between compute host and glance. |
`image_upload_handler = ` | string value | (DEPRECATED FOR REMOVAL) Dom0 plugin driver used to handle image uploads. Provide a string value representing a plugin driver required to handle the image uploading to GlanceStore. Images, and snapshots from XenServer need to be uploaded to the data store for use. image_upload_handler takes in a value for the Dom0 plugin driver. This driver is then called to uplaod images to the GlanceStore. |
| boolean value | Used to prevent attempts to attach VBDs locally, so Nova can be run in a VM on a different host. Related options:
|
| integer value | Number of seconds to wait for SR to settle if the VDI does not exist when first introduced. Some SRs, particularly iSCSI connections are slow to see the VDIs right after they got introduced. Setting this option to a time interval will make the SR to wait for that time period before raising VDI not found exception. |
| string value | URL to the iPXE boot menu. An iPXE ISO is a specially crafted ISO which supports iPXE booting. This feature gives a means to roll your own image. By default this option is not set. Enable this option to boot an iPXE ISO. Related Options:
|
| string value | Name and optionally path of the tool used for ISO image creation. An iPXE ISO is a specially crafted ISO which supports iPXE booting. This feature gives a means to roll your own image.
Note: By default Related Options:
|
| string value | Name of network to use for booting iPXE ISOs. An iPXE ISO is a specially crafted ISO which supports iPXE booting. This feature gives a means to roll your own image. By default this option is not set. Enable this option to boot an iPXE ISO. Related Options:
|
| integer value | Timeout in seconds for XenAPI login. |
| integer value | Maximum size in bytes of kernel or ramdisk images. Specifying the maximum size of kernel or ramdisk will avoid copying large files to dom0 and fill up /boot/guest. |
| integer value | Maximum number of retries to unplug VBD. If set to 0, should try once, no retries. |
| string value | The name of the integration Bridge that is used with xenapi when connecting with Open vSwitch. Note: The value of this config option is dependent on the environment, therefore this configuration value must be set accordingly if you are using XenAPI. Possible values:
|
| integer value | Wait time for instances to go to running state. Provide an integer value representing time in seconds to set the wait time for an instance to go to running state. When a request to create an instance is received by nova-api and communicated to nova-compute, the creation of the instance occurs through interaction with Xen via XenAPI in the compute node. Once the node on which the instance(s) are to be launched is decided by nova-schedule and the launch is triggered, a certain amount of wait time is involved until the instance(s) can become available and running. This wait time is defined by running_timeout. If the instances do not go to running state within this specified wait time, the launch expires and the instance(s) are set to error state. |
| boolean value | Whether to use sparse_copy for copying data on a resize down. (False will use standard dd). This speeds up resizes down considerably since large runs of zeros won’t have to be rsynced. |
| string value | Base path to the storage repository on the XenServer host. |
| string value | Filter for finding the SR to be used to install guest instances on. Possible values:
|
| host address value | The iSCSI Target Host. This option represents the hostname or ip of the iSCSI Target. If the target host is not present in the connection information from the volume provider then the value from this option is taken. Possible values:
|
| port value | The iSCSI Target Port. This option represents the port of the iSCSI Target. If the target port is not present in the connection information from the volume provider then the value from this option is taken. |
| boolean value | Whether or not to use the agent by default when its usage is enabled but not indicated by the image.
The use of XenAPI agent can be disabled altogether using the configuration option
Note that if this configuration is set to Related options:
|
| boolean value | When adding new host to a pool, this will append a --force flag to the command, forcing hosts to join a pool, even if they have different CPUs. Since XenServer version 5.6 it is possible to create a pool of hosts that have different CPU capabilities. To accommodate CPU differences, XenServer limited features it uses to determine CPU compatibility to only the ones that are exposed by CPU and support for CPU masking was added. Despite this effort to level differences between CPUs, it is still possible that adding new host will fail, thus option to force join was introduced. |
| integer value | Max number of times to poll for VHD to coalesce. This option determines the maximum number of attempts that can be made for coalescing the VHD before giving up. Related opitons:
|
| floating point value | The interval used for polling of coalescing vhds. This is the interval after which the task of coalesce VHD is performed, until it reaches the max attempts that is set by vhd_coalesce_max_attempts. Related options:
|
9.1.57. xvp
The following table outlines the options available under the [xvp]
group in the /etc/nova/nova.conf
file.
Table 9.56. xvp
Configuration option = Default value | Type | Description |
---|---|---|
| string value | Generated XVP conf file |
| string value | XVP conf template |
| string value | XVP log file |
| port value | Port for XVP to multiplex VNC connections on |
| string value | XVP master process pid file |
9.1.58. zvm
The following table outlines the options available under the [zvm]
group in the /etc/nova/nova.conf
file.
Table 9.57. zvm
Configuration option = Default value | Type | Description |
---|---|---|
| string value | CA certificate file to be verified in httpd server with TLS enabled A string, it must be a path to a CA bundle to use. |
| uri value | URL to be used to communicate with z/VM Cloud Connector. |
| string value | The path at which images will be stored (snapshot, deploy, etc). Images used for deploy and images captured via snapshot need to be stored on the local disk of the compute host. This configuration identifies the directory location. Possible values: A file system path on the host running the compute service. |
| integer value | Timeout (seconds) to wait for an instance to start. The z/VM driver relies on communication between the instance and cloud connector. After an instance is created, it must have enough time to wait for all the network info to be written into the user directory. The driver will keep rechecking network status to the instance with the timeout value, If setting network failed, it will notify the user that starting the instance failed and put the instance in ERROR state. The underlying z/VM guest will then be deleted. Possible Values: Any positive integer. Recommended to be at least 300 seconds (5 minutes), but it will vary depending on instance and system load. A value of 0 is used for debug. In this case the underlying z/VM guest will not be deleted when the instance is marked in ERROR state. |