Configuration Options

The following is an overview of all available configuration options in Tacker. For a sample configuration file, refer to Sample Configuration File.

DEFAULT

debug
Type:

boolean

Default:

False

Mutable:

This option can be changed without restarting.

If set to true, the logging level will be set to DEBUG instead of the default INFO level.

log_config_append
Type:

string

Default:

<None>

Mutable:

This option can be changed without restarting.

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).

Deprecated Variations

Group

Name

DEFAULT

log-config

DEFAULT

log_config
log_date_format
Type:

string

Default:

%Y-%m-%d %H:%M:%S

Defines the format string for %(asctime)s in log records. Default: the value above . This option is ignored if log_config_append is set.

log_file
Type:

string

Default:

<None>

(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.

Deprecated Variations

Group

Name

DEFAULT

logfile
log_dir
Type:

string

Default:

<None>

(Optional) The base directory used for relative log_file paths. This option is ignored if log_config_append is set.

Deprecated Variations

Group

Name

DEFAULT

logdir
watch_log_file
Type:

boolean

Default:

False

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.

Warning

This option is deprecated for removal. Its value may be silently ignored in the future.

Reason:

This function is known to have bene broken for long time, and depends on the unmaintained library

use_syslog
Type:

boolean

Default:

False

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.

use_journal
Type:

boolean

Default:

False

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.

syslog_log_facility
Type:

string

Default:

LOG_USER

Syslog facility to receive log lines. This option is ignored if log_config_append is set.

use_json
Type:

boolean

Default:

False

Use JSON formatting for logging. This option is ignored if log_config_append is set.

use_stderr
Type:

boolean

Default:

False

Log output to standard error. This option is ignored if log_config_append is set.

use_eventlog
Type:

boolean

Default:

False

Log output to Windows Event Log.

Warning

This option is deprecated for removal. Its value may be silently ignored in the future.

Reason:

Windows support is no longer maintained.

log_color
Type:

boolean

Default:

False

(Optional) Set the ‘color’ key according to log levels. This option takes effect only when logging to stderr or stdout is used. This option is ignored if log_config_append is set.

log_rotate_interval
Type:

integer

Default:

1

The amount of time before the log files are rotated. This option is ignored unless log_rotation_type is set to “interval”.

log_rotate_interval_type
Type:

string

Default:

days

Valid Values:

Seconds, Minutes, Hours, Days, Weekday, Midnight

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.

max_logfile_count
Type:

integer

Default:

30

Maximum number of rotated log files.

max_logfile_size_mb
Type:

integer

Default:

200

Log file maximum size in MB. This option is ignored if “log_rotation_type” is not set to “size”.

log_rotation_type
Type:

string

Default:

none

Valid Values:

interval, size, none

Log rotation type.

Possible values

interval

Rotate logs at predefined time intervals.

size

Rotate logs once they reach a predefined size.

none

Do not rotate log files.

logging_context_format_string
Type:

string

Default:

%(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(global_request_id)s %(request_id)s %(user_identity)s] %(instance)s%(message)s

Format string to use for log messages with context. Used by oslo_log.formatters.ContextFormatter

logging_default_format_string
Type:

string

Default:

%(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s

Format string to use for log messages when context is undefined. Used by oslo_log.formatters.ContextFormatter

logging_debug_format_suffix
Type:

string

Default:

%(funcName)s %(pathname)s:%(lineno)d

Additional data to append to log message when logging level for the message is DEBUG. Used by oslo_log.formatters.ContextFormatter

logging_exception_prefix
Type:

string

Default:

%(asctime)s.%(msecs)03d %(process)d ERROR %(name)s %(instance)s

Prefix each line of exception output with this format. Used by oslo_log.formatters.ContextFormatter

logging_user_identity_format
Type:

string

Default:

%(user)s %(project)s %(domain)s %(system_scope)s %(user_domain)s %(project_domain)s

Defines the format string for %(user_identity)s that is used in logging_context_format_string. Used by oslo_log.formatters.ContextFormatter

default_log_levels
Type:

list

Default:

['amqp=WARN', 'amqplib=WARN', 'boto=WARN', 'qpid=WARN', 'sqlalchemy=WARN', 'suds=INFO', 'oslo.messaging=INFO', 'oslo_messaging=INFO', 'iso8601=WARN', 'requests.packages.urllib3.connectionpool=WARN', 'urllib3.connectionpool=WARN', 'websocket=WARN', 'requests.packages.urllib3.util.retry=WARN', 'urllib3.util.retry=WARN', 'keystonemiddleware=WARN', 'routes.middleware=WARN', 'stevedore=WARN', 'taskflow=WARN', 'keystoneauth=WARN', 'oslo.cache=INFO', 'oslo_policy=INFO', 'dogpile.core.dogpile=INFO']

List of package logging levels in logger=LEVEL pairs. This option is ignored if log_config_append is set.

publish_errors
Type:

boolean

Default:

False

Enables or disables publication of error events.

instance_format
Type:

string

Default:

"[instance: %(uuid)s] "

The format for an instance that is passed with the log message.

instance_uuid_format
Type:

string

Default:

"[instance: %(uuid)s] "

The format for an instance UUID that is passed with the log message.

rate_limit_interval
Type:

integer

Default:

0

Interval, number of seconds, of log rate limiting.

rate_limit_burst
Type:

integer

Default:

0

Maximum number of logged messages per rate_limit_interval.

rate_limit_except_level
Type:

string

Default:

CRITICAL

Valid Values:

CRITICAL, ERROR, INFO, WARNING, DEBUG, ‘’

Log level name used by rate limiting. Logs with level greater or equal to rate_limit_except_level are not filtered. An empty string means that all levels are filtered.

fatal_deprecations
Type:

boolean

Default:

False

Enables or disables fatal status of deprecations.

bind_host
Type:

host address

Default:

0.0.0.0

The host IP to bind to

bind_port
Type:

integer

Default:

9890

The port to bind to

api_paste_config
Type:

string

Default:

api-paste.ini

The API paste config file to use

api_extensions_path
Type:

string

Default:

''

The path for API extensions

service_plugins
Type:

list

Default:

['nfvo', 'vnfm']

The service plugins Tacker will use

auth_strategy
Type:

string

Default:

keystone

The type of authentication to use

allow_bulk
Type:

boolean

Default:

True

Allow the usage of the bulk API

allow_pagination
Type:

boolean

Default:

False

Allow the usage of the pagination

allow_sorting
Type:

boolean

Default:

False

Allow the usage of the sorting

pagination_max_limit
Type:

string

Default:

-1

The maximum number of items returned in a single response, value was ‘infinite’ or negative integer means no limit

host
Type:

host address

Default:

np0039432488

The hostname Tacker is running on

use_credential_encryption
Type:

boolean

Default:

False

Enable to encrypt the credential

keymanager_type
Type:

string

Default:

barbican

The type of keymanager to use when the ‘use_credential_encryption’ option is True

crypt_key_dir
Type:

string

Default:

/etc/tacker/crypt/fernet_keys

Dir.path to store fernet_keys

state_path
Type:

string

Default:

/var/lib/tacker

Where to store Tacker state files. This directory must be writable by the agent.

vnf_package_delete_interval
Type:

integer

Default:

1800

Seconds between running periodic tasks to cleanup residues of deleted vnf packages

db_synchronization_interval
Type:

integer

Default:

300

Interval time in sec for DB sync between Tacker and Kubernetes VIMs

report_interval
Type:

integer

Default:

10

Seconds between running components report states

periodic_interval
Type:

integer

Default:

40

Seconds between running periodic tasks

api_workers
Type:

integer

Default:

0

Number of separate worker processes for service

periodic_fuzzy_delay
Type:

integer

Default:

5

Range of seconds to randomly delay when starting the periodic task scheduler to reduce stampeding. (Disable by setting to 0)

backlog
Type:

integer

Default:

4096

Number of backlog requests to configure the socket with

tcp_keepidle
Type:

integer

Default:

600

Sets the value of TCP_KEEPIDLE in seconds for each server socket. Not supported on OS X.

retry_until_window
Type:

integer

Default:

30

Number of seconds to keep retrying to listen

max_header_line
Type:

integer

Default:

16384

Max header line to accommodate large tokens

use_ssl
Type:

boolean

Default:

False

Enable SSL on the API server

ssl_ca_file
Type:

string

Default:

<None>

CA certificate file to use to verify connecting clients

ssl_cert_file
Type:

string

Default:

<None>

Certificate file to use when starting the server securely

ssl_key_file
Type:

string

Default:

<None>

Private key file to use when starting the server securely

rpc_conn_pool_size
Type:

integer

Default:

30

Minimum Value:

1

Size of RPC connection pool.

Deprecated Variations

Group

Name

DEFAULT

rpc_conn_pool_size
conn_pool_min_size
Type:

integer

Default:

2

The pool size limit for connections expiration policy

conn_pool_ttl
Type:

integer

Default:

1200

The time-to-live in sec of idle connections in the pool

executor_thread_pool_size
Type:

integer

Default:

64

Size of executor thread pool when executor is threading or eventlet.

Deprecated Variations

Group

Name

DEFAULT

rpc_thread_pool_size
rpc_response_timeout
Type:

integer

Default:

60

Seconds to wait for a response from a call.

transport_url
Type:

string

Default:

rabbit://

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

control_exchange
Type:

string

Default:

tacker

The default exchange under which topics are scoped. May be overridden by an exchange name specified in the transport_url option.

rpc_ping_enabled
Type:

boolean

Default:

False

Add an endpoint to answer to ping calls. Endpoint is named oslo_rpc_server_ping

backdoor_port
Type:

string

Default:

<None>

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.

backdoor_socket
Type:

string

Default:

<None>

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.

log_options
Type:

boolean

Default:

True

Enables or disables logging values of all registered options when starting a service (at DEBUG level).

graceful_shutdown_timeout
Type:

integer

Default:

60

Specify a timeout after which a gracefully shutdown server will exit. Zero value means endless wait.

authentication

auth_type
Type:

string

Default:

<None>

Valid Values:

BASIC, OAUTH2_CLIENT_CREDENTIALS

auth_type used for external connection

timeout
Type:

integer

Default:

20

timeout used for external connection

token_endpoint
Type:

string

Default:

<None>

token_endpoint used to get the oauth2 token

client_id
Type:

string

Default:

<None>

client_id used to get the oauth2 token

client_password
Type:

string

Default:

<None>

client_password used to get the oauth2 token

user_name
Type:

string

Default:

<None>

user_name used in basic authentication

password
Type:

string

Default:

<None>

password used in basic authentication

verify_oauth2_ssl
Type:

boolean

Default:

True

verify the certification to get the oauth2 access token by ssl

token_type
Type:

string

Default:

<None>

Valid Values:

Bearer, Basic

authentication type

auth_url
Type:

string

Default:

<None>

URL of the authorization server

connect_grant

base_url
Type:

string

Default:

<None>

grant of base_url

retry_num
Type:

integer

Default:

2

Number of grant retry count

retry_wait
Type:

integer

Default:

30

Number of grant retry wait

timeout
Type:

integer

Default:

20

Number of grant connect timeout

connect_vnf_packages

base_url
Type:

string

Default:

<None>

vnf_packages base_url

pipeline
Type:

list

Default:

<None>

Get vnf_packages api pipeline

retry_num
Type:

integer

Default:

2

Number of vnf_packages retry count

retry_wait
Type:

integer

Default:

30

Number of vnf_packages retry wait

timeout
Type:

integer

Default:

20

Number of vnf_packages connect timeout

coordination

backend_url
Type:

string

Default:

file://$state_path

The backend URL to use for distributed coordination.

cors

allowed_origin
Type:

list

Default:

<None>

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

allow_credentials
Type:

boolean

Default:

True

Indicate that the actual request can include user credentials

expose_headers
Type:

list

Default:

[]

Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers.

max_age
Type:

integer

Default:

3600

Maximum cache age of CORS preflight requests.

allow_methods
Type:

list

Default:

['OPTIONS', 'GET', 'HEAD', 'POST', 'PUT', 'DELETE', 'TRACE', 'PATCH']

Indicate which methods can be used during the actual request.

allow_headers
Type:

list

Default:

[]

Indicate which header field names may be used during the actual request.

database

sqlite_synchronous
Type:

boolean

Default:

True

If True, SQLite uses synchronous mode.

backend
Type:

string

Default:

sqlalchemy

The back end to use for the database.

connection
Type:

string

Default:

<None>

The SQLAlchemy connection string to use to connect to the database.

slave_connection
Type:

string

Default:

<None>

The SQLAlchemy connection string to use to connect to the slave database.

asyncio_connection
Type:

string

Default:

<None>

The SQLAlchemy asyncio connection string to use to connect to the database.

asyncio_slave_connection
Type:

string

Default:

<None>

The SQLAlchemy asyncio connection string to use to connect to the slave database.

mysql_sql_mode
Type:

string

Default:

TRADITIONAL

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=

mysql_wsrep_sync_wait
Type:

integer

Default:

<None>

For Galera only, configure wsrep_sync_wait causality checks on new connections. Default is None, meaning don’t configure any setting.

connection_recycle_time
Type:

integer

Default:

3600

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.

max_pool_size
Type:

integer

Default:

5

Maximum number of SQL connections to keep open in a pool. Setting a value of 0 indicates no limit.

max_retries
Type:

integer

Default:

10

Maximum number of database connection retries during startup. Set to -1 to specify an infinite retry count.

retry_interval
Type:

integer

Default:

10

Interval between retries of opening a SQL connection.

max_overflow
Type:

integer

Default:

50

If set, use this value for max_overflow with SQLAlchemy.

connection_debug
Type:

integer

Default:

0

Minimum Value:

0

Maximum Value:

100

Verbosity of SQL debugging information: 0=None, 100=Everything.

connection_trace
Type:

boolean

Default:

False

Add Python stack traces to SQL as comment strings.

pool_timeout
Type:

integer

Default:

<None>

If set, use this value for pool_timeout with SQLAlchemy.

use_db_reconnect
Type:

boolean

Default:

False

Enable the experimental use of database reconnect on connection lost.

db_retry_interval
Type:

integer

Default:

1

Seconds between retries of a database transaction.

db_inc_retry_interval
Type:

boolean

Default:

True

If True, increases the interval between retries of a database operation up to db_max_retry_interval.

db_max_retry_interval
Type:

integer

Default:

10

If db_inc_retry_interval is set, the maximum seconds between retries of a database operation.

db_max_retries
Type:

integer

Default:

20

Maximum retries in case of connection error or deadlock error before error is raised. Set to -1 to specify an infinite retry count.

connection_parameters
Type:

string

Default:

''

Optional URL parameters to append onto the connection URL at connect time; specify as param1=value1&param2=value2&…

ext_oauth2_auth

use_ext_oauth2_auth
Type:

boolean

Default:

False

Set True to use external Oauth2.0 auth server.

token_endpoint
Type:

string

Default:

<None>

The endpoint for access token API.

scope
Type:

string

Default:

<None>

The scope that the access token can access.

certfile
Type:

string

Default:

<None>

Required if identity server requires client certificate.

keyfile
Type:

string

Default:

<None>

Required if identity server requires client private key.

cafile
Type:

string

Default:

<None>

A PEM encoded Certificate Authority to use when verifying HTTPs connections. Defaults to system CAs.

insecure
Type:

boolean

Default:

False

Verify HTTPS connections.

http_connect_timeout
Type:

integer

Default:

<None>

Request timeout value for communicating with Identity API server.

audience
Type:

string

Default:

<None>

The Audience should be the URL of the Authorization Server’s Token Endpoint. The Authorization Server will verify that it is an intended audience for the token.

auth_method
Type:

string

Default:

client_secret_basic

Valid Values:

client_secret_basic, client_secret_post, tls_client_auth, private_key_jwt, client_secret_jwt

The auth_method must use the authentication method specified by the Authorization Server.

client_id
Type:

string

Default:

<None>

The OAuth 2.0 Client Identifier valid at the Authorization Server.

client_secret
Type:

string

Default:

<None>

The OAuth 2.0 client secret. When the auth_method is client_secret_basic, client_secret_post, or client_secret_jwt, the value is used, and otherwise the value is ignored.

jwt_key_file
Type:

string

Default:

<None>

The jwt_key_file must use the certificate key file which has been registered with the Authorization Server. When the auth_method is private_key_jwt, the value is used, and otherwise the value is ignored.

jwt_algorithm
Type:

string

Default:

<None>

The jwt_algorithm must use the algorithm specified by the Authorization Server. When the auth_method is client_secret_jwt, this value is often set to HS256,when the auth_method is private_key_jwt, the value is often set to RS256, and otherwise the value is ignored.

jwt_bearer_time_out
Type:

integer

Default:

3600

This value is used to calculate the expiration time. If after the expiration time, the access token cannot be accepted. When the auth_method is client_secret_jwt or private_key_jwt, the value is used, and otherwise the value is ignored.

glance_store

stores
Type:

list

Default:

['file', 'http']

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 file and http.

Possible values:
  • A comma separated list that could include:

    • file

    • http

    • swift

    • rbd

    • cinder

    • vmware

    • s3

Related Options:

  • default_store

Warning

This option is deprecated for removal since Rocky. Its value may be silently ignored in the future.

Reason:

This option is deprecated against new config option enabled_backends which helps to configure multiple backend stores of different schemes. This option is scheduled for removal in the U development cycle.

default_store
Type:

string

Default:

file

Valid Values:

file, filesystem, http, https, swift, swift+http, swift+https, swift+config, rbd, cinder, vsphere, s3

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 file as the default scheme to store images with the file store.

NOTE: The value given for this configuration option must be a valid scheme for a store registered with the stores configuration option.

Possible values:

  • file

  • filesystem

  • http

  • https

  • swift

  • swift+http

  • swift+https

  • swift+config

  • rbd

  • cinder

  • vsphere

  • s3

Related Options:

  • stores

Warning

This option is deprecated for removal since Rocky. Its value may be silently ignored in the future.

Reason:

This option is deprecated against new config option default_backend which acts similar to default_store config option. This option is scheduled for removal in the U development cycle.

filesystem_store_datadir
Type:

string

Default:

/var/lib/glance/images

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 glance-api runs. If the write access isn’t available, a BadStoreConfiguration exception is raised and the filesystem store may not be available for adding new images.

NOTE: This directory is used only when filesystem store is used as a storage backend. Either filesystem_store_datadir or filesystem_store_datadirs option must be specified in glance-api.conf. If both options are specified, a BadStoreConfiguration will be raised and the filesystem store may not be available for adding new images.

Possible values:

  • A valid path to a directory

Related options:

  • filesystem_store_datadirs

  • filesystem_store_file_perm

filesystem_store_datadirs
Type:

multi-valued

Default:

''

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 filesystem_store_datadir configuration option. When using multiple directories, each directory can be given an optional priority to specify the preference order in which they should be used. Priority is an integer that is concatenated to the directory path with a colon where a higher value indicates higher priority. When two directories have the same priority, the directory with most free space is used. When no priority is specified, it defaults to zero.

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 filesystem_store_datadir or filesystem_store_datadirs option must be specified in glance-api.conf. If both options are specified, a BadStoreConfiguration will be raised and the filesystem store may not be available for adding new images.

Possible values:
  • List of strings of the following form:

    • <a valid directory path>:<optional integer priority>

Related options:

  • filesystem_store_datadir

  • filesystem_store_file_perm

filesystem_store_metadata_file
Type:

string

Default:

<None>

Filesystem store metadata file.

The path to a file which contains the metadata to be returned with any location associated with the filesystem store. Once this option is set, it is used for new images created afterward only - previously existing images are not affected.

The file must contain a valid JSON object. The object should contain the keys id and mountpoint. The value for both keys should be a string.

Possible values:

  • A valid path to the store metadata file

Related options:

  • None

filesystem_store_file_perm
Type:

integer

Default:

0

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:

  • A valid file access permission

  • Zero

  • Any negative integer

Related options:

  • None

filesystem_store_chunk_size
Type:

integer

Default:

65536

Minimum Value:

1

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:

  • Any positive integer value

Related options:

  • None

filesystem_thin_provisioning
Type:

boolean

Default:

False

Enable or not thin provisioning in this backend.

This configuration option enable the feature of not really write null byte sequences on the filesystem, the holes who can appear will automatically be interpreted by the filesystem as null bytes, and do not really consume your storage. Enabling this feature will also speed up image upload and save network traffic in addition to save space in the backend, as null bytes sequences are not sent over the network.

Possible Values:

  • True

  • False

Related options:

  • None

https_ca_certificates_file
Type:

string

Default:

<None>

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 https_insecure option will be ignored and the CA file specified will be used to authenticate the server certificate and establish a secure connection to the server.

Possible values:

  • A valid path to a CA file

Related options:

  • https_insecure

https_insecure
Type:

boolean

Default:

True

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 https_ca_certificates_file is set. The remote server certificate will then be verified using the file specified using the https_ca_certificates_file option.

Possible values:

  • True

  • False

Related options:

  • https_ca_certificates_file

http_proxy_information
Type:

dict

Default:

{}

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:

  • A comma separated list of scheme:proxy pairs as described above

Related options:

  • None

rbd_store_chunk_size
Type:

integer

Default:

8

Minimum Value:

1

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:

  • Any positive integer value

Related options:

  • None

rbd_store_pool
Type:

string

Default:

images

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 pool. Each pool is defined with the number of placement groups it can contain. The default pool that is used is ‘images’.

More information on the RBD storage backend can be found here: http://ceph.com/planet/how-data-is-stored-in-ceph-cluster/

Possible Values:

  • A valid pool name

Related options:

  • None

rbd_store_user
Type:

string

Default:

<None>

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:

  • A valid RADOS user

Related options:

  • rbd_store_ceph_conf

rbd_store_ceph_conf
Type:

string

Default:

''

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:

  • A valid path to a configuration file

Related options:

  • rbd_store_user

rados_connect_timeout
Type:

integer

Default:

-1

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 0, no timeout is set and the default librados value is used.

Possible Values:

  • Any integer value

Related options:

  • None

rbd_thin_provisioning
Type:

boolean

Default:

False

Enable or not thin provisioning in this backend.

This configuration option enable the feature of not really write null byte sequences on the RBD backend, the holes who can appear will automatically be interpreted by Ceph as null bytes, and do not really consume your storage. Enabling this feature will also speed up image upload and save network traffic in addition to save space in the backend, as null bytes sequences are not sent over the network.

Possible Values:

  • True

  • False

Related options:

  • None

s3_store_host
Type:

string

Default:

<None>

The host where the S3 server is listening.

This configuration option sets the host of the S3 or S3 compatible storage Server. This option is required when using the S3 storage backend. The host can contain a DNS name (e.g. s3.amazonaws.com, my-object-storage.com) or an IP address (127.0.0.1).

Possible values:

  • A valid DNS name

  • A valid IPv4 address

Related Options:

  • s3_store_access_key

  • s3_store_secret_key

s3_store_region_name
Type:

string

Default:

''

The S3 region name.

This parameter will set the region_name used by boto. If this parameter is not set, we we will try to compute it from the s3_store_host.

Possible values:

  • A valid region name

Related Options:

  • s3_store_host

s3_store_access_key
Type:

string

Default:

<None>

The S3 query token access key.

This configuration option takes the access key for authenticating with the Amazon S3 or S3 compatible storage server. This option is required when using the S3 storage backend.

Possible values:

  • Any string value that is the access key for a user with appropriate privileges

Related Options:

  • s3_store_host

  • s3_store_secret_key

s3_store_secret_key
Type:

string

Default:

<None>

The S3 query token secret key.

This configuration option takes the secret key for authenticating with the Amazon S3 or S3 compatible storage server. This option is required when using the S3 storage backend.

Possible values:

  • Any string value that is a secret key corresponding to the access key specified using the s3_store_host option

Related Options:

  • s3_store_host

  • s3_store_access_key

s3_store_bucket
Type:

string

Default:

<None>

The S3 bucket to be used to store the Glance data.

This configuration option specifies where the glance images will be stored in the S3. If s3_store_create_bucket_on_put is set to true, it will be created automatically even if the bucket does not exist.

Possible values:

  • Any string value

Related Options:

  • s3_store_create_bucket_on_put

  • s3_store_bucket_url_format

s3_store_create_bucket_on_put
Type:

boolean

Default:

False

Determine whether S3 should create a new bucket.

This configuration option takes boolean value to indicate whether Glance should create a new bucket to S3 if it does not exist.

Possible values:

  • Any Boolean value

Related Options:

  • None

s3_store_bucket_url_format
Type:

string

Default:

auto

The S3 calling format used to determine the object.

This configuration option takes access model that is used to specify the address of an object in an S3 bucket.

NOTE: In path-style, the endpoint for the object looks like ‘https://s3.amazonaws.com/bucket/example.img’. And in virtual-style, the endpoint for the object looks like ‘https://bucket.s3.amazonaws.com/example.img’. If you do not follow the DNS naming convention in the bucket name, you can get objects in the path style, but not in the virtual style.

Possible values:

  • Any string value of auto, virtual, or path

Related Options:

  • s3_store_bucket

s3_store_large_object_size
Type:

integer

Default:

100

What size, in MB, should S3 start chunking image files and do a multipart upload in S3.

This configuration option takes a threshold in MB to determine whether to upload the image to S3 as is or to split it (Multipart Upload).

Note: You can only split up to 10,000 images.

Possible values:

  • Any positive integer value

Related Options:

  • s3_store_large_object_chunk_size

  • s3_store_thread_pools

s3_store_large_object_chunk_size
Type:

integer

Default:

10

What multipart upload part size, in MB, should S3 use when uploading parts.

This configuration option takes the image split size in MB for Multipart Upload.

Note: You can only split up to 10,000 images.

Possible values:

  • Any positive integer value (must be greater than or equal to 5M)

Related Options:

  • s3_store_large_object_size

  • s3_store_thread_pools

s3_store_thread_pools
Type:

integer

Default:

10

The number of thread pools to perform a multipart upload in S3.

This configuration option takes the number of thread pools when performing a Multipart Upload.

Possible values:

  • Any positive integer value

Related Options:

  • s3_store_large_object_size

  • s3_store_large_object_chunk_size

swift_store_auth_insecure
Type:

boolean

Default:

False

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:

  • True

  • False

Related options:

  • swift_store_cacert

swift_store_cacert
Type:

string

Default:

/etc/ssl/certs/ca-certificates.crt

This option has a sample default set, which means that its actual default value may vary from the one documented above.

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:

  • A valid path to a CA file

Related options:

  • swift_store_auth_insecure

swift_store_region
Type:

string

Default:

RegionTwo

This option has a sample default set, which means that its actual default value may vary from the one documented above.

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 swift_store_region allows Glance to connect to Swift in the specified region as opposed to a single region connectivity.

This option can be configured for both single-tenant and multi-tenant storage.

NOTE: Setting the region with swift_store_region is tenant-specific and is necessary only if the tenant has multiple endpoints across different regions.

Possible values:

  • A string value representing a valid Swift region.

Related Options:

  • None

swift_store_endpoint
Type:

string

Default:

https://swift.openstack.example.org/v1/path_not_including_container_name

This option has a sample default set, which means that its actual default value may vary from the one documented above.

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 auth is used. Setting an endpoint with swift_store_endpoint overrides the storage URL and is used for Glance image storage.

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:

  • String value representing a valid URL path up to a Swift container

Related Options:

  • None

swift_store_endpoint_type
Type:

string

Default:

publicURL

Valid Values:

publicURL, adminURL, internalURL

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:

  • publicURL

  • adminURL

  • internalURL

Related options:

  • swift_store_endpoint

swift_store_service_type
Type:

string

Default:

object-store

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 object-store.

NOTE: If swift_store_auth_version is set to 2, the value for this configuration option needs to be object-store. If using a higher version of Keystone or a different auth scheme, this option may be modified.

Possible values:

  • A string representing a valid service type for Swift storage.

Related Options:

  • None

swift_store_container
Type:

string

Default:

glance

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 swift_store_multiple_containers_seed.

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 swift_store_multiple_containers_seed).

Example: if the seed is set to 3 and swift_store_container = glance, then an image with UUID fdae39a1-bac5-4238-aba4-69bcc726e848 would be placed in the container glance_fda. All dashes in the UUID are included when creating the container name but do not count toward the character limit, so when N=10 the container name would be glance_fdae39a1-ba.

Possible values:

  • If using single container, this configuration option can be any string that is a valid swift container name in Glance’s Swift account

  • If using multiple containers, this configuration option can be any string as long as it satisfies the container naming rules enforced by Swift. The value of swift_store_multiple_containers_seed should be taken into account as well.

Related options:

  • swift_store_multiple_containers_seed

  • swift_store_multi_tenant

  • swift_store_create_container_on_put

swift_store_large_object_size
Type:

integer

Default:

5120

Minimum Value:

1

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:

  • A positive integer that is less than or equal to the large object limit enforced by the Swift cluster in consideration.

Related options:

  • swift_store_large_object_chunk_size

swift_store_large_object_chunk_size
Type:

integer

Default:

200

Minimum Value:

1

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 swift_store_large_object_size for more detail.

For example: if swift_store_large_object_size is 5GB and swift_store_large_object_chunk_size is 1GB, an image of size 6.2GB will be segmented into 7 segments where the first six segments will be 1GB in size and the seventh segment will be 0.2GB.

Possible values:

  • A positive integer that is less than or equal to the large object limit enforced by Swift cluster in consideration.

Related options:

  • swift_store_large_object_size

swift_store_create_container_on_put
Type:

boolean

Default:

False

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:

  • True

  • False

Related options:

  • None

swift_store_multi_tenant
Type:

boolean

Default:

False

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:

  • True

  • False

Related options:

  • swift_store_config_file

swift_store_multiple_containers_seed
Type:

integer

Default:

0

Minimum Value:

0

Maximum Value:

32

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 swift_store_container for more detail on the naming convention. More detail about using multiple containers can be found at https://specs.openstack.org/openstack/glance-specs/specs/kilo/swift-store-multiple-containers.html

NOTE: This is used only when swift_store_multi_tenant is disabled.

Possible values:

  • A non-negative integer less than or equal to 32

Related options:

  • swift_store_container

  • swift_store_multi_tenant

  • swift_store_create_container_on_put

swift_store_admin_tenants
Type:

list

Default:

[]

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:

  • A comma separated list of strings representing UUIDs of Keystone projects/tenants

Related options:

  • None

swift_store_ssl_compression
Type:

boolean

Default:

True

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:

  • True

  • False

Related Options:

  • None

swift_store_retry_get_count
Type:

integer

Default:

0

Minimum Value:

0

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, swift_store_retry_get_count ensures that the download is attempted this many more times upon a download failure before sending an error message.

Possible values:

  • Zero

  • Positive integer value

Related Options:

  • None

swift_store_expire_soon_interval
Type:

integer

Default:

60

Minimum Value:

0

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:

  • Zero

  • Positive integer value

Related Options:

  • None

swift_store_use_trusts
Type:

boolean

Default:

True

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, swift_store_use_trusts is set to True``(use of trusts is enabled). If set to ``False, a user token is used for the Swift connection instead, eliminating the overhead of trust creation.

NOTE: This option is considered only when swift_store_multi_tenant is set to True

Possible values:

  • True

  • False

Related options:

  • swift_store_multi_tenant

swift_buffer_on_upload
Type:

boolean

Default:

False

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: (swift_store_large_object_chunk_size * workers * 1000)

Possible values:

  • True

  • False

Related options:

  • swift_upload_buffer_dir

default_swift_reference
Type:

string

Default:

ref1

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:

  • A valid string value

Related options:

  • None

swift_store_auth_version
Type:

string

Default:

2

Version of the authentication service to use. Valid versions are 2 and 3 for keystone and 1 (deprecated) for swauth and rackspace.

Warning

This option is deprecated for removal. Its value may be silently ignored in the future.

Reason:

The option ‘auth_version’ in the Swift back-end configuration file is used instead.

swift_store_auth_address
Type:

string

Default:

<None>

The address where the Swift authentication service is listening.

Warning

This option is deprecated for removal. Its value may be silently ignored in the future.

Reason:

The option ‘auth_address’ in the Swift back-end configuration file is used instead.

swift_store_user
Type:

string

Default:

<None>

The user to authenticate against the Swift authentication service.

Warning

This option is deprecated for removal. Its value may be silently ignored in the future.

Reason:

The option ‘user’ in the Swift back-end configuration file is set instead.

swift_store_key
Type:

string

Default:

<None>

Auth key for the user authenticating against the Swift authentication service.

Warning

This option is deprecated for removal. Its value may be silently ignored in the future.

Reason:

The option ‘key’ in the Swift back-end configuration file is used to set the authentication key instead.

swift_store_config_file
Type:

string

Default:

<None>

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 swift_store_multi_tenant to True.

Possible values:

  • String value representing an absolute path on the glance-api node

Related options:

  • swift_store_multi_tenant

swift_upload_buffer_dir
Type:

string

Default:

<None>

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 swift_buffer_on_upload is set to True.

  • This directory should be provisioned keeping in mind the swift_store_large_object_chunk_size and the maximum number of images that could be uploaded simultaneously by a given glance node.

Possible values:

  • String value representing an absolute directory path

Related options:

  • swift_buffer_on_upload

  • swift_store_large_object_chunk_size

vmware_server_host
Type:

host address

Default:

127.0.0.1

This option has a sample default set, which means that its actual default value may vary from the one documented above.

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:

  • A valid IPv4 or IPv6 address

  • A valid DNS name

Related options:

  • vmware_server_username

  • vmware_server_password

vmware_server_username
Type:

string

Default:

root

This option has a sample default set, which means that its actual default value may vary from the one documented above.

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:

  • Any string that is the username for a user with appropriate privileges

Related options:

  • vmware_server_host

  • vmware_server_password

vmware_server_password
Type:

string

Default:

vmware

This option has a sample default set, which means that its actual default value may vary from the one documented above.

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:

  • Any string that is a password corresponding to the username specified using the “vmware_server_username” option

Related options:

  • vmware_server_host

  • vmware_server_username

vmware_api_retry_count
Type:

integer

Default:

10

Minimum Value:

1

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:

  • Any positive integer value

Related options:

  • None

vmware_task_poll_interval
Type:

integer

Default:

5

Minimum Value:

1

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:

  • Any positive integer value

Related options:

  • None

vmware_store_image_dir
Type:

string

Default:

/openstack_glance

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:

  • Any string that is a valid path to a directory

Related options:

  • None

vmware_insecure
Type:

boolean

Default:

False

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:

  • True

  • False

Related options:

  • vmware_ca_file

Deprecated Variations

Group

Name

glance_store

vmware_api_insecure
vmware_ca_file
Type:

string

Default:

/etc/ssl/certs/ca-certificates.crt

This option has a sample default set, which means that its actual default value may vary from the one documented above.

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:

  • Any string that is a valid absolute path to a CA file

Related options:

  • vmware_insecure

vmware_datastores
Type:

multi-valued

Default:

''

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:

  • Any string of the format: <datacenter_path>:<datastore_name>:<optional_weight>

Related options:

  • None

healthcheck

path
Type:

string

Default:

/healthcheck

The path to respond to healtcheck requests on.

Warning

This option is deprecated for removal. Its value may be silently ignored in the future.

detailed
Type:

boolean

Default:

False

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.

backends
Type:

list

Default:

[]

Additional backends that can perform health checks and report that information back as part of a request.

allowed_source_ranges
Type:

list

Default:

[]

A list of network addresses to limit source ip allowed to access healthcheck information. Any request from ip outside of these network addresses are ignored.

ignore_proxied_requests
Type:

boolean

Default:

False

Ignore requests with proxy headers.

disable_by_file_path
Type:

string

Default:

<None>

Check the presence of a file to determine if an application is running on a port. Used by DisableByFileHealthcheck plugin.

disable_by_file_paths
Type:

list

Default:

[]

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.

enable_by_file_paths
Type:

list

Default:

[]

Check the presence of files. Used by EnableByFilesHealthcheck plugin.

k8s_vim

use_barbican
Type:

boolean

Default:

True

Use barbican to encrypt vim password if True, save vim credentials in local file system if False

key_manager

api_class
Type:

string

Default:

tacker.keymgr.barbican_key_manager.BarbicanKeyManager

The full class name of the key manager API class

barbican_endpoint
Type:

string

Default:

<None>

The endpoint for barbican API.

barbican_version
Type:

string

Default:

v1

The version for barbican API.

keystone_authtoken

www_authenticate_uri
Type:

string

Default:

<None>

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.

Deprecated Variations

Group

Name

keystone_authtoken

auth_uri
auth_uri
Type:

string

Default:

<None>

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.

Warning

This option is deprecated for removal since Queens. Its value may be silently ignored in the future.

Reason:

The auth_uri option is deprecated in favor of www_authenticate_uri and will be removed in the S release.

auth_version
Type:

string

Default:

<None>

API version of the Identity API endpoint.

interface
Type:

string

Default:

internal

Interface to use for the Identity API endpoint. Valid values are “public”, “internal” (default) or “admin”.

delay_auth_decision
Type:

boolean

Default:

False

Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components.

http_connect_timeout
Type:

integer

Default:

<None>

Request timeout value for communicating with Identity API server.

http_request_max_retries
Type:

integer

Default:

3

How many times are we trying to reconnect when communicating with Identity API Server.

cache
Type:

string

Default:

<None>

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 memcached_servers option instead.

certfile
Type:

string

Default:

<None>

Required if identity server requires client certificate

keyfile
Type:

string

Default:

<None>

Required if identity server requires client certificate

cafile
Type:

string

Default:

<None>

A PEM encoded Certificate Authority to use when verifying HTTPs connections. Defaults to system CAs.

insecure
Type:

boolean

Default:

False

Verify HTTPS connections.

region_name
Type:

string

Default:

<None>

The region in which the identity server can be found.

memcached_servers
Type:

list

Default:

<None>

Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process.

Deprecated Variations

Group

Name

keystone_authtoken

memcache_servers
token_cache_time
Type:

integer

Default:

300

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.

memcache_security_strategy
Type:

string

Default:

None

Valid Values:

None, MAC, ENCRYPT

(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.

memcache_secret_key
Type:

string

Default:

<None>

(Optional, mandatory if memcache_security_strategy is defined) This string is used for key derivation.

memcache_pool_dead_retry
Type:

integer

Default:

300

(Optional) Number of seconds memcached server is considered dead before it is tried again.

memcache_pool_maxsize
Type:

integer

Default:

10

(Optional) Maximum total number of open connections to every memcached server.

memcache_pool_socket_timeout
Type:

integer

Default:

3

(Optional) Socket timeout in seconds for communicating with a memcached server.

memcache_pool_unused_timeout
Type:

integer

Default:

60

(Optional) Number of seconds a connection to memcached is held unused in the pool before it is closed.

memcache_pool_conn_get_timeout
Type:

integer

Default:

10

(Optional) Number of seconds that an operation will wait to get a memcached client connection from the pool.

memcache_use_advanced_pool
Type:

boolean

Default:

True

(Optional) Use the advanced (eventlet safe) memcached client pool.

include_service_catalog
Type:

boolean

Default:

True

(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.

enforce_token_bind
Type:

string

Default:

permissive

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.

service_token_roles
Type:

list

Default:

['service']

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.

service_token_roles_required
Type:

boolean

Default:

False

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.

service_type
Type:

string

Default:

<None>

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.

auth_type
Type:

unknown type

Default:

<None>

Authentication type to load

Deprecated Variations

Group

Name

keystone_authtoken

auth_plugin
auth_section
Type:

unknown type

Default:

<None>

Config Section from which to load plugin specific options

user_domain_id
Type:

string

Default:

default

User Domain Id

project_domain_id
Type:

string

Default:

default

Project Domain Id

password
Type:

string

Default:

default

User Password

username
Type:

string

Default:

default

User Name

user_domain_name
Type:

string

Default:

Default

Use Domain Name

project_name
Type:

string

Default:

default

Project Name

project_domain_name
Type:

string

Default:

Default

Project Domain Name

auth_url
Type:

string

Default:

http://localhost/identity/v3

Keystone endpoint

kubernetes_vim

stack_retries
Type:

integer

Default:

100

Number of attempts to retry for stack creation/deletion

stack_retry_wait
Type:

integer

Default:

5

Wait time (in seconds) between consecutive stack create/delete retries

nfvo_vim

vim_drivers
Type:

list

Default:

['openstack', 'kubernetes']

VIM driver for launching VNFs

openstack_vim

stack_retries
Type:

integer

Default:

60

Number of attempts to retry for stack creation/deletion

stack_retry_wait
Type:

integer

Default:

10

Wait time (in seconds) between consecutive stack create/delete retries

flavor_extra_specs
Type:

dict

Default:

{}

Flavor Extra Specs

oslo_messaging_kafka

kafka_max_fetch_bytes
Type:

integer

Default:

1048576

Max fetch bytes of Kafka consumer

kafka_consumer_timeout
Type:

floating point

Default:

1.0

Default timeout(s) for Kafka consumers

pool_size
Type:

integer

Default:

10

Pool Size for Kafka Consumers

Warning

This option is deprecated for removal. Its value may be silently ignored in the future.

Reason:

Driver no longer uses connection pool.

conn_pool_min_size
Type:

integer

Default:

2

The pool size limit for connections expiration policy

Warning

This option is deprecated for removal. Its value may be silently ignored in the future.

Reason:

Driver no longer uses connection pool.

conn_pool_ttl
Type:

integer

Default:

1200

The time-to-live in sec of idle connections in the pool

Warning

This option is deprecated for removal. Its value may be silently ignored in the future.

Reason:

Driver no longer uses connection pool.

consumer_group
Type:

string

Default:

oslo_messaging_consumer

Group id for Kafka consumer. Consumers in one group will coordinate message consumption

producer_batch_timeout
Type:

floating point

Default:

0.0

Upper bound on the delay for KafkaProducer batching in seconds

producer_batch_size
Type:

integer

Default:

16384

Size of batch for the producer async send

compression_codec
Type:

string

Default:

none

Valid Values:

none, gzip, snappy, lz4, zstd

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

enable_auto_commit
Type:

boolean

Default:

False

Enable asynchronous consumer commits

max_poll_records
Type:

integer

Default:

500

The maximum number of records returned in a poll call

security_protocol
Type:

string

Default:

PLAINTEXT

Valid Values:

PLAINTEXT, SASL_PLAINTEXT, SSL, SASL_SSL

Protocol used to communicate with brokers

sasl_mechanism
Type:

string

Default:

PLAIN

Mechanism when security protocol is SASL

ssl_cafile
Type:

string

Default:

''

CA certificate PEM file used to verify the server certificate

ssl_client_cert_file
Type:

string

Default:

''

Client certificate PEM file used for authentication.

ssl_client_key_file
Type:

string

Default:

''

Client key PEM file used for authentication.

ssl_client_key_password
Type:

string

Default:

''

Client key password file used for authentication.

oslo_messaging_notifications

driver
Type:

multi-valued

Default:

''

The Drivers(s) to handle sending notifications. Possible values are messaging, messagingv2, routing, log, test, noop

Deprecated Variations

Group

Name

DEFAULT

notification_driver
transport_url
Type:

string

Default:

<None>

A URL representing the messaging driver to use for notifications. If not set, we fall back to the same configuration used for RPC.

Deprecated Variations

Group

Name

DEFAULT

notification_transport_url
topics
Type:

list

Default:

['notifications']

AMQP topic used for OpenStack notifications.

Deprecated Variations

Group

Name

rpc_notifier2

topics

DEFAULT

notification_topics
retry
Type:

integer

Default:

-1

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

oslo_messaging_rabbit

amqp_durable_queues
Type:

boolean

Default:

False

Use durable queues in AMQP. If rabbit_quorum_queue is enabled, queues will be durable and this value will be ignored.

amqp_auto_delete
Type:

boolean

Default:

False

Auto-delete queues in AMQP.

Deprecated Variations

Group

Name

DEFAULT

amqp_auto_delete
ssl
Type:

boolean

Default:

False

Connect over SSL.

Deprecated Variations

Group

Name

oslo_messaging_rabbit

rabbit_use_ssl
ssl_version
Type:

string

Default:

''

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.

Deprecated Variations

Group

Name

oslo_messaging_rabbit

kombu_ssl_version
ssl_key_file
Type:

string

Default:

''

SSL key file (valid only if SSL enabled).

Deprecated Variations

Group

Name

oslo_messaging_rabbit

kombu_ssl_keyfile
ssl_cert_file
Type:

string

Default:

''

SSL cert file (valid only if SSL enabled).

Deprecated Variations

Group

Name

oslo_messaging_rabbit

kombu_ssl_certfile
ssl_ca_file
Type:

string

Default:

''

SSL certification authority file (valid only if SSL enabled).

Deprecated Variations

Group

Name

oslo_messaging_rabbit

kombu_ssl_ca_certs
ssl_enforce_fips_mode
Type:

boolean

Default:

False

Global toggle for enforcing the OpenSSL FIPS mode. This feature requires Python support. This is available in Python 3.9 in all environments and may have been backported to older Python versions on select environments. If the Python executable used does not support OpenSSL FIPS mode, an exception will be raised.

heartbeat_in_pthread
Type:

boolean

Default:

False

(DEPRECATED) It is recommend not to use this option anymore. Run the health check heartbeat thread through a native python thread by default. If this option is equal to False then the health check heartbeat will inherit the execution model from the parent process. For example if the parent process has monkey patched the stdlib by using eventlet/greenlet then the heartbeat will be run through a green thread. This option should be set to True only for the wsgi services.

Warning

This option is deprecated for removal. Its value may be silently ignored in the future.

Reason:

The option is related to Eventlet which will be removed. In addition this has never worked as expected with services using eventlet for core service framework.

kombu_reconnect_delay
Type:

floating point

Default:

1.0

Minimum Value:

0.0

Maximum Value:

4.5

How long to wait (in seconds) before reconnecting in response to an AMQP consumer cancel notification.

Deprecated Variations

Group

Name

DEFAULT

kombu_reconnect_delay
kombu_compression
Type:

string

Default:

<None>

EXPERIMENTAL: Possible values are: gzip, bz2. If not set compression will not be used. This option may not be available in future versions.

kombu_missing_consumer_retry_timeout
Type:

integer

Default:

60

How long to wait a missing client before abandoning to send it its replies. This value should not be longer than rpc_response_timeout.

Deprecated Variations

Group

Name

oslo_messaging_rabbit

kombu_reconnect_timeout
kombu_failover_strategy
Type:

string

Default:

round-robin

Valid Values:

round-robin, shuffle

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.

rabbit_login_method
Type:

string

Default:

AMQPLAIN

Valid Values:

PLAIN, AMQPLAIN, EXTERNAL, RABBIT-CR-DEMO

The RabbitMQ login method.

Deprecated Variations

Group

Name

DEFAULT

rabbit_login_method
rabbit_retry_interval
Type:

integer

Default:

1

How frequently to retry connecting with RabbitMQ.

rabbit_retry_backoff
Type:

integer

Default:

2

How long to backoff for between retries when connecting to RabbitMQ.

Deprecated Variations

Group

Name

DEFAULT

rabbit_retry_backoff
rabbit_interval_max
Type:

integer

Default:

30

Maximum interval of RabbitMQ connection retries. Default is 30 seconds.

rabbit_ha_queues
Type:

boolean

Default:

False

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”}’ “

Deprecated Variations

Group

Name

DEFAULT

rabbit_ha_queues
rabbit_quorum_queue
Type:

boolean

Default:

False

Use quorum queues in RabbitMQ (x-queue-type: quorum). The quorum queue is a modern queue type for RabbitMQ implementing a durable, replicated FIFO queue based on the Raft consensus algorithm. It is available as of RabbitMQ 3.8.0. If set this option will conflict with the HA queues (rabbit_ha_queues) aka mirrored queues, in other words the HA queues should be disabled. Quorum queues are also durable by default so the amqp_durable_queues option is ignored when this option is enabled.

rabbit_transient_quorum_queue
Type:

boolean

Default:

False

Use quorum queues for transients queues in RabbitMQ. Enabling this option will then make sure those queues are also using quorum kind of rabbit queues, which are HA by default.

rabbit_quorum_delivery_limit
Type:

integer

Default:

0

Each time a message is redelivered to a consumer, a counter is incremented. Once the redelivery count exceeds the delivery limit the message gets dropped or dead-lettered (if a DLX exchange has been configured) Used only when rabbit_quorum_queue is enabled, Default 0 which means dont set a limit.

rabbit_quorum_max_memory_length
Type:

integer

Default:

0

By default all messages are maintained in memory if a quorum queue grows in length it can put memory pressure on a cluster. This option can limit the number of messages in the quorum queue. Used only when rabbit_quorum_queue is enabled, Default 0 which means dont set a limit.

Deprecated Variations

Group

Name

oslo_messaging_rabbit

rabbit_quroum_max_memory_length
rabbit_quorum_max_memory_bytes
Type:

integer

Default:

0

By default all messages are maintained in memory if a quorum queue grows in length it can put memory pressure on a cluster. This option can limit the number of memory bytes used by the quorum queue. Used only when rabbit_quorum_queue is enabled, Default 0 which means dont set a limit.

Deprecated Variations

Group

Name

oslo_messaging_rabbit

rabbit_quroum_max_memory_bytes
rabbit_transient_queues_ttl
Type:

integer

Default:

1800

Minimum Value:

0

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. Setting 0 as value will disable the x-expires. If doing so, make sure you have a rabbitmq policy to delete the queues or you deployment will create an infinite number of queue over time.In case rabbit_stream_fanout is set to True, this option will control data retention policy (x-max-age) for messages in the fanout queue rather then the queue duration itself. So the oldest data in the stream queue will be discarded from it once reaching TTL Setting to 0 will disable x-max-age for stream which make stream grow indefinitely filling up the diskspace

rabbit_qos_prefetch_count
Type:

integer

Default:

0

Specifies the number of messages to prefetch. Setting to zero allows unlimited messages.

heartbeat_timeout_threshold
Type:

integer

Default:

60

Number of seconds after which the Rabbit broker is considered down if heartbeat’s keep-alive fails (0 disables heartbeat).

heartbeat_rate
Type:

integer

Default:

3

How often times during the heartbeat_timeout_threshold we check the heartbeat.

direct_mandatory_flag
Type:

boolean

Default:

True

(DEPRECATED) 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.MessageUndeliverable exception will be used to loop for a timeout to lets a chance to sender to recover.This flag is deprecated and it will not be possible to deactivate this functionality anymore

Warning

This option is deprecated for removal. Its value may be silently ignored in the future.

Reason:

Mandatory flag no longer deactivable.

enable_cancel_on_failover
Type:

boolean

Default:

False

Enable x-cancel-on-ha-failover flag so that rabbitmq server will cancel and notify consumerswhen queue is down

use_queue_manager
Type:

boolean

Default:

False

Should we use consistant queue names or random ones

hostname
Type:

string

Default:

node1.example.com

This option has a sample default set, which means that its actual default value may vary from the one documented above.

Hostname used by queue manager. Defaults to the value returned by socket.gethostname().

processname
Type:

string

Default:

nova-api

This option has a sample default set, which means that its actual default value may vary from the one documented above.

Process name used by queue manager

rabbit_stream_fanout
Type:

boolean

Default:

False

Use stream queues in RabbitMQ (x-queue-type: stream). Streams are a new persistent and replicated data structure (“queue type”) in RabbitMQ which models an append-only log with non-destructive consumer semantics. It is available as of RabbitMQ 3.9.0. If set this option will replace all fanout queues with only one stream queue.

oslo_middleware

max_request_body_size
Type:

integer

Default:

114688

The maximum body size for each request, in bytes.

Deprecated Variations

Group

Name

DEFAULT

osapi_max_request_body_size

DEFAULT

max_request_body_size
enable_proxy_headers_parsing
Type:

boolean

Default:

False

Whether the application is behind a proxy or not. This determines if the middleware should parse the headers or not.

http_basic_auth_user_file
Type:

string

Default:

/etc/htpasswd

HTTP basic auth password file.

oslo_policy

enhanced_tacker_policy
Type:

boolean

Default:

False

Enable enhanced tacker policy

enforce_scope
Type:

boolean

Default:

False

This option controls whether or not to enforce scope when evaluating policies. If True, the scope of the token used in the request is compared to the scope_types of the policy being enforced. If the scopes do not match, an InvalidScope exception will be raised. If False, a message will be logged informing operators that policies are being invoked with mismatching scope.

Warning

This option is deprecated for removal. Its value may be silently ignored in the future.

Reason:

This configuration was added temporarily to facilitate a smooth transition to the new RBAC. OpenStack will always enforce scope checks. This configuration option is deprecated and will be removed in the 2025.2 cycle.

enforce_new_defaults
Type:

boolean

Default:

False

This option controls whether or not to use old deprecated defaults when evaluating policies. If True, the old deprecated defaults are not going to be evaluated. This means if any existing token is allowed for old defaults but is disallowed for new defaults, it will be disallowed. It is encouraged to enable this flag along with the enforce_scope flag so that you can get the benefits of new defaults and scope_type together. If False, the deprecated policy check string is logically OR’d with the new policy check string, allowing for a graceful upgrade experience between releases with new policies, which is the default behavior.

policy_file
Type:

string

Default:

policy.yaml

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.

policy_default_rule
Type:

string

Default:

default

Default rule. Enforced when a requested rule is not found.

policy_dirs
Type:

multi-valued

Default:

policy.d

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.

remote_content_type
Type:

string

Default:

application/x-www-form-urlencoded

Valid Values:

application/x-www-form-urlencoded, application/json

Content Type to send and receive data for REST based policy check

remote_ssl_verify_server_crt
Type:

boolean

Default:

False

server identity verification for REST based policy check

remote_ssl_ca_crt_file
Type:

string

Default:

<None>

Absolute path to ca cert file for REST based policy check

remote_ssl_client_crt_file
Type:

string

Default:

<None>

Absolute path to client cert for REST based policy check

remote_ssl_client_key_file
Type:

string

Default:

<None>

Absolute path client key file REST based policy check

remote_timeout
Type:

floating point

Default:

60

Minimum Value:

0

Timeout in seconds for REST based policy check

oslo_reports

log_dir
Type:

string

Default:

<None>

Path to a log directory where to create a file

file_event_handler
Type:

string

Default:

<None>

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.

file_event_handler_interval
Type:

integer

Default:

1

How many seconds to wait between polls when file_event_handler is set

prometheus_plugin

performance_management
Type:

boolean

Default:

False

Enable prometheus plugin performance management

reporting_period_margin
Type:

integer

Default:

1

Some margin time for PM jos’s reportingPeriod

fault_management
Type:

boolean

Default:

False

Enable prometheus plugin fault management

auto_healing
Type:

boolean

Default:

False

Enable prometheus plugin autohealing

auto_scaling
Type:

boolean

Default:

False

Enable prometheus plugin autoscaling

performance_management_package
Type:

string

Default:

tacker.sol_refactored.common.prometheus_plugin

Package name for performance management PMJob. This configuration is changed in case of replacing the original function with a vendor specific function.

performance_management_threshold_package
Type:

string

Default:

tacker.sol_refactored.common.prometheus_plugin

Package name for performance management threshold. This configuration is changed in case of replacing the original function with a vendor specific function.

performance_management_class
Type:

string

Default:

PrometheusPluginPm

Class name for performance management PMJob. This configuration is changed in case of replacing the original function with a vendor specific function.

performance_management_threshold_class
Type:

string

Default:

PrometheusPluginThreshold

Class name for performance management threshold. This configuration is changed in case of replacing the original function with a vendor specific function.

fault_management_package
Type:

string

Default:

tacker.sol_refactored.common.prometheus_plugin

Package name for fault management. This configuration is changed in case of replacing the original function with a vendor specific function.

fault_management_class
Type:

string

Default:

PrometheusPluginFm

Class name for fault management. This configuration is changed in case of replacing the original function with a vendor specific function.

auto_healing_package
Type:

string

Default:

tacker.sol_refactored.common.prometheus_plugin

Package name for auto healing. This configuration is changed in case of replacing the original function with a vendor specific function.

auto_healing_class
Type:

string

Default:

PrometheusPluginAutoHealing

Class name for auto healing. This configuration is changed in case of replacing the original function with a vendor specific function.

timer_interval
Type:

integer

Default:

20

Timeout (second) of packing for multiple auto healing.

auto_scaling_package
Type:

string

Default:

tacker.sol_refactored.common.prometheus_plugin

Package name for auto scaling. This configuration is changed in case of replacing the original function with a vendor specific function.

auto_scaling_class
Type:

string

Default:

PrometheusPluginAutoScaling

Class name for auto scaling. This configuration is changed in case of replacing the original function with a vendor specific function.

test_rule_with_promtool
Type:

boolean

Default:

False

Enable rule file validation using promtool.

reporting_period_threshold
Type:

integer

Default:

90

The time of reportingPeriod for the PM Threshold. If there is a PromQL that requires reporting_period, it is read from the configuration file. The unit shall be seconds.

collection_period_threshold
Type:

integer

Default:

30

The time of collectionPeriod for the PM threshold. If there is a PromQL that requires collection_period, it is read from the configuration file. The unit shall be seconds.

server_notification

server_notification
Type:

boolean

Default:

False

Enable server notification autohealing

uri_path_prefix
Type:

string

Default:

/server_notification

Uri path prefix string for server notification. When changing this configuration, server_notification description in api-paste.ini must be changed to the same value.

timer_interval
Type:

integer

Default:

20

Timeout (second) of packing for multiple server notification.

server_notification_package
Type:

string

Default:

tacker.sol_refactored.common.server_notification

Package name for server notification. This configuration is changed in case of replacing the original function with a vendor specific function.

server_notification_class
Type:

string

Default:

ServerNotification

Class name for server notification. This configuration is changed in case of replacing the original function with a vendor specific function.

tacker

vnflcm_infra_driver
Type:

list

Default:

['openstack', 'kubernetes']

Hosting vnf drivers tacker plugin will use

vnflcm_mgmt_driver
Type:

list

Default:

['vnflcm_noop']

MGMT driver to communicate with Hosting VNF/logical service instance tacker plugin will use

infra_driver
Type:

list

Default:

['noop', 'openstack', 'kubernetes']

Hosting vnf drivers tacker plugin will use

v2_nfvo

use_external_nfvo
Type:

boolean

Default:

False

Use external NFVO if True, use internal NFVO in tacker if False

grant_api_version
Type:

string

Default:

1.4.0

Grant api_version of NFVO.

vnfpkgm_api_version
Type:

string

Default:

2.1.0

Vnf package management api_version of NFVO.

endpoint
Type:

string

Default:

''

Endpoint of external NFVO.

token_endpoint
Type:

string

Default:

''

Token endpoint for OAuth2.0 authentication.

client_id
Type:

string

Default:

''

Client id used by OAuth2.0 authentication.

client_password
Type:

string

Default:

''

Client password used by OAuth2.0 authentication.

vnf_package_cache_dir
Type:

string

Default:

/opt/stack/data/tacker/vnf_package_cache

Vnf package content cache directory.

mtls_ca_cert_file
Type:

string

Default:

''

CA Certificate file used by OAuth2.0 mTLS authentication.

mtls_client_cert_file
Type:

string

Default:

''

Client Certificate file used by OAuth2.0 mTLS authentication.

test_callback_uri
Type:

boolean

Default:

True

Check to get notification from callback Uri.

test_grant_zone_list
Type:

list

Default:

['nova']

Zones used for test which returned in Grant response.

use_client_secret_basic
Type:

boolean

Default:

False

Use password authenticatiojn if True, use certificate authentication if False.

nfvo_verify_cert
Type:

boolean

Default:

False

Enable certificate verification during SSL/TLS communication to NFVO.

nfvo_ca_cert_file
Type:

string

Default:

''

Specifies the root CA certificate to use when thenfvo_verify_cert option is True.

v2_vnfm

endpoint
Type:

string

Default:

http://127.0.0.1:9890

Endpoint of VNFM (self).

default_graceful_termination_timeout
Type:

integer

Default:

10

Default timeout value (second) of GRACEFUL termination.

max_content_length
Type:

integer

Default:

1000000

Max content length for list APIs.

openstack_vim_stack_create_timeout
Type:

integer

Default:

20

Timeout (in minutes) of heat stack creation.

kubernetes_vim_rsc_wait_timeout
Type:

integer

Default:

500

Timeout (second) of k8s res creation.

vnf_instance_page_size
Type:

integer

Default:

0

Paged response size of the query result for VNF instances.

subscription_page_size
Type:

integer

Default:

0

Paged response size of the query result for Subscriptions.

lcm_op_occ_page_size
Type:

integer

Default:

0

Paged response size of the query result for VNF LCM operation occurrences.

notification_mtls_ca_cert_file
Type:

string

Default:

''

CA Certificate file used by OAuth2.0 mTLS authentication.

notification_mtls_client_cert_file
Type:

string

Default:

''

Client Certificate file used by OAuth2.0 mTLS authentication.

notify_connect_retries
Type:

integer

Default:

0

Number of retries that should be attempted for connection error when sending a notification. Period between retries is exponential starting 0.5 seconds up to a maximum of 60 seconds.

vnffm_alarm_page_size
Type:

integer

Default:

0

Paged response size of the query result for VNF Fault Management alarm.

vnfpm_pmthreshold_page_size
Type:

integer

Default:

0

Paged response size of the query result for VNF PM threshold.

vnfpm_pmjob_page_size
Type:

integer

Default:

0

Paged response size of the query result for VNF PM job.

placement_fallback_best_effort
Type:

boolean

Default:

False

If True, fallbackBestEffort setting is enabled and run Availability Zone reselection.

placement_az_select_retry
Type:

integer

Default:

0

Number of retries to reselect Availability Zone. Default value “0” means unlimited number of retries.

placement_az_resource_error
Type:

string

Default:

Resource CREATE failed: ResourceInError: resources\.(.*)\.(.*): (.*)|Resource UPDATE failed: resources\.(.*): Resource CREATE failed: ResourceInError: resources\.(.*): (.*)

Error message for Availability Zone reselection. These configs are regular expressions to detect error messages from OpenStack Heat.

enable_rollback_stack
Type:

boolean

Default:

False

If True, enable rollback stack on resource create failure.

test_enable_lcm_op_occ_delete
Type:

boolean

Default:

False

Enable to delete LCM operation occurrence if True. This is intended to use under development.

notification_verify_cert
Type:

boolean

Default:

False

Enable certificate verification during SSL/TLS communication to notification server.

notification_ca_cert_file
Type:

string

Default:

''

Specifies the root CA certificate to use when the notification_verify_cert option is True.

use_oauth2_mtls_for_heat
Type:

boolean

Default:

False

Enable OAuth2.0 mTLS authentication for heat server.

heat_mtls_ca_cert_file
Type:

string

Default:

''

CA Certificate file used by OAuth2.0 mTLS authentication.

heat_mtls_client_cert_file
Type:

string

Default:

''

Client Certificate file used by OAuth2.0 mTLS authentication.

heat_verify_cert
Type:

boolean

Default:

False

Enable certificate verification during SSL/TLS communication to heat server.

heat_ca_cert_file
Type:

string

Default:

''

Specifies the root CA certificate to use when the heat_verify_cert option is True.

tf_file_dir
Type:

string

Default:

/var/lib/tacker/terraform

Temporary directory for Terraform infra-driver to store terraform config files

nova_verify_cert
Type:

boolean

Default:

False

Enable certificate verification during SSL/TLS communication to nova server.

nova_ca_cert_file
Type:

string

Default:

''

Specifies the root CA certificate to use when the nova_verify_cert option is True.

vim_keys

openstack
Type:

string

Default:

/etc/tacker/vim/fernet_keys

Dir.path to store fernet keys.

use_barbican
Type:

boolean

Default:

False

Use barbican to encrypt vim password if True, save vim credentials in local file system if False

vnf_lcm

Vnflcm options group

endpoint_url
Type:

string

Default:

http://localhost:9890/

endpoint_url

subscription_num
Type:

integer

Default:

100

Number of subscriptions

retry_num
Type:

integer

Default:

3

Number of retry

retry_wait
Type:

integer

Default:

10

Retry interval (sec)

retry_timeout
Type:

integer

Default:

10

Retry timeout (sec)

test_callback_uri
Type:

boolean

Default:

True

Test callbackUri

operation_timeout
Type:

integer

Default:

60

LCM operation timeout (sec)

verify_notification_ssl
Type:

boolean

Default:

True

Verify the certificate to send notification by ssl

lcm_op_occ_num
Type:

integer

Default:

100

Number of lcm_op_occs contained in 1 page

vnf_instance_num
Type:

integer

Default:

100

Number of vnf_instances contained in 1 page

vnf_package

Options under this group are used to store vnf packages in glance store.

vnf_package_csar_path
Type:

string

Default:

/var/lib/tacker/vnfpackages/

Path to store extracted CSAR file

csar_file_size_cap
Type:

floating point

Default:

1024

Minimum Value:

1e-06

Maximum Value:

9223372036

Maximum size of CSAR file a user can upload in GB.

An CSAR file upload greater than the size mentioned here would result in an CSAR upload failure. This configuration option defaults to 1024 GB (1 TiB).

NOTES:

  • This value should only be increased after careful consideration and must be set less than or equal to 8 EiB (~9223372036).

  • This value must be set with careful consideration of the backend storage capacity. Setting this to a very low value may result in a large number of image failures. And, setting this to a very large value may result in faster consumption of storage. Hence, this must be set according to the nature of images created and storage capacity available.

Possible values:

  • Any positive number less than or equal to 9223372036854775808

hashing_algorithm
Type:

string

Default:

sha512

Secure hashing algorithm used for computing the ‘hash’ property.

Possible values:

  • sha256, sha512

Related options:

  • None

get_top_list
Type:

list

Default:

['tosca_definitions_version', 'description', 'metadata']

List of items to get from top-vnfd

exclude_node
Type:

list

Default:

['VNF']

Exclude node from node_template

get_lower_list
Type:

list

Default:

['tosca.nodes.nfv.VNF']

List of types to get from lower-vnfd

del_input_list
Type:

list

Default:

['descriptor_id', 'descriptor_versionprovider', 'product_name', 'software_version', 'vnfm_info', 'flavour_id', 'flavour_description']

List of del inputs from lower-vnfd

vnf_package_num
Type:

integer

Default:

100

Number of vnf_packages contained in 1 page