glance-api.conf¶
DEFAULT¶
- allow_anonymous_access¶
- Type
boolean
- Default
False
Allow limited access to unauthenticated users.
Assign a boolean to determine API access for unathenticated users. When set to False, the API cannot be accessed by unauthenticated users. When set to True, unauthenticated users can access the API with read-only privileges. This however only applies when using ContextMiddleware.
- Possible values:
True
False
- Related options:
None
- max_request_id_length¶
- Type
integer
- Default
64
- Minimum Value
0
Limit the request ID length.
Provide an integer value to limit the length of the request ID to the specified length. The default value is 64. Users can change this to any ineteger value between 0 and 16384 however keeping in mind that a larger value may flood the logs.
- Possible values:
Integer value between 0 and 16384
- Related options:
None
- public_endpoint¶
- Type
string
- Default
<None>
Public url endpoint to use for Glance versions response.
This is the public url endpoint that will appear in the Glance “versions” response. If no value is specified, the endpoint that is displayed in the version’s response is that of the host running the API service. Change the endpoint to represent the proxy URL if the API service is running behind a proxy. If the service is running behind a load balancer, add the load balancer’s URL for this value.
- Possible values:
None
Proxy URL
Load balancer URL
- Related options:
None
- 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 asadditional 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 viaimage_property_quota
configuration option.- Possible values:
True
False
- Related options:
image_property_quota
Warning
This option is deprecated for removal since Ussuri. Its value may be silently ignored in the future.
- Reason
This option is redundant. Control custom image property usage via the ‘image_property_quota’ configuration option. This option is scheduled to be removed during the Victoria development cycle.
- 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
- 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 alimit
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 thelimit
parameter in the request or thelimit_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 toTrue
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 toFalse
.
- 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 propertylocations
.- 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 toTrue
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 toFalse
.
- 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
andTB
representing Bytes, KiloBytes, MegaBytes, GigaBytes and TeraBytes respectively. Note that there should not be any space between the value and unit. Value0
signifies no quota enforcement. Negative values are invalid and result in errors.This has no effect if
use_keystone_limits
is enabled.- 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:
use_keystone_limits
- use_keystone_limits¶
- Type
boolean
- Default
False
Utilize per-tenant resource limits registered in Keystone.
Enabling this feature will cause Glance to retrieve limits set in keystone for resource consumption and enforce them against API users. Before turning this on, the limits need to be registered in Keystone or all quotas will be considered to be zero, and thus reject all new resource requests.
These per-tenant resource limits are independent from the static global ones configured in this config file. If this is enabled, the relevant static global limits will be ignored.
- pydev_worker_debug_host¶
- Type
host address
- Default
localhost
This option has a sample default set, which means that its actual default value may vary from the one documented above.
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', 'copy-image']
List of enabled Image Import Methods
‘glance-direct’, ‘copy-image’ and ‘web-download’ are enabled by default.
- Related options:
[DEFAULT]/node_staging_uri
- enforce_secure_rbac¶
- Type
boolean
- Default
False
Enforce API access based on common persona definitions used across OpenStack. Enabling this option formalizes project-specific read/write operations, like creating private images or updating the status of shared image, behind the member role. It also formalizes a read-only variant useful for project-specific API operations, like listing private images in a project, behind the reader role.
Operators should take an opportunity to understand glance’s new image policies, audit assignments in their deployment, and update permissions using the default roles in keystone (e.g., admin, member, and reader).
- Related options:
[oslo_policy]/enforce_new_defaults
Warning
This option is deprecated for removal since Wallaby. Its value may be silently ignored in the future.
- Reason
This option has been introduced to require operators to opt into enforcing authorization based on common RBAC personas, which is EXPERIMENTAL as of the Wallaby release. This behavior will be the default and STABLE in a future release, allowing this option to be removed.
- worker_self_reference_url¶
- Type
string
- Default
<None>
The URL to this worker.
If this is set, other glance workers will know how to contact this one directly if needed. For image import, a single worker stages the image and other workers need to be able to proxy the import request to the right one.
If unset, this will be considered to be public_endpoint, which normally would be set to the same value on all workers, effectively disabling the proxying behavior.
- Possible values:
A URL by which this worker is reachable from other workers
- Related options:
public_endpoint
- location_strategy¶
- Type
string
- Default
location_order
- Valid Values
location_order, store_type
Strategy to determine the preference order of image locations.
This configuration option indicates the strategy to determine the order in which an image’s locations must be accessed to serve the image’s data. Glance then retrieves the image data from the first responsive active location it finds in this list.
This option takes one of two possible values
location_order
andstore_type
. The default value islocation_order
, which suggests that image data be served by using locations in the order they are stored in Glance. Thestore_type
value sets the image location preference based on the order in which the storage backends are listed as a comma separated list for the configuration optionstore_type_preference
.- Possible values:
location_order
store_type
- Related options:
store_type_preference
- property_protection_file¶
- Type
string
- Default
<None>
The location of the property protection file.
Provide a valid path to the property protection file which contains the rules for property protections and the roles/policies associated with them.
A property protection file, when set, restricts the Glance image properties to be created, read, updated and/or deleted by a specific set of users that are identified by either roles or policies. If this configuration option is not set, by default, property protections won’t be enforced. If a value is specified and the file is not found, the glance-api service will fail to start. More information on property protections can be found at: https://docs.openstack.org/glance/latest/admin/property-protections.html
- Possible values:
Empty string
Valid path to the property protection configuration file
- Related options:
property_protection_rule_format
- property_protection_rule_format¶
- Type
string
- Default
roles
- Valid Values
roles, policies
Rule format for property protection.
Provide the desired way to set property protection on Glance image properties. The two permissible values are
roles
andpolicies
. The default value isroles
.If the value is
roles
, the property protection file must contain a comma separated list of user roles indicating permissions for each of the CRUD operations on each property being protected. If set topolicies
, a policy defined in policy.yaml is used to express property protections for each of the CRUD operations. Examples of how property protections are enforced based onroles
orpolicies
can be found at: https://docs.openstack.org/glance/latest/admin/property-protections.html#examples- Possible values:
roles
policies
- Related options:
property_protection_file
- bind_host¶
- Type
host address
- Default
0.0.0.0
IP address to bind the glance servers to.
Provide an IP address to bind the glance server to. The default value is
0.0.0.0
.Edit this option to enable the server to listen on one particular IP address on the network card. This facilitates selection of a particular network interface for the server.
- Possible values:
A valid IPv4 address
A valid IPv6 address
- Related options:
None
- bind_port¶
- Type
port number
- Default
<None>
- Minimum Value
0
- Maximum Value
65535
Port number on which the server will listen.
Provide a valid port number to bind the server’s socket to. This port is then set to identify processes and forward network messages that arrive at the server. The default bind_port value for the API server is 9292 and for the registry server is 9191.
- Possible values:
A valid port number (0 to 65535)
- Related options:
None
- workers¶
- Type
integer
- Default
<None>
- Minimum Value
0
Number of Glance worker processes to start.
Provide a non-negative integer value to set the number of child process workers to service requests. By default, the number of CPUs available is set as the value for
workers
limited to 8. For example if the processor count is 6, 6 workers will be used, if the processor count is 24 only 8 workers will be used. The limit will only apply to the default value, if 24 workers is configured, 24 is used.Each worker process is made to listen on the port set in the configuration file and contains a greenthread pool of size 1000.
NOTE: Setting the number of workers to zero, triggers the creation of a single API process with a greenthread pool of size 1000.
- Possible values:
0
Positive integer value (typically equal to the number of CPUs)
- Related options:
None
- max_header_line¶
- Type
integer
- Default
16384
- Minimum Value
0
Maximum line size of message headers.
Provide an integer value representing a length to limit the size of message headers. The default value is 16384.
NOTE:
max_header_line
may need to be increased when using large tokens (typically those generated by the Keystone v3 API with big service catalogs). However, it is to be kept in mind that larger values formax_header_line
would flood the logs.Setting
max_header_line
to 0 sets no limit for the line size of message headers.- Possible values:
0
Positive integer
- Related options:
None
- http_keepalive¶
- Type
boolean
- Default
True
Set keep alive option for HTTP over TCP.
Provide a boolean value to determine sending of keep alive packets. If set to
False
, the server returns the header “Connection: close”. If set toTrue
, the server returns a “Connection: Keep-Alive” in its responses. This enables retention of the same TCP connection for HTTP conversations instead of opening a new one with each new request.This option must be set to
False
if the client socket connection needs to be closed explicitly after the response is received and read successfully by the client.- Possible values:
True
False
- Related options:
None
- client_socket_timeout¶
- Type
integer
- Default
900
- Minimum Value
0
Timeout for client connections’ socket operations.
Provide a valid integer value representing time in seconds to set the period of wait before an incoming connection can be closed. The default value is 900 seconds.
The value zero implies wait forever.
- Possible values:
Zero
Positive integer
- Related options:
None
- backlog¶
- Type
integer
- Default
4096
- Minimum Value
1
Set the number of incoming connection requests.
Provide a positive integer value to limit the number of requests in the backlog queue. The default queue size is 4096.
An incoming connection to a TCP listener socket is queued before a connection can be established with the server. Setting the backlog for a TCP socket ensures a limited queue size for incoming traffic.
- Possible values:
Positive integer
- Related options:
None
- tcp_keepidle¶
- Type
integer
- Default
600
- Minimum Value
1
Set the wait time before a connection recheck.
Provide a positive integer value representing time in seconds which is set as the idle wait time before a TCP keep alive packet can be sent to the host. The default value is 600 seconds.
Setting
tcp_keepidle
helps verify at regular intervals that a connection is intact and prevents frequent TCP connection reestablishment.- Possible values:
Positive integer value representing time in seconds
- Related options:
None
- secure_proxy_ssl_header¶
- Type
string
- Default
<None>
The HTTP header used to determine the scheme for the original request, even if it was removed by an SSL terminating proxy. Typical value is “HTTP_X_FORWARDED_PROTO”.
Warning
This option is deprecated for removal. Its value may be silently ignored in the future.
- Reason
Use the http_proxy_to_wsgi middleware instead.
- enabled_backends¶
- Type
dict
- Default
<None>
Key:Value pair of store identifier and store type. In case of multiple backends should be separated using comma.
- 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 aresqlite
andxattr
. 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 setsatime
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 theincomplete
directory. This configuration option sets a time limit on how long the incomplete images should remain in theincomplete
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
andqueue
.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 theinvalid
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 inqueue
directory and starts downloading them in the order they were created. When the download is successful, the zero-sized file is deleted from thequeue
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
- default_publisher_id¶
- Type
string
- Default
image.localhost
Default publisher_id for outgoing Glance notifications.
This is the value that the notification driver will use to identify messages for events originating from the Glance service. Typically, this is the hostname of the instance that generated the message.
- Possible values:
Any reasonable instance identifier, for example: image.host1
- Related options:
None
- disabled_notifications¶
- Type
list
- Default
[]
List of notifications to be disabled.
Specify a list of notifications that should not be emitted. A notification can be given either as a notification type to disable a single event notification, or as a notification group prefix to disable all event notifications within a group.
- Possible values:
A comma-separated list of individual notification types or notification groups to be disabled. Currently supported groups:
image
image.member
task
metadef_namespace
metadef_object
metadef_property
metadef_resource_type
metadef_tag
For a complete listing and description of each event refer to: http://docs.openstack.org/developer/glance/notifications.html
The values must be specified as: <group_name>.<event_name> For example: image.create,task.success,metadef_tag
- Related options:
None
- scrub_time¶
- Type
integer
- Default
0
- Minimum Value
0
The amount of time, in seconds, to delay image scrubbing.
When delayed delete is turned on, an image is put into
pending_delete
state upon deletion until the scrubber deletes its image data. Typically, soon after the image is put intopending_delete
state, it is available for scrubbing. However, scrubbing can be delayed until a later point using this configuration option. This option denotes the time period an image spends inpending_delete
state before it is available for scrubbing.It is important to realize that this has storage implications. The larger the
scrub_time
, the longer the time to reclaim backend storage from deleted images.- Possible values:
Any non-negative integer
- Related options:
delayed_delete
- scrub_pool_size¶
- Type
integer
- Default
1
- Minimum Value
1
The size of thread pool to be used for scrubbing images.
When there are a large number of images to scrub, it is beneficial to scrub images in parallel so that the scrub queue stays in control and the backend storage is reclaimed in a timely fashion. This configuration option denotes the maximum number of images to be scrubbed in parallel. The default value is one, which signifies serial scrubbing. Any value above one indicates parallel scrubbing.
- Possible values:
Any non-zero positive integer
- Related options:
delayed_delete
- delayed_delete¶
- Type
boolean
- Default
False
Turn on/off delayed delete.
Typically when an image is deleted, the
glance-api
service puts the image intodeleted
state and deletes its data at the same time. Delayed delete is a feature in Glance that delays the actual deletion of image data until a later point in time (as determined by the configuration optionscrub_time
). When delayed delete is turned on, theglance-api
service puts the image intopending_delete
state upon deletion and leaves the image data in the storage backend for the image scrubber to delete at a later time. The image scrubber will move the image intodeleted
state upon successful deletion of image data.NOTE: When delayed delete is turned on, image scrubber MUST be running as a periodic task to prevent the backend storage from filling up with undesired usage.
- Possible values:
True
False
- Related options:
scrub_time
wakeup_time
scrub_pool_size
- 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, log-date-format).
¶ 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.
- use_eventlog¶
- Type
boolean
- Default
False
Log output to Windows Event Log.
- log_rotate_interval¶
- Type
integer
- Default
1
The amount of time before the log files are rotated. This option is ignored unless log_rotation_type is set to “interval”.
- log_rotate_interval_type¶
- Type
string
- Default
days
- Valid Values
Seconds, Minutes, Hours, Days, Weekday, Midnight
Rotation interval type. The time of the last file change (or the time when the service was started) is used when scheduling the next rotation.
- max_logfile_count¶
- Type
integer
- Default
30
Maximum number of rotated log files.
- max_logfile_size_mb¶
- Type
integer
- Default
200
Log file maximum size in MB. This option is ignored if “log_rotation_type” is not set to “size”.
- log_rotation_type¶
- Type
string
- Default
none
- Valid Values
interval, size, none
Log rotation type.
Possible values
- interval
Rotate logs at predefined time intervals.
- size
Rotate logs once they reach a predefined size.
- none
Do not rotate log files.
- 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. Used by oslo_log.formatters.ContextFormatter
- 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. Used by oslo_log.formatters.ContextFormatter
- 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. Used by oslo_log.formatters.ContextFormatter
- 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. Used by oslo_log.formatters.ContextFormatter
- 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. Used by oslo_log.formatters.ContextFormatter
- 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', 'oslo_policy=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.
- rpc_conn_pool_size¶
- Type
integer
- Default
30
- Minimum Value
1
Size of RPC connection pool.
¶ Group
Name
DEFAULT
rpc_conn_pool_size
- conn_pool_min_size¶
- Type
integer
- Default
2
The pool size limit for connections expiration policy
- conn_pool_ttl¶
- Type
integer
- Default
1200
The time-to-live in sec of idle connections in the pool
- executor_thread_pool_size¶
- Type
integer
- Default
64
Size of executor thread pool when executor is threading or eventlet.
¶ Group
Name
DEFAULT
rpc_thread_pool_size
- rpc_response_timeout¶
- Type
integer
- Default
60
Seconds to wait for a response from a call.
- transport_url¶
- Type
string
- Default
rabbit://
The network address and optional user credentials for connecting to the messaging backend, in URL format. The expected format is:
driver://[user:pass@]host:port[,[userN:passN@]hostN:portN]/virtual_host?query
Example: rabbit://rabbitmq:password@127.0.0.1:5672//
For full details on the fields in the URL see the documentation of oslo_messaging.TransportURL at https://docs.openstack.org/oslo.messaging/latest/reference/transport.html
- control_exchange¶
- Type
string
- Default
openstack
The default exchange under which topics are scoped. May be overridden by an exchange name specified in the transport_url option.
- rpc_ping_enabled¶
- Type
boolean
- Default
False
Add an endpoint to answer to ping calls. Endpoint is named oslo_rpc_server_ping
barbican¶
- barbican_endpoint¶
- Type
string
- Default
<None>
Use this endpoint to connect to Barbican, for example: “http://localhost:9311/”
- barbican_api_version¶
- Type
string
- Default
<None>
Version of the Barbican API, for example: “v1”
- auth_endpoint¶
- Type
string
- Default
http://localhost/identity/v3
Use this endpoint to connect to Keystone
¶ Group
Name
key_manager
auth_url
- retry_delay¶
- Type
integer
- Default
1
Number of seconds to wait before retrying poll for key creation completion
- number_of_retries¶
- Type
integer
- Default
60
Number of times to retry poll for key creation completion
- verify_ssl¶
- Type
boolean
- Default
True
Specifies if insecure TLS (https) requests. If False, the server’s certificate will not be validated, if True, we can set the verify_ssl_path config meanwhile.
- verify_ssl_path¶
- Type
string
- Default
<None>
A path to a bundle or CA certs to check against, or None for requests to attempt to locate and use certificates which verify_ssh is True. If verify_ssl is False, this is ignored.
- barbican_endpoint_type¶
- Type
string
- Default
public
- Valid Values
public, internal, admin
Specifies the type of endpoint. Allowed values are: public, private, and admin
- barbican_region_name¶
- Type
string
- Default
<None>
Specifies the region of the chosen endpoint.
- send_service_user_token¶
- Type
boolean
- Default
False
When True, if sending a user token to a REST API, also send a service token.
Nova often reuses the user token provided to the nova-api to talk to other REST APIs, such as Cinder, Glance and Neutron. It is possible that while the user token was valid when the request was made to Nova, the token may expire before it reaches the other service. To avoid any failures, and to make it clear it is Nova calling the service on the user’s behalf, we include a service token along with the user token. Should the user’s token have expired, a valid service token ensures the REST API request will still be accepted by the keystone middleware.
barbican_service_user¶
- cafile¶
- Type
string
- Default
<None>
PEM encoded Certificate Authority to use when verifying HTTPs connections.
- certfile¶
- Type
string
- Default
<None>
PEM encoded client certificate cert file
- keyfile¶
- Type
string
- Default
<None>
PEM encoded client certificate key file
- insecure¶
- Type
boolean
- Default
False
Verify HTTPS connections.
- timeout¶
- Type
integer
- Default
<None>
Timeout value for http requests
- collect_timing¶
- Type
boolean
- Default
False
Collect per-API call timing information.
- split_loggers¶
- Type
boolean
- Default
False
Log requests to multiple loggers.
- auth_type¶
- Type
unknown type
- Default
<None>
Authentication type to load
¶ Group
Name
barbican_service_user
auth_plugin
- auth_section¶
- Type
unknown type
- Default
<None>
Config Section from which to load plugin specific options
cors¶
- allowed_origin¶
- Type
list
- Default
<None>
Indicate whether this resource may be shared with the domain received in the requests “origin” header. Format: “<protocol>://<host>[:<port>]”, no trailing slash. Example: https://horizon.example.com
- allow_credentials¶
- Type
boolean
- Default
True
Indicate that the actual request can include user credentials
- expose_headers¶
- Type
list
- Default
['X-Image-Meta-Checksum', 'X-Auth-Token', 'X-Subject-Token', 'X-Service-Token', 'X-OpenStack-Request-ID']
Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers.
- max_age¶
- Type
integer
- Default
3600
Maximum cache age of CORS preflight requests.
- allow_methods¶
- Type
list
- Default
['GET', 'PUT', 'POST', 'DELETE', 'PATCH']
Indicate which methods can be used during the actual request.
- allow_headers¶
- Type
list
- Default
['Content-MD5', 'X-Image-Meta-Checksum', 'X-Storage-Token', 'Accept-Encoding', 'X-Auth-Token', 'X-Identity-Status', 'X-Roles', 'X-Service-Catalog', 'X-User-Id', 'X-Tenant-Id', 'X-OpenStack-Request-ID']
Indicate which header field names may be used during the actual request.
database¶
- sqlite_synchronous¶
- Type
boolean
- Default
True
If True, SQLite uses synchronous mode.
¶ Group
Name
DEFAULT
sqlite_synchronous
- backend¶
- Type
string
- Default
sqlalchemy
The back end to use for the database.
¶ Group
Name
DEFAULT
db_backend
- connection¶
- Type
string
- Default
<None>
The SQLAlchemy connection string to use to connect to the database.
¶ Group
Name
DEFAULT
sql_connection
DATABASE
sql_connection
sql
connection
- slave_connection¶
- Type
string
- Default
<None>
The SQLAlchemy connection string to use to connect to the slave database.
- mysql_sql_mode¶
- Type
string
- Default
TRADITIONAL
The SQL mode to be used for MySQL sessions. This option, including the default, overrides any server-set SQL mode. To use whatever SQL mode is set by the server configuration, set this to no value. Example: mysql_sql_mode=
- mysql_enable_ndb¶
- Type
boolean
- Default
False
If True, transparently enables support for handling MySQL Cluster (NDB).
- connection_recycle_time¶
- Type
integer
- Default
3600
Connections which have been present in the connection pool longer than this number of seconds will be replaced with a new one the next time they are checked out from the pool.
- max_pool_size¶
- Type
integer
- Default
5
Maximum number of SQL connections to keep open in a pool. Setting a value of 0 indicates no limit.
- max_retries¶
- Type
integer
- Default
10
Maximum number of database connection retries during startup. Set to -1 to specify an infinite retry count.
¶ Group
Name
DEFAULT
sql_max_retries
DATABASE
sql_max_retries
- retry_interval¶
- Type
integer
- Default
10
Interval between retries of opening a SQL connection.
¶ Group
Name
DEFAULT
sql_retry_interval
DATABASE
reconnect_interval
- max_overflow¶
- Type
integer
- Default
50
If set, use this value for max_overflow with SQLAlchemy.
¶ Group
Name
DEFAULT
sql_max_overflow
DATABASE
sqlalchemy_max_overflow
- connection_debug¶
- Type
integer
- Default
0
- Minimum Value
0
- Maximum Value
100
Verbosity of SQL debugging information: 0=None, 100=Everything.
¶ Group
Name
DEFAULT
sql_connection_debug
- connection_trace¶
- Type
boolean
- Default
False
Add Python stack traces to SQL as comment strings.
¶ Group
Name
DEFAULT
sql_connection_trace
- pool_timeout¶
- Type
integer
- Default
<None>
If set, use this value for pool_timeout with SQLAlchemy.
¶ Group
Name
DATABASE
sqlalchemy_pool_timeout
- use_db_reconnect¶
- Type
boolean
- Default
False
Enable the experimental use of database reconnect on connection lost.
- db_retry_interval¶
- Type
integer
- Default
1
Seconds between retries of a database transaction.
- db_inc_retry_interval¶
- Type
boolean
- Default
True
If True, increases the interval between retries of a database operation up to db_max_retry_interval.
- db_max_retry_interval¶
- Type
integer
- Default
10
If db_inc_retry_interval is set, the maximum seconds between retries of a database operation.
- db_max_retries¶
- Type
integer
- Default
20
Maximum retries in case of connection error or deadlock error before error is raised. Set to -1 to specify an infinite retry count.
- connection_parameters¶
- Type
string
- Default
''
Optional URL parameters to append onto the connection URL at connect time; specify as param1=value1¶m2=value2&…
- use_tpool¶
- Type
boolean
- Default
False
Enable the experimental use of thread pooling for all DB API calls
¶ Group
Name
DEFAULT
dbapi_use_tpool
Warning
This option is deprecated for removal since 10.0.0. Its value may be silently ignored in the future.
- Reason
This feature has never graduated from experimental status and is now being removed due to lack of maintenance and test coverage
file¶
- 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, aBadStoreConfiguration
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
orfilesystem_store_datadirs
option must be specified inglance-api.conf
. If both options are specified, aBadStoreConfiguration
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
''
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
orfilesystem_store_datadirs
option must be specified inglance-api.conf
. If both options are specified, aBadStoreConfiguration
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. Once this option is set, it is used for new images created afterward only - previously existing images are not affected.
The file must contain a valid JSON object. The object should contain the keys
id
andmountpoint
. 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
- filesystem_store_chunk_size¶
- Type
integer
- Default
65536
- Minimum Value
1
Chunk size, in bytes.
The chunk size used when reading or writing image files. Raising this value may improve the throughput but it may also slightly increase the memory usage when handling a large number of requests.
- Possible Values:
Any positive integer value
- Related options:
None
- filesystem_thin_provisioning¶
- Type
boolean
- Default
False
Enable or not thin provisioning in this backend.
This configuration option enable the feature of not really write null byte sequences on the filesystem, the holes who can appear will automatically be interpreted by the filesystem as null bytes, and do not really consume your storage. Enabling this feature will also speed up image upload and save network trafic in addition to save space in the backend, as null bytes sequences are not sent over the network.
- Possible Values:
True
False
- Related options:
None
glance.store.http.store¶
- 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 thehttps_ca_certificates_file
option.- Possible values:
True
False
- Related options:
https_ca_certificates_file
- 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.
- Possible values:
A comma separated list of scheme:proxy pairs as described above
- Related options:
None
glance.store.rbd.store¶
- 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
''
Ceph configuration file path.
This configuration option specifies 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 the empty string, librados will read the standard ceph.conf file by searching the default Ceph configuration file locations in sequential order. See the Ceph documentation for details.
NOTE: If using Cephx authentication, this file should include a reference to the right keyring in a client.<USER> section
NOTE 2: If you leave this option empty (the default), the actual Ceph configuration file used may change depending on what version of librados is being used. If it is important for you to know exactly which configuration file is in effect, you may specify that file here using this option.
- 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
- rbd_thin_provisioning¶
- Type
boolean
- Default
False
Enable or not thin provisioning in this backend.
This configuration option enable the feature of not really write null byte sequences on the RBD backend, the holes who can appear will automatically be interpreted by Ceph as null bytes, and do not really consume your storage. Enabling this feature will also speed up image upload and save network trafic in addition to save space in the backend, as null bytes sequences are not sent over the network.
- Possible Values:
True
False
- Related options:
None
glance.store.swift.store¶
- 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
This option has a sample default set, which means that its actual default value may vary from the one documented above.
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
This option has a sample default set, which means that its actual default value may vary from the one documented above.
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 necessaryonly 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
This option has a sample default set, which means that its actual default value may vary from the one documented above.
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 withswift_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 beobject-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 UUIDfdae39a1-bac5-4238-aba4-69bcc726e848
would be placed in the containerglance_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 beglance_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 andswift_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.htmlNOTE: 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
[]
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 toTrue``(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 toTrue
- 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
toTrue
.- 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
glance.store.vmware_datastore.store¶
- vmware_server_host¶
- Type
host address
- Default
127.0.0.1
This option has a sample default set, which means that its actual default value may vary from the one documented above.
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
This option has a sample default set, which means that its actual default value may vary from the one documented above.
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
This option has a sample default set, which means that its actual default value may vary from the one documented above.
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
¶ Group
Name
glance.store.vmware_datastore.store
vmware_api_insecure
- vmware_ca_file¶
- Type
string
- Default
/etc/ssl/certs/ca-certificates.crt
This option has a sample default set, which means that its actual default value may vary from the one documented above.
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
''
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
glance_store¶
- default_backend¶
- Type
string
- Default
<None>
The store identifier for the default backend in which data will be stored.
The value must be defined as one of the keys in the dict defined by the
enabled_backends
configuration option in the DEFAULT configuration group.If a value is not defined for this option:
the consuming service may refuse to start
store_add calls that do not specify a specific backend will raise a
glance_store.exceptions.UnknownScheme
exception
- Related Options:
enabled_backends
- 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
andhttp
.- Possible values:
- A comma separated list that could include:
file
http
swift
rbd
cinder
vmware
s3
- 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 U development cycle.
- default_store¶
- Type
string
- Default
file
- Valid Values
file, filesystem, http, https, swift, swift+http, swift+https, swift+config, rbd, cinder, vsphere, s3
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 thefile
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
cinder
vsphere
s3
- 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 todefault_store
config option. This option is scheduled for removal in the U development cycle.
- 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, aBadStoreConfiguration
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
orfilesystem_store_datadirs
option must be specified inglance-api.conf
. If both options are specified, aBadStoreConfiguration
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
''
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
orfilesystem_store_datadirs
option must be specified inglance-api.conf
. If both options are specified, aBadStoreConfiguration
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. Once this option is set, it is used for new images created afterward only - previously existing images are not affected.
The file must contain a valid JSON object. The object should contain the keys
id
andmountpoint
. 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
- filesystem_store_chunk_size¶
- Type
integer
- Default
65536
- Minimum Value
1
Chunk size, in bytes.
The chunk size used when reading or writing image files. Raising this value may improve the throughput but it may also slightly increase the memory usage when handling a large number of requests.
- Possible Values:
Any positive integer value
- Related options:
None
- filesystem_thin_provisioning¶
- Type
boolean
- Default
False
Enable or not thin provisioning in this backend.
This configuration option enable the feature of not really write null byte sequences on the filesystem, the holes who can appear will automatically be interpreted by the filesystem as null bytes, and do not really consume your storage. Enabling this feature will also speed up image upload and save network trafic in addition to save space in the backend, as null bytes sequences are not sent over the network.
- Possible Values:
True
False
- 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 thehttps_ca_certificates_file
option.- Possible values:
True
False
- Related options:
https_ca_certificates_file
- 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.
- 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
''
Ceph configuration file path.
This configuration option specifies 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 the empty string, librados will read the standard ceph.conf file by searching the default Ceph configuration file locations in sequential order. See the Ceph documentation for details.
NOTE: If using Cephx authentication, this file should include a reference to the right keyring in a client.<USER> section
NOTE 2: If you leave this option empty (the default), the actual Ceph configuration file used may change depending on what version of librados is being used. If it is important for you to know exactly which configuration file is in effect, you may specify that file here using this option.
- 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
- rbd_thin_provisioning¶
- Type
boolean
- Default
False
Enable or not thin provisioning in this backend.
This configuration option enable the feature of not really write null byte sequences on the RBD backend, the holes who can appear will automatically be interpreted by Ceph as null bytes, and do not really consume your storage. Enabling this feature will also speed up image upload and save network trafic in addition to save space in the backend, as null bytes sequences are not sent over the network.
- Possible Values:
True
False
- Related options:
None
- 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
This option has a sample default set, which means that its actual default value may vary from the one documented above.
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
This option has a sample default set, which means that its actual default value may vary from the one documented above.
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 necessaryonly 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
This option has a sample default set, which means that its actual default value may vary from the one documented above.
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 withswift_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 beobject-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 UUIDfdae39a1-bac5-4238-aba4-69bcc726e848
would be placed in the containerglance_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 beglance_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 andswift_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.htmlNOTE: 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
[]
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 toTrue``(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 toTrue
- 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
toTrue
.- 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
This option has a sample default set, which means that its actual default value may vary from the one documented above.
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
This option has a sample default set, which means that its actual default value may vary from the one documented above.
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
This option has a sample default set, which means that its actual default value may vary from the one documented above.
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
¶ Group
Name
glance_store
vmware_api_insecure
- vmware_ca_file¶
- Type
string
- Default
/etc/ssl/certs/ca-certificates.crt
This option has a sample default set, which means that its actual default value may vary from the one documented above.
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
''
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
healthcheck¶
- path¶
- Type
string
- Default
/healthcheck
The path to respond to healtcheck requests on.
Warning
This option is deprecated for removal. Its value may be silently ignored in the future.
- detailed¶
- Type
boolean
- Default
False
Show more detailed information as part of the response. Security note: Enabling this option may expose sensitive details about the service being monitored. Be sure to verify that it will not violate your security policies.
- backends¶
- Type
list
- Default
[]
Additional backends that can perform health checks and report that information back as part of a request.
- disable_by_file_path¶
- Type
string
- Default
<None>
Check the presence of a file to determine if an application is running on a port. Used by DisableByFileHealthcheck plugin.
- disable_by_file_paths¶
- Type
list
- Default
[]
Check the presence of a file based on a port to determine if an application is running on a port. Expects a “port:path” list of strings. Used by DisableByFilesPortsHealthcheck plugin.
image_format¶
- container_formats¶
- Type
list
- Default
['ami', 'ari', 'aki', 'bare', 'ovf', 'ova', 'docker', 'compressed']
Supported values for the ‘container_format’ image attribute
¶ Group
Name
DEFAULT
container_formats
- disk_formats¶
- Type
list
- Default
['ami', 'ari', 'aki', 'vhd', 'vhdx', 'vmdk', 'raw', 'qcow2', 'vdi', 'iso', 'ploop']
Supported values for the ‘disk_format’ image attribute
¶ Group
Name
DEFAULT
disk_formats
- vmdk_allowed_types¶
- Type
list
- Default
['streamOptimized', 'monolithicSparse']
A list of strings describing allowed VMDK ‘create-type’ subformats that will be allowed. This is recommended to only include single-file-with-sparse-header variants to avoid potential host file exposure due to processing named extents. If this list is empty, then no VDMK image types allowed. Note that this is currently only checked during image conversion (if enabled), and limits the types of VMDK images we will convert from.
key_manager¶
- backend¶
- Type
string
- Default
barbican
Specify the key manager implementation. Options are “barbican” and “vault”. Default is “barbican”. Will support the values earlier set using [key_manager]/api_class for some time.
¶ Group
Name
key_manager
api_class
- auth_type¶
- Type
string
- Default
<None>
The type of authentication credential to create. Possible values are ‘token’, ‘password’, ‘keystone_token’, and ‘keystone_password’. Required if no context is passed to the credential factory.
- token¶
- Type
string
- Default
<None>
Token for authentication. Required for ‘token’ and ‘keystone_token’ auth_type if no context is passed to the credential factory.
- username¶
- Type
string
- Default
<None>
Username for authentication. Required for ‘password’ auth_type. Optional for the ‘keystone_password’ auth_type.
- password¶
- Type
string
- Default
<None>
Password for authentication. Required for ‘password’ and ‘keystone_password’ auth_type.
- auth_url¶
- Type
string
- Default
<None>
Use this endpoint to connect to Keystone.
- user_id¶
- Type
string
- Default
<None>
User ID for authentication. Optional for ‘keystone_token’ and ‘keystone_password’ auth_type.
- user_domain_id¶
- Type
string
- Default
<None>
User’s domain ID for authentication. Optional for ‘keystone_token’ and ‘keystone_password’ auth_type.
- user_domain_name¶
- Type
string
- Default
<None>
User’s domain name for authentication. Optional for ‘keystone_token’ and ‘keystone_password’ auth_type.
- trust_id¶
- Type
string
- Default
<None>
Trust ID for trust scoping. Optional for ‘keystone_token’ and ‘keystone_password’ auth_type.
- domain_id¶
- Type
string
- Default
<None>
Domain ID for domain scoping. Optional for ‘keystone_token’ and ‘keystone_password’ auth_type.
- domain_name¶
- Type
string
- Default
<None>
Domain name for domain scoping. Optional for ‘keystone_token’ and ‘keystone_password’ auth_type.
- project_id¶
- Type
string
- Default
<None>
Project ID for project scoping. Optional for ‘keystone_token’ and ‘keystone_password’ auth_type.
- project_name¶
- Type
string
- Default
<None>
Project name for project scoping. Optional for ‘keystone_token’ and ‘keystone_password’ auth_type.
- project_domain_id¶
- Type
string
- Default
<None>
Project’s domain ID for project. Optional for ‘keystone_token’ and ‘keystone_password’ auth_type.
- project_domain_name¶
- Type
string
- Default
<None>
Project’s domain name for project. Optional for ‘keystone_token’ and ‘keystone_password’ auth_type.
- reauthenticate¶
- Type
boolean
- Default
True
Allow fetching a new token if the current one is going to expire. Optional for ‘keystone_token’ and ‘keystone_password’ auth_type.
keystone_authtoken¶
- www_authenticate_uri¶
- Type
string
- Default
<None>
Complete “public” Identity API endpoint. This endpoint should not be an “admin” endpoint, as it should be accessible by all end users. Unauthenticated clients are redirected to this endpoint to authenticate. Although this endpoint should ideally be unversioned, client support in the wild varies. If you’re using a versioned v2 endpoint here, then this should not be the same endpoint the service user utilizes for validating tokens, because normal end users may not be able to reach that endpoint.
¶ Group
Name
keystone_authtoken
auth_uri
- auth_uri¶
- Type
string
- Default
<None>
Complete “public” Identity API endpoint. This endpoint should not be an “admin” endpoint, as it should be accessible by all end users. Unauthenticated clients are redirected to this endpoint to authenticate. Although this endpoint should ideally be unversioned, client support in the wild varies. If you’re using a versioned v2 endpoint here, then this should not be the same endpoint the service user utilizes for validating tokens, because normal end users may not be able to reach that endpoint. This option is deprecated in favor of www_authenticate_uri and will be removed in the S release.
Warning
This option is deprecated for removal since Queens. Its value may be silently ignored in the future.
- Reason
The auth_uri option is deprecated in favor of www_authenticate_uri and will be removed in the S release.
- auth_version¶
- Type
string
- Default
<None>
API version of the Identity API endpoint.
- interface¶
- Type
string
- Default
internal
Interface to use for the Identity API endpoint. Valid values are “public”, “internal” (default) or “admin”.
- delay_auth_decision¶
- Type
boolean
- Default
False
Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components.
- http_connect_timeout¶
- Type
integer
- Default
<None>
Request timeout value for communicating with Identity API server.
- http_request_max_retries¶
- Type
integer
- Default
3
How many times are we trying to reconnect when communicating with Identity API Server.
- cache¶
- Type
string
- Default
<None>
Request environment key where the Swift cache object is stored. When auth_token middleware is deployed with a Swift cache, use this option to have the middleware share a caching backend with swift. Otherwise, use the
memcached_servers
option instead.
- certfile¶
- Type
string
- Default
<None>
Required if identity server requires client certificate
- keyfile¶
- Type
string
- Default
<None>
Required if identity server requires client certificate
- cafile¶
- Type
string
- Default
<None>
A PEM encoded Certificate Authority to use when verifying HTTPs connections. Defaults to system CAs.
- insecure¶
- Type
boolean
- Default
False
Verify HTTPS connections.
- region_name¶
- Type
string
- Default
<None>
The region in which the identity server can be found.
- memcached_servers¶
- Type
list
- Default
<None>
Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process.
¶ Group
Name
keystone_authtoken
memcache_servers
- token_cache_time¶
- Type
integer
- Default
300
In order to prevent excessive effort spent validating tokens, the middleware caches previously-seen tokens for a configurable duration (in seconds). Set to -1 to disable caching completely.
- memcache_security_strategy¶
- Type
string
- Default
None
- Valid Values
None, MAC, ENCRYPT
(Optional) If defined, indicate whether token data should be authenticated or authenticated and encrypted. If MAC, token data is authenticated (with HMAC) in the cache. If ENCRYPT, token data is encrypted and authenticated in the cache. If the value is not one of these options or empty, auth_token will raise an exception on initialization.
- memcache_secret_key¶
- Type
string
- Default
<None>
(Optional, mandatory if memcache_security_strategy is defined) This string is used for key derivation.
- memcache_pool_dead_retry¶
- Type
integer
- Default
300
(Optional) Number of seconds memcached server is considered dead before it is tried again.
- memcache_pool_maxsize¶
- Type
integer
- Default
10
(Optional) Maximum total number of open connections to every memcached server.
- memcache_pool_socket_timeout¶
- Type
integer
- Default
3
(Optional) Socket timeout in seconds for communicating with a memcached server.
- memcache_pool_unused_timeout¶
- Type
integer
- Default
60
(Optional) Number of seconds a connection to memcached is held unused in the pool before it is closed.
- memcache_pool_conn_get_timeout¶
- Type
integer
- Default
10
(Optional) Number of seconds that an operation will wait to get a memcached client connection from the pool.
- memcache_use_advanced_pool¶
- Type
boolean
- Default
True
(Optional) Use the advanced (eventlet safe) memcached client pool.
- include_service_catalog¶
- Type
boolean
- Default
True
(Optional) Indicate whether to set the X-Service-Catalog header. If False, middleware will not ask for service catalog on token validation and will not set the X-Service-Catalog header.
- enforce_token_bind¶
- Type
string
- Default
permissive
Used to control the use and type of token binding. Can be set to: “disabled” to not check token binding. “permissive” (default) to validate binding information if the bind type is of a form known to the server and ignore it if not. “strict” like “permissive” but if the bind type is unknown the token will be rejected. “required” any form of token binding is needed to be allowed. Finally the name of a binding method that must be present in tokens.
- service_token_roles¶
- Type
list
- Default
['service']
A choice of roles that must be present in a service token. Service tokens are allowed to request that an expired token can be used and so this check should tightly control that only actual services should be sending this token. Roles here are applied as an ANY check so any role in this list must be present. For backwards compatibility reasons this currently only affects the allow_expired check.
- service_token_roles_required¶
- Type
boolean
- Default
False
For backwards compatibility reasons we must let valid service tokens pass that don’t pass the service_token_roles check as valid. Setting this true will become the default in a future release and should be enabled if possible.
- service_type¶
- Type
string
- Default
<None>
The name or type of the service as it appears in the service catalog. This is used to validate tokens that have restricted access rules.
- auth_type¶
- Type
unknown type
- Default
<None>
Authentication type to load
¶ Group
Name
keystone_authtoken
auth_plugin
- auth_section¶
- Type
unknown type
- Default
<None>
Config Section from which to load plugin specific options
oslo_concurrency¶
- disable_process_locking¶
- Type
boolean
- Default
False
Enables or disables inter-process locks.
¶ Group
Name
DEFAULT
disable_process_locking
- lock_path¶
- Type
string
- Default
<None>
Directory to use for lock files. For security, the specified directory should only be writable by the user running the processes that need locking. Defaults to environment variable OSLO_LOCK_PATH. If external locks are used, a lock path must be set.
¶ Group
Name
DEFAULT
lock_path
oslo_messaging_amqp¶
- container_name¶
- Type
string
- Default
<None>
Name for the AMQP container. must be globally unique. Defaults to a generated UUID
¶ Group
Name
amqp1
container_name
- idle_timeout¶
- Type
integer
- Default
0
Timeout for inactive connections (in seconds)
¶ Group
Name
amqp1
idle_timeout
- ssl¶
- Type
boolean
- Default
False
Attempt to connect via SSL. If no other ssl-related parameters are given, it will use the system’s CA-bundle to verify the server’s certificate.
- ssl_ca_file¶
- Type
string
- Default
''
CA certificate PEM file used to verify the server’s certificate
¶ Group
Name
amqp1
ssl_ca_file
- ssl_cert_file¶
- Type
string
- Default
''
Self-identifying certificate PEM file for client authentication
¶ Group
Name
amqp1
ssl_cert_file
- ssl_key_file¶
- Type
string
- Default
''
Private key PEM file used to sign ssl_cert_file certificate (optional)
¶ Group
Name
amqp1
ssl_key_file
- ssl_key_password¶
- Type
string
- Default
<None>
Password for decrypting ssl_key_file (if encrypted)
¶ Group
Name
amqp1
ssl_key_password
- ssl_verify_vhost¶
- Type
boolean
- Default
False
By default SSL checks that the name in the server’s certificate matches the hostname in the transport_url. In some configurations it may be preferable to use the virtual hostname instead, for example if the server uses the Server Name Indication TLS extension (rfc6066) to provide a certificate per virtual host. Set ssl_verify_vhost to True if the server’s SSL certificate uses the virtual host name instead of the DNS name.
- sasl_mechanisms¶
- Type
string
- Default
''
Space separated list of acceptable SASL mechanisms
¶ Group
Name
amqp1
sasl_mechanisms
- sasl_config_dir¶
- Type
string
- Default
''
Path to directory that contains the SASL configuration
¶ Group
Name
amqp1
sasl_config_dir
- sasl_config_name¶
- Type
string
- Default
''
Name of configuration file (without .conf suffix)
¶ Group
Name
amqp1
sasl_config_name
- sasl_default_realm¶
- Type
string
- Default
''
SASL realm to use if no realm present in username
- connection_retry_interval¶
- Type
integer
- Default
1
- Minimum Value
1
Seconds to pause before attempting to re-connect.
- connection_retry_backoff¶
- Type
integer
- Default
2
- Minimum Value
0
Increase the connection_retry_interval by this many seconds after each unsuccessful failover attempt.
- connection_retry_interval_max¶
- Type
integer
- Default
30
- Minimum Value
1
Maximum limit for connection_retry_interval + connection_retry_backoff
- link_retry_delay¶
- Type
integer
- Default
10
- Minimum Value
1
Time to pause between re-connecting an AMQP 1.0 link that failed due to a recoverable error.
- default_reply_retry¶
- Type
integer
- Default
0
- Minimum Value
-1
The maximum number of attempts to re-send a reply message which failed due to a recoverable error.
- default_reply_timeout¶
- Type
integer
- Default
30
- Minimum Value
5
The deadline for an rpc reply message delivery.
- default_send_timeout¶
- Type
integer
- Default
30
- Minimum Value
5
The deadline for an rpc cast or call message delivery. Only used when caller does not provide a timeout expiry.
- default_notify_timeout¶
- Type
integer
- Default
30
- Minimum Value
5
The deadline for a sent notification message delivery. Only used when caller does not provide a timeout expiry.
- default_sender_link_timeout¶
- Type
integer
- Default
600
- Minimum Value
1
The duration to schedule a purge of idle sender links. Detach link after expiry.
- addressing_mode¶
- Type
string
- Default
dynamic
Indicates the addressing mode used by the driver. Permitted values: ‘legacy’ - use legacy non-routable addressing ‘routable’ - use routable addresses ‘dynamic’ - use legacy addresses if the message bus does not support routing otherwise use routable addressing
- pseudo_vhost¶
- Type
boolean
- Default
True
Enable virtual host support for those message buses that do not natively support virtual hosting (such as qpidd). When set to true the virtual host name will be added to all message bus addresses, effectively creating a private ‘subnet’ per virtual host. Set to False if the message bus supports virtual hosting using the ‘hostname’ field in the AMQP 1.0 Open performative as the name of the virtual host.
- server_request_prefix¶
- Type
string
- Default
exclusive
address prefix used when sending to a specific server
¶ Group
Name
amqp1
server_request_prefix
- broadcast_prefix¶
- Type
string
- Default
broadcast
address prefix used when broadcasting to all servers
¶ Group
Name
amqp1
broadcast_prefix
- group_request_prefix¶
- Type
string
- Default
unicast
address prefix when sending to any server in group
¶ Group
Name
amqp1
group_request_prefix
- rpc_address_prefix¶
- Type
string
- Default
openstack.org/om/rpc
Address prefix for all generated RPC addresses
- notify_address_prefix¶
- Type
string
- Default
openstack.org/om/notify
Address prefix for all generated Notification addresses
- multicast_address¶
- Type
string
- Default
multicast
Appended to the address prefix when sending a fanout message. Used by the message bus to identify fanout messages.
- unicast_address¶
- Type
string
- Default
unicast
Appended to the address prefix when sending to a particular RPC/Notification server. Used by the message bus to identify messages sent to a single destination.
- anycast_address¶
- Type
string
- Default
anycast
Appended to the address prefix when sending to a group of consumers. Used by the message bus to identify messages that should be delivered in a round-robin fashion across consumers.
- default_notification_exchange¶
- Type
string
- Default
<None>
Exchange name used in notification addresses. Exchange name resolution precedence: Target.exchange if set else default_notification_exchange if set else control_exchange if set else ‘notify’
- default_rpc_exchange¶
- Type
string
- Default
<None>
Exchange name used in RPC addresses. Exchange name resolution precedence: Target.exchange if set else default_rpc_exchange if set else control_exchange if set else ‘rpc’
- reply_link_credit¶
- Type
integer
- Default
200
- Minimum Value
1
Window size for incoming RPC Reply messages.
- rpc_server_credit¶
- Type
integer
- Default
100
- Minimum Value
1
Window size for incoming RPC Request messages
- notify_server_credit¶
- Type
integer
- Default
100
- Minimum Value
1
Window size for incoming Notification messages
- pre_settled¶
- Type
multi-valued
- Default
rpc-cast
- Default
rpc-reply
Send messages of this type pre-settled. Pre-settled messages will not receive acknowledgement from the peer. Note well: pre-settled messages may be silently discarded if the delivery fails. Permitted values: ‘rpc-call’ - send RPC Calls pre-settled ‘rpc-reply’- send RPC Replies pre-settled ‘rpc-cast’ - Send RPC Casts pre-settled ‘notify’ - Send Notifications pre-settled
oslo_messaging_kafka¶
- kafka_max_fetch_bytes¶
- Type
integer
- Default
1048576
Max fetch bytes of Kafka consumer
- kafka_consumer_timeout¶
- Type
floating point
- Default
1.0
Default timeout(s) for Kafka consumers
- pool_size¶
- Type
integer
- Default
10
Pool Size for Kafka Consumers
Warning
This option is deprecated for removal. Its value may be silently ignored in the future.
- Reason
Driver no longer uses connection pool.
- conn_pool_min_size¶
- Type
integer
- Default
2
The pool size limit for connections expiration policy
Warning
This option is deprecated for removal. Its value may be silently ignored in the future.
- Reason
Driver no longer uses connection pool.
- conn_pool_ttl¶
- Type
integer
- Default
1200
The time-to-live in sec of idle connections in the pool
Warning
This option is deprecated for removal. Its value may be silently ignored in the future.
- Reason
Driver no longer uses connection pool.
- consumer_group¶
- Type
string
- Default
oslo_messaging_consumer
Group id for Kafka consumer. Consumers in one group will coordinate message consumption
- producer_batch_timeout¶
- Type
floating point
- Default
0.0
Upper bound on the delay for KafkaProducer batching in seconds
- producer_batch_size¶
- Type
integer
- Default
16384
Size of batch for the producer async send
- compression_codec¶
- Type
string
- Default
none
- Valid Values
none, gzip, snappy, lz4, zstd
The compression codec for all data generated by the producer. If not set, compression will not be used. Note that the allowed values of this depend on the kafka version
- enable_auto_commit¶
- Type
boolean
- Default
False
Enable asynchronous consumer commits
- max_poll_records¶
- Type
integer
- Default
500
The maximum number of records returned in a poll call
- security_protocol¶
- Type
string
- Default
PLAINTEXT
- Valid Values
PLAINTEXT, SASL_PLAINTEXT, SSL, SASL_SSL
Protocol used to communicate with brokers
- sasl_mechanism¶
- Type
string
- Default
PLAIN
Mechanism when security protocol is SASL
- ssl_cafile¶
- Type
string
- Default
''
CA certificate PEM file used to verify the server certificate
- ssl_client_cert_file¶
- Type
string
- Default
''
Client certificate PEM file used for authentication.
- ssl_client_key_file¶
- Type
string
- Default
''
Client key PEM file used for authentication.
- ssl_client_key_password¶
- Type
string
- Default
''
Client key password file used for authentication.
oslo_messaging_notifications¶
- driver¶
- Type
multi-valued
- Default
''
The Drivers(s) to handle sending notifications. Possible values are messaging, messagingv2, routing, log, test, noop
¶ Group
Name
DEFAULT
notification_driver
- transport_url¶
- Type
string
- Default
<None>
A URL representing the messaging driver to use for notifications. If not set, we fall back to the same configuration used for RPC.
¶ Group
Name
DEFAULT
notification_transport_url
- topics¶
- Type
list
- Default
['notifications']
AMQP topic used for OpenStack notifications.
¶ Group
Name
rpc_notifier2
topics
DEFAULT
notification_topics
- retry¶
- Type
integer
- Default
-1
The maximum number of attempts to re-send a notification message which failed to be delivered due to a recoverable error. 0 - No retry, -1 - indefinite
oslo_messaging_rabbit¶
- amqp_durable_queues¶
- Type
boolean
- Default
False
Use durable queues in AMQP.
- amqp_auto_delete¶
- Type
boolean
- Default
False
Auto-delete queues in AMQP.
¶ Group
Name
DEFAULT
amqp_auto_delete
- ssl_version¶
- Type
string
- Default
''
SSL version to use (valid only if SSL enabled). Valid values are TLSv1 and SSLv23. SSLv2, SSLv3, TLSv1_1, and TLSv1_2 may be available on some distributions.
¶ Group
Name
oslo_messaging_rabbit
kombu_ssl_version
- ssl_key_file¶
- Type
string
- Default
''
SSL key file (valid only if SSL enabled).
¶ Group
Name
oslo_messaging_rabbit
kombu_ssl_keyfile
- ssl_cert_file¶
- Type
string
- Default
''
SSL cert file (valid only if SSL enabled).
¶ Group
Name
oslo_messaging_rabbit
kombu_ssl_certfile
- ssl_ca_file¶
- Type
string
- Default
''
SSL certification authority file (valid only if SSL enabled).
¶ Group
Name
oslo_messaging_rabbit
kombu_ssl_ca_certs
- heartbeat_in_pthread¶
- Type
boolean
- Default
True
Run the health check heartbeat thread through a native python thread by default. If this option is equal to False then the health check heartbeat will inherit the execution model from the parent process. For example if the parent process has monkey patched the stdlib by using eventlet/greenlet then the heartbeat will be run through a green thread.
Warning
This option is deprecated for removal. Its value may be silently ignored in the future.
- kombu_reconnect_delay¶
- Type
floating point
- Default
1.0
How long to wait before reconnecting in response to an AMQP consumer cancel notification.
¶ Group
Name
DEFAULT
kombu_reconnect_delay
- kombu_compression¶
- Type
string
- Default
<None>
EXPERIMENTAL: Possible values are: gzip, bz2. If not set compression will not be used. This option may not be available in future versions.
- kombu_missing_consumer_retry_timeout¶
- Type
integer
- Default
60
How long to wait a missing client before abandoning to send it its replies. This value should not be longer than rpc_response_timeout.
¶ Group
Name
oslo_messaging_rabbit
kombu_reconnect_timeout
- kombu_failover_strategy¶
- Type
string
- Default
round-robin
- Valid Values
round-robin, shuffle
Determines how the next RabbitMQ node is chosen in case the one we are currently connected to becomes unavailable. Takes effect only if more than one RabbitMQ node is provided in config.
- rabbit_login_method¶
- Type
string
- Default
AMQPLAIN
- Valid Values
PLAIN, AMQPLAIN, RABBIT-CR-DEMO
The RabbitMQ login method.
¶ Group
Name
DEFAULT
rabbit_login_method
- rabbit_retry_interval¶
- Type
integer
- Default
1
How frequently to retry connecting with RabbitMQ.
- rabbit_retry_backoff¶
- Type
integer
- Default
2
How long to backoff for between retries when connecting to RabbitMQ.
¶ Group
Name
DEFAULT
rabbit_retry_backoff
- rabbit_interval_max¶
- Type
integer
- Default
30
Maximum interval of RabbitMQ connection retries. Default is 30 seconds.
- rabbit_ha_queues¶
- Type
boolean
- Default
False
Try to use HA queues in RabbitMQ (x-ha-policy: all). If you change this option, you must wipe the RabbitMQ database. In RabbitMQ 3.0, queue mirroring is no longer controlled by the x-ha-policy argument when declaring a queue. If you just want to make sure that all queues (except those with auto-generated names) are mirrored across all nodes, run: “rabbitmqctl set_policy HA ‘^(?!amq.).*’ ‘{“ha-mode”: “all”}’ “
¶ Group
Name
DEFAULT
rabbit_ha_queues
- rabbit_transient_queues_ttl¶
- Type
integer
- Default
1800
- Minimum Value
1
Positive integer representing duration in seconds for queue TTL (x-expires). Queues which are unused for the duration of the TTL are automatically deleted. The parameter affects only reply and fanout queues.
- rabbit_qos_prefetch_count¶
- Type
integer
- Default
0
Specifies the number of messages to prefetch. Setting to zero allows unlimited messages.
- heartbeat_timeout_threshold¶
- Type
integer
- Default
60
Number of seconds after which the Rabbit broker is considered down if heartbeat’s keep-alive fails (0 disables heartbeat).
- heartbeat_rate¶
- Type
integer
- Default
2
How often times during the heartbeat_timeout_threshold we check the heartbeat.
- direct_mandatory_flag¶
- Type
boolean
- Default
True
(DEPRECATED) Enable/Disable the RabbitMQ mandatory flag for direct send. The direct send is used as reply, so the MessageUndeliverable exception is raised in case the client queue does not exist.MessageUndeliverable exception will be used to loop for a timeout to lets a chance to sender to recover.This flag is deprecated and it will not be possible to deactivate this functionality anymore
Warning
This option is deprecated for removal. Its value may be silently ignored in the future.
- Reason
Mandatory flag no longer deactivable.
- enable_cancel_on_failover¶
- Type
boolean
- Default
False
Enable x-cancel-on-ha-failover flag so that rabbitmq server will cancel and notify consumerswhen queue is down
oslo_middleware¶
- enable_proxy_headers_parsing¶
- Type
boolean
- Default
False
Whether the application is behind a proxy or not. This determines if the middleware should parse the headers or not.
oslo_policy¶
- 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 thescope_types
of the policy being enforced. If the scopes do not match, anInvalidScope
exception will be raised. IfFalse
, a message will be logged informing operators that policies are being invoked with mismatching scope.
- enforce_new_defaults¶
- Type
boolean
- Default
False
This option controls whether or not to use old deprecated defaults when evaluating policies. If
True
, the old deprecated defaults are not going to be evaluated. This means if any existing token is allowed for old defaults but is disallowed for new defaults, it will be disallowed. It is encouraged to enable this flag along with theenforce_scope
flag so that you can get the benefits of new defaults andscope_type
together
- policy_file¶
- Type
string
- Default
policy.yaml
The relative or absolute path of a file that maps roles to permissions for a given service. Relative paths must be specified in relation to the configuration file setting this option.
¶ 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
oslo_reports¶
- log_dir¶
- Type
string
- Default
<None>
Path to a log directory where to create a file
- file_event_handler¶
- Type
string
- Default
<None>
The path to a file to watch for changes to trigger the reports, instead of signals. Setting this option disables the signal trigger for the reports. If application is running as a WSGI application it is recommended to use this instead of signals.
- file_event_handler_interval¶
- Type
integer
- Default
1
How many seconds to wait between polls when file_event_handler is set
paste_deploy¶
- flavor¶
- Type
string
- Default
keystone
This option has a sample default set, which means that its actual default value may vary from the one documented above.
Deployment flavor to use in the server application pipeline.
Provide a string value representing the appropriate deployment flavor used in the server application pipleline. This is typically the partial name of a pipeline in the paste configuration file with the service name removed.
For example, if your paste section name in the paste configuration file is [pipeline:glance-api-keystone], set
flavor
tokeystone
.- Possible values:
String value representing a partial pipeline name.
- Related Options:
config_file
- config_file¶
- Type
string
- Default
glance-api-paste.ini
This option has a sample default set, which means that its actual default value may vary from the one documented above.
Name of the paste configuration file.
Provide a string value representing the name of the paste configuration file to use for configuring piplelines for server application deployments.
- NOTES:
Provide the name or the path relative to the glance directory for the paste configuration file and not the absolute path.
The sample paste configuration file shipped with Glance need not be edited in most cases as it comes with ready-made pipelines for all common deployment flavors.
If no value is specified for this option, the
paste.ini
file with the prefix of the corresponding Glance service’s configuration file name will be searched for in the known configuration directories. (For example, if this option is missing from or has no value set inglance-api.conf
, the service will look for a file namedglance-api-paste.ini
.) If the paste configuration file is not found, the service will not start.- Possible values:
A string value representing the name of the paste configuration file.
- Related Options:
flavor
profiler¶
- enabled¶
- Type
boolean
- Default
False
Enable the profiling for all services on this node.
Default value is False (fully disable the profiling feature).
Possible values:
True: Enables the feature
False: Disables the feature. The profiling cannot be started via this project operations. If the profiling is triggered by another project, this project part will be empty.
¶ Group
Name
profiler
profiler_enabled
- trace_sqlalchemy¶
- Type
boolean
- Default
False
Enable SQL requests profiling in services.
Default value is False (SQL requests won’t be traced).
Possible values:
True: Enables SQL requests profiling. Each SQL query will be part of the trace and can the be analyzed by how much time was spent for that.
False: Disables SQL requests profiling. The spent time is only shown on a higher level of operations. Single SQL queries cannot be analyzed this way.
- hmac_keys¶
- Type
string
- Default
SECRET_KEY
Secret key(s) to use for encrypting context data for performance profiling.
This string value should have the following format: <key1>[,<key2>,…<keyn>], where each key is some random string. A user who triggers the profiling via the REST API has to set one of these keys in the headers of the REST API call to include profiling results of this node for this particular project.
Both “enabled” flag and “hmac_keys” config options should be set to enable profiling. Also, to generate correct profiling information across all services at least one key needs to be consistent between OpenStack projects. This ensures it can be used from client side to generate the trace, containing information from all possible resources.
- connection_string¶
- Type
string
- Default
messaging://
Connection string for a notifier backend.
Default value is
messaging://
which sets the notifier to oslo_messaging.Examples of possible values:
messaging://
- use oslo_messaging driver for sending spans.redis://127.0.0.1:6379
- use redis driver for sending spans.mongodb://127.0.0.1:27017
- use mongodb driver for sending spans.elasticsearch://127.0.0.1:9200
- use elasticsearch driver for sending spans.jaeger://127.0.0.1:6831
- use jaeger tracing as driver for sending spans.
- es_doc_type¶
- Type
string
- Default
notification
Document type for notification indexing in elasticsearch.
- es_scroll_time¶
- Type
string
- Default
2m
This parameter is a time value parameter (for example: es_scroll_time=2m), indicating for how long the nodes that participate in the search will maintain relevant resources in order to continue and support it.
- es_scroll_size¶
- Type
integer
- Default
10000
Elasticsearch splits large requests in batches. This parameter defines maximum size of each batch (for example: es_scroll_size=10000).
- socket_timeout¶
- Type
floating point
- Default
0.1
Redissentinel provides a timeout option on the connections. This parameter defines that timeout (for example: socket_timeout=0.1).
- sentinel_service_name¶
- Type
string
- Default
mymaster
Redissentinel uses a service name to identify a master redis service. This parameter defines the name (for example:
sentinal_service_name=mymaster
).
- filter_error_trace¶
- Type
boolean
- Default
False
Enable filter traces that contain error/exception to a separated place.
Default value is set to False.
Possible values:
True: Enable filter traces that contain error/exception.
False: Disable the filter.
store_type_location_strategy¶
- store_type_preference¶
- Type
list
- Default
[]
Preference order of storage backends.
Provide a comma separated list of store names in the order in which images should be retrieved from storage backends. These store names must be registered with the
stores
configuration option.NOTE: The
store_type_preference
configuration option is applied only ifstore_type
is chosen as a value for thelocation_strategy
configuration option. An empty list will not change the location order.- Possible values:
Empty list
- Comma separated list of registered store names. Legal values are:
file
http
rbd
swift
cinder
vmware
- Related options:
location_strategy
stores
task¶
- task_time_to_live¶
- Type
integer
- Default
48
Time in hours for which a task lives after, either succeeding or failing
¶ Group
Name
DEFAULT
task_time_to_live
- task_executor¶
- Type
string
- Default
taskflow
Task executor to be used to run task scripts.
Provide a string value representing the executor to use for task executions. By default,
TaskFlow
executor is used.TaskFlow
helps make task executions easy, consistent, scalable and reliable. It also enables creation of lightweight task objects and/or functions that are combined together into flows in a declarative manner.- Possible values:
taskflow
- Related Options:
None
- work_dir¶
- Type
string
- Default
/work_dir
This option has a sample default set, which means that its actual default value may vary from the one documented above.
Absolute path to the work directory to use for asynchronous task operations.
The directory set here will be used to operate over images - normally before they are imported in the destination store.
NOTE: When providing a value for
work_dir
, please make sure that enough space is provided for concurrent tasks to run efficiently without running out of space.A rough estimation can be done by multiplying the number of
max_workers
with an average image size (e.g 500MB). The image size estimation should be done based on the average size in your deployment. Note that depending on the tasks running you may need to multiply this number by some factor depending on what the task does. For example, you may want to double the available size if image conversion is enabled. All this being said, remember these are just estimations and you should do them based on the worst case scenario and be prepared to act in case they were wrong.- Possible values:
String value representing the absolute path to the working directory
- Related Options:
None
taskflow_executor¶
- engine_mode¶
- Type
string
- Default
parallel
- Valid Values
serial, parallel
Set the taskflow engine mode.
Provide a string type value to set the mode in which the taskflow engine would schedule tasks to the workers on the hosts. Based on this mode, the engine executes tasks either in single or multiple threads. The possible values for this configuration option are:
serial
andparallel
. When set toserial
, the engine runs all the tasks in a single thread which results in serial execution of tasks. Setting this toparallel
makes the engine run tasks in multiple threads. This results in parallel execution of tasks.- Possible values:
serial
parallel
- Related options:
max_workers
- max_workers¶
- Type
integer
- Default
10
- Minimum Value
1
Set the number of engine executable tasks.
Provide an integer value to limit the number of workers that can be instantiated on the hosts. In other words, this number defines the number of parallel tasks that can be executed at the same time by the taskflow engine. This value can be greater than one when the engine mode is set to parallel.
- Possible values:
Integer value greater than or equal to 1
- Related options:
engine_mode
¶ Group
Name
task
eventlet_executor_pool_size
- conversion_format¶
- Type
string
- Default
raw
- Valid Values
qcow2, raw, vmdk
This option has a sample default set, which means that its actual default value may vary from the one documented above.
Set the desired image conversion format.
Provide a valid image format to which you want images to be converted before they are stored for consumption by Glance. Appropriate image format conversions are desirable for specific storage backends in order to facilitate efficient handling of bandwidth and usage of the storage infrastructure.
By default,
conversion_format
is not set and must be set explicitly in the configuration file.The allowed values for this option are
raw
,qcow2
andvmdk
. Theraw
format is the unstructured disk format and should be chosen when RBD or Ceph storage backends are used for image storage.qcow2
is supported by the QEMU emulator that expands dynamically and supports Copy on Write. Thevmdk
is another common disk format supported by many common virtual machine monitors like VMWare Workstation.- Possible values:
qcow2
raw
vmdk
- Related options:
disk_formats
vault¶
- root_token_id¶
- Type
string
- Default
<None>
root token for vault
- approle_role_id¶
- Type
string
- Default
<None>
AppRole role_id for authentication with vault
- approle_secret_id¶
- Type
string
- Default
<None>
AppRole secret_id for authentication with vault
- kv_mountpoint¶
- Type
string
- Default
secret
Mountpoint of KV store in Vault to use, for example: secret
- kv_version¶
- Type
integer
- Default
2
Version of KV store in Vault to use, for example: 2
- vault_url¶
- Type
string
- Default
http://127.0.0.1:8200
Use this endpoint to connect to Vault, for example: “http://127.0.0.1:8200”
- ssl_ca_crt_file¶
- Type
string
- Default
<None>
Absolute path to ca cert file
- use_ssl¶
- Type
boolean
- Default
False
SSL Enabled/Disabled
wsgi¶
- task_pool_threads¶
- Type
integer
- Default
16
- Minimum Value
1
The number of threads (per worker process) in the pool for processing asynchronous tasks. This controls how many asynchronous tasks (i.e. for image interoperable import) each worker can run at a time. If this is too large, you may have increased memory footprint per worker and/or you may overwhelm other system resources such as disk or outbound network bandwidth. If this is too small, image import requests will have to wait until a thread becomes available to begin processing.
- python_interpreter¶
- Type
string
- Default
/home/zuul/src/opendev.org/openstack/glance/.tox/docs/bin/python
Path to the python interpreter to use when spawning external processes. By default this is sys.executable, which should be the same interpreter running Glance itself. However, in some situations (i.e. uwsgi) this may not actually point to a python interpreter itself.