Red Hat Training

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

Chapter 5. Database service

The Database service provides a scalable and reliable Cloud Database-as-a-Service functionality for both relational and non-relational database engines.
The following tables provide a comprehensive list of the Database service configuration options.

Table 5.1. Description of API configuration options

Configuration option = Default value Description
[DEFAULT]
admin_roles = admin (ListOpt) Roles to add to an admin user.
api_paste_config = api-paste.ini (StrOpt) File name for the paste.deploy config for trove-api.
bind_host = 0.0.0.0 (StrOpt) IP address the API server will listen on.
bind_port = 8779 (IntOpt) Port the API server will listen on.
black_list_regex = None (StrOpt) Exclude IP addresses that match this regular expression.
db_api_implementation = trove.db.sqlalchemy.api (StrOpt) API Implementation for Trove database access.
hostname_require_valid_ip = True (BoolOpt) Require user hostnames to be valid IP addresses.
http_delete_rate = 200 (IntOpt) Maximum number of HTTP 'DELETE' requests (per minute).
http_get_rate = 200 (IntOpt) Maximum number of HTTP 'GET' requests (per minute).
http_mgmt_post_rate = 200 (IntOpt) Maximum number of management HTTP 'POST' requests (per minute).
http_post_rate = 200 (IntOpt) Maximum number of HTTP 'POST' requests (per minute).
http_put_rate = 200 (IntOpt) Maximum number of HTTP 'PUT' requests (per minute).
injected_config_location = /etc/trove/conf.d (StrOpt) Path to folder on the Guest where config files will be injected during instance creation.
instances_page_size = 20 (IntOpt) Page size for listing instances.
max_header_line = 16384 (IntOpt) Maximum line size of message headers to be accepted. max_header_line may need to be increased when using large tokens (typically those generated by the Keystone v3 API with big service catalogs).
os_region_name = RegionOne (StrOpt) Region name of this node. Used when searching catalog.
region = LOCAL_DEV (StrOpt) The region this service is located.
tcp_keepidle = 600 (IntOpt) Sets the value of TCP_KEEPIDLE in seconds for each server socket. Not supported on OS X.
trove_api_workers = None (IntOpt) Number of workers for the API service. The default will be the number of CPUs available.
trove_auth_url = http://0.0.0.0:5000/v2.0 (StrOpt) Trove authentication URL.
trove_conductor_workers = None (IntOpt) Number of workers for the Conductor service. The default will be the number of CPUs available.
trove_security_group_name_prefix = SecGroup (StrOpt) Prefix to use when creating Security Groups.
trove_security_group_rule_cidr = 0.0.0.0/0 (StrOpt) CIDR to use when creating Security Group Rules.
trove_security_groups_support = True (BoolOpt) Whether Trove should add Security Groups on create.
users_page_size = 20 (IntOpt) Page size for listing users.

Table 5.2. Description of authorization token configuration options

Configuration option = Default value Description
[keystone_authtoken]
admin_password = None (StrOpt) Service user password.
admin_tenant_name = admin (StrOpt) Service tenant name.
admin_token = None (StrOpt) 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 = None (StrOpt) Service username.
auth_admin_prefix = (StrOpt) Prefix to prepend at the beginning of the path. Deprecated, use identity_uri.
auth_host = 127.0.0.1 (StrOpt) Host providing the admin Identity API endpoint. Deprecated, use identity_uri.
auth_plugin = None (StrOpt) Name of the plugin to load
auth_port = 35357 (IntOpt) Port of the admin Identity API endpoint. Deprecated, use identity_uri.
auth_protocol = https (StrOpt) Protocol of the admin Identity API endpoint (http or https). Deprecated, use identity_uri.
auth_section = None (StrOpt) Config Section from which to load plugin specific options
auth_uri = None (StrOpt) Complete public Identity API endpoint.
auth_version = None (StrOpt) API version of the admin Identity API endpoint.
cache = None (StrOpt) Env key for the swift cache.
cafile = None (StrOpt) A PEM encoded Certificate Authority to use when verifying HTTPs connections. Defaults to system CAs.
certfile = None (StrOpt) Required if identity server requires client certificate
check_revocations_for_cached = False (BoolOpt) If true, the revocation list will be checked for cached tokens. This requires that PKI tokens are configured on the identity server.
delay_auth_decision = False (BoolOpt) Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components.
enforce_token_bind = permissive (StrOpt) 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.
hash_algorithms = md5 (ListOpt) Hash algorithms to use for hashing PKI tokens. This may be a single algorithm or multiple. The algorithms are those supported by Python standard hashlib.new(). The hashes will be tried in the order given, so put the preferred one first for performance. The result of the first hash will be stored in the cache. This will typically be set to multiple values only while migrating from a less secure algorithm to a more secure one. Once all the old tokens are expired this option should be set to a single value for better performance.
http_connect_timeout = None (IntOpt) Request timeout value for communicating with Identity API server.
http_request_max_retries = 3 (IntOpt) How many times are we trying to reconnect when communicating with Identity API Server.
identity_uri = None (StrOpt) Complete admin Identity API endpoint. This should specify the unversioned root endpoint e.g. https://localhost:35357/
include_service_catalog = True (BoolOpt) (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.
insecure = False (BoolOpt) Verify HTTPS connections.
keyfile = None (StrOpt) Required if identity server requires client certificate
memcache_pool_conn_get_timeout = 10 (IntOpt) (Optional) Number of seconds that an operation will wait to get a memcached client connection from the pool.
memcache_pool_dead_retry = 300 (IntOpt) (Optional) Number of seconds memcached server is considered dead before it is tried again.
memcache_pool_maxsize = 10 (IntOpt) (Optional) Maximum total number of open connections to every memcached server.
memcache_pool_socket_timeout = 3 (IntOpt) (Optional) Socket timeout in seconds for communicating with a memcached server.
memcache_pool_unused_timeout = 60 (IntOpt) (Optional) Number of seconds a connection to memcached is held unused in the pool before it is closed.
memcache_secret_key = None (StrOpt) (Optional, mandatory if memcache_security_strategy is defined) This string is used for key derivation.
memcache_security_strategy = None (StrOpt) (Optional) If defined, indicate whether token data should be authenticated or authenticated and encrypted. Acceptable values are MAC or ENCRYPT. 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_use_advanced_pool = False (BoolOpt) (Optional) Use the advanced (eventlet safe) memcached client pool. The advanced pool will only work under python 2.x.
region_name = None (StrOpt) The region in which the identity server can be found.
revocation_cache_time = 10 (IntOpt) Determines the frequency at which the list of revoked tokens is retrieved from the Identity service (in seconds). A high number of revocation events combined with a low cache duration may significantly reduce performance.
signing_dir = None (StrOpt) Directory used to cache files related to PKI tokens.
token_cache_time = 300 (IntOpt) 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.

Table 5.3. Description of backup configuration options

Configuration option = Default value Description
[DEFAULT]
backup_aes_cbc_key = default_aes_cbc_key (StrOpt) Default OpenSSL aes_cbc key.
backup_chunk_size = 65536 (IntOpt) 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_runner = trove.guestagent.backup.backup_types.InnoBackupEx (StrOpt) Runner to use for backups.
backup_runner_options = {} (DictOpt) Additional options to be passed to the backup runner.
backup_segment_max_size = 2147483648 (IntOpt) Maximum size (in bytes) of each segment of the backup file.
backup_swift_container = database_backups (StrOpt) Swift container to put backups in.
backup_use_gzip_compression = True (BoolOpt) Compress backups using gzip.
backup_use_openssl_encryption = True (BoolOpt) Encrypt backups using OpenSSL.
backup_use_snet = False (BoolOpt) Send backup files over snet.
backups_page_size = 20 (IntOpt) Page size for listing backups.

Table 5.4. Description of CA and SSL configuration options

Configuration option = Default value Description
[ssl]
ca_file = None (StrOpt) CA certificate file to use to verify connecting clients
cert_file = None (StrOpt) Certificate file to use when starting the server securely
key_file = None (StrOpt) Private key file to use when starting the server securely

Table 5.5. Description of clients configuration options

Configuration option = Default value Description
[DEFAULT]
remote_cinder_client = trove.common.remote.cinder_client (StrOpt) Client to send Cinder calls to.
remote_dns_client = trove.common.remote.dns_client (StrOpt) Client to send DNS calls to.
remote_guest_client = trove.common.remote.guest_client (StrOpt) Client to send Guest Agent calls to.
remote_heat_client = trove.common.remote.heat_client (StrOpt) Client to send Heat calls to.
remote_neutron_client = trove.common.remote.neutron_client (StrOpt) Client to send Neutron calls to.
remote_nova_client = trove.common.remote.nova_client (StrOpt) Client to send Nova calls to.
remote_swift_client = trove.common.remote.swift_client (StrOpt) Client to send Swift calls to.

Table 5.6. Description of cluster configuration options

Configuration option = Default value Description
[DEFAULT]
cluster_delete_time_out = 180 (IntOpt) Maximum time (in seconds) to wait for a cluster delete.
cluster_usage_timeout = 36000 (IntOpt) Maximum time (in seconds) to wait for a cluster to become active.
clusters_page_size = 20 (IntOpt) Page size for listing clusters.

Table 5.7. Description of common configuration options

Configuration option = Default value Description
[DEFAULT]
configurations_page_size = 20 (IntOpt) Page size for listing configurations.
databases_page_size = 20 (IntOpt) Page size for listing databases.
default_datastore = None (StrOpt) 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.
default_neutron_networks = (ListOpt) List of IDs for management networks which should be attached to the instance regardless of what NICs are specified in the create API call.
default_password_length = 36 (IntOpt) Character length of generated passwords.
executor_thread_pool_size = 64 (IntOpt) Size of executor thread pool.
expected_filetype_suffixes = json (ListOpt) Filetype endings not to be reattached to an ID by the utils method correct_id_with_req.
host = 0.0.0.0 (StrOpt) Host to listen for RPC messages.
memcached_servers = None (ListOpt) Memcached servers or None for in process cache.
pybasedir = /usr/lib/python2.7/site-packages/trove (StrOpt) Directory where the Trove python module is installed.
pydev_path = None (StrOpt) Set path to pydevd library, used if pydevd is not found in python sys.path.
taskmanager_queue = taskmanager (StrOpt) Message queue name the Taskmanager will listen to.
template_path = /etc/trove/templates/ (StrOpt) Path which leads to datastore templates.
timeout_wait_for_service = 120 (IntOpt) Maximum time (in seconds) to wait for a service to become alive.
usage_timeout = 900 (IntOpt) Maximum time (in seconds) to wait for a Guest to become active.
[keystone_authtoken]
memcached_servers = None (ListOpt) Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process.

Table 5.8. Description of Compute configuration options

Configuration option = Default value Description
[DEFAULT]
ip_regex = None (StrOpt) List IP addresses that match this regular expression.
nova_compute_endpoint_type = publicURL (StrOpt) Service endpoint type to use when searching catalog.
nova_compute_service_type = compute (StrOpt) Service type to use when searching catalog.
nova_compute_url = None (StrOpt) URL without the tenant segment.
root_grant = ALL (ListOpt) Permissions to grant to the 'root' user.
root_grant_option = True (BoolOpt) Assign the 'root' user GRANT permissions.

Table 5.9. Description of logging configuration options

Configuration option = Default value Description
[DEFAULT]
backlog = 4096 (IntOpt) Number of backlog requests to configure the socket with
pydev_debug = disabled (StrOpt) Enable or disable pydev remote debugging. If value is 'auto' tries to connect to remote debugger server, but in case of error continues running with debugging disabled.
pydev_debug_host = None (StrOpt) Pydev debug server host (localhost by default).
pydev_debug_port = None (IntOpt) Pydev debug server port (5678 by default).
[profiler]
enabled = False (BoolOpt) If False fully disable profiling feature.
trace_sqlalchemy = True (BoolOpt) If False doesn't trace SQL requests.

Table 5.10. Description of DNS configuration options

Configuration option = Default value Description
[DEFAULT]
dns_account_id = (StrOpt) Tenant ID for DNSaaS.
dns_auth_url = (StrOpt) Authentication URL for DNSaaS.
dns_domain_id = (StrOpt) Domain ID used for adding DNS entries.
dns_domain_name = (StrOpt) Domain name used for adding DNS entries.
dns_driver = trove.dns.driver.DnsDriver (StrOpt) Driver for DNSaaS.
dns_endpoint_url = 0.0.0.0 (StrOpt) Endpoint URL for DNSaaS.
dns_hostname = (StrOpt) Hostname used for adding DNS entries.
dns_instance_entry_factory = trove.dns.driver.DnsInstanceEntryFactory (StrOpt) Factory for adding DNS entries.
dns_management_base_url = (StrOpt) Management URL for DNSaaS.
dns_passkey = (StrOpt) Passkey for DNSaaS.
dns_region = (StrOpt) Region name for DNSaaS.
dns_service_type = (StrOpt) Service Type for DNSaaS.
dns_time_out = 120 (IntOpt) Maximum time (in seconds) to wait for a DNS entry add.
dns_ttl = 300 (IntOpt) Time (in seconds) before a refresh of DNS information occurs.
dns_username = (StrOpt) Username for DNSaaS.
trove_dns_support = False (BoolOpt) Whether Trove should add DNS entries on create (using Designate DNSaaS).

Table 5.11. Description of guest agent configuration options

Configuration option = Default value Description
[DEFAULT]
agent_call_high_timeout = 60 (IntOpt) Maximum time (in seconds) to wait for Guest Agent 'slow' requests (such as restarting the database).
agent_call_low_timeout = 5 (IntOpt) Maximum time (in seconds) to wait for Guest Agent 'quick'requests (such as retrieving a list of users or databases).
agent_heartbeat_expiry = 60 (IntOpt) Time (in seconds) after which a guest is considered unreachable
agent_heartbeat_time = 10 (IntOpt) Maximum time (in seconds) for the Guest Agent to reply to a heartbeat request.
agent_replication_snapshot_timeout = 36000 (IntOpt) Maximum time (in seconds) to wait for taking a Guest Agent replication snapshot.
guest_config = /etc/trove/trove-guestagent.conf (StrOpt) Path to the Guest Agent config file to be injected during instance creation.
guest_id = None (StrOpt) ID of the Guest Instance.
guest_info = guest_info.conf (StrOpt) 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
ignore_dbs = mysql, information_schema, performance_schema (ListOpt) Databases to exclude when listing databases.
ignore_users = os_admin, root (ListOpt) Users to exclude when listing users.
mount_options = defaults,noatime (StrOpt) Options to use when mounting a volume.
storage_namespace = trove.guestagent.strategies.storage.swift (StrOpt) Namespace to load the default storage strategy from.
storage_strategy = SwiftStorage (StrOpt) Default strategy to store backups.
usage_sleep_time = 5 (IntOpt) Time to sleep during the check for an active Guest.

Table 5.12. Description of Orchestration module configuration options

Configuration option = Default value Description
[DEFAULT]
heat_endpoint_type = publicURL (StrOpt) Service endpoint type to use when searching catalog.
heat_service_type = orchestration (StrOpt) Service type to use when searching catalog.
heat_time_out = 60 (IntOpt) Maximum time (in seconds) to wait for a Heat request to complete.
heat_url = None (StrOpt) URL without the tenant segment.

Table 5.13. Description of logging configuration options

Configuration option = Default value Description
[DEFAULT]
debug = False (BoolOpt) Print debugging output (set logging level to DEBUG instead of default INFO level).
default_log_levels = amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, oslo.messaging=INFO, iso8601=WARN, requests.packages.urllib3.connectionpool=WARN, urllib3.connectionpool=WARN, websocket=WARN, requests.packages.urllib3.util.retry=WARN, urllib3.util.retry=WARN, keystonemiddleware=WARN, routes.middleware=WARN, stevedore=WARN, taskflow=WARN (ListOpt) List of logger=LEVEL pairs. This option is ignored if log_config_append is set.
fatal_deprecations = False (BoolOpt) Enables or disables fatal status of deprecations.
format_options = -m 5 (StrOpt) Options to use when formatting a volume.
instance_format = "[instance: %(uuid)s] " (StrOpt) The format for an instance that is passed with the log message.
instance_uuid_format = "[instance: %(uuid)s] " (StrOpt) The format for an instance UUID that is passed with the log message.
log_config_append = None (StrOpt) The name of a logging configuration file. This file is appended to any existing logging configuration files. For details about logging configuration files, see the Python logging module documentation. 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_format).
log_date_format = %Y-%m-%d %H:%M:%S (StrOpt) Format string for %%(asctime)s in log records. Default: %(default)s . This option is ignored if log_config_append is set.
log_dir = None (StrOpt) (Optional) The base directory used for relative --log-file paths. This option is ignored if log_config_append is set.
log_file = None (StrOpt) (Optional) Name of log file to output to. If no default is set, logging will go to stdout. This option is ignored if log_config_append is set.
log_format = None (StrOpt) DEPRECATED. A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. This option is deprecate, use logging_context_format_string and logging_default_format_string instead. This option is ignored if log_config_append is set.
logging_context_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s (StrOpt) Format string to use for log messages with context.
logging_debug_format_suffix = %(funcName)s %(pathname)s:%(lineno)d (StrOpt) Data to append to log format when level is DEBUG.
logging_default_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s (StrOpt) Format string to use for log messages without context.
logging_exception_prefix = %(asctime)s.%(msecs)03d %(process)d ERROR %(name)s %(instance)s (StrOpt) Prefix each line of exception output with this format.
network_label_regex = ^private$ (StrOpt) Regular expression to match Trove network labels.
publish_errors = False (BoolOpt) Enables or disables publication of error events.
syslog_log_facility = LOG_USER (StrOpt) Syslog facility to receive log lines. This option is ignored if log_config_append is set.
use_stderr = True (BoolOpt) Log output to standard error. This option is ignored if log_config_append is set.
use_syslog = False (BoolOpt) 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_syslog_rfc_format = True (BoolOpt) (Optional) Enables or disables syslog rfc5424 format for logging. If enabled, prefixes the MSG part of the syslog message with APP-NAME (RFC5424). The format without the APP-NAME is deprecated in Kilo, and will be removed in Mitaka, along with this option. This option is ignored if log_config_append is set.
verbose = True (BoolOpt) If set to false, will disable INFO logging level, making WARNING the default.
watch_log_file = False (BoolOpt) (Optional) 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.

Table 5.14. Description of network configuration options

Configuration option = Default value Description
[DEFAULT]
network_driver = trove.network.nova.NovaNetwork (StrOpt) Describes the actual network manager used for the management of network attributes (security groups, floating IPs, etc.).
neutron_endpoint_type = publicURL (StrOpt) Service endpoint type to use when searching catalog.
neutron_service_type = network (StrOpt) Service type to use when searching catalog.
neutron_url = None (StrOpt) URL without the tenant segment.

Table 5.15. Description of nova configuration options

Configuration option = Default value Description
[DEFAULT]
nova_proxy_admin_pass = (StrOpt) Admin password used to connect to Nova.
nova_proxy_admin_tenant_id = (StrOpt) Admin tenant ID used to connect to Nova.
nova_proxy_admin_tenant_name = (StrOpt) Admin tenant name used to connect to Nova.
nova_proxy_admin_user = (StrOpt) Admin username used to connect to Nova.

Table 5.16. Description of quota configuration options

Configuration option = Default value Description
[DEFAULT]
max_accepted_volume_size = 5 (IntOpt) Default maximum volume size (in GB) for an instance.
max_backups_per_user = 50 (IntOpt) Default maximum number of backups created by a tenant.
max_instances_per_user = 5 (IntOpt) Default maximum number of instances per tenant.
max_volumes_per_user = 20 (IntOpt) Default maximum volume capacity (in GB) spanning across all Trove volumes per tenant.
quota_driver = trove.quota.quota.DbQuotaDriver (StrOpt) Default driver to use for quota checks.

Table 5.17. Description of Redis configuration options

Configuration option = Default value Description
[DEFAULT]
password = (StrOpt) Password for Redis server (optional).
port = 6379 (IntOpt) Use this port to connect to redis host.
[matchmaker_redis]
host = 127.0.0.1 (StrOpt) Host to locate redis.
password = (StrOpt) Password for Redis server (optional).
port = 6379 (IntOpt) Use this port to connect to redis host.

Table 5.18. Description of swift configuration options

Configuration option = Default value Description
[DEFAULT]
swift_endpoint_type = publicURL (StrOpt) Service endpoint type to use when searching catalog.
swift_service_type = object-store (StrOpt) Service type to use when searching catalog.
swift_url = None (StrOpt) URL ending in AUTH_.

Table 5.19. Description of taskmanager configuration options

Configuration option = Default value Description
[DEFAULT]
cloudinit_location = /etc/trove/cloudinit (StrOpt) Path to folder with cloudinit scripts.
datastore_manager = None (StrOpt) Manager class in the Guest Agent, set up by the Taskmanager on instance provision.
datastore_registry_ext = {} (DictOpt) Extension for default datastore managers. Allows the use of custom managers for each of the datastores supported by Trove.
exists_notification_interval = 3600 (IntOpt) Seconds to wait between pushing events.
exists_notification_transformer = None (StrOpt) Transformer for exists notifications.
reboot_time_out = 120 (IntOpt) Maximum time (in seconds) to wait for a server reboot.
resize_time_out = 600 (IntOpt) Maximum time (in seconds) to wait for a server resize.
restore_usage_timeout = 36000 (IntOpt) Maximum time (in seconds) to wait for a Guest instance restored from a backup to become active.
revert_time_out = 600 (IntOpt) Maximum time (in seconds) to wait for a server resize revert.
server_delete_time_out = 60 (IntOpt) Maximum time (in seconds) to wait for a server delete.
state_change_wait_time = 180 (IntOpt) Maximum time (in seconds) to wait for a state change.
update_status_on_fail = True (BoolOpt) Set the service and instance task statuses to ERROR when an instance fails to become active within the configured usage_timeout.
usage_sleep_time = 5 (IntOpt) Time to sleep during the check for an active Guest.
use_heat = False (BoolOpt) Use Heat for provisioning.
use_nova_server_config_drive = False (BoolOpt) Use config drive for file injection when booting instance.
use_nova_server_volume = False (BoolOpt) Whether to provision a Cinder volume for the Nova instance.
verify_swift_checksum_on_restore = True (BoolOpt) Enable verification of Swift checksum before starting restore. Makes sure the checksum of original backup matches the checksum of the Swift backup file.

Table 5.20. Description of upgrades configuration options

Configuration option = Default value Description
[upgrade_levels]
conductor = icehouse (StrOpt) Set a version cap for messages sent to conductor services
guestagent = icehouse (StrOpt) Set a version cap for messages sent to guestagent services
taskmanager = icehouse (StrOpt) Set a version cap for messages sent to taskmanager services

Table 5.21. Description of volume configuration options

Configuration option = Default value Description
[DEFAULT]
block_device_mapping = vdb (StrOpt) Block device to map onto the created instance.
cinder_endpoint_type = publicURL (StrOpt) Service endpoint type to use when searching catalog.
cinder_service_type = volumev2 (StrOpt) Service type to use when searching catalog.
cinder_url = None (StrOpt) URL without the tenant segment.
cinder_volume_type = None (StrOpt) Volume type to use when provisioning a Cinder volume.
device_path = /dev/vdb (StrOpt) Device path for volume if volume support is enabled.
trove_volume_support = True (BoolOpt) Whether to provision a Cinder volume for datadir.
volume_format_timeout = 120 (IntOpt) Maximum time (in seconds) to wait for a volume format.
volume_fstype = ext3 (StrOpt) File system type used to format a volume.
volume_time_out = 60 (IntOpt) Maximum time (in seconds) to wait for a volume attach.

5.1. Configure the Database

Use the options to configure the used databases:

Table 5.22. Description of MariaDB database configuration options

Configuration option = Default value Description
[mariadb]
backup_incremental_strategy = {'InnoBackupEx': 'InnoBackupExIncremental'} (DictOpt) Incremental Backup Runner based on the default strategy. For strategies that do not implement an incremental backup, the runner will use the default full backup.
backup_namespace = trove.guestagent.strategies.backup.mysql_impl (StrOpt) Namespace to load backup strategies from.
backup_strategy = InnoBackupEx (StrOpt) Default strategy to perform backups.
device_path = /dev/vdb (StrOpt) Device path for volume if volume support is enabled.
mount_point = /var/lib/mysql (StrOpt) Filesystem path for mounting volumes if volume support is enabled.
replication_namespace = trove.guestagent.strategies.replication.mysql_binlog (StrOpt) Namespace to load replication strategies from.
replication_strategy = MysqlBinlogReplication (StrOpt) Default strategy for replication.
restore_namespace = trove.guestagent.strategies.restore.mysql_impl (StrOpt) Namespace to load restore strategies from.
root_controller = trove.extensions.common.service.DefaultRootController (StrOpt) Root controller implementation for mysql.
root_on_create = False (BoolOpt) 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.
tcp_ports = 3306 (ListOpt) 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 = (ListOpt) List of UDP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True).
usage_timeout = 400 (IntOpt) Maximum time (in seconds) to wait for a Guest to become active.
volume_support = True (BoolOpt) Whether to provision a Cinder volume for datadir.

Table 5.23. Description of MySQL database configuration options

Configuration option = Default value Description
[mysql]
backup_incremental_strategy = {'InnoBackupEx': 'InnoBackupExIncremental'} (DictOpt) Incremental Backup Runner based on the default strategy. For strategies that do not implement an incremental backup, the runner will use the default full backup.
backup_namespace = trove.guestagent.strategies.backup.mysql_impl (StrOpt) Namespace to load backup strategies from.
backup_strategy = InnoBackupEx (StrOpt) Default strategy to perform backups.
device_path = /dev/vdb (StrOpt) Device path for volume if volume support is enabled.
mount_point = /var/lib/mysql (StrOpt) Filesystem path for mounting volumes if volume support is enabled.
replication_namespace = trove.guestagent.strategies.replication.mysql_gtid (StrOpt) Namespace to load replication strategies from.
replication_strategy = MysqlGTIDReplication (StrOpt) Default strategy for replication.
restore_namespace = trove.guestagent.strategies.restore.mysql_impl (StrOpt) Namespace to load restore strategies from.
root_controller = trove.extensions.common.service.DefaultRootController (StrOpt) Root controller implementation for mysql.
root_on_create = False (BoolOpt) 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.
tcp_ports = 3306 (ListOpt) 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 = (ListOpt) List of UDP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True).
usage_timeout = 400 (IntOpt) Maximum time (in seconds) to wait for a Guest to become active.
volume_support = True (BoolOpt) Whether to provision a Cinder volume for datadir.