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.
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.
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.
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
.
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.
image_location_quota
¶Type: | integer |
---|---|
Default: | 10 |
Maximum number of locations allowed on an image.
Any negative value is interpreted as unlimited.
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.
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.
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.
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.
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
.
False
by default. Set this to True
with
EXTREME CAUTION and ONLY IF you know what you are doing!show_multiple_locations
MUST be set to False
.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
.
False
by default. Set this to True
with
EXTREME CAUTION and ONLY IF you know what you are doing!show_image_direct_url
MUST be set to False
.Warning
This option is deprecated for removal since Newton. Its value may be silently ignored in the future.
Reason: | This option will be removed in the Pike release or later because the same functionality can be achieved with greater granularity by using policies. Please see the Newton release notes for more information. |
---|
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).
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.
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.
enable_v2_registry
option, which is enabled by default, is also recommended
to be disabled.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.
enable_v2_api
is set to
True
and the data_api
option is set to
glance.db.registry.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.
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.
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.
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.
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.
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.
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.
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 glancenode 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 setsatime
on the files when accessed.
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.
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.
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.
image_cache_sqlite_db
registry_host
¶Type: | host address |
---|---|
Default: | 0.0.0.0 |
Address the registry server is hosted on.
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.
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.
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.
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.
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
.
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.
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.
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. |
---|
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).
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.
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.
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.
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
.
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.
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.
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.
<service_type>:<service_name>:<interface>
At least service_type
and interface
should be specified.
service_name
can be omitted.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.
%(tenant)s
is
replaced with the current tenant (project) name.
For example: http://cinder.openstack.example.org/v2/%(tenant)s
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.
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.
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.
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.
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.
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.
http://openstack.example.org/identity/v2.0
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.
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.
cinder_store_user_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.
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.
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.
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.
filesystem_store_datadirs
filesystem_store_file_perm
filesystem_store_datadirs
¶Type: | multi-valued |
---|---|
Default: | '' |
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.
<a valid directory path>:<optional integer priority>
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.
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
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.
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.
http_proxy_information
¶Type: | dict |
---|---|
Default: | '' |
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.
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.
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/
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.
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
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.
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.
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.
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.
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).
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.
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.
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’.
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.
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.
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 .
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.
vmware_datastores
¶Type: | multi-valued |
---|---|
Default: | '' |
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.
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.
Group | Name |
---|---|
DEFAULT | policy_file |
policy_default_rule
¶Type: | string |
---|---|
Default: | default |
Default rule. Enforced when a requested rule is not found.
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.
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
Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.