3.2.3. glance_store
The following table outlines the options available under the [glance_store] group in the /etc/glance/glance-scrubber.conf file.
| Configuration option = Default value | Type | Description |
|---|---|---|
|
| boolean value | 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 Possible values:
Related options:
|
|
| string value | 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. Possible values:
Related options:
|
|
| string value | Information to match when looking for cinder in the service catalog.
When the
The service catalog can be listed by the Possible values:
Related options:
|
|
| string value | 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
If this configuration option is set, Possible values:
Related options:
|
|
| boolean value | If this is set to True, attachment of volumes for image transfer will be aborted when multipathd is not running. Otherwise, it will fallback to single path. Possible values:
Related options:
|
|
| integer value | Number of cinderclient retries on failed http calls. When a call failed by any errors, cinderclient will retry the call up to the specified times after sleeping a few seconds. Possible values:
Related options:
|
|
| string value | Directory where the NFS volume is mounted on the glance node. Possible values:
|
|
| string value | Region name to lookup cinder service from the service catalog.
This is used only when Possible values:
Related options:
|
|
| integer value | 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 Possible values:
Related options:
|
|
| string value | The address where the cinder authentication service is listening.
When all of If either of these options are not set, the cinder endpoint is looked up from the service catalog, and current context’s user and project are used. Possible values:
Related options:
|
|
| string value | Password for the user authenticating against cinder. This must be used with all the following related options. If any of these are not specified, the user of the current context is used. Possible values:
Related options:
|
|
| string value | Project name where the image volume is stored in cinder. If this configuration option is not set, the project in current context is used. This must be used with all the following related options. If any of these are not specified, the project of the current context is used. Possible values:
Related options:
|
|
| string value | User name to authenticate against cinder. This must be used with all the following related options. If any of these are not specified, the user of the current context is used. Possible values:
Related options:
|
|
| boolean value | Flag to identify mutipath is supported or not in the deployment. Set it to False if multipath is not supported. Possible values:
Related options:
|
|
| string value | Volume type that will be used for volume creation in cinder. Some cinder backends can have several volume types to optimize storage usage. Adding this option allows an operator to choose a specific volume type in cinder that can be optimized for images. If this is not set, then the default volume type specified in the cinder configuration will be used for volume creation. Possible values:
Related options:
|
|
| string value | (DEPRECATED FOR REMOVAL) 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 注記
The value given for this configuration option must be a valid scheme for a store registered with the Possible values:
Related Options:
|
|
| string value | 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:
Related options:
|
|
| integer value | 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:
Related options:
|
|
| string value | 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 注記
This directory is used only when filesystem store is used as a storage backend. Either Possible values:
Related options:
|
|
| multi valued | 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 More information on configuring filesystem store with multiple store directories can be found at https://docs.openstack.org/glance/latest/configuration/configuring.html 注記
This directory is used only when filesystem store is used as a storage backend. Either Possible values:
Related options:
|
|
| integer value | 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:
Related options:
|
|
| string value | 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 Possible values:
Related options:
|
|
| dict value | 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:
Related options:
|
|
| string value | 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 Possible values:
Related options:
|
|
| boolean value | 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 Possible values:
Related options:
|
|
| integer value | 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:
Related options:
|
| `rbd_store_ceph_conf = ` | string value | 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. 注記 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:
Related options:
|
|
| integer value | 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:
Related options:
|
|
| string value | 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 More information on the RBD storage backend can be found here: http://ceph.com/planet/how-data-is-stored-in-ceph-cluster/ Possible Values:
Related options:
|
|
| string value | 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:
Related options:
|
|
| string value | Path to the rootwrap configuration file to use for running commands as root. The cinder store requires root privileges to operate the image volumes (for connecting to iSCSI/FC volumes and reading/writing the volume data, etc.). The configuration file should allow the required commands by cinder store and os-brick library. Possible values:
Related options:
|
|
| host address value | (DEPRECATED FOR REMOVAL) 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 Possible values:
Related Options:
|
|
| integer value | (DEPRECATED FOR REMOVAL) Chunk size for images to be stored in Sheepdog data store. Provide an integer value representing the size in mebibyte (1048576 bytes) to chunk Glance images into. The default chunk size is 64 mebibytes. When using Sheepdog distributed storage system, the images are chunked into objects of this size and then stored across the distributed data store to use for Glance. Chunk sizes, if a power of two, help avoid fragmentation and enable improved performance. Possible values:
Related Options:
|
|
| port value | (DEPRECATED FOR REMOVAL) 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 Possible values:
Related Options:
|
|
| list value | (DEPRECATED FOR REMOVAL) 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 Possible values:
Related Options:
|
|
| boolean value | 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: ( Possible values:
Related options:
|
|
| list value | 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:
Related options:
|
|
| string value | (DEPRECATED FOR REMOVAL) The address where the Swift authentication service is listening. |
|
| boolean value | 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:
Related options:
|
|
| string value | (DEPRECATED FOR REMOVAL) Version of the authentication service to use. Valid versions are 2 and 3 for keystone and 1 (deprecated) for swauth and rackspace. |
|
| string value | 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:
Related options:
|
|
| string value | 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. 注記
Please do not configure this option if you have set Possible values:
Related options:
|
|
| string value | 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
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
Example: if the seed is set to 3 and swift_store_container = Possible values:
Related options:
|
|
| boolean value | 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:
Related options:
|
|
| string value | 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 注記 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:
Related Options:
|
|
| string value | 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:
Related options:
|
|
| integer value | 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:
Related Options:
|
|
| string value | (DEPRECATED FOR REMOVAL) Auth key for the user authenticating against the Swift authentication service. |
|
| integer value | 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
For example: if Possible values:
Related options:
|
|
| integer value | 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. 注記 This should be set by taking into account the large object limit enforced by the Swift cluster in consideration. Possible values:
Related options:
|
|
| boolean value | 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 注記 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:
Related options:
|
|
| integer value | 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 注記 This is used only when swift_store_multi_tenant is disabled. Possible values:
Related options:
|
|
| string value | 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 This option can be configured for both single-tenant and multi-tenant storage. 注記
Setting the region with Possible values:
Related Options:
|
|
| integer value | 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, Possible values:
Related Options:
|
|
| string value | 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 注記
If Possible values:
Related Options:
|
|
| boolean value | 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:
Related Options:
|
|
| boolean value | 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, 注記
This option is considered only when Possible values:
Related options:
|
|
| string value | (DEPRECATED FOR REMOVAL) The user to authenticate against the Swift authentication service. |
|
| string value | 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 Possible values:
Related options:
|
|
| integer value | 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:
Related options:
|
|
| string value | 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:
Related options:
|
|
| multi valued | 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:
Related options: * None |
|
| boolean value | 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:
Related options:
|
|
| host address value | 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:
Related options:
|
|
| string value | 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:
Related options:
|
|
| string value | 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:
Related options:
|
|
| string value | 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:
Related options:
|
|
| integer value | 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:
Related options:
|