glance-scrubber.conf¶
DEFAULT¶
-
debug
¶ Type: boolean Default: false
Mutable: This option can be changed without restarting. If set to true, the logging level will be set to DEBUG instead of the default INFO level.
-
verbose
¶ Type: boolean Default: true
If set to false, the logging level will be set to WARNING instead of the default INFO level.
Warning
This option is deprecated for removal. Its value may be silently ignored in the future.
-
log_config_append
¶ Type: string Default: <None>
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, logging_context_format_string).
Deprecated Variations¶ Group Name 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.
-
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_stderr
¶ Type: boolean Default: true
Log output to standard error. This option is ignored if log_config_append is set.
-
logging_context_format_string
¶ Type: string Default: %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s
Format string to use for log messages with context.
-
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.
-
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.
-
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.
-
logging_user_identity_format
¶ Type: string Default: %(user)s %(tenant)s %(domain)s %(user_domain)s %(project_domain)s
Defines the format string for %(user_identity)s that is used in logging_context_format_string.
-
default_log_levels
¶ Type: list Default: 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,keystoneauth=WARN,oslo.cache=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.
-
fatal_deprecations
¶ Type: boolean Default: false
Enables or disables fatal status of deprecations.
database¶
-
sqlite_db
¶ Type: string Default: oslo.sqlite
The file name to use with SQLite.
Deprecated Variations¶ Group Name DEFAULT sqlite_db
-
sqlite_synchronous
¶ Type: boolean Default: true
If True, SQLite uses synchronous mode.
Deprecated Variations¶ Group Name DEFAULT sqlite_synchronous
-
backend
¶ Type: string Default: sqlalchemy
The back end to use for the database.
Deprecated Variations¶ Group Name DEFAULT db_backend
-
connection
¶ Type: string Default: <None>
The SQLAlchemy connection string to use to connect to the database.
Deprecated Variations¶ Group Name DEFAULT sql_connection DATABASE sql_connection sql connection
-
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=
-
idle_timeout
¶ Type: integer Default: 3600
Timeout before idle SQL connections are reaped.
Deprecated Variations¶ Group Name DEFAULT sql_idle_timeout DATABASE sql_idle_timeout sql idle_timeout
-
min_pool_size
¶ Type: integer Default: 1
Minimum number of SQL connections to keep open in a pool.
Deprecated Variations¶ Group Name DEFAULT sql_min_pool_size DATABASE sql_min_pool_size
-
max_pool_size
¶ Type: integer Default: <None>
Maximum number of SQL connections to keep open in a pool.
Deprecated Variations¶ Group Name DEFAULT sql_max_pool_size DATABASE sql_max_pool_size
-
max_retries
¶ Type: integer Default: 10
Maximum number of database connection retries during startup. Set to -1 to specify an infinite retry count.
Deprecated Variations¶ Group Name DEFAULT sql_max_retries DATABASE sql_max_retries
-
retry_interval
¶ Type: integer Default: 10
Interval between retries of opening a SQL connection.
Deprecated Variations¶ Group Name DEFAULT sql_retry_interval DATABASE reconnect_interval
-
max_overflow
¶ Type: integer Default: 50
If set, use this value for max_overflow with SQLAlchemy.
Deprecated Variations¶ Group Name DEFAULT sql_max_overflow DATABASE sqlalchemy_max_overflow
-
connection_debug
¶ Type: integer Default: 0
Verbosity of SQL debugging information: 0=None, 100=Everything.
Deprecated Variations¶ Group Name DEFAULT sql_connection_debug
-
connection_trace
¶ Type: boolean Default: false
Add Python stack traces to SQL as comment strings.
Deprecated Variations¶ Group Name DEFAULT sql_connection_trace
-
pool_timeout
¶ Type: integer Default: <None>
If set, use this value for pool_timeout with SQLAlchemy.
Deprecated Variations¶ Group Name DATABASE sqlalchemy_pool_timeout
-
use_db_reconnect
¶ Type: boolean Default: false
Enable the experimental use of database reconnect on connection lost.
-
db_retry_interval
¶ Type: integer Default: 1
Seconds between retries of a database transaction.
-
db_inc_retry_interval
¶ Type: boolean Default: true
If True, increases the interval between retries of a database operation up to db_max_retry_interval.
-
db_max_retry_interval
¶ Type: integer Default: 10
If db_inc_retry_interval is set, the maximum seconds between retries of a database operation.
-
db_max_retries
¶ Type: integer Default: 20
Maximum retries in case of connection error or deadlock error before error is raised. Set to -1 to specify an infinite retry count.
-
use_tpool
¶ Type: boolean Default: false
Enable the experimental use of thread pooling for all DB API calls
Deprecated Variations¶ Group Name DEFAULT dbapi_use_tpool
glance_store¶
-
stores
¶ Type: list Default: file,http
List of stores enabled. Valid stores are: cinder, file, http, rbd, sheepdog, swift, s3, vsphere
-
default_store
¶ Type: string Default: file
Default scheme to use to store image data. The scheme must be registered by one of the stores defined by the ‘stores’ config option.
-
store_capabilities_update_min_interval
¶ Type: integer Default: 0
Minimum interval seconds to execute updating dynamic storage capabilities based on backend status then. It’s not a periodic routine, the update logic will be executed only when interval seconds elapsed and an operation of store has triggered. The feature will be enabled only when the option value greater then zero.
-
sheepdog_store_chunk_size
¶ Type: integer Default: 64
Images will be chunked into objects of this size (in megabytes). For best performance, this should be a power of two.
-
sheepdog_store_port
¶ Type: integer Default: 7000
Port of sheep daemon.
-
sheepdog_store_address
¶ Type: string Default: localhost
IP address of sheep daemon.
-
rbd_store_chunk_size
¶ Type: integer Default: 8
RADOS images will be chunked into objects of this size (in megabytes). For best performance, this should be a power of two.
-
rbd_store_pool
¶ Type: string Default: images
RADOS pool in which images are stored.
-
rbd_store_user
¶ Type: string Default: <None>
RADOS user to authenticate as (only applicable if using Cephx. If <None>, a default will be chosen based on the client. section in rbd_store_ceph_conf)
-
rbd_store_ceph_conf
¶ Type: string Default: /etc/ceph/ceph.conf
Ceph configuration file path. If <None>, librados will locate the default config. If using cephx authentication, this file should include a reference to the right keyring in a client.<USER> section
-
rados_connect_timeout
¶ Type: integer Default: 0
Timeout value (in seconds) used when connecting to ceph cluster. If value <= 0, no timeout is set and default librados value is used.
-
https_ca_certificates_file
¶ Type: string Default: <None>
Specify the path to the CA bundle file to use in verifying the remote server certificate.
-
https_insecure
¶ Type: boolean Default: true
If true, the remote server certificate is not verified. If false, then the default CA truststore is used for verification. This option is ignored if “https_ca_certificates_file” is set.
-
http_proxy_information
¶ Type: dict Default: Specify the http/https proxy information that should be used to connect to the remote server. The proxy information should be a key value pair of the scheme and proxy. e.g. http:10.0.0.1:3128. You can specify proxies for multiple schemes by seperating the key value pairs with a comma.e.g. http:10.0.0.1:3128, https:10.0.0.1:1080.
-
filesystem_store_datadir
¶ Type: string Default: /var/lib/glance/images
Directory to which the Filesystem backend store writes images.
-
filesystem_store_datadirs
¶ Type: multi-valued Default: List of directories and its priorities to which the Filesystem backend store writes images.
-
filesystem_store_metadata_file
¶ Type: string Default: <None>
The path to a file which contains the metadata to be returned with any location associated with this store. The file must contain a valid JSON object. The object should contain the keys ‘id’ and ‘mountpoint’. The value for both keys should be ‘string’.
-
filesystem_store_file_perm
¶ Type: integer Default: 0
The required permission for created image file. In this way the user other service used, e.g. Nova, who consumes the image could be the exclusive member of the group that owns the files created. Assigning it less then or equal to zero means don’t change the default permission of the file. This value will be decoded as an octal digit.
-
s3_store_host
¶ Type: string Default: <None>
The host where the S3 server is listening.
-
s3_store_access_key
¶ Type: string Default: <None>
The S3 query token access key.
-
s3_store_secret_key
¶ Type: string Default: <None>
The S3 query token secret key.
-
s3_store_bucket
¶ Type: string Default: <None>
The S3 bucket to be used to store the Glance data.
-
s3_store_object_buffer_dir
¶ Type: string Default: <None>
The local directory where uploads will be staged before they are transferred into S3.
-
s3_store_create_bucket_on_put
¶ Type: boolean Default: false
A boolean to determine if the S3 bucket should be created on upload if it does not exist or if an error should be returned to the user.
-
s3_store_bucket_url_format
¶ Type: string Default: subdomain
The S3 calling format used to determine the bucket. Either subdomain or path can be used.
-
s3_store_large_object_size
¶ Type: integer Default: 100
What size, in MB, should S3 start chunking image files and do a multipart upload in S3.
-
s3_store_large_object_chunk_size
¶ Type: integer Default: 10
What multipart upload part size, in MB, should S3 use when uploading parts. The size must be greater than or equal to 5M.
-
s3_store_thread_pools
¶ Type: integer Default: 10
The number of thread pools to perform a multipart upload in S3.
-
s3_store_enable_proxy
¶ Type: boolean Default: false
Enable the use of a proxy.
-
s3_store_proxy_host
¶ Type: string Default: <None>
Address or hostname for the proxy server.
-
s3_store_proxy_port
¶ Type: integer Default: 8080
The port to use when connecting over a proxy.
-
s3_store_proxy_user
¶ Type: string Default: <None>
The username to connect to the proxy.
-
s3_store_proxy_password
¶ Type: string Default: <None>
The password to use when connecting over a proxy.
-
vmware_server_host
¶ Type: string Default: <None>
ESX/ESXi or vCenter Server target system. The server value can be an IP address or a DNS name.
-
vmware_server_username
¶ Type: string Default: <None>
Username for authenticating with VMware ESX/VC server.
-
vmware_server_password
¶ Type: string Default: <None>
Password for authenticating with VMware ESX/VC server.
-
vmware_api_retry_count
¶ Type: integer Default: 10
Number of times VMware ESX/VC server API must be retried upon connection related issues.
-
vmware_task_poll_interval
¶ Type: integer Default: 5
The interval used for polling remote tasks invoked on VMware ESX/VC server.
-
vmware_store_image_dir
¶ Type: string Default: /openstack_glance
The name of the directory where the glance images will be stored in the VMware datastore.
-
vmware_insecure
¶ Type: boolean Default: false
If true, the ESX/vCenter server certificate is not verified. If false, then the default CA truststore is used for verification. This option is ignored if “vmware_ca_file” is set.
Deprecated Variations¶ Group Name glance_store vmware_api_insecure
-
vmware_ca_file
¶ Type: string Default: <None>
Specify a CA bundle file to use in verifying the ESX/vCenter server certificate.
-
vmware_datastores
¶ Type: multi-valued Default: A list of datastores where the image can be stored. This option may be specified multiple times for specifying multiple datastores. The datastore name should be specified after its datacenter path, seperated by ”:”. An optional weight may be given after the datastore name, seperated again by ”:”. Thus, the required format becomes <datacenter_path>:<datastore_name>:<optional_weight>. When adding an image, the datastore with highest weight will be selected, unless there is not enough free space available in cases where the image size is already known. If no weight is given, it is assumed to be zero and the directory will be considered for selection last. If multiple datastores have the same weight, then the one with the most free space available is selected.
-
cinder_catalog_info
¶ Type: string Default: volumev2::publicURL
Info to match when looking for cinder in the service catalog. Format is : separated values of the form: <service_type>:<service_name>:<endpoint_type>
-
cinder_endpoint_template
¶ Type: string Default: <None>
Override service catalog lookup with template for cinder endpoint e.g. http://localhost:8776/v2/%(tenant)s
-
cinder_os_region_name
¶ Type: string Default: <None>
Region name of this node. If specified, it will be used to locate OpenStack services for stores.
Deprecated Variations¶ Group Name glance_store os_region_name
-
cinder_ca_certificates_file
¶ Type: string Default: <None>
Location of ca certicates file to use for cinder client requests.
-
cinder_http_retries
¶ Type: integer Default: 3
Number of cinderclient retries on failed http calls
-
cinder_state_transition_timeout
¶ Type: integer Default: 300
Time period of time in seconds to wait for a cinder volume transition to complete.
-
cinder_api_insecure
¶ Type: boolean Default: false
Allow to perform insecure SSL requests to cinder
-
cinder_store_auth_address
¶ Type: string Default: <None>
The address where the Cinder authentication service is listening. If <None>, the cinder endpoint in the service catalog is used.
-
cinder_store_user_name
¶ Type: string Default: <None>
User name to authenticate against Cinder. If <None>, the user of current context is used.
-
cinder_store_password
¶ Type: string Default: <None>
Password for the user authenticating against Cinder. If <None>, the current context auth token is used.
-
cinder_store_project_name
¶ Type: string Default: <None>
Project name where the image is stored in Cinder. If <None>, the project in current context is used.
-
rootwrap_config
¶ Type: string Default: /etc/glance/rootwrap.conf
Path to the rootwrap configuration file to use for running commands as root.
-
swift_store_auth_insecure
¶ Type: boolean Default: false
If True, swiftclient won’t check for a valid SSL certificate when authenticating.
-
swift_store_cacert
¶ Type: string Default: <None>
A string giving the CA certificate file to use in SSL connections for verifying certs.
-
swift_store_region
¶ Type: string Default: <None>
The region of the swift endpoint to be used for single tenant. This setting is only necessary if the tenant has multiple swift endpoints.
-
swift_store_endpoint
¶ Type: string Default: <None>
If set, the configured endpoint will be used. If None, the storage url from the auth response will be used.
-
swift_store_endpoint_type
¶ Type: string Default: publicURL
A string giving the endpoint type of the swift service to use (publicURL, adminURL or internalURL). This setting is only used if swift_store_auth_version is 2.
-
swift_store_service_type
¶ Type: string Default: object-store
A string giving the service type of the swift service to use. This setting is only used if swift_store_auth_version is 2.
-
swift_store_container
¶ Type: string Default: glance
Container within the account that the account should use for storing images in Swift when using single container mode. In multiple container mode, this will be the prefix for all containers.
-
swift_store_large_object_size
¶ Type: integer Default: 5120
The size, in MB, that Glance will start chunking image files and do a large object manifest in Swift.
-
swift_store_large_object_chunk_size
¶ Type: integer Default: 200
The amount of data written to a temporary disk buffer during the process of chunking the image file.
-
swift_store_create_container_on_put
¶ Type: boolean Default: false
A boolean value that determines if we create the container if it does not exist.
-
swift_store_multi_tenant
¶ Type: boolean Default: false
If set to True, enables multi-tenant storage mode which causes Glance images to be stored in tenant specific Swift accounts.
-
swift_store_multiple_containers_seed
¶ Type: integer Default: 0
When set to 0, a single-tenant store will only use one container to store all images. When set to an integer value between 1 and 32, a single-tenant store will use multiple containers to store images, and this value will determine how many containers are created.Used only when swift_store_multi_tenant is disabled. The total number of containers that will be used is equal to 16^N, so if this config option is set to 2, then 16^2=256 containers will be used to store images.
-
swift_store_admin_tenants
¶ Type: list Default: A list of tenants that will be granted read/write access on all Swift containers created by Glance in multi-tenant mode.
-
swift_store_ssl_compression
¶ Type: boolean Default: true
If set to False, disables SSL layer compression of https swift requests. Setting to False may improve performance for images which are already in a compressed format, eg qcow2.
-
swift_store_retry_get_count
¶ Type: integer Default: 0
The number of times a Swift download will be retried before the request fails.
-
swift_store_expire_soon_interval
¶ Type: integer Default: 60
The period of time (in seconds) before token expirationwhen glance_store will try to reques new user token. Default value 60 sec means that if token is going to expire in 1 min then glance_store request new user token.
-
swift_store_use_trusts
¶ Type: boolean Default: true
If set to True create a trust for each add/get request to Multi-tenant store in order to prevent authentication token to be expired during uploading/downloading data. If set to False then user token is used for Swift connection (so no overhead on trust creation). Please note that this option is considered only and only if swift_store_multi_tenant=True
-
default_swift_reference
¶ Type: string Default: ref1
The reference to the default swift account/backing store parameters to use for adding new images.
-
swift_store_auth_version
¶ Type: string Default: 2
Version of the authentication service to use. Valid versions are 2 and 3 for keystone and 1 (deprecated) for swauth and rackspace. (deprecated - use “auth_version” in swift_store_config_file)
-
swift_store_auth_address
¶ Type: string Default: <None>
The address where the Swift authentication service is listening. (deprecated - use “auth_address” in swift_store_config_file)
-
swift_store_user
¶ Type: string Default: <None>
The user to authenticate against the Swift authentication service (deprecated - use “user” in swift_store_config_file)
-
swift_store_key
¶ Type: string Default: <None>
Auth key for the user authenticating against the Swift authentication service. (deprecated - use “key” in swift_store_config_file)
-
swift_store_config_file
¶ Type: string Default: <None>
The config file that has the swift account(s)configs.
oslo_concurrency¶
-
disable_process_locking
¶ Type: boolean Default: false
Enables or disables inter-process locks.
Deprecated Variations¶ Group Name DEFAULT disable_process_locking
-
lock_path
¶ Type: string Default: /tmp
Directory to use for lock files. For security, the specified directory should only be writable by the user running the processes that need locking. Defaults to environment variable OSLO_LOCK_PATH. If OSLO_LOCK_PATH is not set in the environment, use the Python tempfile.gettempdir function to find a suitable location. If external locks are used, a lock path must be set.
Deprecated Variations¶ Group Name DEFAULT lock_path
oslo_policy¶
-
policy_file
¶ Type: string Default: policy.json
The JSON file that defines policies.
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