Trove Configuration Options¶
The following is an overview of all available configuration options in Trove. To see sample configuration file, see Trove Sample Configuration File.
DEFAULT¶
- pybasedir¶
- Type:
string
- Default:
/build/openstack-trove-Hy45Z4/openstack-trove-20.0.0/trove
Directory where the Trove python module is installed.
- public_endpoint¶
- Type:
string
- Default:
<None>
Public URL to use for versions endpoint. The default is None, which will use the request’s host_url attribute to populate the URL base. If Trove is operating behind a proxy, you will want to change this to represent the proxy’s URL.
- bind_host¶
- Type:
ip address
- Default:
0.0.0.0
IP address the API server will listen on.
- bind_port¶
- Type:
port number
- Default:
8779
- Minimum Value:
0
- Maximum Value:
65535
Port the API server will listen on.
- api_paste_config¶
- Type:
string
- Default:
api-paste.ini
File name for the paste.deploy config for trove-api.
- trove_volume_support¶
- Type:
boolean
- Default:
True
Whether to provision a Cinder volume for datadir.
- admin_roles¶
- Type:
list
- Default:
['admin']
Roles to add to an admin user.
- update_status_on_fail¶
- Type:
boolean
- Default:
True
Set the service and instance task statuses to ERROR when an instance fails to become active within the configured usage_timeout.
- nova_compute_url¶
- Type:
URI
- Default:
<None>
URL without the tenant segment.
- nova_compute_service_type¶
- Type:
string
- Default:
compute
Service type to use when searching catalog.
- nova_compute_endpoint_type¶
- Type:
string
- Default:
publicURL
Service endpoint type to use when searching catalog.
- nova_client_version¶
- Type:
string
- Default:
2.12
The version of the compute service client.
- glance_client_version¶
- Type:
string
- Default:
2
The version of the image service client.
- nova_api_insecure¶
- Type:
boolean
- Default:
False
Allow to perform insecure SSL requests to nova.
- nova_keypair¶
- Type:
string
- Default:
<None>
Name of a Nova keypair to inject into a database instance to enable SSH access. The keypair should be prior created by the cloud operator.
- neutron_url¶
- Type:
URI
- Default:
<None>
URL without the tenant segment.
- neutron_service_type¶
- Type:
string
- Default:
network
Service type to use when searching catalog.
- neutron_endpoint_type¶
- Type:
string
- Default:
publicURL
Service endpoint type to use when searching catalog.
- neutron_api_insecure¶
- Type:
boolean
- Default:
False
Allow to perform insecure SSL requests to neutron.
- cinder_url¶
- Type:
URI
- Default:
<None>
URL without the tenant segment.
- cinder_service_type¶
- Type:
string
- Default:
volumev3
Service type to use when searching catalog.
- cinder_endpoint_type¶
- Type:
string
- Default:
publicURL
Service endpoint type to use when searching catalog.
- cinder_api_insecure¶
- Type:
boolean
- Default:
False
Allow to perform insecure SSL requests to cinder.
- swift_url¶
- Type:
URI
- Default:
<None>
URL ending in
AUTH_
.
- swift_service_type¶
- Type:
string
- Default:
object-store
Service type to use when searching catalog.
- swift_endpoint_type¶
- Type:
string
- Default:
publicURL
Service endpoint type to use when searching catalog.
- swift_api_insecure¶
- Type:
boolean
- Default:
False
Allow to perform insecure SSL requests to swift.
- glance_url¶
- Type:
URI
- Default:
<None>
URL ending in
AUTH_
.
- glance_service_type¶
- Type:
string
- Default:
image
Service type to use when searching catalog.
- glance_endpoint_type¶
- Type:
string
- Default:
publicURL
Service endpoint type to use when searching catalog.
- taskmanager_manager¶
- Type:
string
- Default:
trove.taskmanager.manager.Manager
Driver for taskmanager
- trove_url¶
- Type:
string
- Default:
<None>
URL without the tenant segment.
- trove_service_type¶
- Type:
string
- Default:
database
Service type to use when searching catalog.
- trove_endpoint_type¶
- Type:
string
- Default:
publicURL
Service endpoint type to use when searching catalog.
- host¶
- Type:
ip address
- Default:
0.0.0.0
Host to listen for RPC messages.
- report_interval¶
- Type:
integer
- Default:
30
The interval (in seconds) which periodic tasks are run.
- trove_dns_support¶
- Type:
boolean
- Default:
False
Whether Trove should add DNS entries on create (using Designate DNSaaS).
- db_api_implementation¶
- Type:
string
- Default:
trove.db.sqlalchemy.api
API Implementation for Trove database access.
- dns_driver¶
- Type:
string
- Default:
trove.dns.driver.DnsDriver
Driver for DNSaaS.
- dns_instance_entry_factory¶
- Type:
string
- Default:
trove.dns.driver.DnsInstanceEntryFactory
Factory for adding DNS entries.
- dns_hostname¶
- Type:
hostname
- Default:
localhost
Hostname used for adding DNS entries.
- dns_account_id¶
- Type:
string
- Default:
''
Tenant ID for DNSaaS.
- dns_endpoint_url¶
- Type:
URI
- Default:
http://0.0.0.0
Endpoint URL for DNSaaS.
- dns_service_type¶
- Type:
string
- Default:
''
Service Type for DNSaaS.
- dns_region¶
- Type:
string
- Default:
''
Region name for DNSaaS.
- dns_auth_url¶
- Type:
URI
- Default:
http://0.0.0.0
Authentication URL for DNSaaS.
- dns_user_domain_id¶
- Type:
string
- Default:
default
Keystone user domain ID used for auth
- dns_project_domain_id¶
- Type:
string
- Default:
default
Keystone project domain ID used for auth
- dns_domain_name¶
- Type:
string
- Default:
''
Domain name used for adding DNS entries.
- dns_username¶
- Type:
string
- Default:
''
Username for DNSaaS.
- dns_passkey¶
- Type:
string
- Default:
''
Passkey for DNSaaS.
- dns_management_base_url¶
- Type:
URI
- Default:
http://0.0.0.0
Management URL for DNSaaS.
- dns_ttl¶
- Type:
integer
- Default:
300
Time (in seconds) before a refresh of DNS information occurs.
- dns_domain_id¶
- Type:
string
- Default:
''
Domain ID used for adding DNS entries.
- users_page_size¶
- Type:
integer
- Default:
20
Page size for listing users.
- databases_page_size¶
- Type:
integer
- Default:
20
Page size for listing databases.
- instances_page_size¶
- Type:
integer
- Default:
20
Page size for listing instances.
- clusters_page_size¶
- Type:
integer
- Default:
20
Page size for listing clusters.
- backups_page_size¶
- Type:
integer
- Default:
20
Page size for listing backups.
- configurations_page_size¶
- Type:
integer
- Default:
20
Page size for listing configurations.
- modules_page_size¶
- Type:
integer
- Default:
20
Page size for listing modules.
- agent_call_low_timeout¶
- Type:
integer
- Default:
15
Maximum time (in seconds) to wait for Guest Agent ‘quick’ requests (such as retrieving a list of users or databases).
- agent_call_high_timeout¶
- Type:
integer
- Default:
180
Maximum time (in seconds) to wait for Guest Agent ‘slow’ requests (such as restarting the database).
- agent_replication_snapshot_timeout¶
- Type:
integer
- Default:
1800
Maximum time (in seconds) to wait for taking a Guest Agent replication snapshot.
- command_process_timeout¶
- Type:
integer
- Default:
30
Maximum time (in seconds) to wait for out of process commands to complete.
- guest_id¶
- Type:
string
- Default:
<None>
ID of the Guest Instance.
- controller_address¶
- Type:
string
- Default:
<None>
The address used to download Trove code by guest agent in developer mode. This address is inserted into the file /etc/trove/controller.conf inside the guest.
- state_change_wait_time¶
- Type:
integer
- Default:
180
Maximum time (in seconds) to wait for database state change.
- state_change_poll_time¶
- Type:
integer
- Default:
3
Interval between state change poll requests (seconds).
- state_healthy_counts¶
- Type:
integer
- Default:
5
consecutive success db connections for status HEALTHY
- agent_heartbeat_time¶
- Type:
integer
- Default:
10
Maximum time (in seconds) for the Guest Agent to reply to a heartbeat request.
- agent_heartbeat_expiry¶
- Type:
integer
- Default:
90
Time (in seconds) after which a guest is considered unreachable
- num_tries¶
- Type:
integer
- Default:
3
Number of times to check if a volume exists.
- volume_fstype¶
- Type:
string
- Default:
ext3
- Valid Values:
ext3, ext4, xfs
File system type used to format a volume.
- cinder_volume_type¶
- Type:
string
- Default:
<None>
Volume type to use when provisioning a Cinder volume.
- format_options¶
- Type:
string
- Default:
-m 5
Options to use when formatting a volume.
- volume_format_timeout¶
- Type:
integer
- Default:
120
Maximum time (in seconds) to wait for a volume format.
- mount_options¶
- Type:
string
- Default:
defaults,noatime
Options to use when mounting a volume.
- max_instances_per_tenant¶
- Type:
integer
- Default:
10
Default maximum number of instances per tenant.
Deprecated Variations¶ Group
Name
DEFAULT
max_instances_per_user
- max_ram_per_tenant¶
- Type:
integer
- Default:
-1
Default maximum total amount of RAM in MB per tenant.
- max_accepted_volume_size¶
- Type:
integer
- Default:
10
Default maximum volume size (in GB) for an instance.
- max_volumes_per_tenant¶
- Type:
integer
- Default:
40
Default maximum volume capacity (in GB) spanning across all Trove volumes per tenant.
Deprecated Variations¶ Group
Name
DEFAULT
max_volumes_per_user
- max_backups_per_tenant¶
- Type:
integer
- Default:
50
Default maximum number of backups created by a tenant.
Deprecated Variations¶ Group
Name
DEFAULT
max_backups_per_user
- quota_driver¶
- Type:
string
- Default:
trove.quota.quota.DbQuotaDriver
Default driver to use for quota checks.
- taskmanager_queue¶
- Type:
string
- Default:
taskmanager
Message queue name the Taskmanager will listen to.
- conductor_queue¶
- Type:
string
- Default:
trove-conductor
Message queue name the Conductor will listen on.
- trove_conductor_workers¶
- Type:
integer
- Default:
<None>
Number of workers for the Conductor service. The default will be the number of CPUs available.
- use_nova_server_config_drive¶
- Type:
boolean
- Default:
False
Use config drive for file injection when booting instance.
- device_path¶
- Type:
string
- Default:
/dev/vdb
Device path for volume if volume support is enabled.
- default_datastore¶
- Type:
string
- Default:
<None>
The default datastore id or name to use if one is not provided by the user. If the default value is None, the field becomes required in the instance create request.
- datastore_manager¶
- Type:
string
- Default:
<None>
Manager class in the Guest Agent, set up by the Taskmanager on instance provision.
- datastore_version¶
- Type:
string
- Default:
<None>
The guest datastore version that is set by the Taskmanager during instance provision.
- block_device_mapping¶
- Type:
string
- Default:
vdb
Block device to map onto the created instance.
- server_delete_time_out¶
- Type:
integer
- Default:
60
Maximum time (in seconds) to wait for a server delete.
- volume_time_out¶
- Type:
integer
- Default:
60
Maximum time (in seconds) to wait for a volume attach.
- reboot_time_out¶
- Type:
integer
- Default:
120
Maximum time (in seconds) to wait for a server reboot.
- dns_time_out¶
- Type:
integer
- Default:
120
Maximum time (in seconds) to wait for a DNS entry add.
- resize_time_out¶
- Type:
integer
- Default:
900
Maximum time (in seconds) to wait for a server resize.
- revert_time_out¶
- Type:
integer
- Default:
600
Maximum time (in seconds) to wait for a server resize revert.
- cluster_delete_time_out¶
- Type:
integer
- Default:
180
Maximum time (in seconds) to wait for a cluster delete.
- root_grant¶
- Type:
list
- Default:
['ALL']
Permissions to grant to the ‘root’ user.
- root_grant_option¶
- Type:
boolean
- Default:
True
Assign the ‘root’ user GRANT permissions.
- http_get_rate¶
- Type:
integer
- Default:
200
Maximum number of HTTP ‘GET’ requests (per minute).
- http_post_rate¶
- Type:
integer
- Default:
200
Maximum number of HTTP ‘POST’ requests (per minute).
- http_delete_rate¶
- Type:
integer
- Default:
200
Maximum number of HTTP ‘DELETE’ requests (per minute).
- http_put_rate¶
- Type:
integer
- Default:
200
Maximum number of HTTP ‘PUT’ requests (per minute).
- http_mgmt_post_rate¶
- Type:
integer
- Default:
200
Maximum number of management HTTP ‘POST’ requests (per minute).
- hostname_require_valid_ip¶
- Type:
boolean
- Default:
True
Require user hostnames to be valid IP addresses.
Deprecated Variations¶ Group
Name
DEFAULT
hostname_require_ipv4
- trove_security_groups_support¶
- Type:
boolean
- Default:
True
Whether Trove should add Security Groups on create.
- trove_security_group_name_prefix¶
- Type:
string
- Default:
trove_sg
Prefix to use when creating Security Groups.
- trove_security_group_rule_cidr¶
- Type:
string
- Default:
0.0.0.0/0
CIDR to use when creating Security Group Rules.
- trove_api_workers¶
- Type:
integer
- Default:
<None>
Number of workers for the API service. The default will be the number of CPUs available.
- usage_sleep_time¶
- Type:
integer
- Default:
5
Time to sleep during the check for an active Guest.
- region¶
- Type:
string
- Default:
LOCAL_DEV
The region this service is located.
- backup_runner¶
- Type:
string
- Default:
trove.guestagent.backup.backup_types.InnoBackupEx
Runner to use for backups.
Warning
This option is deprecated for removal. Its value may be silently ignored in the future.
- backup_runner_options¶
- Type:
dict
- Default:
{}
Additional options to be passed to the backup runner.
Warning
This option is deprecated for removal. Its value may be silently ignored in the future.
- verify_swift_checksum_on_restore¶
- Type:
boolean
- Default:
True
Enable verification of Swift checksum before starting restore. Makes sure the checksum of original backup matches the checksum of the Swift backup file.
- verify_replica_volume_size¶
- Type:
boolean
- Default:
True
Require the replica volume size to be greater than or equal to the size of the master volume during replica creation.
- storage_strategy¶
- Type:
string
- Default:
swift
Default strategy to store backups.
- storage_namespace¶
- Type:
string
- Default:
trove.common.strategies.storage.swift
Namespace to load the default storage strategy from.
Warning
This option is deprecated for removal. Its value may be silently ignored in the future.
- backup_swift_container¶
- Type:
string
- Default:
database_backups
Swift container to put backups in.
- backup_use_gzip_compression¶
- Type:
boolean
- Default:
True
Compress backups using gzip.
Warning
This option is deprecated for removal since V. Its value may be silently ignored in the future.
- Reason:
Backup data compression is enabled by default. This option is ignored.
- backup_use_openssl_encryption¶
- Type:
boolean
- Default:
True
Encrypt backups using OpenSSL.
Warning
This option is deprecated for removal since V. Its value may be silently ignored in the future.
- Reason:
Trove should not encrypt backup data on behalf of the user. This option is ignored.
- backup_aes_cbc_key¶
- Type:
string
- Default:
''
Default OpenSSL aes_cbc key for decrypting backup data created prior to Victoria.
Warning
This option is deprecated for removal since V. Its value may be silently ignored in the future.
- Reason:
This option is only for backward compatibility. Backups created after Victoria are not encrypted any more.
- backup_use_snet¶
- Type:
boolean
- Default:
False
Send backup files over snet.
Warning
This option is deprecated for removal since V. Its value may be silently ignored in the future.
- Reason:
This option is not supported any more.
- backup_chunk_size¶
- Type:
integer
- Default:
65536
Chunk size (in bytes) to stream to the Swift container. This should be in multiples of 128 bytes, since this is the size of an md5 digest block allowing the process to update the file checksum during streaming. See: http://stackoverflow.com/questions/1131220/
- backup_segment_max_size¶
- Type:
integer
- Default:
2147483648
Maximum size (in bytes) of each segment of the backup file.
- remote_dns_client¶
- Type:
string
- Default:
trove.common.clients.dns_client
Client to send DNS calls to.
- remote_guest_client¶
- Type:
string
- Default:
trove.common.clients.guest_client
Client to send Guest Agent calls to.
- remote_nova_client¶
- Type:
string
- Default:
trove.common.clients_admin.nova_client_trove_admin
Client to send Nova calls to.
- remote_neutron_client¶
- Type:
string
- Default:
trove.common.clients_admin.neutron_client_trove_admin
Client to send Neutron calls to.
- remote_cinder_client¶
- Type:
string
- Default:
trove.common.clients_admin.cinder_client_trove_admin
Client to send Cinder calls to.
- remote_swift_client¶
- Type:
string
- Default:
trove.common.clients.swift_client
Client to send Swift calls to.
- remote_trove_client¶
- Type:
string
- Default:
trove.common.trove_remote.trove_client
Client to send Trove calls to.
- remote_glance_client¶
- Type:
string
- Default:
trove.common.clients_admin.glance_client_trove_admin
Client to send Glance calls to.
- exists_notification_transformer¶
- Type:
string
- Default:
<None>
Transformer for exists notifications.
- exists_notification_interval¶
- Type:
integer
- Default:
3600
Seconds to wait between pushing events.
- quota_notification_interval¶
- Type:
integer
- Default:
<None>
Seconds to wait between pushing events.
- notification_service_id¶
- Type:
dict
- Default:
{'mysql': '2f3ff068-2bfb-4f70-9a9d-a6bb65bc084b', 'percona': 'fd1723f5-68d2-409c-994f-a4a197892a17', 'pxc': '75a628c3-f81b-4ffb-b10a-4087c26bc854', 'redis': 'b216ffc5-1947-456c-a4cf-70f94c05f7d0', 'cassandra': '459a230d-4e97-4344-9067-2a54a310b0ed', 'couchbase': 'fa62fe68-74d9-4779-a24e-36f19602c415', 'mongodb': 'c8c907af-7375-456f-b929-b637ff9209ee', 'postgresql': 'ac277e0d-4f21-40aa-b347-1ea31e571720', 'couchdb': 'f0a9ab7b-66f7-4352-93d7-071521d44c7c', 'vertica': 'a8d805ae-a3b2-c4fd-gb23-b62cee5201ae', 'db2': 'e040cd37-263d-4869-aaa6-c62aa97523b5', 'mariadb': '7a4f82cc-10d2-4bc6-aadc-d9aacc2a3cb5'}
Unique ID to tag notification events.
- network_label_regex¶
- Type:
string
- Default:
^private$
Regular expression to match Trove network labels.
Warning
This option is deprecated for removal. Its value may be silently ignored in the future.
- ip_regex¶
- Type:
string
- Default:
<None>
List IP addresses that match this regular expression.
- black_list_regex¶
- Type:
string
- Default:
<None>
Exclude IP addresses that match this regular expression.
- cloudinit_location¶
- Type:
string
- Default:
/etc/trove/cloudinit
Path to folder with cloudinit scripts.
- injected_config_location¶
- Type:
string
- Default:
/etc/trove/conf.d
Path to folder on the Guest where config files will be injected during instance creation.
- injected_config_owner¶
- Type:
string
- Default:
ubuntu
Owner of the Guest Agent directory and files to be injected during instance creation.
- injected_config_group¶
- Type:
string
- Default:
root
Group of the Guest Agent directory and files to be injected during instance creation.
- guest_config¶
- Type:
string
- Default:
/etc/trove/trove-guestagent.conf
Path to the Guest Agent config file to be injected during instance creation.
- guest_info¶
- Type:
string
- Default:
guest_info.conf
The guest info filename found in the injected config location. If a full path is specified then it will be used as the path to the guest info file
- datastore_registry_ext¶
- Type:
dict
- Default:
{}
Extension for default datastore managers. Allows the use of custom managers for each of the datastores supported by Trove.
- docker_bridge_network_ip¶
- Type:
string
- Default:
<None>
Docker bridge network IP.
- docker_insecure_registries¶
- Type:
list
- Default:
[]
Docker insecure registries for image development.
- template_path¶
- Type:
string
- Default:
/etc/trove/templates/
Path which leads to datastore templates.
- sql_query_logging¶
- Type:
boolean
- Default:
False
Allow insecure logging while executing queries through SQLAlchemy.
- expected_filetype_suffixes¶
- Type:
list
- Default:
['json']
Filetype endings not to be reattached to an ID by the utils method correct_id_with_req.
- management_networks¶
- Type:
list
- Default:
[]
List of IDs for management networks which should be attached to the instance regardless of what NICs are specified in the create API call. Currently only one management network is allowed.
Deprecated Variations¶ Group
Name
DEFAULT
default_neutron_networks
- management_security_groups¶
- Type:
list
- Default:
[]
List of the security group IDs that are applied on the management port of the database instance.
- max_header_line¶
- Type:
integer
- Default:
16384
Maximum line size of message headers to be accepted. max_header_line may need to be increased when using large tokens (typically those generated by the Keystone v3 API with big service catalogs).
- conductor_manager¶
- Type:
string
- Default:
trove.conductor.manager.Manager
Qualified class name to use for conductor manager.
- network_driver¶
- Type:
string
- Default:
trove.network.nova.NovaNetwork
Describes the actual network manager used for the management of network attributes (security groups, floating IPs, etc.).
- usage_timeout¶
- Type:
integer
- Default:
1800
Maximum time (in seconds) to wait for a Guest to become active.
- restore_usage_timeout¶
- Type:
integer
- Default:
3600
Maximum time (in seconds) to wait for a Guest instance restored from a backup to become active.
- cluster_usage_timeout¶
- Type:
integer
- Default:
36000
Maximum time (in seconds) to wait for a cluster to become active.
- module_aes_cbc_key¶
- Type:
string
- Default:
module_aes_cbc_key
OpenSSL aes_cbc key for module encryption.
- module_types¶
- Type:
list
- Default:
['ping', 'new_relic_license']
A list of module types supported. A module type corresponds to the name of a ModuleDriver.
- module_reapply_max_batch_size¶
- Type:
integer
- Default:
50
The maximum number of instances to reapply a module to at the same time.
- module_reapply_min_batch_delay¶
- Type:
integer
- Default:
2
The minimum delay (in seconds) between subsequent module batch reapply executions.
- guest_log_container_name¶
- Type:
string
- Default:
database_logs
Name of container that stores guest log components.
- guest_log_limit¶
- Type:
integer
- Default:
1000000
Maximum size of a chunk saved in guest log container.
- guest_log_expiry¶
- Type:
integer
- Default:
2592000
Expiry (in seconds) of objects in guest log container.
- enable_secure_rpc_messaging¶
- Type:
boolean
- Default:
True
Should RPC messaging traffic be secured by encryption.
- taskmanager_rpc_encr_key¶
- Type:
string
- Default:
bzH6y0SGmjuoY0FNSTptrhgieGXNDX6PIhvz
Key (OpenSSL aes_cbc) for taskmanager RPC encryption.
- inst_rpc_key_encr_key¶
- Type:
string
- Default:
emYjgHFqfXNB1NGehAFIUeoyw4V4XwWHEaKP
Key (OpenSSL aes_cbc) to encrypt instance keys in DB.
- instance_rpc_encr_key¶
- Type:
string
- Default:
<None>
Key (OpenSSL aes_cbc) for instance RPC encryption.
- database_service_uid¶
- Type:
string
- Default:
1001
The UID(GID) of database service user.
- reserved_network_cidrs¶
- Type:
list
- Default:
[]
Network CIDRs reserved for Trove guest instance management.
- online_volume_resize¶
- Type:
boolean
- Default:
True
If online volume resize is supported.
- enable_volume_az¶
- Type:
boolean
- Default:
False
If true create the volume in the same availability-zone as the instance
- 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.
- 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.
- 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
Log level name used by rate limiting: CRITICAL, ERROR, INFO, WARNING, DEBUG or empty string. Logs with level greater or equal to rate_limit_except_level are not filtered. An empty string means that all levels are filtered.
- fatal_deprecations¶
- Type:
boolean
- Default:
False
Enables or disables fatal status of deprecations.
- 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:
openstack
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
cache¶
- config_prefix¶
- Type:
string
- Default:
cache.oslo
Prefix for building the configuration dictionary for the cache region. This should not need to be changed unless there is another dogpile.cache region with the same configuration name.
- expiration_time¶
- Type:
integer
- Default:
600
Default TTL, in seconds, for any cached item in the dogpile.cache region. This applies to any cached method that doesn’t have an explicit cache expiration time defined for it.
- backend¶
- Type:
string
- Default:
dogpile.cache.null
- Valid Values:
oslo_cache.memcache_pool, oslo_cache.dict, oslo_cache.mongo, oslo_cache.etcd3gw, dogpile.cache.pymemcache, dogpile.cache.memcached, dogpile.cache.pylibmc, dogpile.cache.bmemcached, dogpile.cache.dbm, dogpile.cache.redis, dogpile.cache.memory, dogpile.cache.memory_pickle, dogpile.cache.null
Cache backend module. For eventlet-based or environments with hundreds of threaded servers, Memcache with pooling (oslo_cache.memcache_pool) is recommended. For environments with less than 100 threaded servers, Memcached (dogpile.cache.memcached) or Redis (dogpile.cache.redis) is recommended. Test environments with a single instance of the server can use the dogpile.cache.memory backend.
- backend_argument¶
- Type:
multi-valued
- Default:
''
Arguments supplied to the backend module. Specify this option once per argument to be passed to the dogpile.cache backend. Example format: “<argname>:<value>”.
- proxies¶
- Type:
list
- Default:
[]
Proxy classes to import that will affect the way the dogpile.cache backend functions. See the dogpile.cache documentation on changing-backend-behavior.
- enabled¶
- Type:
boolean
- Default:
False
Global toggle for caching.
- debug_cache_backend¶
- Type:
boolean
- Default:
False
Extra debugging from the cache backend (cache keys, get/set/delete/etc calls). This is only really useful if you need to see the specific cache-backend get/set/delete calls with the keys/values. Typically this should be left set to false.
- memcache_servers¶
- Type:
list
- Default:
['localhost:11211']
Memcache servers in the format of “host:port”. This is used by backends dependent on Memcached.If
dogpile.cache.memcached
oroslo_cache.memcache_pool
is used and a given host refer to an IPv6 or a given domain refer to IPv6 then you should prefix the given address withthe address family (inet6
) (e.ginet6[::1]:11211
,inet6:[fd12:3456:789a:1::1]:11211
,inet6:[controller-0.internalapi]:11211
). If the address family is not given then these backends will use the defaultinet
address family which corresponds to IPv4
- memcache_dead_retry¶
- Type:
integer
- Default:
300
Number of seconds memcached server is considered dead before it is tried again. (dogpile.cache.memcache and oslo_cache.memcache_pool backends only).
- memcache_socket_timeout¶
- Type:
floating point
- Default:
1.0
Timeout in seconds for every call to a server. (dogpile.cache.memcache and oslo_cache.memcache_pool backends only).
- memcache_pool_maxsize¶
- Type:
integer
- Default:
10
Max total number of open connections to every memcached server. (oslo_cache.memcache_pool backend only).
- memcache_pool_unused_timeout¶
- Type:
integer
- Default:
60
Number of seconds a connection to memcached is held unused in the pool before it is closed. (oslo_cache.memcache_pool backend only).
- memcache_pool_connection_get_timeout¶
- Type:
integer
- Default:
10
Number of seconds that an operation will wait to get a memcache client connection.
- memcache_pool_flush_on_reconnect¶
- Type:
boolean
- Default:
False
Global toggle if memcache will be flushed on reconnect. (oslo_cache.memcache_pool backend only).
- memcache_sasl_enabled¶
- Type:
boolean
- Default:
False
Enable the SASL(Simple Authentication and SecurityLayer) if the SASL_enable is true, else disable.
- memcache_username¶
- Type:
string
- Default:
''
the user name for the memcached which SASL enabled
- memcache_password¶
- Type:
string
- Default:
''
the password for the memcached which SASL enabled
- tls_enabled¶
- Type:
boolean
- Default:
False
Global toggle for TLS usage when comunicating with the caching servers.
- tls_cafile¶
- Type:
string
- Default:
<None>
Path to a file of concatenated CA certificates in PEM format necessary to establish the caching servers’ authenticity. If tls_enabled is False, this option is ignored.
- tls_certfile¶
- Type:
string
- Default:
<None>
Path to a single file in PEM format containing the client’s certificate as well as any number of CA certificates needed to establish the certificate’s authenticity. This file is only required when client side authentication is necessary. If tls_enabled is False, this option is ignored.
- tls_keyfile¶
- Type:
string
- Default:
<None>
Path to a single file containing the client’s private key in. Otherwise the private key will be taken from the file specified in tls_certfile. If tls_enabled is False, this option is ignored.
- tls_allowed_ciphers¶
- Type:
string
- Default:
<None>
Set the available ciphers for sockets created with the TLS context. It should be a string in the OpenSSL cipher list format. If not specified, all OpenSSL enabled ciphers will be available.
- enable_socket_keepalive¶
- Type:
boolean
- Default:
False
Global toggle for the socket keepalive of dogpile’s pymemcache backend
- socket_keepalive_idle¶
- Type:
integer
- Default:
1
- Minimum Value:
0
The time (in seconds) the connection needs to remain idle before TCP starts sending keepalive probes. Should be a positive integer most greater than zero.
- socket_keepalive_interval¶
- Type:
integer
- Default:
1
- Minimum Value:
0
The time (in seconds) between individual keepalive probes. Should be a positive integer greater than zero.
- socket_keepalive_count¶
- Type:
integer
- Default:
1
- Minimum Value:
0
The maximum number of keepalive probes TCP should send before dropping the connection. Should be a positive integer greater than zero.
- enable_retry_client¶
- Type:
boolean
- Default:
False
Enable retry client mechanisms to handle failure. Those mechanisms can be used to wrap all kind of pymemcache clients. The wrapper allows you to define how many attempts to make and how long to wait between attemots.
- retry_attempts¶
- Type:
integer
- Default:
2
- Minimum Value:
1
Number of times to attempt an action before failing.
- retry_delay¶
- Type:
floating point
- Default:
0
Number of seconds to sleep between each attempt.
- hashclient_retry_attempts¶
- Type:
integer
- Default:
2
- Minimum Value:
1
Amount of times a client should be tried before it is marked dead and removed from the pool in the HashClient’s internal mechanisms.
- hashclient_retry_delay¶
- Type:
floating point
- Default:
1
Time in seconds that should pass between retry attempts in the HashClient’s internal mechanisms.
- dead_timeout¶
- Type:
floating point
- Default:
60
Time in seconds before attempting to add a node back in the pool in the HashClient’s internal mechanisms.
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¶
- connection¶
- Type:
string
- Default:
sqlite:///trove_test.sqlite
SQL Connection.
Deprecated Variations¶ Group
Name
DEFAULT
sql_connection
- connection_recycle_time¶
- Type:
integer
- Default:
3600
- query_log¶
- Type:
boolean
- Default:
False
Deprecated Variations¶ Group
Name
DEFAULT
sql_query_log
Warning
This option is deprecated for removal. Its value may be silently ignored in the future.
- sqlite_synchronous¶
- Type:
boolean
- Default:
True
If True, SQLite uses synchronous mode.
- slave_connection¶
- Type:
string
- Default:
<None>
The SQLAlchemy 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=
- max_pool_size¶
- Type:
integer
- Default:
<None>
Maximum number of SQL connections to keep open in a pool.
- 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:
<None>
If set, use this value for max_overflow with SQLAlchemy.
- connection_debug¶
- Type:
integer
- Default:
0
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.
guest_agent¶
Config options used by guest agent.
- container_registry¶
- Type:
string
- Default:
<None>
URL to the registry. E.g. https://index.docker.io/v1/
- container_registry_username¶
- Type:
string
- Default:
<None>
The registry username.
- container_registry_password¶
- Type:
string
- Default:
<None>
The plaintext registry password.
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.
- 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.
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_admin_prefix¶
- Type:
string
- Default:
''
Prefix to prepend at the beginning of the path. Deprecated, use identity_uri.
- auth_host¶
- Type:
string
- Default:
127.0.0.1
Host providing the admin Identity API endpoint. Deprecated, use identity_uri.
- auth_port¶
- Type:
integer
- Default:
35357
Port of the admin Identity API endpoint. Deprecated, use identity_uri.
- auth_protocol¶
- Type:
string
- Default:
https
- Valid Values:
http, https
Protocol of the admin Identity API endpoint. Deprecated, use identity_uri.
- identity_uri¶
- Type:
string
- Default:
<None>
Complete admin Identity API endpoint. This should specify the unversioned root endpoint e.g. https://localhost:35357/
- admin_token¶
- Type:
string
- Default:
<None>
This option is deprecated and may be removed in a future release. Single shared secret with the Keystone configuration used for bootstrapping a Keystone installation, or otherwise bypassing the normal authentication process. This option should not be used, use admin_user and admin_password instead.
- admin_user¶
- Type:
string
- Default:
<None>
Service username.
- admin_password¶
- Type:
string
- Default:
<None>
Service user password.
- admin_tenant_name¶
- Type:
string
- Default:
admin
Service tenant name.
- 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
- auth_url¶
- Type:
unknown type
- Default:
<None>
Authentication URL
- system_scope¶
- Type:
unknown type
- Default:
<None>
Scope for system operations
- domain_id¶
- Type:
unknown type
- Default:
<None>
Domain ID to scope to
- domain_name¶
- Type:
unknown type
- Default:
<None>
Domain name to scope to
- project_id¶
- Type:
unknown type
- Default:
<None>
Project ID to scope to
Deprecated Variations¶ Group
Name
keystone_authtoken
tenant-id
keystone_authtoken
tenant_id
- project_name¶
- Type:
unknown type
- Default:
<None>
Project name to scope to
Deprecated Variations¶ Group
Name
keystone_authtoken
tenant-name
keystone_authtoken
tenant_name
- project_domain_id¶
- Type:
unknown type
- Default:
<None>
Domain ID containing project
- project_domain_name¶
- Type:
unknown type
- Default:
<None>
Domain name containing project
- trust_id¶
- Type:
unknown type
- Default:
<None>
ID of the trust to use as a trustee use
- default_domain_id¶
- Type:
unknown type
- Default:
<None>
Optional domain ID to use with v3 and v2 parameters. It will be used for both the user and project domain in v3 and ignored in v2 authentication.
- default_domain_name¶
- Type:
unknown type
- Default:
<None>
Optional domain name to use with v3 API and v2 parameters. It will be used for both the user and project domain in v3 and ignored in v2 authentication.
- user_id¶
- Type:
unknown type
- Default:
<None>
User id
- username¶
- Type:
unknown type
- Default:
<None>
Username
Deprecated Variations¶ Group
Name
keystone_authtoken
user-name
keystone_authtoken
user_name
- user_domain_id¶
- Type:
unknown type
- Default:
<None>
User’s domain id
- user_domain_name¶
- Type:
unknown type
- Default:
<None>
User’s domain name
- password¶
- Type:
unknown type
- Default:
<None>
User’s password
mariadb¶
Oslo option group designed for MariaDB datastore
- icmp¶
- Type:
boolean
- Default:
False
Whether to permit ICMP.
Warning
This option is deprecated for removal. Its value may be silently ignored in the future.
- tcp_ports¶
- Type:
list
- Default:
['3306', '4444', '4567', '4568']
List of TCP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True).
- udp_ports¶
- Type:
list
- Default:
[]
List of UDP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True).
- backup_strategy¶
- Type:
string
- Default:
mariabackup
Default strategy to perform backups.
Deprecated Variations¶ Group
Name
DEFAULT
backup_strategy
- replication_strategy¶
- Type:
string
- Default:
MariaDBGTIDReplication
Default strategy for replication.
- replication_namespace¶
- Type:
string
- Default:
trove.guestagent.strategies.replication.mariadb_gtid
Namespace to load replication strategies from.
- mount_point¶
- Type:
string
- Default:
/var/lib/mysql
Filesystem path for mounting volumes if volume support is enabled.
- root_on_create¶
- Type:
boolean
- Default:
False
Enable the automatic creation of the root user for the service during instance-create. The generated password for the root user is immediately returned in the response of instance-create as the ‘password’ field.
- usage_timeout¶
- Type:
integer
- Default:
400
Maximum time (in seconds) to wait for a Guest to become active.
- volume_support¶
- Type:
boolean
- Default:
True
Whether to provision a Cinder volume for datadir.
- device_path¶
- Type:
string
- Default:
/dev/vdb
Device path for volume if volume support is enabled.
- root_controller¶
- Type:
string
- Default:
trove.extensions.common.service.DefaultRootController
Root controller implementation for mysql.
- ignore_users¶
- Type:
list
- Default:
['os_admin', 'root']
Users to exclude when listing users.
Deprecated Variations¶ Group
Name
DEFAULT
ignore_users
- ignore_dbs¶
- Type:
list
- Default:
['mysql', 'information_schema', 'performance_schema']
Databases to exclude when listing databases.
Deprecated Variations¶ Group
Name
DEFAULT
ignore_dbs
- guest_log_exposed_logs¶
- Type:
string
- Default:
general,slow_query
List of Guest Logs to expose for publishing.
- guest_log_long_query_time¶
- Type:
integer
- Default:
1000
The time in milliseconds that a statement must take in in order to be logged in the slow_query log.
Warning
This option is deprecated for removal. Its value may be silently ignored in the future.
- Reason:
Will be replaced by a configuration group option: long_query_time
- cluster_support¶
- Type:
boolean
- Default:
True
Enable clusters to be created and managed.
- min_cluster_member_count¶
- Type:
integer
- Default:
3
Minimum number of members in MariaDB cluster.
- api_strategy¶
- Type:
string
- Default:
trove.common.strategies.cluster.experimental.galera_common.api.GaleraCommonAPIStrategy
Class that implements datastore-specific API logic.
- taskmanager_strategy¶
- Type:
string
- Default:
trove.common.strategies.cluster.experimental.galera_common.taskmanager.GaleraCommonTaskManagerStrategy
Class that implements datastore-specific task manager logic.
- guestagent_strategy¶
- Type:
string
- Default:
trove.common.strategies.cluster.experimental.galera_common.guestagent.GaleraCommonGuestAgentStrategy
Class that implements datastore-specific Guest Agent API logic.
- default_password_length¶
- Type:
integer
- Default:
${mysql.default_password_length}
Character length of generated passwords.
Deprecated Variations¶ Group
Name
DEFAULT
default_password_length
- docker_image¶
- Type:
string
- Default:
mariadb
Database docker image.
- backup_docker_image¶
- Type:
string
- Default:
openstacktrove/db-backup-mariadb:1.1.0
The docker image used for backup and restore.
mysql¶
Oslo option group designed for MySQL datastore
- icmp¶
- Type:
boolean
- Default:
False
Whether to permit ICMP.
Warning
This option is deprecated for removal. Its value may be silently ignored in the future.
- tcp_ports¶
- Type:
list
- Default:
['3306']
List of TCP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True).
- udp_ports¶
- Type:
list
- Default:
[]
List of UDP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True).
- backup_strategy¶
- Type:
string
- Default:
innobackupex
Default strategy to perform backups.
Deprecated Variations¶ Group
Name
DEFAULT
backup_strategy
- replication_strategy¶
- Type:
string
- Default:
MysqlGTIDReplication
Default strategy for replication.
- replication_namespace¶
- Type:
string
- Default:
trove.guestagent.strategies.replication.mysql_gtid
Namespace to load replication strategies from.
- mount_point¶
- Type:
string
- Default:
/var/lib/mysql
Filesystem path for mounting volumes if volume support is enabled.
- root_on_create¶
- Type:
boolean
- Default:
False
Enable the automatic creation of the root user for the service during instance-create. The generated password for the root user is immediately returned in the response of instance-create as the ‘password’ field.
- usage_timeout¶
- Type:
integer
- Default:
400
Maximum time (in seconds) to wait for a Guest to become active.
- volume_support¶
- Type:
boolean
- Default:
True
Whether to provision a Cinder volume for datadir.
- device_path¶
- Type:
string
- Default:
/dev/vdb
Device path for volume if volume support is enabled.
- root_controller¶
- Type:
string
- Default:
trove.extensions.common.service.DefaultRootController
Root controller implementation for mysql.
- ignore_users¶
- Type:
list
- Default:
['os_admin', 'root']
Users to exclude when listing users.
Deprecated Variations¶ Group
Name
DEFAULT
ignore_users
- ignore_dbs¶
- Type:
list
- Default:
['mysql', 'information_schema', 'performance_schema', 'sys']
Databases to exclude when listing databases.
Deprecated Variations¶ Group
Name
DEFAULT
ignore_dbs
- guest_log_exposed_logs¶
- Type:
string
- Default:
general,slow_query
List of Guest Logs to expose for publishing.
- guest_log_long_query_time¶
- Type:
integer
- Default:
1000
The time in milliseconds that a statement must take in in order to be logged in the slow_query log.
Warning
This option is deprecated for removal. Its value may be silently ignored in the future.
- Reason:
Will be replaced by a configuration group option: long_query_time
- default_password_length¶
- Type:
integer
- Default:
36
Character length of generated passwords.
Deprecated Variations¶ Group
Name
DEFAULT
default_password_length
- docker_image¶
- Type:
string
- Default:
mysql
Database docker image.
- backup_docker_image¶
- Type:
string
- Default:
openstacktrove/db-backup-mysql:1.1.0
The docker image used for backup and restore. For mysql, the minor version is added to the image name as a suffix before creating container, e.g. openstacktrove/db-backup-mysql5.7:1.0.0
network¶
Options related to the trove instance networking.
- public_network_id¶
- Type:
string
- Default:
<None>
ID of the Neutron public network to create floating IP for the public trove instance. If not given, Trove will try to query all the public networks and use the first one in the list.
- enable_access_check¶
- Type:
boolean
- Default:
True
Check if the user provided network is associated with router. This is needed for the instance initialization. The check is also necessary when creating public facing instance. A scenario to set this option False is when using Neutron provider network.
- network_isolation¶
- Type:
boolean
- Default:
False
whether to plug user defined port to database container.This would be useful to isolate user traffic from managementtraffic and to avoid network address conflicts.
oslo_messaging_amqp¶
- container_name¶
- Type:
string
- Default:
<None>
Name for the AMQP container. must be globally unique. Defaults to a generated UUID
Deprecated Variations¶ Group
Name
amqp1
container_name
- idle_timeout¶
- Type:
integer
- Default:
0
Timeout for inactive connections (in seconds)
Deprecated Variations¶ Group
Name
amqp1
idle_timeout
- trace¶
- Type:
boolean
- Default:
False
Debug: dump AMQP frames to stdout
Deprecated Variations¶ Group
Name
amqp1
trace
- ssl¶
- Type:
boolean
- Default:
False
Attempt to connect via SSL. If no other ssl-related parameters are given, it will use the system’s CA-bundle to verify the server’s certificate.
- ssl_ca_file¶
- Type:
string
- Default:
''
CA certificate PEM file used to verify the server’s certificate
Deprecated Variations¶ Group
Name
amqp1
ssl_ca_file
- ssl_cert_file¶
- Type:
string
- Default:
''
Self-identifying certificate PEM file for client authentication
Deprecated Variations¶ Group
Name
amqp1
ssl_cert_file
- ssl_key_file¶
- Type:
string
- Default:
''
Private key PEM file used to sign ssl_cert_file certificate (optional)
Deprecated Variations¶ Group
Name
amqp1
ssl_key_file
- ssl_key_password¶
- Type:
string
- Default:
<None>
Password for decrypting ssl_key_file (if encrypted)
Deprecated Variations¶ Group
Name
amqp1
ssl_key_password
- ssl_verify_vhost¶
- Type:
boolean
- Default:
False
By default SSL checks that the name in the server’s certificate matches the hostname in the transport_url. In some configurations it may be preferable to use the virtual hostname instead, for example if the server uses the Server Name Indication TLS extension (rfc6066) to provide a certificate per virtual host. Set ssl_verify_vhost to True if the server’s SSL certificate uses the virtual host name instead of the DNS name.
- sasl_mechanisms¶
- Type:
string
- Default:
''
Space separated list of acceptable SASL mechanisms
Deprecated Variations¶ Group
Name
amqp1
sasl_mechanisms
- sasl_config_dir¶
- Type:
string
- Default:
''
Path to directory that contains the SASL configuration
Deprecated Variations¶ Group
Name
amqp1
sasl_config_dir
- sasl_config_name¶
- Type:
string
- Default:
''
Name of configuration file (without .conf suffix)
Deprecated Variations¶ Group
Name
amqp1
sasl_config_name
- sasl_default_realm¶
- Type:
string
- Default:
''
SASL realm to use if no realm present in username
- connection_retry_interval¶
- Type:
integer
- Default:
1
- Minimum Value:
1
Seconds to pause before attempting to re-connect.
- connection_retry_backoff¶
- Type:
integer
- Default:
2
- Minimum Value:
0
Increase the connection_retry_interval by this many seconds after each unsuccessful failover attempt.
- connection_retry_interval_max¶
- Type:
integer
- Default:
30
- Minimum Value:
1
Maximum limit for connection_retry_interval + connection_retry_backoff
- link_retry_delay¶
- Type:
integer
- Default:
10
- Minimum Value:
1
Time to pause between re-connecting an AMQP 1.0 link that failed due to a recoverable error.
- default_reply_retry¶
- Type:
integer
- Default:
0
- Minimum Value:
-1
The maximum number of attempts to re-send a reply message which failed due to a recoverable error.
- default_reply_timeout¶
- Type:
integer
- Default:
30
- Minimum Value:
5
The deadline for an rpc reply message delivery.
- default_send_timeout¶
- Type:
integer
- Default:
30
- Minimum Value:
5
The deadline for an rpc cast or call message delivery. Only used when caller does not provide a timeout expiry.
- default_notify_timeout¶
- Type:
integer
- Default:
30
- Minimum Value:
5
The deadline for a sent notification message delivery. Only used when caller does not provide a timeout expiry.
- default_sender_link_timeout¶
- Type:
integer
- Default:
600
- Minimum Value:
1
The duration to schedule a purge of idle sender links. Detach link after expiry.
- addressing_mode¶
- Type:
string
- Default:
dynamic
Indicates the addressing mode used by the driver. Permitted values: ‘legacy’ - use legacy non-routable addressing ‘routable’ - use routable addresses ‘dynamic’ - use legacy addresses if the message bus does not support routing otherwise use routable addressing
- pseudo_vhost¶
- Type:
boolean
- Default:
True
Enable virtual host support for those message buses that do not natively support virtual hosting (such as qpidd). When set to true the virtual host name will be added to all message bus addresses, effectively creating a private ‘subnet’ per virtual host. Set to False if the message bus supports virtual hosting using the ‘hostname’ field in the AMQP 1.0 Open performative as the name of the virtual host.
- server_request_prefix¶
- Type:
string
- Default:
exclusive
address prefix used when sending to a specific server
Deprecated Variations¶ Group
Name
amqp1
server_request_prefix
- broadcast_prefix¶
- Type:
string
- Default:
broadcast
address prefix used when broadcasting to all servers
Deprecated Variations¶ Group
Name
amqp1
broadcast_prefix
- group_request_prefix¶
- Type:
string
- Default:
unicast
address prefix when sending to any server in group
Deprecated Variations¶ Group
Name
amqp1
group_request_prefix
- rpc_address_prefix¶
- Type:
string
- Default:
openstack.org/om/rpc
Address prefix for all generated RPC addresses
- notify_address_prefix¶
- Type:
string
- Default:
openstack.org/om/notify
Address prefix for all generated Notification addresses
- multicast_address¶
- Type:
string
- Default:
multicast
Appended to the address prefix when sending a fanout message. Used by the message bus to identify fanout messages.
- unicast_address¶
- Type:
string
- Default:
unicast
Appended to the address prefix when sending to a particular RPC/Notification server. Used by the message bus to identify messages sent to a single destination.
- anycast_address¶
- Type:
string
- Default:
anycast
Appended to the address prefix when sending to a group of consumers. Used by the message bus to identify messages that should be delivered in a round-robin fashion across consumers.
- default_notification_exchange¶
- Type:
string
- Default:
<None>
Exchange name used in notification addresses. Exchange name resolution precedence: Target.exchange if set else default_notification_exchange if set else control_exchange if set else ‘notify’
- default_rpc_exchange¶
- Type:
string
- Default:
<None>
Exchange name used in RPC addresses. Exchange name resolution precedence: Target.exchange if set else default_rpc_exchange if set else control_exchange if set else ‘rpc’
- reply_link_credit¶
- Type:
integer
- Default:
200
- Minimum Value:
1
Window size for incoming RPC Reply messages.
- rpc_server_credit¶
- Type:
integer
- Default:
100
- Minimum Value:
1
Window size for incoming RPC Request messages
- notify_server_credit¶
- Type:
integer
- Default:
100
- Minimum Value:
1
Window size for incoming Notification messages
- pre_settled¶
- Type:
multi-valued
- Default:
rpc-cast
- Default:
rpc-reply
Send messages of this type pre-settled. Pre-settled messages will not receive acknowledgement from the peer. Note well: pre-settled messages may be silently discarded if the delivery fails. Permitted values: ‘rpc-call’ - send RPC Calls pre-settled ‘rpc-reply’- send RPC Replies pre-settled ‘rpc-cast’ - Send RPC Casts pre-settled ‘notify’ - Send Notifications pre-settled
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
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.
- 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 durable by default so the amqp_durable_queues opion is ignored when this option enabled.
- 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:
1
Positive integer representing duration in seconds for queue TTL (x-expires). Queues which are unused for the duration of the TTL are automatically deleted. The parameter affects only reply and fanout queues.
- rabbit_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:
2
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
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
- secure_proxy_ssl_header¶
- Type:
string
- Default:
X-Forwarded-Proto
The HTTP Header that will be used to determine what the original request protocol scheme was, even if it was hidden by a SSL termination proxy.
Warning
This option is deprecated for removal. Its value may be silently ignored in the future.
- 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¶
- 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 thescope_types
of the policy being enforced. If the scopes do not match, anInvalidScope
exception will be raised. IfFalse
, a message will be logged informing operators that policies are being invoked with mismatching scope.
- 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 theenforce_scope
flag so that you can get the benefits of new defaults andscope_type
together. IfFalse
, 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.json
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.
Deprecated Variations¶ Group
Name
DEFAULT
policy_file
- policy_default_rule¶
- Type:
string
- Default:
default
Default rule. Enforced when a requested rule is not found.
Deprecated Variations¶ Group
Name
DEFAULT
policy_default_rule
- 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.
Deprecated Variations¶ Group
Name
DEFAULT
policy_dirs
- 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
postgresql¶
Oslo option group for the PostgreSQL datastore.
- enable_clean_wal_archives¶
- Type:
boolean
- Default:
True
Enable the periodic job to clean up WAL archive folder.
- docker_image¶
- Type:
string
- Default:
postgres
Database docker image.
- backup_docker_image¶
- Type:
string
- Default:
openstacktrove/db-backup-postgresql:1.1.2
The docker image used for backup and restore.
- icmp¶
- Type:
boolean
- Default:
False
Whether to permit ICMP.
Warning
This option is deprecated for removal. Its value may be silently ignored in the future.
- tcp_ports¶
- Type:
list
- Default:
['5432']
List of TCP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True).
- udp_ports¶
- Type:
list
- Default:
[]
List of UDP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True).
- postgresql_port¶
- Type:
port number
- Default:
5432
- Minimum Value:
0
- Maximum Value:
65535
The TCP port the server listens on.
- backup_strategy¶
- Type:
string
- Default:
pg_basebackup
Default strategy to perform backups.
- replication_strategy¶
- Type:
string
- Default:
PostgresqlReplicationStreaming
Default strategy for replication.
- replication_namespace¶
- Type:
string
- Default:
trove.guestagent.strategies.replication.postgresql
Namespace to load replication strategies from.
- mount_point¶
- Type:
string
- Default:
/var/lib/postgresql
Filesystem path for mounting volumes if volume support is enabled.
- wal_archive_location¶
- Type:
string
- Default:
/mnt/wal_archive
Filesystem path storing WAL archive files when WAL-shipping based backups or replication is enabled.
Warning
This option is deprecated for removal. Its value may be silently ignored in the future.
- Reason:
Option is not used any more, will be removed in future release.
- root_on_create¶
- Type:
boolean
- Default:
False
Enable the automatic creation of the root user for the service during instance-create. The generated password for the root user is immediately returned in the response of instance-create as the ‘password’ field.
- volume_support¶
- Type:
boolean
- Default:
True
Whether to provision a Cinder volume for datadir.
- device_path¶
- Type:
string
- Default:
/dev/vdb
- ignore_users¶
- Type:
list
- Default:
['os_admin', 'postgres']
- ignore_dbs¶
- Type:
list
- Default:
['os_admin', 'postgres']
- root_controller¶
- Type:
string
- Default:
trove.extensions.common.service.DefaultRootController
Root controller implementation for postgresql.
- guest_log_exposed_logs¶
- Type:
string
- Default:
general
List of Guest Logs to expose for publishing.
- guest_log_long_query_time¶
- Type:
integer
- Default:
0
The time in milliseconds that a statement must take in in order to be logged in the ‘general’ log. A value of ‘0’ logs all statements, while ‘-1’ turns off statement logging.
Warning
This option is deprecated for removal. Its value may be silently ignored in the future.
- Reason:
Will be replaced by configuration group option: log_min_duration_statement
- default_password_length¶
- Type:
integer
- Default:
36
Character length of generated passwords.
Deprecated Variations¶ Group
Name
DEFAULT
default_password_length
profiler¶
- enabled¶
- Type:
boolean
- Default:
False
Enable the profiling for all services on this node.
Default value is False (fully disable the profiling feature).
Possible values:
True: Enables the feature
False: Disables the feature. The profiling cannot be started via this project operations. If the profiling is triggered by another project, this project part will be empty.
Deprecated Variations¶ Group
Name
profiler
profiler_enabled
- trace_sqlalchemy¶
- Type:
boolean
- Default:
False
Enable SQL requests profiling in services.
Default value is False (SQL requests won’t be traced).
Possible values:
True: Enables SQL requests profiling. Each SQL query will be part of the trace and can the be analyzed by how much time was spent for that.
False: Disables SQL requests profiling. The spent time is only shown on a higher level of operations. Single SQL queries cannot be analyzed this way.
- hmac_keys¶
- Type:
string
- Default:
SECRET_KEY
Secret key(s) to use for encrypting context data for performance profiling.
This string value should have the following format: <key1>[,<key2>,…<keyn>], where each key is some random string. A user who triggers the profiling via the REST API has to set one of these keys in the headers of the REST API call to include profiling results of this node for this particular project.
Both “enabled” flag and “hmac_keys” config options should be set to enable profiling. Also, to generate correct profiling information across all services at least one key needs to be consistent between OpenStack projects. This ensures it can be used from client side to generate the trace, containing information from all possible resources.
- connection_string¶
- Type:
string
- Default:
messaging://
Connection string for a notifier backend.
Default value is
messaging://
which sets the notifier to oslo_messaging.Examples of possible values:
messaging://
- use oslo_messaging driver for sending spans.redis://127.0.0.1:6379
- use redis driver for sending spans.mongodb://127.0.0.1:27017
- use mongodb driver for sending spans.elasticsearch://127.0.0.1:9200
- use elasticsearch driver for sending spans.jaeger://127.0.0.1:6831
- use jaeger tracing as driver for sending spans.
- es_doc_type¶
- Type:
string
- Default:
notification
Document type for notification indexing in elasticsearch.
- es_scroll_time¶
- Type:
string
- Default:
2m
This parameter is a time value parameter (for example: es_scroll_time=2m), indicating for how long the nodes that participate in the search will maintain relevant resources in order to continue and support it.
- es_scroll_size¶
- Type:
integer
- Default:
10000
Elasticsearch splits large requests in batches. This parameter defines maximum size of each batch (for example: es_scroll_size=10000).
- socket_timeout¶
- Type:
floating point
- Default:
0.1
Redissentinel provides a timeout option on the connections. This parameter defines that timeout (for example: socket_timeout=0.1).
- sentinel_service_name¶
- Type:
string
- Default:
mymaster
Redissentinel uses a service name to identify a master redis service. This parameter defines the name (for example:
sentinal_service_name=mymaster
).
- filter_error_trace¶
- Type:
boolean
- Default:
False
Enable filter traces that contain error/exception to a separated place.
Default value is set to False.
Possible values:
True: Enable filter traces that contain error/exception.
False: Disable the filter.
service_credentials¶
Options related to Trove service credentials.
- auth_url¶
- Type:
URI
- Default:
https://0.0.0.0/identity/v3
Keystone authentication URL.
Deprecated Variations¶ Group
Name
DEFAULT
trove_auth_url
- username¶
- Type:
string
- Default:
''
Trove service user name.
Deprecated Variations¶ Group
Name
DEFAULT
nova_proxy_admin_user
- password¶
- Type:
string
- Default:
''
Trove service user password.
Deprecated Variations¶ Group
Name
DEFAULT
nova_proxy_admin_pass
- project_id¶
- Type:
string
- Default:
''
Trove service project ID.
Deprecated Variations¶ Group
Name
DEFAULT
nova_proxy_admin_tenant_id
- project_name¶
- Type:
string
- Default:
''
Trove service project name.
Deprecated Variations¶ Group
Name
DEFAULT
nova_proxy_admin_tenant_name
- user_domain_name¶
- Type:
string
- Default:
Default
Keystone domain name of the Trove service user.
Deprecated Variations¶ Group
Name
DEFAULT
nova_proxy_admin_user_domain_name