debug
¶Type: | boolean |
---|---|
Default: | false |
Mutable: | This option can be changed without restarting. |
If set to true, the logging level will be set to DEBUG instead of the default INFO level.
log_config_append
¶Type: | string |
---|---|
Default: | <None> |
Mutable: | This option can be changed without restarting. |
The name of a logging configuration file. This file is appended to any existing logging configuration files. For details about logging configuration files, see the Python logging module documentation. Note that when logging configuration files are used then all logging configuration is set in the configuration file and other logging configuration options are ignored (for example, logging_context_format_string).
Group | Name |
---|---|
DEFAULT | log-config |
DEFAULT | log_config |
log_date_format
¶Type: | string |
---|---|
Default: | %Y-%m-%d %H:%M:%S |
Defines the format string for %(asctime)s in log records. Default: the value above . This option is ignored if log_config_append is set.
log_file
¶Type: | string |
---|---|
Default: | <None> |
(Optional) Name of log file to send logging output to. If no default is set, logging will go to stderr as defined by use_stderr. This option is ignored if log_config_append is set.
Group | Name |
---|---|
DEFAULT | logfile |
log_dir
¶Type: | string |
---|---|
Default: | <None> |
(Optional) The base directory used for relative log_file paths. This option is ignored if log_config_append is set.
Group | Name |
---|---|
DEFAULT | logdir |
watch_log_file
¶Type: | boolean |
---|---|
Default: | false |
Uses logging handler designed to watch file system. When log file is moved or removed this handler will open a new log file with specified path instantaneously. It makes sense only if log_file option is specified and Linux platform is used. This option is ignored if log_config_append is set.
use_syslog
¶Type: | boolean |
---|---|
Default: | false |
Use syslog for logging. Existing syslog format is DEPRECATED and will be changed later to honor RFC5424. This option is ignored if log_config_append is set.
use_journal
¶Type: | boolean |
---|---|
Default: | false |
Enable journald for logging. If running in a systemd environment you may wish to enable journal support. Doing so will use the journal native protocol which includes structured metadata in addition to log messages.This option is ignored if log_config_append is set.
syslog_log_facility
¶Type: | string |
---|---|
Default: | LOG_USER |
Syslog facility to receive log lines. This option is ignored if log_config_append is set.
use_json
¶Type: | boolean |
---|---|
Default: | false |
Use JSON formatting for logging. This option is ignored if log_config_append is set.
use_stderr
¶Type: | boolean |
---|---|
Default: | false |
Log output to standard error. This option is ignored if log_config_append is set.
logging_context_format_string
¶Type: | string |
---|---|
Default: | %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s |
Format string to use for log messages with context.
logging_default_format_string
¶Type: | string |
---|---|
Default: | %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s |
Format string to use for log messages when context is undefined.
logging_debug_format_suffix
¶Type: | string |
---|---|
Default: | %(funcName)s %(pathname)s:%(lineno)d |
Additional data to append to log message when logging level for the message is DEBUG.
logging_exception_prefix
¶Type: | string |
---|---|
Default: | %(asctime)s.%(msecs)03d %(process)d ERROR %(name)s %(instance)s |
Prefix each line of exception output with this format.
logging_user_identity_format
¶Type: | string |
---|---|
Default: | %(user)s %(tenant)s %(domain)s %(user_domain)s %(project_domain)s |
Defines the format string for %(user_identity)s that is used in logging_context_format_string.
default_log_levels
¶Type: | list |
---|---|
Default: | amqp=WARN,amqplib=WARN,boto=WARN,qpid=WARN,sqlalchemy=WARN,suds=INFO,oslo.messaging=INFO,oslo_messaging=INFO,iso8601=WARN,requests.packages.urllib3.connectionpool=WARN,urllib3.connectionpool=WARN,websocket=WARN,requests.packages.urllib3.util.retry=WARN,urllib3.util.retry=WARN,keystonemiddleware=WARN,routes.middleware=WARN,stevedore=WARN,taskflow=WARN,keystoneauth=WARN,oslo.cache=INFO,dogpile.core.dogpile=INFO |
List of package logging levels in logger=LEVEL pairs. This option is ignored if log_config_append is set.
publish_errors
¶Type: | boolean |
---|---|
Default: | false |
Enables or disables publication of error events.
instance_format
¶Type: | string |
---|---|
Default: | "[instance: %(uuid)s] " |
The format for an instance that is passed with the log message.
instance_uuid_format
¶Type: | string |
---|---|
Default: | "[instance: %(uuid)s] " |
The format for an instance UUID that is passed with the log message.
rate_limit_interval
¶Type: | integer |
---|---|
Default: | 0 |
Interval, number of seconds, of log rate limiting.
rate_limit_burst
¶Type: | integer |
---|---|
Default: | 0 |
Maximum number of logged messages per rate_limit_interval.
rate_limit_except_level
¶Type: | string |
---|---|
Default: | CRITICAL |
Log level name used by rate limiting: CRITICAL, ERROR, INFO, WARNING, DEBUG or empty string. Logs with level greater or equal to rate_limit_except_level are not filtered. An empty string means that all levels are filtered.
fatal_deprecations
¶Type: | boolean |
---|---|
Default: | false |
Enables or disables fatal status of deprecations.
stores
¶Type: | list |
---|---|
Default: | file,http |
List of enabled Glance stores.
Register the storage backends to use for storing disk images
as a comma separated list. The default stores enabled for
storing disk images with Glance are file
and http
.
Warning
This option is deprecated for removal since Rocky. Its value may be silently ignored in the future.
Reason: | This option is deprecated against new config option enabled_backends which helps to configure multiple backend stores of different schemes. This option is scheduled for removal in the Stein development cycle. |
---|
default_store
¶Type: | string |
---|---|
Default: | file |
Valid Values: | file, filesystem, http, https, swift, swift+http, swift+https, swift+config, rbd, sheepdog, cinder, vsphere |
The default scheme to use for storing images.
Provide a string value representing the default scheme to use for
storing images. If not set, Glance uses file
as the default
scheme to store images with the file
store.
NOTE: The value given for this configuration option must be a valid
scheme for a store registered with the stores
configuration
option.
Warning
This option is deprecated for removal since Rocky. Its value may be silently ignored in the future.
Reason: | This option is deprecated against new config option default_backend which acts similar to default_store config option. This option is scheduled for removal in the Stein development cycle. |
---|
store_capabilities_update_min_interval
¶Type: | integer |
---|---|
Default: | 0 |
Minimum Value: | 0 |
Minimum interval in seconds to execute updating dynamic storage capabilities based on current backend status.
Provide an integer value representing time in seconds to set the
minimum interval before an update of dynamic storage capabilities
for a storage backend can be attempted. Setting
store_capabilities_update_min_interval
does not mean updates
occur periodically based on the set interval. Rather, the update
is performed at the elapse of this interval set, if an operation
of the store is triggered.
By default, this option is set to zero and is disabled. Provide an integer value greater than zero to enable this option.
NOTE 1: For more information on store capabilities and their updates, please visit: https://specs.openstack.org/openstack/glance-specs/specs/kilo/store-capabilities.html
For more information on setting up a particular store in your deployment and help with the usage of this feature, please contact the storage driver maintainers listed here: https://docs.openstack.org/glance_store/latest/user/drivers.html
NOTE 2: The dynamic store update capability described above is not implemented by any current store drivers. Thus, this option DOES NOT DO ANYTHING (and it never has). It is DEPRECATED and scheduled for removal early in the Stein development cycle.
Warning
This option is deprecated for removal since Rocky. Its value may be silently ignored in the future.
Reason: | This option configures a stub method that has not been implemented for any existing store drivers. Hence it is non-operational, and giving it a value does absolutely nothing. This option is scheduled for removal early in the Stein development cycle. |
---|
cinder_catalog_info
¶Type: | string |
---|---|
Default: | volumev2::publicURL |
Information to match when looking for cinder in the service catalog.
When the cinder_endpoint_template
is not set and any of
cinder_store_auth_address
, cinder_store_user_name
,
cinder_store_project_name
, cinder_store_password
is not set,
cinder store uses this information to lookup cinder endpoint from the service
catalog in the current context. cinder_os_region_name
, if set, is taken
into consideration to fetch the appropriate endpoint.
The service catalog can be listed by the openstack catalog list
command.
<service_type>:<service_name>:<interface>
At least service_type
and interface
should be specified.
service_name
can be omitted.cinder_endpoint_template
¶Type: | string |
---|---|
Default: | <None> |
Override service catalog lookup with template for cinder endpoint.
When this option is set, this value is used to generate cinder endpoint,
instead of looking up from the service catalog.
This value is ignored if cinder_store_auth_address
,
cinder_store_user_name
, cinder_store_project_name
, and
cinder_store_password
are specified.
If this configuration option is set, cinder_catalog_info
will be ignored.
%(tenant)s
is
replaced with the current tenant (project) name.
For example: http://cinder.openstack.example.org/v2/%(tenant)s
cinder_os_region_name
¶Type: | string |
---|---|
Default: | <None> |
Region name to lookup cinder service from the service catalog.
This is used only when cinder_catalog_info
is used for determining the
endpoint. If set, the lookup for cinder endpoint by this node is filtered to
the specified region. It is useful when multiple regions are listed in the
catalog. If this is not set, the endpoint is looked up from every region.
Group | Name |
---|---|
glance_store | os_region_name |
cinder_ca_certificates_file
¶Type: | string |
---|---|
Default: | <None> |
Location of a CA certificates file used for cinder client requests.
The specified CA certificates file, if set, is used to verify cinder
connections via HTTPS endpoint. If the endpoint is HTTP, this value is ignored.
cinder_api_insecure
must be set to True
to enable the verification.
cinder_http_retries
¶Type: | integer |
---|---|
Default: | 3 |
Minimum Value: | 0 |
Number of cinderclient retries on failed http calls.
When a call failed by any errors, cinderclient will retry the call up to the specified times after sleeping a few seconds.
cinder_state_transition_timeout
¶Type: | integer |
---|---|
Default: | 300 |
Minimum Value: | 0 |
Time period, in seconds, to wait for a cinder volume transition to complete.
When the cinder volume is created, deleted, or attached to the glance node to
read/write the volume data, the volume’s state is changed. For example, the
newly created volume status changes from creating
to available
after
the creation process is completed. This specifies the maximum time to wait for
the status change. If a timeout occurs while waiting, or the status is changed
to an unexpected value (e.g. error`), the image creation fails.
cinder_api_insecure
¶Type: | boolean |
---|---|
Default: | false |
Allow to perform insecure SSL requests to cinder.
If this option is set to True, HTTPS endpoint connection is verified using the
CA certificates file specified by cinder_ca_certificates_file
option.
cinder_store_auth_address
¶Type: | string |
---|---|
Default: | <None> |
The address where the cinder authentication service is listening.
When all of cinder_store_auth_address
, cinder_store_user_name
,
cinder_store_project_name
, and cinder_store_password
options are
specified, the specified values are always used for the authentication.
This is useful to hide the image volumes from users by storing them in a
project/tenant specific to the image service. It also enables users to share
the image volume among other projects under the control of glance’s ACL.
If either of these options are not set, the cinder endpoint is looked up from the service catalog, and current context’s user and project are used.
http://openstack.example.org/identity/v2.0
cinder_store_user_name
¶Type: | string |
---|---|
Default: | <None> |
User name to authenticate against cinder.
This must be used with all the following related options. If any of these are not specified, the user of the current context is used.
cinder_store_password
¶Type: | string |
---|---|
Default: | <None> |
Password for the user authenticating against cinder.
This must be used with all the following related options. If any of these are not specified, the user of the current context is used.
cinder_store_user_name
cinder_store_project_name
¶Type: | string |
---|---|
Default: | <None> |
Project name where the image volume is stored in cinder.
If this configuration option is not set, the project in current context is used.
This must be used with all the following related options. If any of these are not specified, the project of the current context is used.
cinder_store_auth_address
cinder_store_user_name
cinder_store_password
rootwrap_config
¶Type: | string |
---|---|
Default: | /etc/glance/rootwrap.conf |
Path to the rootwrap configuration file to use for running commands as root.
The cinder store requires root privileges to operate the image volumes (for connecting to iSCSI/FC volumes and reading/writing the volume data, etc.). The configuration file should allow the required commands by cinder store and os-brick library.
cinder_volume_type
¶Type: | string |
---|---|
Default: | <None> |
Volume type that will be used for volume creation in cinder.
Some cinder backends can have several volume types to optimize storage usage. Adding this option allows an operator to choose a specific volume type in cinder that can be optimized for images.
If this is not set, then the default volume type specified in the cinder configuration will be used for volume creation.
filesystem_store_datadir
¶Type: | string |
---|---|
Default: | /var/lib/glance/images |
Directory to which the filesystem backend store writes images.
Upon start up, Glance creates the directory if it doesn’t already
exist and verifies write access to the user under which
glance-api
runs. If the write access isn’t available, a
BadStoreConfiguration
exception is raised and the filesystem
store may not be available for adding new images.
NOTE: This directory is used only when filesystem store is used as a
storage backend. Either filesystem_store_datadir
or
filesystem_store_datadirs
option must be specified in
glance-api.conf
. If both options are specified, a
BadStoreConfiguration
will be raised and the filesystem store
may not be available for adding new images.
filesystem_store_datadirs
filesystem_store_file_perm
filesystem_store_datadirs
¶Type: | multi-valued |
---|---|
Default: | u'' |
List of directories and their priorities to which the filesystem backend store writes images.
The filesystem store can be configured to store images in multiple
directories as opposed to using a single directory specified by the
filesystem_store_datadir
configuration option. When using
multiple directories, each directory can be given an optional
priority to specify the preference order in which they should
be used. Priority is an integer that is concatenated to the
directory path with a colon where a higher value indicates higher
priority. When two directories have the same priority, the directory
with most free space is used. When no priority is specified, it
defaults to zero.
More information on configuring filesystem store with multiple store directories can be found at https://docs.openstack.org/glance/latest/configuration/configuring.html
NOTE: This directory is used only when filesystem store is used as a
storage backend. Either filesystem_store_datadir
or
filesystem_store_datadirs
option must be specified in
glance-api.conf
. If both options are specified, a
BadStoreConfiguration
will be raised and the filesystem store
may not be available for adding new images.
<a valid directory path>:<optional integer priority>
filesystem_store_datadir
filesystem_store_file_perm
filesystem_store_metadata_file
¶Type: | string |
---|---|
Default: | <None> |
Filesystem store metadata file.
The path to a file which contains the metadata to be returned with
any location associated with the filesystem store. The file must
contain a valid JSON object. The object should contain the keys
id
and mountpoint
. The value for both keys should be a
string.
filesystem_store_file_perm
¶Type: | integer |
---|---|
Default: | 0 |
File access permissions for the image files.
Set the intended file access permissions for image data. This provides a way to enable other services, e.g. Nova, to consume images directly from the filesystem store. The users running the services that are intended to be given access to could be made a member of the group that owns the files created. Assigning a value less then or equal to zero for this configuration option signifies that no changes be made to the default permissions. This value will be decoded as an octal digit.
For more information, please refer the documentation at https://docs.openstack.org/glance/latest/configuration/configuring.html
https_ca_certificates_file
¶Type: | string |
---|---|
Default: | <None> |
Path to the CA bundle file.
This configuration option enables the operator to use a custom
Certificate Authority file to verify the remote server certificate. If
this option is set, the https_insecure
option will be ignored and
the CA file specified will be used to authenticate the server
certificate and establish a secure connection to the server.
https_insecure
¶Type: | boolean |
---|---|
Default: | true |
Set verification of the remote server certificate.
This configuration option takes in a boolean value to determine whether or not to verify the remote server certificate. If set to True, the remote server certificate is not verified. If the option is set to False, then the default CA truststore is used for verification.
This option is ignored if https_ca_certificates_file
is set.
The remote server certificate will then be verified using the file
specified using the https_ca_certificates_file
option.
http_proxy_information
¶Type: | dict |
---|---|
Default: | u'' |
The http/https proxy information to be used to connect to the remote server.
This configuration option specifies the http/https proxy information that should be used to connect to the remote server. The proxy information should be a key value pair of the scheme and proxy, for example, http:10.0.0.1:3128. You can also specify proxies for multiple schemes by separating the key value pairs with a comma, for example, http:10.0.0.1:3128, https:10.0.0.1:1080.
rbd_store_chunk_size
¶Type: | integer |
---|---|
Default: | 8 |
Minimum Value: | 1 |
Size, in megabytes, to chunk RADOS images into.
Provide an integer value representing the size in megabytes to chunk Glance images into. The default chunk size is 8 megabytes. For optimal performance, the value should be a power of two.
When Ceph’s RBD object storage system is used as the storage backend for storing Glance images, the images are chunked into objects of the size set using this option. These chunked objects are then stored across the distributed block data store to use for Glance.
rbd_store_pool
¶Type: | string |
---|---|
Default: | images |
RADOS pool in which images are stored.
When RBD is used as the storage backend for storing Glance images, the
images are stored by means of logical grouping of the objects (chunks
of images) into a pool
. Each pool is defined with the number of
placement groups it can contain. The default pool that is used is
‘images’.
More information on the RBD storage backend can be found here: http://ceph.com/planet/how-data-is-stored-in-ceph-cluster/
rbd_store_user
¶Type: | string |
---|---|
Default: | <None> |
RADOS user to authenticate as.
This configuration option takes in the RADOS user to authenticate as. This is only needed when RADOS authentication is enabled and is applicable only if the user is using Cephx authentication. If the value for this option is not set by the user or is set to None, a default value will be chosen, which will be based on the client. section in rbd_store_ceph_conf.
rbd_store_ceph_conf
¶Type: | string |
---|---|
Default: | /etc/ceph/ceph.conf |
Ceph configuration file path.
This configuration option takes in the path to the Ceph configuration file to be used. If the value for this option is not set by the user or is set to None, librados will locate the default configuration file which is located at /etc/ceph/ceph.conf. If using Cephx authentication, this file should include a reference to the right keyring in a client.<USER> section
rados_connect_timeout
¶Type: | integer |
---|---|
Default: | 0 |
Timeout value for connecting to Ceph cluster.
This configuration option takes in the timeout value in seconds used when connecting to the Ceph cluster i.e. it sets the time to wait for glance-api before closing the connection. This prevents glance-api hangups during the connection to RBD. If the value for this option is set to less than or equal to 0, no timeout is set and the default librados value is used.
sheepdog_store_chunk_size
¶Type: | integer |
---|---|
Default: | 64 |
Minimum Value: | 1 |
Chunk size for images to be stored in Sheepdog data store.
Provide an integer value representing the size in mebibyte (1048576 bytes) to chunk Glance images into. The default chunk size is 64 mebibytes.
When using Sheepdog distributed storage system, the images are chunked into objects of this size and then stored across the distributed data store to use for Glance.
Chunk sizes, if a power of two, help avoid fragmentation and enable improved performance.
sheepdog_store_port
¶Type: | port number |
---|---|
Default: | 7000 |
Minimum Value: | 0 |
Maximum Value: | 65535 |
Port number on which the sheep daemon will listen.
Provide an integer value representing a valid port number on which you want the Sheepdog daemon to listen on. The default port is 7000.
The Sheepdog daemon, also called ‘sheep’, manages the storage
in the distributed cluster by writing objects across the storage
network. It identifies and acts on the messages it receives on
the port number set using sheepdog_store_port
option to store
chunks of Glance images.
sheepdog_store_address
¶Type: | host address |
---|---|
Default: | 127.0.0.1 |
Address to bind the Sheepdog daemon to.
Provide a string value representing the address to bind the Sheepdog daemon to. The default address set for the ‘sheep’ is 127.0.0.1.
The Sheepdog daemon, also called ‘sheep’, manages the storage
in the distributed cluster by writing objects across the storage
network. It identifies and acts on the messages directed to the
address set using sheepdog_store_address
option to store
chunks of Glance images.
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.
swift_store_cacert
¶Type: | string |
---|---|
Default: | /etc/ssl/certs/ca-certificates.crt |
Path to the CA bundle file.
This configuration option enables the operator to specify the path to a custom Certificate Authority file for SSL verification when connecting to Swift.
swift_store_region
¶Type: | string |
---|---|
Default: | RegionTwo |
The region of Swift endpoint to use by Glance.
Provide a string value representing a Swift region where Glance can connect to for image storage. By default, there is no region set.
When Glance uses Swift as the storage backend to store images
for a specific tenant that has multiple endpoints, setting of a
Swift region with swift_store_region
allows Glance to connect
to Swift in the specified region as opposed to a single region
connectivity.
This option can be configured for both single-tenant and multi-tenant storage.
NOTE: Setting the region with swift_store_region
is
tenant-specific and is necessary only if
the tenant has
multiple endpoints across different regions.
swift_store_endpoint
¶Type: | string |
---|---|
Default: | https://swift.openstack.example.org/v1/path_not_including_container_name |
The URL endpoint to use for Swift backend storage.
Provide a string value representing the URL endpoint to use for
storing Glance images in Swift store. By default, an endpoint
is not set and the storage URL returned by auth
is used.
Setting an endpoint with swift_store_endpoint
overrides the
storage URL and is used for Glance image storage.
NOTE: The URL should include the path up to, but excluding the container. The location of an object is obtained by appending the container and object to the configured URL.
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.
swift_store_service_type
¶Type: | string |
---|---|
Default: | object-store |
Type of Swift service to use.
Provide a string value representing the service type to use for
storing images while using Swift backend storage. The default
service type is set to object-store
.
NOTE: If swift_store_auth_version
is set to 2, the value for
this configuration option needs to be object-store
. If using
a higher version of Keystone or a different auth scheme, this
option may be modified.
swift_store_container
¶Type: | string |
---|---|
Default: | glance |
Name of single container to store images/name prefix for multiple containers
When a single container is being used to store images, this configuration
option indicates the container within the Glance account to be used for
storing all images. When multiple containers are used to store images, this
will be the name prefix for all containers. Usage of single/multiple
containers can be controlled using the configuration option
swift_store_multiple_containers_seed
.
When using multiple containers, the containers will be named after the value
set for this configuration option with the first N chars of the image UUID
as the suffix delimited by an underscore (where N is specified by
swift_store_multiple_containers_seed
).
Example: if the seed is set to 3 and swift_store_container = glance
, then
an image with UUID fdae39a1-bac5-4238-aba4-69bcc726e848
would be placed in
the container glance_fda
. All dashes in the UUID are included when
creating the container name but do not count toward the character limit, so
when N=10 the container name would be glance_fdae39a1-ba.
swift_store_multiple_containers_seed
should be
taken into account as well.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.
swift_store_large_object_chunk_size
swift_store_large_object_chunk_size
¶Type: | integer |
---|---|
Default: | 200 |
Minimum Value: | 1 |
The maximum size, in MB, of the segments when image data is segmented.
When image data is segmented to upload images that are larger than the limit
enforced by the Swift cluster, image data is broken into segments that are no
bigger than the size specified by this configuration option.
Refer to swift_store_large_object_size
for more detail.
For example: if swift_store_large_object_size
is 5GB and
swift_store_large_object_chunk_size
is 1GB, an image of size 6.2GB will be
segmented into 7 segments where the first six segments will be 1GB in size and
the seventh segment will be 0.2GB.
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.
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.
swift_store_multiple_containers_seed
¶Type: | integer |
---|---|
Default: | 0 |
Minimum Value: | 0 |
Maximum Value: | 32 |
Seed indicating the number of containers to use for storing images.
When using a single-tenant store, images can be stored in one or more than one containers. When set to 0, all images will be stored in one single container. When set to an integer value between 1 and 32, multiple containers will be used to store images. This configuration option will determine how many containers are created. The total number of containers that will be used is equal to 16^N, so if this config option is set to 2, then 16^2=256 containers will be used to store images.
Please refer to swift_store_container
for more detail on the naming
convention. More detail about using multiple containers can be found at
https://specs.openstack.org/openstack/glance-specs/specs/kilo/swift-store-multiple-containers.html
NOTE: This is used only when swift_store_multi_tenant is disabled.
swift_store_container
swift_store_multi_tenant
swift_store_create_container_on_put
swift_store_admin_tenants
¶Type: | list |
---|---|
Default: | u'' |
List of tenants that will be granted admin access.
This is a list of tenants that will be granted read/write access on all Swift containers created by Glance in multi-tenant mode. The default value is an empty list.
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.
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.
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.
swift_store_use_trusts
¶Type: | boolean |
---|---|
Default: | true |
Use trusts for multi-tenant Swift store.
This option instructs the Swift store to create a trust for each add/get request when the multi-tenant store is in use. Using trusts allows the Swift store to avoid problems that can be caused by an authentication token expiring during the upload or download of data.
By default, swift_store_use_trusts
is set to True``(use of
trusts is enabled). If set to ``False
, a user token is used for
the Swift connection instead, eliminating the overhead of trust
creation.
NOTE: This option is considered only when
swift_store_multi_tenant
is set to True
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)
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.
swift_store_auth_version
¶Type: | string |
---|---|
Default: | 2 |
Version of the authentication service to use. Valid versions are 2 and 3 for keystone and 1 (deprecated) for swauth and rackspace.
Warning
This option is deprecated for removal. Its value may be silently ignored in the future.
Reason: | The option ‘auth_version’ in the Swift back-end configuration file is used instead. |
---|
swift_store_auth_address
¶Type: | string |
---|---|
Default: | <None> |
The address where the Swift authentication service is listening.
Warning
This option is deprecated for removal. Its value may be silently ignored in the future.
Reason: | The option ‘auth_address’ in the Swift back-end configuration file is used instead. |
---|
swift_store_user
¶Type: | string |
---|---|
Default: | <None> |
The user to authenticate against the Swift authentication service.
Warning
This option is deprecated for removal. Its value may be silently ignored in the future.
Reason: | The option ‘user’ in the Swift back-end configuration file is set instead. |
---|
swift_store_key
¶Type: | string |
---|---|
Default: | <None> |
Auth key for the user authenticating against the Swift authentication service.
Warning
This option is deprecated for removal. Its value may be silently ignored in the future.
Reason: | The option ‘key’ in the Swift back-end configuration file is used to set the authentication key instead. |
---|
swift_store_config_file
¶Type: | string |
---|---|
Default: | <None> |
Absolute path to the file containing the swift account(s) configurations.
Include a string value representing the path to a configuration file that has references for each of the configured Swift account(s)/backing stores. By default, no file path is specified and customized Swift referencing is disabled. Configuring this option is highly recommended while using Swift storage backend for image storage as it avoids storage of credentials in the database.
NOTE: Please do not configure this option if you have set
swift_store_multi_tenant
to True
.
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.
swift_store_large_object_chunk_size
and the maximum
number of images that could be uploaded simultaneously by
a given glance node.vmware_server_host
¶Type: | host address |
---|---|
Default: | 127.0.0.1 |
Address of the ESX/ESXi or vCenter Server target system.
This configuration option sets the address of the ESX/ESXi or vCenter Server target system. This option is required when using the VMware storage backend. The address can contain an IP address (127.0.0.1) or a DNS name (www.my-domain.com).
vmware_server_username
¶Type: | string |
---|---|
Default: | root |
Server username.
This configuration option takes the username for authenticating with the VMware ESX/ESXi or vCenter Server. This option is required when using the VMware storage backend.
vmware_server_password
¶Type: | string |
---|---|
Default: | vmware |
Server password.
This configuration option takes the password for authenticating with the VMware ESX/ESXi or vCenter Server. This option is required when using the VMware storage backend.
vmware_api_retry_count
¶Type: | integer |
---|---|
Default: | 10 |
Minimum Value: | 1 |
The number of VMware API retries.
This configuration option specifies the number of times the VMware ESX/VC server API must be retried upon connection related issues or server API call overload. It is not possible to specify ‘retry forever’.
vmware_task_poll_interval
¶Type: | integer |
---|---|
Default: | 5 |
Minimum Value: | 1 |
Interval in seconds used for polling remote tasks invoked on VMware ESX/VC server.
This configuration option takes in the sleep time in seconds for polling an on-going async task as part of the VMWare ESX/VC server API call.
vmware_store_image_dir
¶Type: | string |
---|---|
Default: | /openstack_glance |
The directory where the glance images will be stored in the datastore.
This configuration option specifies the path to the directory where the glance images will be stored in the VMware datastore. If this option is not set, the default directory where the glance images are stored is openstack_glance.
vmware_insecure
¶Type: | boolean |
---|---|
Default: | false |
Set verification of the ESX/vCenter server certificate.
This configuration option takes a boolean value to determine whether or not to verify the ESX/vCenter server certificate. If this option is set to True, the ESX/vCenter server certificate is not verified. If this option is set to False, then the default CA truststore is used for verification.
This option is ignored if the “vmware_ca_file” option is set. In that case, the ESX/vCenter server certificate will then be verified using the file specified using the “vmware_ca_file” option .
Group | Name |
---|---|
glance_store | vmware_api_insecure |
vmware_ca_file
¶Type: | string |
---|---|
Default: | /etc/ssl/certs/ca-certificates.crt |
Absolute path to the CA bundle file.
This configuration option enables the operator to use a custom Cerificate Authority File to verify the ESX/vCenter certificate.
If this option is set, the “vmware_insecure” option will be ignored and the CA file specified will be used to authenticate the ESX/vCenter server certificate and establish a secure connection to the server.
vmware_datastores
¶Type: | multi-valued |
---|---|
Default: | u'' |
The datastores where the image can be stored.
This configuration option specifies the datastores where the image can be stored in the VMWare store backend. This option may be specified multiple times for specifying multiple datastores. The datastore name should be specified after its datacenter path, separated by “:”. An optional weight may be given after the datastore name, separated again by “:” to specify the priority. Thus, the required format becomes <datacenter_path>:<datastore_name>:<optional_weight>.
When adding an image, the datastore with highest weight will be selected, unless there is not enough free space available in cases where the image size is already known. If no weight is given, it is assumed to be zero and the directory will be considered for selection last. If multiple datastores have the same weight, then the one with the most free space available is selected.
enforce_scope
¶Type: | boolean |
---|---|
Default: | false |
This option controls whether or not to enforce scope when evaluating policies. If True
, the scope of the token used in the request is compared to the scope_types
of the policy being enforced. If the scopes do not match, an InvalidScope
exception will be raised. If False
, a message will be logged informing operators that policies are being invoked with mismatching scope.
policy_file
¶Type: | string |
---|---|
Default: | policy.json |
The file that defines policies.
Group | Name |
---|---|
DEFAULT | policy_file |
policy_default_rule
¶Type: | string |
---|---|
Default: | default |
Default rule. Enforced when a requested rule is not found.
Group | Name |
---|---|
DEFAULT | policy_default_rule |
policy_dirs
¶Type: | multi-valued |
---|---|
Default: | policy.d |
Directories where policy configuration files are stored. They can be relative to any directory in the search path defined by the config_dir option, or absolute paths. The file defined by policy_file must exist for these directories to be searched. Missing or empty directories are ignored.
Group | Name |
---|---|
DEFAULT | policy_dirs |
remote_content_type
¶Type: | string |
---|---|
Default: | application/x-www-form-urlencoded |
Valid Values: | application/x-www-form-urlencoded, application/json |
Content Type to send and receive data for REST based policy check
remote_ssl_verify_server_crt
¶Type: | boolean |
---|---|
Default: | false |
server identity verification for REST based policy check
remote_ssl_ca_crt_file
¶Type: | string |
---|---|
Default: | <None> |
Absolute path to ca cert file for REST based policy check
remote_ssl_client_crt_file
¶Type: | string |
---|---|
Default: | <None> |
Absolute path to client cert for REST based policy check
remote_ssl_client_key_file
¶Type: | string |
---|---|
Default: | <None> |
Absolute path client key file REST based policy check
Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.