glance-cache.conf¶

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

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.

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

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.

allow_additional_image_properties¶

Type:	boolean
Default:	true

Allow users to add additional/custom properties to images.

Glance defines a standard set of properties (in its schema) that appear on every image. These properties are also known as base properties. In addition to these properties, Glance allows users to add custom properties to images. These are known as additional properties.

By default, this configuration option is set to True and users are allowed to add additional properties. The number of additional properties that can be added to an image can be controlled via image_property_quota configuration option.

Possible values:

• True
• False

Related options:

• image_property_quota

hashing_algorithm¶

Type:	string
Default:	sha512

” Secure hashing algorithm used for computing the ‘os_hash_value’ property.

This option configures the Glance “multihash”, which consists of two image properties: the ‘os_hash_algo’ and the ‘os_hash_value’. The ‘os_hash_algo’ will be populated by the value of this configuration option, and the ‘os_hash_value’ will be populated by the hexdigest computed when the algorithm is applied to the uploaded or imported image data.

The value must be a valid secure hash algorithm name recognized by the python ‘hashlib’ library. You can determine what these are by examining the ‘hashlib.algorithms_available’ data member of the version of the library being used in your Glance installation. For interoperability purposes, however, we recommend that you use the set of secure hash names supplied by the ‘hashlib.algorithms_guaranteed’ data member because those algorithms are guaranteed to be supported by the ‘hashlib’ library on all platforms. Thus, any image consumer using ‘hashlib’ locally should be able to verify the ‘os_hash_value’ of the image.

The default value of ‘sha512’ is a performant secure hash algorithm.

If this option is misconfigured, any attempts to store image data will fail. For that reason, we recommend using the default value.

Possible values:

• Any secure hash algorithm name recognized by the Python ‘hashlib’ library

Related options:

• None

image_member_quota¶

Type:	integer
Default:	128

Maximum number of image members per image.

This limits the maximum of users an image can be shared with. Any negative value is interpreted as unlimited.

Related options:

• None

image_property_quota¶

Type:	integer
Default:	128

Maximum number of properties allowed on an image.

This enforces an upper limit on the number of additional properties an image can have. Any negative value is interpreted as unlimited.

NOTE: This won’t have any impact if additional properties are disabled. Please refer to allow_additional_image_properties.

Related options:

• allow_additional_image_properties

image_tag_quota¶

Type:	integer
Default:	128

Maximum number of tags allowed on an image.

Any negative value is interpreted as unlimited.

Related options:

• None

image_location_quota¶

Type:	integer
Default:	10

Maximum number of locations allowed on an image.

Any negative value is interpreted as unlimited.

Related options:

• None

data_api¶

Type:	string
Default:	glance.db.sqlalchemy.api

Python module path of data access API.

Specifies the path to the API to use for accessing the data model. This option determines how the image catalog data will be accessed.

Possible values:

• glance.db.sqlalchemy.api
• glance.db.registry.api
• glance.db.simple.api

If this option is set to glance.db.sqlalchemy.api then the image catalog data is stored in and read from the database via the SQLAlchemy Core and ORM APIs.

Setting this option to glance.db.registry.api will force all database access requests to be routed through the Registry service. This avoids data access from the Glance API nodes for an added layer of security, scalability and manageability.

NOTE: In v2 OpenStack Images API, the registry service is optional. In order to use the Registry API in v2, the option enable_v2_registry must be set to True.

Finally, when this configuration option is set to glance.db.simple.api, image catalog data is stored in and read from an in-memory data structure. This is primarily used for testing.

Related options:

• enable_v2_api
• enable_v2_registry

Warning

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

Reason:	Glance registry service is deprecated for removal. More information can be found from the spec: http://specs.openstack.org/openstack/glance-specs/specs/queens/approved/glance/deprecate-registry.html

limit_param_default¶

Type:	integer
Default:	25
Minimum Value:	1

The default number of results to return for a request.

Responses to certain API requests, like list images, may return multiple items. The number of results returned can be explicitly controlled by specifying the limit parameter in the API request. However, if a limit parameter is not specified, this configuration value will be used as the default number of results to be returned for any API request.

NOTES:

• The value of this configuration option may not be greater than the value specified by api_limit_max.
• Setting this to a very large value may slow down database queries and increase response times. Setting this to a very low value may result in poor user experience.

Possible values:

• Any positive integer

Related options:

• api_limit_max

api_limit_max¶

Type:	integer
Default:	1000
Minimum Value:	1

Maximum number of results that could be returned by a request.

As described in the help text of limit_param_default, some requests may return multiple results. The number of results to be returned are governed either by the limit parameter in the request or the limit_param_default configuration option. The value in either case, can’t be greater than the absolute maximum defined by this configuration option. Anything greater than this value is trimmed down to the maximum value defined here.

NOTE: Setting this to a very large value may slow down database

queries and increase response times. Setting this to a very low value may result in poor user experience.

Possible values:

• Any positive integer

Related options:

• limit_param_default

show_image_direct_url¶

Type:	boolean
Default:	false

Show direct image location when returning an image.

This configuration option indicates whether to show the direct image location when returning image details to the user. The direct image location is where the image data is stored in backend storage. This image location is shown under the image property direct_url.

When multiple image locations exist for an image, the best location is displayed based on the location strategy indicated by the configuration option location_strategy.

NOTES:

• Revealing image locations can present a GRAVE SECURITY RISK as image locations can sometimes include credentials. Hence, this is set to False by default. Set this to True with EXTREME CAUTION and ONLY IF you know what you are doing!
• If an operator wishes to avoid showing any image location(s) to the user, then both this option and show_multiple_locations MUST be set to False.

Possible values:

• True
• False

Related options:

• show_multiple_locations
• location_strategy

show_multiple_locations¶

Type:	boolean
Default:	false

Show all image locations when returning an image.

This configuration option indicates whether to show all the image locations when returning image details to the user. When multiple image locations exist for an image, the locations are ordered based on the location strategy indicated by the configuration opt location_strategy. The image locations are shown under the image property locations.

NOTES:

• Revealing image locations can present a GRAVE SECURITY RISK as image locations can sometimes include credentials. Hence, this is set to False by default. Set this to True with EXTREME CAUTION and ONLY IF you know what you are doing!
• See https://wiki.openstack.org/wiki/OSSN/OSSN-0065 for more information.
• If an operator wishes to avoid showing any image location(s) to the user, then both this option and show_image_direct_url MUST be set to False.

Possible values:

• True
• False

Related options:

• show_image_direct_url
• location_strategy

Warning

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

Reason:

Use of this option, deprecated since Newton, is a security risk and will be removed once we figure out a way to satisfy those use cases that currently require it. An earlier announcement that the same functionality can be achieved with greater granularity by using policies is incorrect. You cannot work around this option via policy configuration at the present time, though that is the direction we believe the fix will take. Please keep an eye on the Glance release notes to stay up to date on progress in addressing this issue.

image_size_cap¶

Type:	integer
Default:	1099511627776
Minimum Value:	1
Maximum Value:	9223372036854775808

Maximum size of image a user can upload in bytes.

An image upload greater than the size mentioned here would result in an image creation failure. This configuration option defaults to 1099511627776 bytes (1 TiB).

NOTES:

• This value should only be increased after careful consideration and must be set less than or equal to 8 EiB (9223372036854775808).
• This value must be set with careful consideration of the backend storage capacity. Setting this to a very low value may result in a large number of image failures. And, setting this to a very large value may result in faster consumption of storage. Hence, this must be set according to the nature of images created and storage capacity available.

Possible values:

• Any positive number less than or equal to 9223372036854775808

user_storage_quota¶

Type:	string
Default:	0

Maximum amount of image storage per tenant.

This enforces an upper limit on the cumulative storage consumed by all images of a tenant across all stores. This is a per-tenant limit.

The default unit for this configuration option is Bytes. However, storage units can be specified using case-sensitive literals B, KB, MB, GB and TB representing Bytes, KiloBytes, MegaBytes, GigaBytes and TeraBytes respectively. Note that there should not be any space between the value and unit. Value 0 signifies no quota enforcement. Negative values are invalid and result in errors.

Possible values:

• A string that is a valid concatenation of a non-negative integer representing the storage value and an optional string literal representing storage units as mentioned above.

Related options:

• None

enable_v2_api¶

Type:	boolean
Default:	true

Deploy the v2 OpenStack Images API.

When this option is set to True, Glance service will respond to requests on registered endpoints conforming to the v2 OpenStack Images API.

NOTES:

• If this option is disabled, then the enable_v2_registry option, which is enabled by default, is also recommended to be disabled.

Possible values:

• True
• False

Related options:

• enable_v2_registry

enable_v1_registry¶

Type:	boolean
Default:	true

DEPRECATED FOR REMOVAL

enable_v2_registry¶

Type:	boolean
Default:	true

Deploy the v2 API Registry service.

When this option is set to True, the Registry service will be enabled in Glance for v2 API requests.

NOTES:

• Use of Registry is optional in v2 API, so this option must only be enabled if both enable_v2_api is set to True and the data_api option is set to glance.db.registry.api.
• If deploying only the v1 OpenStack Images API, this option, which is enabled by default, should be disabled.

Possible values:

• True
• False

Related options:

• enable_v2_api
• data_api

Warning

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

Reason:	Glance registry service is deprecated for removal. More information can be found from the spec: http://specs.openstack.org/openstack/glance-specs/specs/queens/approved/glance/deprecate-registry.html

pydev_worker_debug_host¶

Type:	host address
Default:	localhost

Host address of the pydev server.

Provide a string value representing the hostname or IP of the pydev server to use for debugging. The pydev server listens for debug connections on this address, facilitating remote debugging in Glance.

Possible values:

• Valid hostname
• Valid IP address

Related options:

• None

pydev_worker_debug_port¶

Type:	port number
Default:	5678
Minimum Value:	0
Maximum Value:	65535

Port number that the pydev server will listen on.

Provide a port number to bind the pydev server to. The pydev process accepts debug connections on this port and facilitates remote debugging in Glance.

Possible values:

• A valid port number

Related options:

• None

metadata_encryption_key¶

Type:	string
Default:	<None>

AES key for encrypting store location metadata.

Provide a string value representing the AES cipher to use for encrypting Glance store metadata.

NOTE: The AES key to use must be set to a random string of length 16, 24 or 32 bytes.

Possible values:

• String value representing a valid AES key

Related options:

• None

digest_algorithm¶

Type:	string
Default:	sha256

Digest algorithm to use for digital signature.

Provide a string value representing the digest algorithm to use for generating digital signatures. By default, sha256 is used.

To get a list of the available algorithms supported by the version of OpenSSL on your platform, run the command: openssl list-message-digest-algorithms. Examples are ‘sha1’, ‘sha256’, and ‘sha512’.

NOTE: digest_algorithm is not related to Glance’s image signing and verification. It is only used to sign the universally unique identifier (UUID) as a part of the certificate file and key file validation.

Possible values:

• An OpenSSL message digest algorithm identifier

Relation options:

• None

node_staging_uri¶

Type:	string
Default:	file:///tmp/staging/

The URL provides location where the temporary data will be stored

This option is for Glance internal use only. Glance will save the image data uploaded by the user to ‘staging’ endpoint during the image import process.

This option does not change the ‘staging’ API endpoint by any means.

NOTE: It is discouraged to use same path as [task]/work_dir

NOTE: ‘file://<absolute-directory-path>’ is the only option api_image_import flow will support for now.

NOTE: The staging path must be on shared filesystem available to all Glance API nodes.

Possible values:

• String starting with ‘file://’ followed by absolute FS path

Related options:

• [task]/work_dir

enabled_import_methods¶

Type:	list
Default:	glance-direct,web-download

List of enabled Image Import Methods

Both ‘glance-direct’ and ‘web-download’ are enabled by default.

Related options:

• [DEFAULT]/node_staging_uri

image_cache_sqlite_db¶

Type:	string
Default:	cache.db

The relative path to sqlite file database that will be used for image cache management.

This is a relative path to the sqlite file database that tracks the age and usage statistics of image cache. The path is relative to image cache base directory, specified by the configuration option image_cache_dir.

This is a lightweight database with just one table.

Possible values:

• A valid relative path to sqlite file database

Related options:

• image_cache_dir

image_cache_driver¶

Type:	string
Default:	sqlite
Valid Values:	sqlite, xattr

The driver to use for image cache management.

This configuration option provides the flexibility to choose between the different image-cache drivers available. An image-cache driver is responsible for providing the essential functions of image-cache like write images to/read images from cache, track age and usage of cached images, provide a list of cached images, fetch size of the cache, queue images for caching and clean up the cache, etc.

The essential functions of a driver are defined in the base class glance.image_cache.drivers.base.Driver. All image-cache drivers (existing and prospective) must implement this interface. Currently available drivers are sqlite and xattr. These drivers primarily differ in the way they store the information about cached images:

• The sqlite driver uses a sqlite database (which sits on every glance

node locally) to track the usage of cached images. * The xattr driver uses the extended attributes of files to store this information. It also requires a filesystem that sets atime on the files when accessed.

Possible values:

• sqlite
• xattr

Related options:

• None

image_cache_max_size¶

Type:	integer
Default:	10737418240
Minimum Value:	0

The upper limit on cache size, in bytes, after which the cache-pruner cleans up the image cache.

NOTE: This is just a threshold for cache-pruner to act upon. It is NOT a hard limit beyond which the image cache would never grow. In fact, depending on how often the cache-pruner runs and how quickly the cache fills, the image cache can far exceed the size specified here very easily. Hence, care must be taken to appropriately schedule the cache-pruner and in setting this limit.

Glance caches an image when it is downloaded. Consequently, the size of the image cache grows over time as the number of downloads increases. To keep the cache size from becoming unmanageable, it is recommended to run the cache-pruner as a periodic task. When the cache pruner is kicked off, it compares the current size of image cache and triggers a cleanup if the image cache grew beyond the size specified here. After the cleanup, the size of cache is less than or equal to size specified here.

Possible values:

• Any non-negative integer

Related options:

• None

image_cache_stall_time¶

Type:	integer
Default:	86400
Minimum Value:	0

The amount of time, in seconds, an incomplete image remains in the cache.

Incomplete images are images for which download is in progress. Please see the description of configuration option image_cache_dir for more detail. Sometimes, due to various reasons, it is possible the download may hang and the incompletely downloaded image remains in the incomplete directory. This configuration option sets a time limit on how long the incomplete images should remain in the incomplete directory before they are cleaned up. Once an incomplete image spends more time than is specified here, it’ll be removed by cache-cleaner on its next run.

It is recommended to run cache-cleaner as a periodic task on the Glance API nodes to keep the incomplete images from occupying disk space.

Possible values:

• Any non-negative integer

Related options:

• None

image_cache_dir¶

Type:	string
Default:	<None>

Base directory for image cache.

This is the location where image data is cached and served out of. All cached images are stored directly under this directory. This directory also contains three subdirectories, namely, incomplete, invalid and queue.

The incomplete subdirectory is the staging area for downloading images. An image is first downloaded to this directory. When the image download is successful it is moved to the base directory. However, if the download fails, the partially downloaded image file is moved to the invalid subdirectory.

The queue``subdirectory is used for queuing images for download. This is used primarily by the cache-prefetcher, which can be scheduled as a periodic task like cache-pruner and cache-cleaner, to cache images ahead of their usage. Upon receiving the request to cache an image, Glance touches a file in the ``queue directory with the image id as the file name. The cache-prefetcher, when running, polls for the files in queue directory and starts downloading them in the order they were created. When the download is successful, the zero-sized file is deleted from the queue directory. If the download fails, the zero-sized file remains and it’ll be retried the next time cache-prefetcher runs.

Possible values:

• A valid path

Related options:

• image_cache_sqlite_db

registry_host¶

Type:	host address
Default:	0.0.0.0

Address the registry server is hosted on.

Possible values:

• A valid IP or hostname

Related options:

• None

Warning

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

Reason:	Glance registry service is deprecated for removal. More information can be found from the spec: http://specs.openstack.org/openstack/glance-specs/specs/queens/approved/glance/deprecate-registry.html

registry_port¶

Type:	port number
Default:	9191
Minimum Value:	0
Maximum Value:	65535

Port the registry server is listening on.

Possible values:

• A valid port number

Related options:

• None

Warning

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

Reason:	Glance registry service is deprecated for removal. More information can be found from the spec: http://specs.openstack.org/openstack/glance-specs/specs/queens/approved/glance/deprecate-registry.html

registry_client_protocol¶

Type:	string
Default:	http
Valid Values:	http, https

Protocol to use for communication with the registry server.

Provide a string value representing the protocol to use for communication with the registry server. By default, this option is set to http and the connection is not secure.

This option can be set to https to establish a secure connection to the registry server. In this case, provide a key to use for the SSL connection using the registry_client_key_file option. Also include the CA file and cert file using the options registry_client_ca_file and registry_client_cert_file respectively.

Possible values:

• http
• https

Related options:

• registry_client_key_file
• registry_client_cert_file
• registry_client_ca_file

Warning

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

Reason:	Glance registry service is deprecated for removal. More information can be found from the spec: http://specs.openstack.org/openstack/glance-specs/specs/queens/approved/glance/deprecate-registry.html

registry_client_key_file¶

Type:	string
Default:	/etc/ssl/key/key-file.pem

Absolute path to the private key file.

Provide a string value representing a valid absolute path to the private key file to use for establishing a secure connection to the registry server.

NOTE: This option must be set if registry_client_protocol is set to https. Alternatively, the GLANCE_CLIENT_KEY_FILE environment variable may be set to a filepath of the key file.

Possible values:

• String value representing a valid absolute path to the key file.

Related options:

• registry_client_protocol

Warning

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

Reason:	Glance registry service is deprecated for removal. More information can be found from the spec: http://specs.openstack.org/openstack/glance-specs/specs/queens/approved/glance/deprecate-registry.html

registry_client_cert_file¶

Type:	string
Default:	/etc/ssl/certs/file.crt

Absolute path to the certificate file.

Provide a string value representing a valid absolute path to the certificate file to use for establishing a secure connection to the registry server.

NOTE: This option must be set if registry_client_protocol is set to https. Alternatively, the GLANCE_CLIENT_CERT_FILE environment variable may be set to a filepath of the certificate file.

Possible values:

• String value representing a valid absolute path to the certificate file.

Related options:

• registry_client_protocol

Warning

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

Reason:	Glance registry service is deprecated for removal. More information can be found from the spec: http://specs.openstack.org/openstack/glance-specs/specs/queens/approved/glance/deprecate-registry.html

registry_client_ca_file¶

Type:	string
Default:	/etc/ssl/cafile/file.ca

Absolute path to the Certificate Authority file.

Provide a string value representing a valid absolute path to the certificate authority file to use for establishing a secure connection to the registry server.

NOTE: This option must be set if registry_client_protocol is set to https. Alternatively, the GLANCE_CLIENT_CA_FILE environment variable may be set to a filepath of the CA file. This option is ignored if the registry_client_insecure option is set to True.

Possible values:

• String value representing a valid absolute path to the CA file.

Related options:

• registry_client_protocol
• registry_client_insecure

Warning

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

Reason:	Glance registry service is deprecated for removal. More information can be found from the spec: http://specs.openstack.org/openstack/glance-specs/specs/queens/approved/glance/deprecate-registry.html

registry_client_insecure¶

Type:	boolean
Default:	false

Set verification of the registry server certificate.

Provide a boolean value to determine whether or not to validate SSL connections to the registry server. By default, this option is set to False and the SSL connections are validated.

If set to True, the connection to the registry server is not validated via a certifying authority and the registry_client_ca_file option is ignored. This is the registry’s equivalent of specifying –insecure on the command line using glanceclient for the API.

Possible values:

• True
• False

Related options:

• registry_client_protocol
• registry_client_ca_file

Warning

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

Reason:	Glance registry service is deprecated for removal. More information can be found from the spec: http://specs.openstack.org/openstack/glance-specs/specs/queens/approved/glance/deprecate-registry.html

registry_client_timeout¶

Type:	integer
Default:	600
Minimum Value:	0

Timeout value for registry requests.

Provide an integer value representing the period of time in seconds that the API server will wait for a registry request to complete. The default value is 600 seconds.

A value of 0 implies that a request will never timeout.

Possible values:

• Zero
• Positive integer

Related options:

• None

Warning

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

Reason:	Glance registry service is deprecated for removal. More information can be found from the spec: http://specs.openstack.org/openstack/glance-specs/specs/queens/approved/glance/deprecate-registry.html

use_user_token¶

Type:	boolean
Default:	true

Whether to pass through the user token when making requests to the registry. To prevent failures with token expiration during big files upload, it is recommended to set this parameter to False.If “use_user_token” is not in effect, then admin credentials can be specified.

Warning

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

Reason:	This option was considered harmful and has been deprecated in M release. It will be removed in O release. For more information read OSSN-0060. Related functionality with uploading big images has been implemented with Keystone trusts support.

admin_user¶

Type:	string
Default:	<None>

The administrators user name. If “use_user_token” is not in effect, then admin credentials can be specified.

Warning

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

Reason:	This option was considered harmful and has been deprecated in M release. It will be removed in O release. For more information read OSSN-0060. Related functionality with uploading big images has been implemented with Keystone trusts support.

admin_password¶

Type:	string
Default:	<None>

The administrators password. If “use_user_token” is not in effect, then admin credentials can be specified.

Warning

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

Reason:	This option was considered harmful and has been deprecated in M release. It will be removed in O release. For more information read OSSN-0060. Related functionality with uploading big images has been implemented with Keystone trusts support.

admin_tenant_name¶

Type:	string
Default:	<None>

The tenant name of the administrative user. If “use_user_token” is not in effect, then admin tenant name can be specified.

Warning

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

Reason:	This option was considered harmful and has been deprecated in M release. It will be removed in O release. For more information read OSSN-0060. Related functionality with uploading big images has been implemented with Keystone trusts support.

auth_url¶

Type:	string
Default:	<None>

The URL to the keystone service. If “use_user_token” is not in effect and using keystone auth, then URL of keystone can be specified.

Warning

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

Reason:	This option was considered harmful and has been deprecated in M release. It will be removed in O release. For more information read OSSN-0060. Related functionality with uploading big images has been implemented with Keystone trusts support.

auth_strategy¶

Type:	string
Default:	noauth

The strategy to use for authentication. If “use_user_token” is not in effect, then auth strategy can be specified.

Warning

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

Reason:	This option was considered harmful and has been deprecated in M release. It will be removed in O release. For more information read OSSN-0060. Related functionality with uploading big images has been implemented with Keystone trusts support.

auth_region¶

Type:	string
Default:	<None>

The region for the authentication service. If “use_user_token” is not in effect and using keystone auth, then region name can be specified.

Warning

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

Reason:	This option was considered harmful and has been deprecated in M release. It will be removed in O release. For more information read OSSN-0060. Related functionality with uploading big images has been implemented with Keystone trusts support.

stores¶

Type:	list
Default:	file,http

List of enabled Glance stores.

Register the storage backends to use for storing disk images as a comma separated list. The default stores enabled for storing disk images with Glance are file and http.

Possible values:

• A comma separated list that could include:

  • file
  • http
  • swift
  • rbd
  • sheepdog
  • cinder
  • vmware

Related Options:

• default_store

Warning

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

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

default_store¶

Type:	string
Default:	file
Valid Values:	file, filesystem, http, https, swift, swift+http, swift+https, swift+config, rbd, sheepdog, cinder, vsphere

The default scheme to use for storing images.

Provide a string value representing the default scheme to use for storing images. If not set, Glance uses file as the default scheme to store images with the file store.

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

Possible values:

• file
• filesystem
• http
• https
• swift
• swift+http
• swift+https
• swift+config
• rbd
• sheepdog
• cinder
• vsphere

Related Options:

• stores

Warning

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

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

store_capabilities_update_min_interval¶

Type:	integer
Default:	0
Minimum Value:	0

Minimum interval in seconds to execute updating dynamic storage capabilities based on current backend status.

Provide an integer value representing time in seconds to set the minimum interval before an update of dynamic storage capabilities for a storage backend can be attempted. Setting store_capabilities_update_min_interval does not mean updates occur periodically based on the set interval. Rather, the update is performed at the elapse of this interval set, if an operation of the store is triggered.

By default, this option is set to zero and is disabled. Provide an integer value greater than zero to enable this option.

NOTE 1: For more information on store capabilities and their updates, please visit: https://specs.openstack.org/openstack/glance-specs/specs/kilo/store-capabilities.html

For more information on setting up a particular store in your deployment and help with the usage of this feature, please contact the storage driver maintainers listed here: https://docs.openstack.org/glance_store/latest/user/drivers.html

NOTE 2: The dynamic store update capability described above is not implemented by any current store drivers. Thus, this option DOES NOT DO ANYTHING (and it never has). It is DEPRECATED and scheduled for removal early in the Stein development cycle.

Possible values:

• Zero
• Positive integer

Related Options:

• None

Warning

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

Reason:	This option configures a stub method that has not been implemented for any existing store drivers. Hence it is non-operational, and giving it a value does absolutely nothing. This option is scheduled for removal early in the Stein development cycle.

cinder_catalog_info¶

Type:	string
Default:	volumev2::publicURL

Information to match when looking for cinder in the service catalog.

When the cinder_endpoint_template is not set and any of cinder_store_auth_address, cinder_store_user_name, cinder_store_project_name, cinder_store_password is not set, cinder store uses this information to lookup cinder endpoint from the service catalog in the current context. cinder_os_region_name, if set, is taken into consideration to fetch the appropriate endpoint.

The service catalog can be listed by the openstack catalog list command.

Possible values:

• A string of of the following form: <service_type>:<service_name>:<interface> At least service_type and interface should be specified. service_name can be omitted.

Related options:

• cinder_os_region_name
• cinder_endpoint_template
• cinder_store_auth_address
• cinder_store_user_name
• cinder_store_project_name
• cinder_store_password

cinder_endpoint_template¶

Type:	string
Default:	<None>

Override service catalog lookup with template for cinder endpoint.

When this option is set, this value is used to generate cinder endpoint, instead of looking up from the service catalog. This value is ignored if cinder_store_auth_address, cinder_store_user_name, cinder_store_project_name, and cinder_store_password are specified.

If this configuration option is set, cinder_catalog_info will be ignored.

Possible values:

• URL template string for cinder endpoint, where %(tenant)s is replaced with the current tenant (project) name. For example: http://cinder.openstack.example.org/v2/%(tenant)s

Related options:

• cinder_store_auth_address
• cinder_store_user_name
• cinder_store_project_name
• cinder_store_password
• cinder_catalog_info

cinder_os_region_name¶

Type:	string
Default:	<None>

Region name to lookup cinder service from the service catalog.

This is used only when cinder_catalog_info is used for determining the endpoint. If set, the lookup for cinder endpoint by this node is filtered to the specified region. It is useful when multiple regions are listed in the catalog. If this is not set, the endpoint is looked up from every region.

Possible values:

• A string that is a valid region name.

Related options:

• cinder_catalog_info

Deprecated Variations¶

Group	Name
glance_store	os_region_name

cinder_ca_certificates_file¶

Type:	string
Default:	<None>

Location of a CA certificates file used for cinder client requests.

The specified CA certificates file, if set, is used to verify cinder connections via HTTPS endpoint. If the endpoint is HTTP, this value is ignored. cinder_api_insecure must be set to True to enable the verification.

Possible values:

• Path to a ca certificates file

Related options:

• cinder_api_insecure

cinder_http_retries¶

Type:	integer
Default:	3
Minimum Value:	0

Number of cinderclient retries on failed http calls.

When a call failed by any errors, cinderclient will retry the call up to the specified times after sleeping a few seconds.

Possible values:

• A positive integer

Related options:

• None

cinder_state_transition_timeout¶

Type:	integer
Default:	300
Minimum Value:	0

Time period, in seconds, to wait for a cinder volume transition to complete.

When the cinder volume is created, deleted, or attached to the glance node to read/write the volume data, the volume’s state is changed. For example, the newly created volume status changes from creating to available after the creation process is completed. This specifies the maximum time to wait for the status change. If a timeout occurs while waiting, or the status is changed to an unexpected value (e.g. error`), the image creation fails.

Possible values:

• A positive integer

Related options:

• None

cinder_api_insecure¶

Type:	boolean
Default:	false

Allow to perform insecure SSL requests to cinder.

If this option is set to True, HTTPS endpoint connection is verified using the CA certificates file specified by cinder_ca_certificates_file option.

Possible values:

• True
• False

Related options:

• cinder_ca_certificates_file

cinder_store_auth_address¶

Type:	string
Default:	<None>

The address where the cinder authentication service is listening.

When all of cinder_store_auth_address, cinder_store_user_name, cinder_store_project_name, and cinder_store_password options are specified, the specified values are always used for the authentication. This is useful to hide the image volumes from users by storing them in a project/tenant specific to the image service. It also enables users to share the image volume among other projects under the control of glance’s ACL.

If either of these options are not set, the cinder endpoint is looked up from the service catalog, and current context’s user and project are used.

Possible values:

• A valid authentication service address, for example: http://openstack.example.org/identity/v2.0

Related options:

• cinder_store_user_name
• cinder_store_password
• cinder_store_project_name

cinder_store_user_name¶

Type:	string
Default:	<None>

User name to authenticate against cinder.

This must be used with all the following related options. If any of these are not specified, the user of the current context is used.

Possible values:

• A valid user name

Related options:

• cinder_store_auth_address
• cinder_store_password
• cinder_store_project_name

cinder_store_password¶

Type:	string
Default:	<None>

Password for the user authenticating against cinder.

This must be used with all the following related options. If any of these are not specified, the user of the current context is used.

Possible values:

• A valid password for the user specified by cinder_store_user_name

Related options:

• cinder_store_auth_address
• cinder_store_user_name
• cinder_store_project_name

cinder_store_project_name¶

Type:	string
Default:	<None>

Project name where the image volume is stored in cinder.

If this configuration option is not set, the project in current context is used.

This must be used with all the following related options. If any of these are not specified, the project of the current context is used.

Possible values:

• A valid project name

Related options:

• cinder_store_auth_address
• cinder_store_user_name
• cinder_store_password

rootwrap_config¶

Type:	string
Default:	/etc/glance/rootwrap.conf

Path to the rootwrap configuration file to use for running commands as root.

The cinder store requires root privileges to operate the image volumes (for connecting to iSCSI/FC volumes and reading/writing the volume data, etc.). The configuration file should allow the required commands by cinder store and os-brick library.

Possible values:

• Path to the rootwrap config file

Related options:

• None

cinder_volume_type¶

Type:	string
Default:	<None>

Volume type that will be used for volume creation in cinder.

Some cinder backends can have several volume types to optimize storage usage. Adding this option allows an operator to choose a specific volume type in cinder that can be optimized for images.

If this is not set, then the default volume type specified in the cinder configuration will be used for volume creation.

Possible values:

• A valid volume type from cinder

Related options:

• None

filesystem_store_datadir¶

Type:	string
Default:	/var/lib/glance/images

Directory to which the filesystem backend store writes images.

Upon start up, Glance creates the directory if it doesn’t already exist and verifies write access to the user under which glance-api runs. If the write access isn’t available, a BadStoreConfiguration exception is raised and the filesystem store may not be available for adding new images.

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

Possible values:

• A valid path to a directory

Related options:

• filesystem_store_datadirs
• filesystem_store_file_perm

filesystem_store_datadirs¶

Type:	multi-valued
Default:	u''

List of directories and their priorities to which the filesystem backend store writes images.

The filesystem store can be configured to store images in multiple directories as opposed to using a single directory specified by the filesystem_store_datadir configuration option. When using multiple directories, each directory can be given an optional priority to specify the preference order in which they should be used. Priority is an integer that is concatenated to the directory path with a colon where a higher value indicates higher priority. When two directories have the same priority, the directory with most free space is used. When no priority is specified, it defaults to zero.

More information on configuring filesystem store with multiple store directories can be found at https://docs.openstack.org/glance/latest/configuration/configuring.html

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

Possible values:

• List of strings of the following form:

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

Related options:

• filesystem_store_datadir
• filesystem_store_file_perm

filesystem_store_metadata_file¶

Type:	string
Default:	<None>

Filesystem store metadata file.

The path to a file which contains the metadata to be returned with any location associated with the filesystem store. The file must contain a valid JSON object. The object should contain the keys id and mountpoint. The value for both keys should be a string.

Possible values:

• A valid path to the store metadata file

Related options:

• None

filesystem_store_file_perm¶

Type:	integer
Default:	0

File access permissions for the image files.

Set the intended file access permissions for image data. This provides a way to enable other services, e.g. Nova, to consume images directly from the filesystem store. The users running the services that are intended to be given access to could be made a member of the group that owns the files created. Assigning a value less then or equal to zero for this configuration option signifies that no changes be made to the default permissions. This value will be decoded as an octal digit.

For more information, please refer the documentation at https://docs.openstack.org/glance/latest/configuration/configuring.html

Possible values:

• A valid file access permission
• Zero
• Any negative integer

Related options:

• None

https_ca_certificates_file¶

Type:	string
Default:	<None>

Path to the CA bundle file.

This configuration option enables the operator to use a custom Certificate Authority file to verify the remote server certificate. If this option is set, the https_insecure option will be ignored and the CA file specified will be used to authenticate the server certificate and establish a secure connection to the server.

Possible values:

• A valid path to a CA file

Related options:

• https_insecure

https_insecure¶

Type:	boolean
Default:	true

Set verification of the remote server certificate.

This configuration option takes in a boolean value to determine whether or not to verify the remote server certificate. If set to True, the remote server certificate is not verified. If the option is set to False, then the default CA truststore is used for verification.

This option is ignored if https_ca_certificates_file is set. The remote server certificate will then be verified using the file specified using the https_ca_certificates_file option.

Possible values:

• True
• False

Related options:

• https_ca_certificates_file

http_proxy_information¶

Type:	dict
Default:	u''

The http/https proxy information to be used to connect to the remote server.

This configuration option specifies the http/https proxy information that should be used to connect to the remote server. The proxy information should be a key value pair of the scheme and proxy, for example, http:10.0.0.1:3128. You can also specify proxies for multiple schemes by separating the key value pairs with a comma, for example, http:10.0.0.1:3128, https:10.0.0.1:1080.

Possible values:

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

Related options:

• None

rbd_store_chunk_size¶

Type:	integer
Default:	8
Minimum Value:	1

Size, in megabytes, to chunk RADOS images into.

Provide an integer value representing the size in megabytes to chunk Glance images into. The default chunk size is 8 megabytes. For optimal performance, the value should be a power of two.

When Ceph’s RBD object storage system is used as the storage backend for storing Glance images, the images are chunked into objects of the size set using this option. These chunked objects are then stored across the distributed block data store to use for Glance.

Possible Values:

• Any positive integer value

Related options:

• None

rbd_store_pool¶

Type:	string
Default:	images

RADOS pool in which images are stored.

When RBD is used as the storage backend for storing Glance images, the images are stored by means of logical grouping of the objects (chunks of images) into a pool. Each pool is defined with the number of placement groups it can contain. The default pool that is used is ‘images’.

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

Possible Values:

• A valid pool name

Related options:

• None

rbd_store_user¶

Type:	string
Default:	<None>

RADOS user to authenticate as.

This configuration option takes in the RADOS user to authenticate as. This is only needed when RADOS authentication is enabled and is applicable only if the user is using Cephx authentication. If the value for this option is not set by the user or is set to None, a default value will be chosen, which will be based on the client. section in rbd_store_ceph_conf.

Possible Values:

• A valid RADOS user

Related options:

• rbd_store_ceph_conf

rbd_store_ceph_conf¶

Type:	string
Default:	/etc/ceph/ceph.conf

Ceph configuration file path.

This configuration option takes in the path to the Ceph configuration file to be used. If the value for this option is not set by the user or is set to None, librados will locate the default configuration file which is located at /etc/ceph/ceph.conf. If using Cephx authentication, this file should include a reference to the right keyring in a client.<USER> section

Possible Values:

• A valid path to a configuration file

Related options:

• rbd_store_user

rados_connect_timeout¶

Type:	integer
Default:	0

Timeout value for connecting to Ceph cluster.

This configuration option takes in the timeout value in seconds used when connecting to the Ceph cluster i.e. it sets the time to wait for glance-api before closing the connection. This prevents glance-api hangups during the connection to RBD. If the value for this option is set to less than or equal to 0, no timeout is set and the default librados value is used.

Possible Values:

• Any integer value

Related options:

• None

sheepdog_store_chunk_size¶

Type:	integer
Default:	64
Minimum Value:	1

Chunk size for images to be stored in Sheepdog data store.

Provide an integer value representing the size in mebibyte (1048576 bytes) to chunk Glance images into. The default chunk size is 64 mebibytes.

When using Sheepdog distributed storage system, the images are chunked into objects of this size and then stored across the distributed data store to use for Glance.

Chunk sizes, if a power of two, help avoid fragmentation and enable improved performance.

Possible values:

• Positive integer value representing size in mebibytes.

Related Options:

• None

sheepdog_store_port¶

Type:	port number
Default:	7000
Minimum Value:	0
Maximum Value:	65535

Port number on which the sheep daemon will listen.

Provide an integer value representing a valid port number on which you want the Sheepdog daemon to listen on. The default port is 7000.

The Sheepdog daemon, also called ‘sheep’, manages the storage in the distributed cluster by writing objects across the storage network. It identifies and acts on the messages it receives on the port number set using sheepdog_store_port option to store chunks of Glance images.

Possible values:

• A valid port number (0 to 65535)

Related Options:

• sheepdog_store_address

sheepdog_store_address¶

Type:	host address
Default:	127.0.0.1

Address to bind the Sheepdog daemon to.

Provide a string value representing the address to bind the Sheepdog daemon to. The default address set for the ‘sheep’ is 127.0.0.1.

The Sheepdog daemon, also called ‘sheep’, manages the storage in the distributed cluster by writing objects across the storage network. It identifies and acts on the messages directed to the address set using sheepdog_store_address option to store chunks of Glance images.

Possible values:

• A valid IPv4 address
• A valid IPv6 address
• A valid hostname

Related Options:

• sheepdog_store_port

swift_store_auth_insecure¶

Type:	boolean
Default:	false

Set verification of the server certificate.

This boolean determines whether or not to verify the server certificate. If this option is set to True, swiftclient won’t check for a valid SSL certificate when authenticating. If the option is set to False, then the default CA truststore is used for verification.

Possible values:

• True
• False

Related options:

• swift_store_cacert

swift_store_cacert¶

Type:	string
Default:	/etc/ssl/certs/ca-certificates.crt

Path to the CA bundle file.

This configuration option enables the operator to specify the path to a custom Certificate Authority file for SSL verification when connecting to Swift.

Possible values:

• A valid path to a CA file

Related options:

• swift_store_auth_insecure

swift_store_region¶

Type:	string
Default:	RegionTwo

The region of Swift endpoint to use by Glance.

Provide a string value representing a Swift region where Glance can connect to for image storage. By default, there is no region set.

When Glance uses Swift as the storage backend to store images for a specific tenant that has multiple endpoints, setting of a Swift region with swift_store_region allows Glance to connect to Swift in the specified region as opposed to a single region connectivity.

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

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

Possible values:

• A string value representing a valid Swift region.

Related Options:

• None

swift_store_endpoint¶

Type:	string
Default:	https://swift.openstack.example.org/v1/path_not_including_container_name

The URL endpoint to use for Swift backend storage.

Provide a string value representing the URL endpoint to use for storing Glance images in Swift store. By default, an endpoint is not set and the storage URL returned by auth is used. Setting an endpoint with swift_store_endpoint overrides the storage URL and is used for Glance image storage.

NOTE: The URL should include the path up to, but excluding the container. The location of an object is obtained by appending the container and object to the configured URL.

Possible values:

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

Related Options:

• None

swift_store_endpoint_type¶

Type:	string
Default:	publicURL
Valid Values:	publicURL, adminURL, internalURL

Endpoint Type of Swift service.

This string value indicates the endpoint type to use to fetch the Swift endpoint. The endpoint type determines the actions the user will be allowed to perform, for instance, reading and writing to the Store. This setting is only used if swift_store_auth_version is greater than 1.

Possible values:

• publicURL
• adminURL
• internalURL

Related options:

• swift_store_endpoint

swift_store_service_type¶

Type:	string
Default:	object-store

Type of Swift service to use.

Provide a string value representing the service type to use for storing images while using Swift backend storage. The default service type is set to object-store.

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

Possible values:

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

Related Options:

• None

swift_store_container¶

Type:	string
Default:	glance

Name of single container to store images/name prefix for multiple containers

When a single container is being used to store images, this configuration option indicates the container within the Glance account to be used for storing all images. When multiple containers are used to store images, this will be the name prefix for all containers. Usage of single/multiple containers can be controlled using the configuration option swift_store_multiple_containers_seed.

When using multiple containers, the containers will be named after the value set for this configuration option with the first N chars of the image UUID as the suffix delimited by an underscore (where N is specified by swift_store_multiple_containers_seed).

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

Possible values:

• If using single container, this configuration option can be any string that is a valid swift container name in Glance’s Swift account
• If using multiple containers, this configuration option can be any string as long as it satisfies the container naming rules enforced by Swift. The value of swift_store_multiple_containers_seed should be taken into account as well.

Related options:

• swift_store_multiple_containers_seed
• swift_store_multi_tenant
• swift_store_create_container_on_put

swift_store_large_object_size¶

Type:	integer
Default:	5120
Minimum Value:	1

The size threshold, in MB, after which Glance will start segmenting image data.

Swift has an upper limit on the size of a single uploaded object. By default, this is 5GB. To upload objects bigger than this limit, objects are segmented into multiple smaller objects that are tied together with a manifest file. For more detail, refer to https://docs.openstack.org/swift/latest/overview_large_objects.html

This configuration option specifies the size threshold over which the Swift driver will start segmenting image data into multiple smaller files. Currently, the Swift driver only supports creating Dynamic Large Objects.

NOTE: This should be set by taking into account the large object limit enforced by the Swift cluster in consideration.

Possible values:

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

Related options:

• swift_store_large_object_chunk_size

swift_store_large_object_chunk_size¶

Type:	integer
Default:	200
Minimum Value:	1

The maximum size, in MB, of the segments when image data is segmented.

When image data is segmented to upload images that are larger than the limit enforced by the Swift cluster, image data is broken into segments that are no bigger than the size specified by this configuration option. Refer to swift_store_large_object_size for more detail.

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

Possible values:

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

Related options:

• swift_store_large_object_size

swift_store_create_container_on_put¶

Type:	boolean
Default:	false

Create container, if it doesn’t already exist, when uploading image.

At the time of uploading an image, if the corresponding container doesn’t exist, it will be created provided this configuration option is set to True. By default, it won’t be created. This behavior is applicable for both single and multiple containers mode.

Possible values:

• True
• False

Related options:

• None

swift_store_multi_tenant¶

Type:	boolean
Default:	false

Store images in tenant’s Swift account.

This enables multi-tenant storage mode which causes Glance images to be stored in tenant specific Swift accounts. If this is disabled, Glance stores all images in its own account. More details multi-tenant store can be found at https://wiki.openstack.org/wiki/GlanceSwiftTenantSpecificStorage

NOTE: If using multi-tenant swift store, please make sure that you do not set a swift configuration file with the ‘swift_store_config_file’ option.

Possible values:

• True
• False

Related options:

• swift_store_config_file

swift_store_multiple_containers_seed¶

Type:	integer
Default:	0
Minimum Value:	0
Maximum Value:	32

Seed indicating the number of containers to use for storing images.

When using a single-tenant store, images can be stored in one or more than one containers. When set to 0, all images will be stored in one single container. When set to an integer value between 1 and 32, multiple containers will be used to store images. This configuration option will determine how many containers are created. The total number of containers that will be used is equal to 16^N, so if this config option is set to 2, then 16^2=256 containers will be used to store images.

Please refer to swift_store_container for more detail on the naming convention. More detail about using multiple containers can be found at https://specs.openstack.org/openstack/glance-specs/specs/kilo/swift-store-multiple-containers.html

NOTE: This is used only when swift_store_multi_tenant is disabled.

Possible values:

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

Related options:

• swift_store_container
• swift_store_multi_tenant
• swift_store_create_container_on_put

swift_store_admin_tenants¶

Type:	list
Default:	u''

List of tenants that will be granted admin access.

This is a list of tenants that will be granted read/write access on all Swift containers created by Glance in multi-tenant mode. The default value is an empty list.

Possible values:

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

Related options:

• None

swift_store_ssl_compression¶

Type:	boolean
Default:	true

SSL layer compression for HTTPS Swift requests.

Provide a boolean value to determine whether or not to compress HTTPS Swift requests for images at the SSL layer. By default, compression is enabled.

When using Swift as the backend store for Glance image storage, SSL layer compression of HTTPS Swift requests can be set using this option. If set to False, SSL layer compression of HTTPS Swift requests is disabled. Disabling this option may improve performance for images which are already in a compressed format, for example, qcow2.

Possible values:

• True
• False

Related Options:

• None

swift_store_retry_get_count¶

Type:	integer
Default:	0
Minimum Value:	0

The number of times a Swift download will be retried before the request fails.

Provide an integer value representing the number of times an image download must be retried before erroring out. The default value is zero (no retry on a failed image download). When set to a positive integer value, swift_store_retry_get_count ensures that the download is attempted this many more times upon a download failure before sending an error message.

Possible values:

• Zero
• Positive integer value

Related Options:

• None

swift_store_expire_soon_interval¶

Type:	integer
Default:	60
Minimum Value:	0

Time in seconds defining the size of the window in which a new token may be requested before the current token is due to expire.

Typically, the Swift storage driver fetches a new token upon the expiration of the current token to ensure continued access to Swift. However, some Swift transactions (like uploading image segments) may not recover well if the token expires on the fly.

Hence, by fetching a new token before the current token expiration, we make sure that the token does not expire or is close to expiry before a transaction is attempted. By default, the Swift storage driver requests for a new token 60 seconds or less before the current token expiration.

Possible values:

• Zero
• Positive integer value

Related Options:

• None

swift_store_use_trusts¶

Type:	boolean
Default:	true

Use trusts for multi-tenant Swift store.

This option instructs the Swift store to create a trust for each add/get request when the multi-tenant store is in use. Using trusts allows the Swift store to avoid problems that can be caused by an authentication token expiring during the upload or download of data.

By default, swift_store_use_trusts is set to True``(use of trusts is enabled). If set to ``False, a user token is used for the Swift connection instead, eliminating the overhead of trust creation.

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

Possible values:

• True
• False

Related options:

• swift_store_multi_tenant

swift_buffer_on_upload¶

Type:	boolean
Default:	false

Buffer image segments before upload to Swift.

Provide a boolean value to indicate whether or not Glance should buffer image data to disk while uploading to swift. This enables Glance to resume uploads on error.

NOTES: When enabling this option, one should take great care as this increases disk usage on the API node. Be aware that depending upon how the file system is configured, the disk space used for buffering may decrease the actual disk space available for the glance image cache. Disk utilization will cap according to the following equation: (swift_store_large_object_chunk_size * workers * 1000)

Possible values:

• True
• False

Related options:

• swift_upload_buffer_dir

default_swift_reference¶

Type:	string
Default:	ref1

Reference to default Swift account/backing store parameters.

Provide a string value representing a reference to the default set of parameters required for using swift account/backing store for image storage. The default reference value for this configuration option is ‘ref1’. This configuration option dereferences the parameters and facilitates image storage in Swift storage backend every time a new image is added.

Possible values:

• A valid string value

Related options:

• None

swift_store_auth_version¶

Type:	string
Default:	2

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

Warning

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

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

swift_store_auth_address¶

Type:	string
Default:	<None>

The address where the Swift authentication service is listening.

Warning

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

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

swift_store_user¶

Type:	string
Default:	<None>

The user to authenticate against the Swift authentication service.

Warning

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

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

swift_store_key¶

Type:	string
Default:	<None>

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

Warning

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

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

swift_store_config_file¶

Type:	string
Default:	<None>

Absolute path to the file containing the swift account(s) configurations.

Include a string value representing the path to a configuration file that has references for each of the configured Swift account(s)/backing stores. By default, no file path is specified and customized Swift referencing is disabled. Configuring this option is highly recommended while using Swift storage backend for image storage as it avoids storage of credentials in the database.

NOTE: Please do not configure this option if you have set swift_store_multi_tenant to True.

Possible values:

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

Related options:

• swift_store_multi_tenant

swift_upload_buffer_dir¶

Type:	string
Default:	<None>

Directory to buffer image segments before upload to Swift.

Provide a string value representing the absolute path to the directory on the glance node where image segments will be buffered briefly before they are uploaded to swift.

NOTES: * This is required only when the configuration option

swift_buffer_on_upload is set to True.

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

Possible values:

• String value representing an absolute directory path

Related options:

• swift_buffer_on_upload
• swift_store_large_object_chunk_size

vmware_server_host¶

Type:	host address
Default:	127.0.0.1

Address of the ESX/ESXi or vCenter Server target system.

This configuration option sets the address of the ESX/ESXi or vCenter Server target system. This option is required when using the VMware storage backend. The address can contain an IP address (127.0.0.1) or a DNS name (www.my-domain.com).

Possible Values:

• A valid IPv4 or IPv6 address
• A valid DNS name

Related options:

• vmware_server_username
• vmware_server_password

vmware_server_username¶

Type:	string
Default:	root

Server username.

This configuration option takes the username for authenticating with the VMware ESX/ESXi or vCenter Server. This option is required when using the VMware storage backend.

Possible Values:

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

Related options:

• vmware_server_host
• vmware_server_password

vmware_server_password¶

Type:	string
Default:	vmware

Server password.

This configuration option takes the password for authenticating with the VMware ESX/ESXi or vCenter Server. This option is required when using the VMware storage backend.

Possible Values:

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

Related options:

• vmware_server_host
• vmware_server_username

vmware_api_retry_count¶

Type:	integer
Default:	10
Minimum Value:	1

The number of VMware API retries.

This configuration option specifies the number of times the VMware ESX/VC server API must be retried upon connection related issues or server API call overload. It is not possible to specify ‘retry forever’.

Possible Values:

• Any positive integer value

Related options:

• None

vmware_task_poll_interval¶

Type:	integer
Default:	5
Minimum Value:	1

Interval in seconds used for polling remote tasks invoked on VMware ESX/VC server.

This configuration option takes in the sleep time in seconds for polling an on-going async task as part of the VMWare ESX/VC server API call.

Possible Values:

• Any positive integer value

Related options:

• None

vmware_store_image_dir¶

Type:	string
Default:	/openstack_glance

The directory where the glance images will be stored in the datastore.

This configuration option specifies the path to the directory where the glance images will be stored in the VMware datastore. If this option is not set, the default directory where the glance images are stored is openstack_glance.

Possible Values:

• Any string that is a valid path to a directory

Related options:

• None

vmware_insecure¶

Type:	boolean
Default:	false

Set verification of the ESX/vCenter server certificate.

This configuration option takes a boolean value to determine whether or not to verify the ESX/vCenter server certificate. If this option is set to True, the ESX/vCenter server certificate is not verified. If this option is set to False, then the default CA truststore is used for verification.

This option is ignored if the “vmware_ca_file” option is set. In that case, the ESX/vCenter server certificate will then be verified using the file specified using the “vmware_ca_file” option .

Possible Values:

• True
• False

Related options:

• vmware_ca_file

Deprecated Variations¶

Group	Name
glance_store	vmware_api_insecure

vmware_ca_file¶

Type:	string
Default:	/etc/ssl/certs/ca-certificates.crt

Absolute path to the CA bundle file.

This configuration option enables the operator to use a custom Cerificate Authority File to verify the ESX/vCenter certificate.

If this option is set, the “vmware_insecure” option will be ignored and the CA file specified will be used to authenticate the ESX/vCenter server certificate and establish a secure connection to the server.

Possible Values:

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

Related options:

• vmware_insecure

vmware_datastores¶

Type:	multi-valued
Default:	u''

The datastores where the image can be stored.

This configuration option specifies the datastores where the image can be stored in the VMWare store backend. This option may be specified multiple times for specifying multiple datastores. The datastore name should be specified after its datacenter path, separated by “:”. An optional weight may be given after the datastore name, separated again by “:” to specify the priority. Thus, the required format becomes <datacenter_path>:<datastore_name>:<optional_weight>.

When adding an image, the datastore with highest weight will be selected, unless there is not enough free space available in cases where the image size is already known. If no weight is given, it is assumed to be zero and the directory will be considered for selection last. If multiple datastores have the same weight, then the one with the most free space available is selected.

Possible Values:

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

Related options:

• None

enforce_scope¶

Type:	boolean
Default:	false

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

policy_file¶

Type:	string
Default:	policy.json

The 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

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