Icehouse - Icehouse - Icehouse - Icehouse - Icehouse - Icehouse - Icehouse - Icehouse -
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.
| Configuration option = Default value | Description |
|---|---|
| [DEFAULT] | |
| admin_roles = admin | (ListOpt) No help text available for this option. |
| api_extensions_path = trove/extensions/routes | (StrOpt) Path to extensions. |
| api_paste_config = api-paste.ini | (StrOpt) File name for the paste.deploy config for trove-api. |
| bind_port = 8779 | (IntOpt) No help text available for this option. |
| db_api_implementation = trove.db.sqlalchemy.api | (StrOpt) No help text available for this option. |
| hostname_require_ipv4 = True | (BoolOpt) Require user hostnames to be IPv4 addresses. |
| http_delete_rate = 200 | (IntOpt) No help text available for this option. |
| http_get_rate = 200 | (IntOpt) No help text available for this option. |
| http_post_rate = 200 | (IntOpt) No help text available for this option. |
| http_put_rate = 200 | (IntOpt) No help text available for this option. |
| instances_page_size = 20 | (IntOpt) No help text available for this option. |
| 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 |
| 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) No help text available for this option. |
| trove_auth_url = http://0.0.0.0:5000/v2.0 | (StrOpt) No help text available for this option. |
| trove_conductor_workers = 1 | (IntOpt) No help text available for this option. |
| trove_security_group_name_prefix = SecGroup | (StrOpt) No help text available for this option. |
| trove_security_group_rule_cidr = 0.0.0.0/0 | (StrOpt) No help text available for this option. |
| trove_security_groups_support = True | (BoolOpt) No help text available for this option. |
| users_page_size = 20 | (IntOpt) No help text available for this option. |
| Configuration option = Default value | Description |
|---|---|
| [DEFAULT] | |
| memcached_servers = None | (ListOpt) Memcached servers or None for in process cache. |
| [keystone_authtoken] | |
| admin_password = None | (StrOpt) Keystone account password |
| admin_tenant_name = admin | (StrOpt) Keystone service account tenant name to validate user tokens |
| admin_token = None | (StrOpt) Single shared secret with the Keystone configuration used for bootstrapping a Keystone installation, or otherwise bypassing the normal authentication process. |
| admin_user = None | (StrOpt) Keystone account username |
| auth_admin_prefix = | (StrOpt) Prefix to prepend at the beginning of the path |
| auth_host = 127.0.0.1 | (StrOpt) Host providing the admin Identity API endpoint |
| auth_port = 35357 | (IntOpt) Port of the admin Identity API endpoint |
| auth_protocol = https | (StrOpt) Protocol of the admin Identity API endpoint(http or https) |
| 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 Keystone server requires client certificate |
| 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. |
| http_connect_timeout = None | (BoolOpt) 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. |
| 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 Keystone server requires client certificate |
| 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. |
| 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. |
| revocation_cache_time = 300 | (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. |
| 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 to stream to 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_incremental_strategy = {'InnoBackupEx': 'InnoBackupExIncremental'} | (DictOpt) Incremental Backup Runner Based off of the default strategy. For strategies that do not implement an incremental the runner will use the default full backup. |
| backup_namespace = trove.guestagent.strategies.backup.mysql_impl | (StrOpt) Namespace to load backup strategies from. |
| backup_runner = trove.guestagent.backup.backup_types.InnoBackupEx | (StrOpt) No help text available for this option. |
| backup_runner_options = {} | (DictOpt) Additional options to be passed to the backup runner. |
| backup_segment_max_size = 2147483648 | (IntOpt) Maximum size of each segment of the backup file. |
| backup_strategy = InnoBackupEx | (StrOpt) Default strategy to perform backups. |
| backup_swift_container = database_backups | (StrOpt) No help text available for this option. |
| 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) No help text available for this option. |
| Configuration option = Default value | Description |
|---|---|
| [DEFAULT] | |
| configurations_page_size = 20 | (IntOpt) No help text available for this option. |
| databases_page_size = 20 | (IntOpt) No help text available for this option. |
| 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_log_levels = amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, iso8601=WARN | (ListOpt) list of logger=LEVEL pairs |
| default_neutron_networks = | (ListOpt) List of network IDs which should be attached to instance when networks are not specified in API call. |
| default_notification_level = INFO | (StrOpt) Default notification level for outgoing notifications |
| default_password_length = 36 | (IntOpt) No help text available for this option. |
| default_publisher_id = $host | (StrOpt) Default publisher_id for outgoing notifications |
| expected_filetype_suffixes = json | (ListOpt) Filetype endings not to be reattached to an id by the utils method correct_id_with_req. |
| lock_path = None | (StrOpt) Directory to use for lock files. |
| pybasedir = /usr/lib/python/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) No help text available for this option. |
| template_path = /etc/trove/templates/ | (StrOpt) Path which leads to datastore templates. |
| Configuration option = Default value | Description |
|---|---|
| [DEFAULT] | |
| ip_regex = None | (StrOpt) No help text available for this option. |
| nova_compute_url = http://localhost:8774/v2 | (StrOpt) No help text available for this option. |
| root_grant = ALL | (ListOpt) No help text available for this option. |
| root_grant_option = True | (BoolOpt) No help text available for this option. |
| Configuration option = Default value | Description |
|---|---|
| [DEFAULT] | |
| backdoor_port = None | (StrOpt) Enable eventlet backdoor. Acceptable values are 0, <port>, and <start>:<end>, where 0 results in listening on a random tcp port number; <port> results in listening on the specified port number (and not enabling backdoor if that port is in use); and <start>:<end> results in listening on the smallest unused port number within the specified range of port numbers. The chosen port is displayed in the service's log file. |
| backlog = 4096 | (IntOpt) Number of backlog requests to configure the socket with |
| debug = False | (BoolOpt) Print debugging output (set logging level to DEBUG instead of default WARNING level). |
| disable_process_locking = False | (BoolOpt) Whether to disable inter-process locks |
| fatal_deprecations = False | (BoolOpt) make deprecations fatal |
| 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). |
| remote_cinder_client = trove.common.remote.cinder_client | (StrOpt) No help text available for this option. |
| remote_dns_client = trove.common.remote.dns_client | (StrOpt) No help text available for this option. |
| remote_guest_client = trove.common.remote.guest_client | (StrOpt) No help text available for this option. |
| remote_heat_client = trove.common.remote.heat_client | (StrOpt) No help text available for this option. |
| remote_nova_client = trove.common.remote.nova_client | (StrOpt) No help text available for this option. |
| remote_swift_client = trove.common.remote.swift_client | (StrOpt) No help text available for this option. |
| verbose = False | (BoolOpt) Print more verbose output (set logging level to INFO instead of default WARNING level). |
| Configuration option = Default value | Description |
|---|---|
| [DEFAULT] | |
| dns_account_id = | (StrOpt) No help text available for this option. |
| dns_auth_url = | (StrOpt) No help text available for this option. |
| dns_domain_id = | (StrOpt) No help text available for this option. |
| dns_domain_name = | (StrOpt) No help text available for this option. |
| dns_driver = trove.dns.driver.DnsDriver | (StrOpt) No help text available for this option. |
| dns_endpoint_url = 0.0.0.0 | (StrOpt) No help text available for this option. |
| dns_hostname = | (StrOpt) No help text available for this option. |
| dns_instance_entry_factory = trove.dns.driver.DnsInstanceEntryFactory | (StrOpt) No help text available for this option. |
| dns_management_base_url = | (StrOpt) No help text available for this option. |
| dns_passkey = | (StrOpt) No help text available for this option. |
| dns_region = | (StrOpt) No help text available for this option. |
| dns_service_type = | (StrOpt) No help text available for this option. |
| dns_time_out = 120 | (IntOpt) No help text available for this option. |
| dns_ttl = 300 | (IntOpt) No help text available for this option. |
| dns_username = | (StrOpt) No help text available for this option. |
| trove_dns_support = False | (BoolOpt) No help text available for this option. |
| Configuration option = Default value | Description |
|---|---|
| [DEFAULT] | |
| agent_call_high_timeout = 60 | (IntOpt) No help text available for this option. |
| agent_call_low_timeout = 5 | (IntOpt) No help text available for this option. |
| agent_heartbeat_time = 10 | (IntOpt) No help text available for this option. |
| guest_config = $pybasedir/etc/trove/trove-guestagent.conf.sample | (StrOpt) Path to guestagent config file. |
| guest_id = None | (StrOpt) No help text available for this option. |
| ignore_dbs = lost+found, mysql, information_schema | (ListOpt) No help text available for this option. |
| ignore_users = os_admin, root | (ListOpt) No help text available for this option. |
| mount_options = defaults,noatime | (StrOpt) No help text available for this option. |
| restore_namespace = trove.guestagent.strategies.restore.mysql_impl | (StrOpt) Namespace to load restore strategies from. |
| 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 active guest. |
| Configuration option = Default value | Description |
|---|---|
| [DEFAULT] | |
| heat_time_out = 60 | (IntOpt) No help text available for this option. |
| heat_url = http://localhost:8004/v1 | (StrOpt) No help text available for this option. |
| Configuration option = Default value | Description |
|---|---|
| [DEFAULT] | |
| format_options = -m 5 | (StrOpt) No help text available for this option. |
| instance_format = "[instance: %(uuid)s] " | (StrOpt) If an instance is passed with the log message, format it like this |
| instance_uuid_format = "[instance: %(uuid)s] " | (StrOpt) If an instance UUID is passed with the log message, format it like this |
| log_config_append = None | (StrOpt) The name of logging configuration file. It does not disable existing loggers, but just appends specified logging configuration to any other existing logging options. Please see the Python logging module documentation for details on logging configuration files. |
| log_date_format = %Y-%m-%d %H:%M:%S | (StrOpt) Format string for %%(asctime)s in log records. Default: %(default)s |
| log_dir = None | (StrOpt) (Optional) The base directory used for relative --log-file paths |
| log_file = None | (StrOpt) (Optional) Name of log file to output to. If no default is set, logging will go to stdout. |
| 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 deprecated. Please use logging_context_format_string and logging_default_format_string instead. |
| 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 TRACE %(name)s %(instance)s | (StrOpt) prefix each line of exception output with this format |
| network_label_regex = ^private$ | (StrOpt) No help text available for this option. |
| publish_errors = False | (BoolOpt) publish error events |
| syslog_log_facility = LOG_USER | (StrOpt) syslog facility to receive log lines |
| use_stderr = True | (BoolOpt) Log output to standard error |
| use_syslog = False | (BoolOpt) Use syslog for logging. |
| Configuration option = Default value | Description |
|---|---|
| [DEFAULT] | |
| nova_proxy_admin_pass = | (StrOpt) Admin password used to connect to nova, |
| nova_proxy_admin_tenant_name = | (StrOpt) Admin tenant used to connect to nova. |
| nova_proxy_admin_user = | (StrOpt) Admin username used to connect to nova. |
| Configuration option = Default value | Description |
|---|---|
| [DEFAULT] | |
| max_accepted_volume_size = 5 | (IntOpt) Default maximum volume size 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. |
| Configuration option = Default value | Description |
|---|---|
| [matchmaker_redis] | |
| host = 127.0.0.1 | (StrOpt) Host to locate redis |
| password = None | (StrOpt) Password for Redis server. (optional) |
| port = 6379 | (IntOpt) Use this port to connect to redis host. |
| [matchmaker_ring] | |
| ringfile = /etc/oslo/matchmaker_ring.json | (StrOpt) Matchmaker ring file (JSON) |
| 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 |
| Configuration option = Default value | Description |
|---|---|
| [DEFAULT] | |
| swift_url = http://localhost:8080/v1/AUTH_ | (StrOpt) No help text available for this option. |
| 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 guestagent, setup by taskmanager on instance provision. |
| datastore_registry_ext = {} | (DictOpt) Extension for default datastore managers. Allows to use custom managers for each of datastore supported in trove. |
| exists_notification_ticks = 360 | (IntOpt) Number of report_intervals to wait between pushing events (see report_interval). |
| exists_notification_transformer = None | (StrOpt) Transformer for exists notifications. |
| reboot_time_out = 120 | (IntOpt) No help text available for this option. |
| resize_time_out = 600 | (IntOpt) No help text available for this option. |
| revert_time_out = 600 | (IntOpt) No help text available for this option. |
| server_delete_time_out = 60 | (IntOpt) No help text available for this option. |
| state_change_wait_time = 180 | (IntOpt) No help text available for this option. |
| update_status_on_fail = False | (BoolOpt) If instance fails to become active, taskmanager updates statuses, service status = FAILED_TIMEOUT_GUESTAGENT, instance task status = BUILDING_ERROR_TIMEOUT_GA. |
| usage_sleep_time = 5 | (IntOpt) Time to sleep during the check active guest. |
| use_heat = False | (BoolOpt) No help text available for this option. |
| use_nova_server_volume = False | (BoolOpt) No help text available for this option. |
| verify_swift_checksum_on_restore = True | (BoolOpt) Enable verification of swift checksum before starting restore; makes sure the checksum of original backup matches checksum of the swift backup file. |
| Configuration option = Default value | Description |
|---|---|
| [DEFAULT] | |
| block_device_mapping = vdb | (StrOpt) No help text available for this option. |
| cinder_url = http://localhost:8776/v2 | (StrOpt) No help text available for this option. |
| device_path = /dev/vdb | (StrOpt) No help text available for this option. |
| trove_volume_support = True | (BoolOpt) Whether to provision a cinder volume for datadir. |
| volume_format_timeout = 120 | (IntOpt) No help text available for this option. |
| volume_fstype = ext3 | (StrOpt) No help text available for this option. |
| volume_time_out = 60 | (IntOpt) No help text available for this option. |
