openstack/openstack-manuals
Code Issues Proposed changes

[config-ref] update glance config options for Newton

Browse Source 
Change-Id: Ia35e463e9f2c5528df945ded693fcd9a69e9e9b9
This commit is contained in:
KATO Tomoyuki 2016-09-30 14:24:25 +09:00
parent b52a302144
commit 20feda79a7
27 changed files with 300 additions and 1158 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
doc/config-reference/source/image.rst
View File

@ -3,10 +3,11 @@ Image service
=============
.. toctree::
:maxdepth: 1
image/api.rst
image/rpc.rst
image/backends.rst
image/config-options.rst
image/logs.rst
image/sample-configuration-files.rst
tables/conf-changes/glance.rst
@ -21,19 +22,3 @@ service.
The common configurations for shared service and libraries,
such as database connections and RPC messaging,
are described at :doc:`common-configurations`.
To customize the Compute service, use the configuration option settings
documented in :ref:`nova-glance`.
You can modify many options in the Image service. The following tables provide
a comprehensive list.
.. include:: tables/glance-common.rst
.. include:: tables/glance-imagecache.rst
.. include:: tables/glance-profiler.rst
.. include:: tables/glance-redis.rst
.. include:: tables/glance-registry.rst
.. include:: tables/glance-replicator.rst
.. include:: tables/glance-scrubber.rst
.. include:: tables/glance-taskflow.rst
.. include:: tables/glance-testing.rst

2
doc/config-reference/source/image/backends.rst
View File

@ -58,7 +58,7 @@ options to ``vsphere``, as shown in this code sample:
[glance_store]
# List of stores enabled. Valid stores are: cinder, file, http, rbd,
# sheepdog, swift, s3, vsphere (list value)
# sheepdog, swift, vsphere (list value)
stores = file,http,vsphere
# Which back end scheme should Glance use by default is not specified
# in a request to add a new image to Glance? Known schemes are determined

16
doc/config-reference/source/image/config-options.rst Normal file
View File

@ -0,0 +1,16 @@
==================================================
Additional configuration options for Image service
==================================================
You can modify many options in the Image service.
The following tables provide a comprehensive list.
.. include:: ../tables/glance-common.rst
.. include:: ../tables/glance-imagecache.rst
.. include:: ../tables/glance-profiler.rst
.. include:: ../tables/glance-redis.rst
.. include:: ../tables/glance-registry.rst
.. include:: ../tables/glance-replicator.rst
.. include:: ../tables/glance-scrubber.rst
.. include:: ../tables/glance-taskflow.rst
.. include:: ../tables/glance-testing.rst

18
doc/config-reference/source/image/rpc.rst
View File

@ -1,18 +0,0 @@
==================================
Configure the RPC messaging system
==================================
OpenStack projects use an open standard for messaging middleware known
as AMQP. This messaging middleware enables the OpenStack services that
run on multiple servers to talk to each other. The OpenStack common
library project, oslo, supports two implementations of AMQP: RabbitMQ and
ZeroMQ.
The following tables contain settings to configure the messaging middleware
for the Image service. Use these options to configure the messaging drivers
in the ``glance-api.conf`` and ``glance-registry.conf`` files:
.. include:: ../tables/glance-zeromq.rst
.. include:: ../tables/glance-amqp.rst
.. include:: ../tables/glance-rpc.rst
.. include:: ../tables/glance-rabbitmq.rst

50
doc/config-reference/source/tables/glance-amqp.rst
View File

@ -1,50 +0,0 @@
..
Warning: Do not edit this file. It is automatically generated from the
software project's code and your changes will be overwritten.
The tool to generate this file lives in openstack-doc-tools repository.
Please make any changes needed in the code, then run the
autogenerate-config-doc tool from the openstack-doc-tools repository, or
ask for help on the documentation mailing list, IRC channel or meeting.
.. _glance-amqp:
.. list-table:: Description of AMQP configuration options
:header-rows: 1
:class: config-ref-table
* - Configuration option = Default value
- Description
* - **[DEFAULT]**
-
* - ``control_exchange`` = ``openstack``
- (String) The default exchange under which topics are scoped. May be overridden by an exchange name specified in the transport_url option.
* - ``default_publisher_id`` = ``image.localhost``
- (String) 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`` =
- (List) 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
* - ``transport_url`` = ``None``
- (String) A URL representing the messaging driver to use and its full configuration.
* - **[oslo_messaging_notifications]**
-
* - ``driver`` = ``[]``
- (Multi-valued) The Drivers(s) to handle sending notifications. Possible values are messaging, messagingv2, routing, log, test, noop
* - ``topics`` = ``notifications``
- (List) AMQP topic used for OpenStack notifications.
* - ``transport_url`` = ``None``
- (String) A URL representing the messaging driver to use for notifications. If not set, we fall back to the same configuration used for RPC.

238
doc/config-reference/source/tables/glance-api.rst
View File

@ -19,221 +19,55 @@
* - **[DEFAULT]**
-
* - ``admin_role`` = ``admin``
- (String) Role used to identify an authenticated user as administrator.
Provide a string value representing a Keystone role to identify an administrative user. Users with this role will be granted administrative privileges. The default value for this option is 'admin'.
Possible values: * A string value which is a valid Keystone role
Related options: * None
- (String) Role used to identify an authenticated user as administrator.$sentinal$Provide a string value representing a Keystone role to identify an administrative user. Users with this role will be granted administrative privileges. The default value for this option is 'admin'.$sentinal$Possible values: * A string value which is a valid Keystone role$sentinal$Related options: * None
* - ``allow_anonymous_access`` = ``False``
- (Boolean) 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
- (Boolean) Allow limited access to unauthenticated users.$sentinal$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.$sentinal$Possible values: * True * False$sentinal$Related options: * None
* - ``available_plugins`` =
- (List) A list of artifacts that are allowed in the format name or name-version. Empty list means that any artifact can be loaded.
* - ``client_socket_timeout`` = ``900``
- (Integer) 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
- (Integer) Timeout for client connections' socket operations.$sentinal$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.$sentinal$The value zero implies wait forever.$sentinal$Possible values: * Zero * Positive integer$sentinal$Related options: * None
* - ``enable_v1_api`` = ``True``
- (Boolean) Deploy the v1 OpenStack Images API.
When this option is set to ``True``, Glance service will respond to requests on registered endpoints conforming to the v1 OpenStack Images API.
NOTES: * If this option is enabled, then ``enable_v1_registry`` must also be set to ``True`` to enable mandatory usage of Registry service with v1 API.
* If this option is disabled, then the ``enable_v1_registry`` option, which is enabled by default, is also recommended to be disabled.
* This option is separate from ``enable_v2_api``, both v1 and v2 OpenStack Images API can be deployed independent of each other.
* If deploying only the v2 Images API, this option, which is enabled by default, should be disabled.
Possible values: * True * False
Related options: * enable_v1_registry * enable_v2_api
- (Boolean) Deploy the v1 OpenStack Images API.$sentinal$When this option is set to ``True``, Glance service will respond to requests on registered endpoints conforming to the v1 OpenStack Images API.$sentinal$NOTES: * If this option is enabled, then ``enable_v1_registry`` must also be set to ``True`` to enable mandatory usage of Registry service with v1 API.$sentinal$ * If this option is disabled, then the ``enable_v1_registry`` option, which is enabled by default, is also recommended to be disabled.$sentinal$ * This option is separate from ``enable_v2_api``, both v1 and v2 OpenStack Images API can be deployed independent of each other.$sentinal$ * If deploying only the v2 Images API, this option, which is enabled by default, should be disabled.$sentinal$Possible values: * True * False$sentinal$Related options: * enable_v1_registry * enable_v2_api
* - ``enable_v1_registry`` = ``True``
- (Boolean) Deploy the v1 API Registry service.
When this option is set to ``True``, the Registry service will be enabled in Glance for v1 API requests.
NOTES: * Use of Registry is mandatory in v1 API, so this option must be set to ``True`` if the ``enable_v1_api`` option is enabled.
* If deploying only the v2 OpenStack Images API, this option, which is enabled by default, should be disabled.
Possible values: * True * False
Related options: * enable_v1_api
- (Boolean) Deploy the v1 API Registry service.$sentinal$When this option is set to ``True``, the Registry service will be enabled in Glance for v1 API requests.$sentinal$NOTES: * Use of Registry is mandatory in v1 API, so this option must be set to ``True`` if the ``enable_v1_api`` option is enabled.$sentinal$ * If deploying only the v2 OpenStack Images API, this option, which is enabled by default, should be disabled.$sentinal$Possible values: * True * False$sentinal$Related options: * enable_v1_api
* - ``enable_v2_api`` = ``True``
- (Boolean) Deploy the v2 OpenStack Images API.
When this option is set to ``True``, Glance service will respond to requests on registered endpoints conforming to the v2 OpenStack Images API.
NOTES: * If this option is disabled, then the ``enable_v2_registry`` option, which is enabled by default, is also recommended to be disabled.
* This option is separate from ``enable_v1_api``, both v1 and v2 OpenStack Images API can be deployed independent of each other.
* If deploying only the v1 Images API, this option, which is enabled by default, should be disabled.
Possible values: * True * False
Related options: * enable_v2_registry * enable_v1_api
- (Boolean) Deploy the v2 OpenStack Images API.$sentinal$When this option is set to ``True``, Glance service will respond to requests on registered endpoints conforming to the v2 OpenStack Images API.$sentinal$NOTES: * If this option is disabled, then the ``enable_v2_registry`` option, which is enabled by default, is also recommended to be disabled.$sentinal$ * This option is separate from ``enable_v1_api``, both v1 and v2 OpenStack Images API can be deployed independent of each other.$sentinal$ * If deploying only the v1 Images API, this option, which is enabled by default, should be disabled.$sentinal$Possible values: * True * False$sentinal$Related options: * enable_v2_registry * enable_v1_api
* - ``enable_v2_registry`` = ``True``
- (Boolean) Deploy the v2 API Registry service.
When this option is set to ``True``, the Registry service will be enabled in Glance for v2 API requests.
NOTES: * Use of Registry is optional in v2 API, so this option must only be enabled if both ``enable_v2_api`` is set to ``True`` and the ``data_api`` option is set to ``glance.db.registry.api``.
* If deploying only the v1 OpenStack Images API, this option, which is enabled by default, should be disabled.
Possible values: * True * False
Related options: * enable_v2_api * data_api
- (Boolean) Deploy the v2 API Registry service.$sentinal$When this option is set to ``True``, the Registry service will be enabled in Glance for v2 API requests.$sentinal$NOTES: * Use of Registry is optional in v2 API, so this option must only be enabled if both ``enable_v2_api`` is set to ``True`` and the ``data_api`` option is set to ``glance.db.registry.api``.$sentinal$ * If deploying only the v1 OpenStack Images API, this option, which is enabled by default, should be disabled.$sentinal$Possible values: * True * False$sentinal$Related options: * enable_v2_api * data_api
* - ``http_keepalive`` = ``True``
- (Boolean) 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 to ``True``, 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
- (Boolean) Set keep alive option for HTTP over TCP.$sentinal$Provide a boolean value to determine sending of keep alive packets. If set to ``False``, the server returns the header "Connection: close". If set to ``True``, 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.$sentinal$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.$sentinal$Possible values: * True * False$sentinal$Related options: * None
* - ``image_size_cap`` = ``1099511627776``
- (Integer) 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
- (Integer) Maximum size of image a user can upload in bytes.$sentinal$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).$sentinal$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.$sentinal$Possible values: * Any positive number less than or equal to 9223372036854775808
* - ``load_enabled`` = ``True``
- (Boolean) When false, no artifacts can be loaded regardless of available_plugins. When true, artifacts can be loaded.
* - ``location_strategy`` = ``location_order``
- (String) 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`` and ``store_type``. The default value is ``location_order``, which suggests that image data be served by using locations in the order they are stored in Glance. The ``store_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 option ``store_type_preference``.
Possible values: * location_order * store_type
Related options: * store_type_preference
- (String) Strategy to determine the preference order of image locations.$sentinal$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.$sentinal$This option takes one of two possible values ``location_order`` and ``store_type``. The default value is ``location_order``, which suggests that image data be served by using locations in the order they are stored in Glance. The ``store_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 option ``store_type_preference``.$sentinal$Possible values: * location_order * store_type$sentinal$Related options: * store_type_preference
* - ``max_header_line`` = ``16384``
- (Integer) 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 for ``max_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
- (Integer) Maximum line size of message headers.$sentinal$Provide an integer value representing a length to limit the size of message headers. The default value is 16384.$sentinal$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 for ``max_header_line`` would flood the logs.$sentinal$Setting ``max_header_line`` to 0 sets no limit for the line size of message headers.$sentinal$Possible values: * 0 * Positive integer$sentinal$Related options: * None
* - ``max_request_id_length`` = ``64``
- (Integer) 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
- (Integer) Limit the request ID length.$sentinal$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.$sentinal$Possible values: * Integer value between 0 and 16384$sentinal$Related options: * None
* - ``owner_is_tenant`` = ``True``
- (Boolean) Set the image owner to tenant or the authenticated user.
Assign a boolean value to determine the owner of an image. When set to True, the owner of the image is the tenant. When set to False, the owner of the image will be the authenticated user issuing the request. Setting it to False makes the image private to the associated user and sharing with other users within the same tenant (or "project") requires explicit image sharing via image membership.
Possible values: * True * False
Related options: * None
- (Boolean) Set the image owner to tenant or the authenticated user.$sentinal$Assign a boolean value to determine the owner of an image. When set to True, the owner of the image is the tenant. When set to False, the owner of the image will be the authenticated user issuing the request. Setting it to False makes the image private to the associated user and sharing with other users within the same tenant (or "project") requires explicit image sharing via image membership.$sentinal$Possible values: * True * False$sentinal$Related options: * None
* - ``public_endpoint`` = ``None``
- (String) Public url endpoint to use for Glance/Glare versions response.
This is the public url endpoint that will appear in the Glance/Glare "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
- (String) Public url endpoint to use for Glance/Glare versions response.$sentinal$This is the public url endpoint that will appear in the Glance/Glare "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.$sentinal$Possible values: * None * Proxy URL * Load balancer URL$sentinal$Related options: * None
* - ``secure_proxy_ssl_header`` = ``None``
- (String) DEPRECATED: 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". Use the http_proxy_to_wsgi middleware instead.
* - ``send_identity_headers`` = ``False``
- (Boolean) Send headers received from identity when making requests to registry.
Typically, Glance registry can be deployed in multiple flavors, which may or may not include authentication. For example, ``trusted-auth`` is a flavor that does not require the registry service to authenticate the requests it receives. However, the registry service may still need a user context to be populated to serve the requests. This can be achieved by the caller (the Glance API usually) passing through the headers it received from authenticating with identity for the same request. The typical headers sent are ``X-User-Id``, ``X-Tenant-Id``, ``X-Roles``, ``X-Identity-Status`` and ``X-Service-Catalog``.
Provide a boolean value to determine whether to send the identity headers to provide tenant and user information along with the requests to registry service. By default, this option is set to ``False``, which means that user and tenant information is not available readily. It must be obtained by authenticating. Hence, if this is set to ``False``, ``flavor`` must be set to value that either includes authentication or authenticated user context.
Possible values: * True * False
Related options: * flavor
- (Boolean) Send headers received from identity when making requests to registry.$sentinal$Typically, Glance registry can be deployed in multiple flavors, which may or may not include authentication. For example, ``trusted-auth`` is a flavor that does not require the registry service to authenticate the requests it receives. However, the registry service may still need a user context to be populated to serve the requests. This can be achieved by the caller (the Glance API usually) passing through the headers it received from authenticating with identity for the same request. The typical headers sent are ``X-User-Id``, ``X-Tenant-Id``, ``X-Roles``, ``X-Identity-Status`` and ``X-Service-Catalog``.$sentinal$Provide a boolean value to determine whether to send the identity headers to provide tenant and user information along with the requests to registry service. By default, this option is set to ``False``, which means that user and tenant information is not available readily. It must be obtained by authenticating. Hence, if this is set to ``False``, ``flavor`` must be set to value that either includes authentication or authenticated user context.$sentinal$Possible values: * True * False$sentinal$Related options: * flavor
* - ``show_multiple_locations`` = ``False``
- (Boolean) DEPRECATED: Show all image locations when returning an image.
This configuration option indicates whether to show all the image locations when returning image details to the user. When multiple image locations exist for an image, the locations are ordered based on the location strategy indicated by the configuration opt ``location_strategy``. The image locations are shown under the image property ``locations``.
NOTES: * Revealing image locations can present a GRAVE SECURITY RISK as image locations can sometimes include credentials. Hence, this is set to ``False`` by default. Set this to ``True`` with EXTREME CAUTION and ONLY IF you know what you are doing! * If an operator wishes to avoid showing any image location(s) to the user, then both this option and ``show_image_direct_url`` MUST be set to ``False``.
Possible values: * True * False
Related options: * show_image_direct_url * location_strategy This option will be removed in the Ocata release because the same functionality can be achieved with greater granularity by using policies. Please see the Newton release notes for more information.
- (Boolean) DEPRECATED: Show all image locations when returning an image.$sentinal$This configuration option indicates whether to show all the image locations when returning image details to the user. When multiple image locations exist for an image, the locations are ordered based on the location strategy indicated by the configuration opt ``location_strategy``. The image locations are shown under the image property ``locations``.$sentinal$NOTES: * Revealing image locations can present a GRAVE SECURITY RISK as image locations can sometimes include credentials. Hence, this is set to ``False`` by default. Set this to ``True`` with EXTREME CAUTION and ONLY IF you know what you are doing! * If an operator wishes to avoid showing any image location(s) to the user, then both this option and ``show_image_direct_url`` MUST be set to ``False``.$sentinal$Possible values: * True * False$sentinal$Related options: * show_image_direct_url * location_strategy This option will be removed in the Ocata release because the same functionality can be achieved with greater granularity by using policies. Please see the Newton release notes for more information.
* - ``tcp_keepidle`` = ``600``
- (Integer) 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
- (Integer) Set the wait time before a connection recheck.$sentinal$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.$sentinal$Setting ``tcp_keepidle`` helps verify at regular intervals that a connection is intact and prevents frequent TCP connection reestablishment.$sentinal$Possible values: * Positive integer value representing time in seconds$sentinal$Related options: * None
* - ``use_user_token`` = ``True``
- (Boolean) DEPRECATED: Whether to pass through the user token when making requests to the registry. To prevent failures with token expiration during big files upload, it is recommended to set this parameter to False.If "use_user_token" is not in effect, then admin credentials can be specified. This option was considered harmful and has been deprecated in M release. It will be removed in O release. For more information read OSSN-0060. Related functionality with uploading big images has been implemented with Keystone trusts support.
* - **[glance_store]**
-
* - ``default_store`` = ``file``
- (String) The default scheme to use for storing images.
Provide a string value representing the default scheme to use for storing images. If not set, Glance uses ``file`` as the default scheme to store images with the ``file`` store.
NOTE: The value given for this configuration option must be a valid scheme for a store registered with the ``stores`` configuration option.
Possible values: * file * filesystem * http * https * swift * swift+http * swift+https * swift+config * rbd * sheepdog * cinder * vsphere
Related Options: * stores
- (String) The default scheme to use for storing images.$sentinal$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.$sentinal$NOTE: The value given for this configuration option must be a valid scheme for a store registered with the ``stores`` configuration option.$sentinal$Possible values: * file * filesystem * http * https * swift * swift+http * swift+https * swift+config * rbd * sheepdog * cinder * vsphere$sentinal$Related Options: * stores
* - ``store_capabilities_update_min_interval`` = ``0``
- (Integer) 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: 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 deplyment and help with the usage of this feature, please contact the storage driver maintainers listed here: http://docs.openstack.org/developer/glance_store/drivers/index.html
Possible values: * Zero * Positive integer
Related Options: * None
- (Integer) Minimum interval in seconds to execute updating dynamic storage capabilities based on current backend status.$sentinal$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.$sentinal$By default, this option is set to zero and is disabled. Provide an integer value greater than zero to enable this option.$sentinal$NOTE: For more information on store capabilities and their updates, please visit: https://specs.openstack.org/openstack/glance-specs/specs/kilo/store-capabilities.html$sentinal$For more information on setting up a particular store in your deplyment and help with the usage of this feature, please contact the storage driver maintainers listed here: http://docs.openstack.org/developer/glance_store/drivers/index.html$sentinal$Possible values: * Zero * Positive integer$sentinal$Related Options: * None
* - ``stores`` = ``file, http``
- (List) List of enabled Glance stores.
Register the storage backends to use for storing disk images as a comma separated list. The default stores enabled for storing disk images with Glance are ``file`` and ``http``.
Possible values: * A comma separated list that could include: * file * http * swift * rbd * sheepdog * cinder * vmware
Related Options: * default_store
- (List) List of enabled Glance stores.$sentinal$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``.$sentinal$Possible values: * A comma separated list that could include: * file * http * swift * rbd * sheepdog * cinder * vmware$sentinal$Related Options: * default_store
* - **[oslo_middleware]**
-
* - ``enable_proxy_headers_parsing`` = ``False``
@ -245,36 +79,10 @@
* - **[paste_deploy]**
-
* - ``config_file`` = ``glance-api-paste.ini``
- (String) 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 in ``glance-api.conf``, the service will look for a file named ``glance-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
- (String) Name of the paste configuration file.$sentinal$Provide a string value representing the name of the paste configuration file to use for configuring piplelines for server application deployments.$sentinal$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.$sentinal$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 in ``glance-api.conf``, the service will look for a file named ``glance-api-paste.ini``.) If the paste configuration file is not found, the service will not start.$sentinal$Possible values: * A string value representing the name of the paste configuration file.$sentinal$Related Options: * flavor
* - ``flavor`` = ``keystone``
- (String) 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`` to ``keystone``.
Possible values: * String value representing a partial pipeline name.
Related Options: * config_file
- (String) Deployment flavor to use in the server application pipeline.$sentinal$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.$sentinal$For example, if your paste section name in the paste configuration file is [pipeline:glance-api-keystone], set ``flavor`` to ``keystone``.$sentinal$Possible values: * String value representing a partial pipeline name.$sentinal$Related Options: * config_file
* - **[store_type_location_strategy]**
-
* - ``store_type_preference`` =
- (List) 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 if ``store_type`` is chosen as a value for the ``location_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: (NOTE: Use only the following choices, which, unfortunately, are not entirely consistent with the store names used in other similar configuration options. Please take extra care while setting this option, and read the help text carefully when setting other similar options.) * filesystem * http * rbd * swift * sheepdog * cinder * vmware_datastore
Related options: * location_strategy * stores
- (List) Preference order of storage backends.$sentinal$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.$sentinal$NOTE: The ``store_type_preference`` configuration option is applied only if ``store_type`` is chosen as a value for the ``location_strategy`` configuration option. An empty list will not change the location order.$sentinal$Possible values: * Empty list * Comma separated list of registered store names. Legal values are: * file * http * rbd * swift * sheepdog * cinder * vmware$sentinal$Related options: * location_strategy * stores

28
doc/config-reference/source/tables/glance-ca.rst
View File

@ -19,30 +19,8 @@
* - **[DEFAULT]**
-
* - ``ca_file`` = ``/etc/ssl/cafile``
- (String) Absolute path to the CA file.
Provide a string value representing a valid absolute path to the Certificate Authority file to use for client authentication.
A CA file typically contains necessary trusted certificates to use for the client authentication. This is essential to ensure that a secure connection is established to the server via the internet.
Possible values: * Valid absolute path to the CA file
Related options: * None
- (String) Absolute path to the CA file.$sentinal$Provide a string value representing a valid absolute path to the Certificate Authority file to use for client authentication.$sentinal$A CA file typically contains necessary trusted certificates to use for the client authentication. This is essential to ensure that a secure connection is established to the server via the internet.$sentinal$Possible values: * Valid absolute path to the CA file$sentinal$Related options: * None
* - ``cert_file`` = ``/etc/ssl/certs``
- (String) Absolute path to the certificate file.
Provide a string value representing a valid absolute path to the certificate file which is required to start the API service securely.
A certificate file typically is a public key container and includes the server's public key, server name, server information and the signature which was a result of the verification process using the CA certificate. This is required for a secure connection establishment.
Possible values: * Valid absolute path to the certificate file
Related options: * None
- (String) Absolute path to the certificate file.$sentinal$Provide a string value representing a valid absolute path to the certificate file which is required to start the API service securely.$sentinal$A certificate file typically is a public key container and includes the server's public key, server name, server information and the signature which was a result of the verification process using the CA certificate. This is required for a secure connection establishment.$sentinal$Possible values: * Valid absolute path to the certificate file$sentinal$Related options: * None
* - ``key_file`` = ``/etc/ssl/key/key-file.pem``
- (String) Absolute path to a private key file.
Provide a string value representing a valid absolute path to a private key file which is required to establish the client-server connection.
Possible values: * Absolute path to the private key file
Related options: * None
- (String) Absolute path to a private key file.$sentinal$Provide a string value representing a valid absolute path to a private key file which is required to establish the client-server connection.$sentinal$Possible values: * Absolute path to the private key file$sentinal$Related options: * None

22
doc/config-reference/source/tables/glance-cinder.rst
View File

@ -19,24 +19,24 @@
* - **[glance_store]**
-
* - ``cinder_api_insecure`` = ``False``
- (Boolean) Allow to perform insecure SSL requests to cinder
- (Boolean) Allow to perform insecure SSL requests to cinder.$sentinal$If this option is set to True, HTTPS endpoint connection is verified using the CA certificates file specified by ``cinder_ca_certificates_file`` option.$sentinal$Possible values: * True * False$sentinal$Related options: * cinder_ca_certificates_file
* - ``cinder_ca_certificates_file`` = ``None``
- (String) Location of ca certicates file to use for cinder client requests.
- (String) Location of a CA certificates file used for cinder client requests.$sentinal$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.$sentinal$Possible values: * Path to a ca certificates file$sentinal$Related options: * cinder_api_insecure
* - ``cinder_catalog_info`` = ``volumev2::publicURL``
- (String) Info to match when looking for cinder in the service catalog. Format is : separated values of the form: <service_type>:<service_name>:<endpoint_type>
- (String) Information to match when looking for cinder in the service catalog.$sentinal$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.$sentinal$The service catalog can be listed by the ``openstack catalog list`` command.$sentinal$Possible values: * A string of of the following form: ``<service_type>:<service_name>:<endpoint_type>`` At least ``service_type`` and ``endpoint_type`` should be specified. ``service_name`` can be omitted.$sentinal$Related options: * cinder_os_region_name * cinder_endpoint_template * cinder_store_auth_address * cinder_store_user_name * cinder_store_project_name * cinder_store_password
* - ``cinder_endpoint_template`` = ``None``
- (String) Override service catalog lookup with template for cinder endpoint e.g. http://localhost:8776/v2/%(tenant)s
- (String) Override service catalog lookup with template for cinder endpoint.$sentinal$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.$sentinal$If this configuration option is set, ``cinder_catalog_info`` will be ignored.$sentinal$Possible values: * URL template string for cinder endpoint, where ``%%(tenant)s`` is replaced with the current tenant (project) name. For example: ``http://cinder.openstack.example.org/v2/%%(tenant)s$sentinal$`` Related options: * cinder_store_auth_address * cinder_store_user_name * cinder_store_project_name * cinder_store_password * cinder_catalog_info
* - ``cinder_http_retries`` = ``3``
- (Integer) Number of cinderclient retries on failed http calls
- (Integer) Number of cinderclient retries on failed http calls.$sentinal$When a call failed by any errors, cinderclient will retry the call up to the specified times after sleeping a few seconds.$sentinal$Possible values: * A positive integer$sentinal$Related options: * None
* - ``cinder_os_region_name`` = ``None``
- (String) Region name of this node. If specified, it will be used to locate OpenStack services for stores.
- (String) Region name to lookup cinder service from the service catalog.$sentinal$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.$sentinal$Possible values: * A string that is a valid region name.$sentinal$Related options: * cinder_catalog_info
* - ``cinder_state_transition_timeout`` = ``300``
- (Integer) Time period of time in seconds to wait for a cinder volume transition to complete.
- (Integer) Time period, in seconds, to wait for a cinder volume transition to complete.$sentinal$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.$sentinal$Possible values: * A positive integer$sentinal$Related options: * None
* - ``cinder_store_auth_address`` = ``None``
- (String) The address where the Cinder authentication service is listening. If <None>, the cinder endpoint in the service catalog is used.
- (String) The address where the cinder authentication service is listening.$sentinal$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.$sentinal$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.$sentinal$Possible values: * A valid authentication service address, for example: ``http://openstack.example.org/identity/v2.0`` $sentinal$ Related options: * cinder_store_user_name * cinder_store_password * cinder_store_project_name
* - ``cinder_store_password`` = ``None``
- (String) Password for the user authenticating against Cinder. If <None>, the current context auth token is used.
- (String) Password for the user authenticating against cinder.$sentinal$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.$sentinal$Possible values: * A valid password for the user specified by ``cinder_store_user_name$sentinal$`` Related options: * cinder_store_auth_address * cinder_store_user_name * cinder_store_project_name
* - ``cinder_store_project_name`` = ``None``
- (String) Project name where the image is stored in Cinder. If <None>, the project in current context is used.
- (String) Project name where the image volume is stored in cinder.$sentinal$If this configuration option is not set, the project in current context is used.$sentinal$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.$sentinal$Possible values: * A valid project name$sentinal$Related options: * ``cinder_store_auth_address`` * ``cinder_store_user_name`` * ``cinder_store_password``
* - ``cinder_store_user_name`` = ``None``
- (String) User name to authenticate against Cinder. If <None>, the user of current context is used.
- (String) User name to authenticate against cinder.$sentinal$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.$sentinal$Possible values: * A valid user name$sentinal$Related options: * cinder_store_auth_address * cinder_store_password * cinder_store_project_name

50
doc/config-reference/source/tables/glance-common.rst
View File

@ -19,62 +19,60 @@
* - **[DEFAULT]**
-
* - ``allow_additional_image_properties`` = ``True``
- (Boolean) Whether to allow users to specify image properties beyond what the image schema provides
- (Boolean) Allow users to add additional/custom properties to images.$sentinal$Glance defines a standard set of properties (in its schema) that appear on every image. These properties are also known as ``base properties``. In addition to these properties, Glance allows users to add custom properties to images. These are known as ``additional properties``.$sentinal$By default, this configuration option is set to ``True`` and users are allowed to add additional properties. The number of additional properties that can be added to an image can be controlled via ``image_property_quota`` configuration option.$sentinal$Possible values: * True * False$sentinal$Related options: * image_property_quota
* - ``api_limit_max`` = ``1000``
- (Integer) Maximum permissible number of items that could be returned by a request
- (Integer) Maximum number of results that could be returned by a request.$sentinal$As described in the help text of ``limit_param_default``, some requests may return multiple results. The number of results to be returned are governed either by the ``limit`` parameter in the request or the ``limit_param_default`` configuration option. The value in either case, can't be greater than the absolute maximum defined by this configuration option. Anything greater than this value is trimmed down to the maximum value defined here.$sentinal$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.$sentinal$Possible values: * Any positive integer$sentinal$Related options: * limit_param_default
* - ``backlog`` = ``4096``
- (Integer) The backlog value that will be used when creating the TCP listener socket.
- (Integer) Set the number of incoming connection requests.$sentinal$Provide a positive integer value to limit the number of requests in the backlog queue. The default queue size is 4096.$sentinal$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.$sentinal$Possible values: * Positive integer$sentinal$Related options: * None
* - ``bind_host`` = ``0.0.0.0``
- (String) Address to bind the server. Useful when selecting a particular network interface.
- (String) IP address to bind the glance servers to.$sentinal$Provide an IP address to bind the glance server to. The default value is ``0.0.0.0``.$sentinal$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.$sentinal$Possible values: * A valid IPv4 address * A valid IPv6 address$sentinal$Related options: * None
* - ``bind_port`` = ``None``
- (Port number) The port on which the server will listen.
- (Port number) Port number on which the server will listen.$sentinal$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.$sentinal$Possible values: * A valid port number (0 to 65535)$sentinal$Related options: * None
* - ``data_api`` = ``glance.db.sqlalchemy.api``
- (String) Python module path of data access API
- (String) Python module path of data access API.$sentinal$Specifies the path to the API to use for accessing the data model. This option determines how the image catalog data will be accessed.$sentinal$Possible values: * glance.db.sqlalchemy.api * glance.db.registry.api * glance.db.simple.api$sentinal$If this option is set to ``glance.db.sqlalchemy.api`` then the image catalog data is stored in and read from the database via the SQLAlchemy Core and ORM APIs.$sentinal$Setting this option to ``glance.db.registry.api`` will force all database access requests to be routed through the Registry service. This avoids data access from the Glance API nodes for an added layer of security, scalability and manageability.$sentinal$NOTE: In v2 OpenStack Images API, the registry service is optional. In order to use the Registry API in v2, the option ``enable_v2_registry`` must be set to ``True``.$sentinal$Finally, when this configuration option is set to ``glance.db.simple.api``, image catalog data is stored in and read from an in-memory data structure. This is primarily used for testing.$sentinal$Related options: * enable_v2_api * enable_v2_registry
* - ``digest_algorithm`` = ``sha256``
- (String) Digest algorithm which will be used for digital signature. Use the command "openssl list-message-digest-algorithms" to get the available algorithms supported by the version of OpenSSL on the platform. Examples are "sha1", "sha256", "sha512", etc.
- (String) Digest algorithm to use for digital signature.$sentinal$Provide a string value representing the digest algorithm to use for generating digital signatures. By default, ``sha256`` is used.$sentinal$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'.$sentinal$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.$sentinal$Possible values: * An OpenSSL message digest algorithm identifier$sentinal$Relation options: * None
* - ``executor_thread_pool_size`` = ``64``
- (Integer) Size of executor thread pool.
* - ``image_location_quota`` = ``10``
- (Integer) Maximum number of locations allowed on an image. Negative values evaluate to unlimited.
- (Integer) Maximum number of locations allowed on an image.$sentinal$Any negative value is interpreted as unlimited.$sentinal$Related options: * None
* - ``image_member_quota`` = ``128``
- (Integer) Maximum number of image members per image. Negative values evaluate to unlimited.
- (Integer) Maximum number of image members per image.$sentinal$This limits the maximum of users an image can be shared with. Any negative value is interpreted as unlimited.$sentinal$Related options: * None
* - ``image_property_quota`` = ``128``
- (Integer) Maximum number of properties allowed on an image. Negative values evaluate to unlimited.
- (Integer) Maximum number of properties allowed on an image.$sentinal$This enforces an upper limit on the number of additional properties an image can have. Any negative value is interpreted as unlimited.$sentinal$NOTE: This won't have any impact if additional properties are disabled. Please refer to ``allow_additional_image_properties``.$sentinal$Related options: * ``allow_additional_image_properties``
* - ``image_tag_quota`` = ``128``
- (Integer) Maximum number of tags allowed on an image. Negative values evaluate to unlimited.
- (Integer) Maximum number of tags allowed on an image.$sentinal$Any negative value is interpreted as unlimited.$sentinal$Related options: * None
* - ``limit_param_default`` = ``25``
- (Integer) Default value for the number of items returned by a request if not specified explicitly in the request
* - ``memcached_servers`` = ``None``
- (List) Memcached servers or None for in process cache.
- (Integer) The default number of results to return for a request.$sentinal$Responses to certain API requests, like list images, may return multiple items. The number of results returned can be explicitly controlled by specifying the ``limit`` parameter in the API request. However, if a ``limit`` parameter is not specified, this configuration value will be used as the default number of results to be returned for any API request.$sentinal$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.$sentinal$Possible values: * Any positive integer$sentinal$Related options: * api_limit_max
* - ``metadata_encryption_key`` = ``None``
- (String) AES key for encrypting store 'location' metadata. This includes, if used, Swift or S3 credentials. Should be set to a random string of length 16, 24 or 32 bytes
- (String) AES key for encrypting store location metadata.$sentinal$Provide a string value representing the AES cipher to use for encrypting Glance store metadata.$sentinal$NOTE: The AES key to use must be set to a random string of length 16, 24 or 32 bytes.$sentinal$Possible values: * String value representing a valid AES key$sentinal$Related options: * None
* - ``metadata_source_path`` = ``/etc/glance/metadefs/``
- (String) Path to the directory where json metadata files are stored
- (String) Absolute path to the directory where JSON metadefs files are stored.$sentinal$Glance Metadata Definitions ("metadefs") are served from the database, but are stored in files in the JSON format. The files in this directory are used to initialize the metadefs in the database. Additionally, when metadefs are exported from the database, the files are written to this directory.$sentinal$NOTE: If you plan to export metadefs, make sure that this directory has write permissions set for the user being used to run the glance-api service.$sentinal$Possible values: * String value representing a valid absolute pathname$sentinal$Related options: * None
* - ``property_protection_file`` = ``None``
- (String) The location of the property protection file.This file contains the rules for property protections and the roles/policies associated with it. If this config value is not specified, by default, property protections won't be enforced. If a value is specified and the file is not found, then the glance-api service will not start.
- (String) The location of the property protection file.$sentinal$Provide a valid path to the property protection file which contains the rules for property protections and the roles/policies associated with them.$sentinal$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: http://docs.openstack.org/developer/glance/property-protections.html$sentinal$Possible values: * Empty string * Valid path to the property protection configuration file$sentinal$Related options: * property_protection_rule_format
* - ``property_protection_rule_format`` = ``roles``
- (String) This config value indicates whether "roles" or "policies" are used in the property protection file.
- (String) Rule format for property protection.$sentinal$Provide the desired way to set property protection on Glance image properties. The two permissible values are ``roles`` and ``policies``. The default value is ``roles``.$sentinal$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 to ``policies``, a policy defined in policy.json is used to express property protections for each of the CRUD operations. Examples of how property protections are enforced based on ``roles`` or ``policies`` can be found at: http://docs.openstack.org/developer/glance/property-protections.html#examples$sentinal$Possible values: * roles * policies$sentinal$Related options: * property_protection_file
* - ``show_image_direct_url`` = ``False``
- (Boolean) Whether to include the backend image storage location in image properties. Revealing storage location can be a security risk, so use this setting with caution!
- (Boolean) Show direct image location when returning an image.$sentinal$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``.$sentinal$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``.$sentinal$NOTES: * Revealing image locations can present a GRAVE SECURITY RISK as image locations can sometimes include credentials. Hence, this is set to ``False`` by default. Set this to ``True`` with EXTREME CAUTION and ONLY IF you know what you are doing! * If an operator wishes to avoid showing any image location(s) to the user, then both this option and ``show_multiple_locations`` MUST be set to ``False``.$sentinal$Possible values: * True * False$sentinal$Related options: * show_multiple_locations * location_strategy
* - ``user_storage_quota`` = ``0``
- (String) Set a system wide quota for every user. This value is the total capacity that a user can use across all storage systems. A value of 0 means unlimited.Optional unit can be specified for the value. Accepted units are B, KB, MB, GB and TB representing Bytes, KiloBytes, MegaBytes, GigaBytes and TeraBytes respectively. If no unit is specified then Bytes is assumed. Note that there should not be any space between value and unit and units are case sensitive.
- (String) Maximum amount of image storage per tenant.$sentinal$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.$sentinal$The default unit for this configuration option is Bytes. However, storage units can be specified using case-sensitive literals ``B``, ``KB``, ``MB``, ``GB`` and ``TB`` representing Bytes, KiloBytes, MegaBytes, GigaBytes and TeraBytes respectively. Note that there should not be any space between the value and unit. Value ``0`` signifies no quota enforcement. Negative values are invalid and result in errors.$sentinal$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.$sentinal$Related options: * None
* - ``workers`` = ``None``
- (Integer) The number of child process workers that will be created to service requests. The default will be equal to the number of CPUs available.
- (Integer) Number of Glance worker processes to start.$sentinal$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``.$sentinal$Each worker process is made to listen on the port set in the configuration file and contains a greenthread pool of size 1000.$sentinal$NOTE: Setting the number of workers to zero, triggers the creation of a single API process with a greenthread pool of size 1000.$sentinal$Possible values: * 0 * Positive integer value (typically equal to the number of CPUs)$sentinal$Related options: * None
* - **[glance_store]**
-
* - ``rootwrap_config`` = ``/etc/glance/rootwrap.conf``
- (String) Path to the rootwrap configuration file to use for running commands as root.
- (String) Path to the rootwrap configuration file to use for running commands as root.$sentinal$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.$sentinal$Possible values: * Path to the rootwrap config file$sentinal$Related options: * None
* - **[image_format]**
-
* - ``container_formats`` = ``ami, ari, aki, bare, ovf, ova, docker``
- (List) Supported values for the 'container_format' image attribute
* - ``disk_formats`` = ``ami, ari, aki, vhd, vmdk, raw, qcow2, vdi, iso``
* - ``disk_formats`` = ``ami, ari, aki, vhd, vhdx, vmdk, raw, qcow2, vdi, iso``
- (List) Supported values for the 'disk_format' image attribute
* - **[task]**
-
* - ``task_executor`` = ``taskflow``
- (String) Specifies which task executor to be used to run the task scripts.
- (String) Task executor to be used to run task scripts.$sentinal$Provide a string value representing the executor to use for task executions. By default, ``TaskFlow`` executor is used.$sentinal$``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.$sentinal$Possible values: * taskflow$sentinal$Related Options: * None
* - ``task_time_to_live`` = ``48``
- (Integer) Time in hours for which a task lives after, either succeeding or failing
* - ``work_dir`` = ``None``
- (String) Work dir for asynchronous task operations. The directory set here will be used to operate over images - normally before they are imported in the destination store. When providing work dir, make sure 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` - or the N of workers running - by 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.
* - ``work_dir`` = ``/work_dir``
- (String) Absolute path to the work directory to use for asynchronous task operations.$sentinal$The directory set here will be used to operate over images - normally before they are imported in the destination store.$sentinal$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.$sentinal$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.$sentinal$Possible values: * String value representing the absolute path to the working directory$sentinal$Related Options: * None

8
doc/config-reference/source/tables/glance-filesystem.rst
View File

@ -19,10 +19,10 @@
* - **[glance_store]**
-
* - ``filesystem_store_datadir`` = ``/var/lib/glance/images``
- (String) Directory to which the Filesystem backend store writes images.
- (String) Directory to which the filesystem backend store writes images.$sentinal$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.$sentinal$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.$sentinal$Possible values: * A valid path to a directory$sentinal$Related options: * ``filesystem_store_datadirs`` * ``filesystem_store_file_perm``
* - ``filesystem_store_datadirs`` = ``None``
- (Multi-valued) List of directories and its priorities to which the Filesystem backend store writes images.
- (Multi-valued) List of directories and their priorities to which the filesystem backend store writes images.$sentinal$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.$sentinal$More information on configuring filesystem store with multiple store directories can be found at http://docs.openstack.org/developer/glance/configuring.html$sentinal$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.$sentinal$Possible values: * List of strings of the following form: * ``<a valid directory path>:<optional integer priority>``$sentinal$Related options: * ``filesystem_store_datadir`` * ``filesystem_store_file_perm``
* - ``filesystem_store_file_perm`` = ``0``
- (Integer) The required permission for created image file. In this way the user other service used, e.g. Nova, who consumes the image could be the exclusive member of the group that owns the files created. Assigning it less then or equal to zero means don't change the default permission of the file. This value will be decoded as an octal digit.
- (Integer) File access permissions for the image files.$sentinal$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.$sentinal$For more information, please refer the documentation at http://docs.openstack.org/developer/glance/configuring.html$sentinal$Possible values: * A valid file access permission * Zero * Any negative integer$sentinal$Related options: * None
* - ``filesystem_store_metadata_file`` = ``None``
- (String) The path to a file which contains the metadata to be returned with any location associated with this 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 'string'.
- (String) Filesystem store metadata file.$sentinal$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.$sentinal$Possible values: * A valid path to the store metadata file$sentinal$Related options: * None

28
doc/config-reference/source/tables/glance-http.rst
View File

@ -10,7 +10,7 @@
.. _glance-http:
.. list-table:: Description of http configuration options
.. list-table:: Description of HTTP configuration options
:header-rows: 1
:class: config-ref-table
@ -19,28 +19,8 @@
* - **[glance_store]**
-
* - ``http_proxy_information`` = ``{}``
- (Dict) 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
- (Dict) The http/https proxy information to be used to connect to the remote server.$sentinal$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.$sentinal$Possible values: * A comma separated list of scheme:proxy pairs as described above$sentinal$Related options: * None
* - ``https_ca_certificates_file`` = ``None``
- (String) 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
- (String) Path to the CA bundle file.$sentinal$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.$sentinal$Possible values: * A valid path to a CA file$sentinal$Related options: * https_insecure
* - ``https_insecure`` = ``True``
- (Boolean) Set verification of the remote server certificate.
This configuration option takes in a boolean value to determine whether or not to verify the remote server certificate. If set to True, the remote server certificate is not verified. If the option is set to False, then the default CA truststore is used for verification.
This option is ignored if ``https_ca_certificates_file`` is set. The remote server certificate will then be verified using the file specified using the ``https_ca_certificates_file`` option.
Possible values: * True * False
Related options: * https_ca_certificates_file
- (Boolean) Set verification of the remote server certificate.$sentinal$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.$sentinal$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.$sentinal$Possible values: * True * False$sentinal$Related options: * https_ca_certificates_file

16
doc/config-reference/source/tables/glance-imagecache.rst
View File

@ -19,18 +19,18 @@
* - **[DEFAULT]**
-
* - ``delayed_delete`` = ``False``
- (Boolean) Turn on/off delayed delete.
- (Boolean) Turn on/off delayed delete.$sentinal$Typically when an image is deleted, the ``glance-api`` service puts the image into ``deleted`` 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 option ``scrub_time``). When delayed delete is turned on, the ``glance-api`` service puts the image into ``pending_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 into ``deleted`` state upon successful deletion of image data.$sentinal$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.$sentinal$Possible values: * True * False$sentinal$Related options: * ``scrub_time`` * ``wakeup_time`` * ``scrub_pool_size``
* - ``image_cache_dir`` = ``None``
- (String) Base directory that the image cache uses.
- (String) Base directory for image cache.$sentinal$This is the location where image data is cached and served out of. All cached images are stored directly under this directory. This directory also contains three subdirectories, namely, ``incomplete``, ``invalid`` and ``queue``.$sentinal$The ``incomplete`` subdirectory is the staging area for downloading images. An image is first downloaded to this directory. When the image download is successful it is moved to the base directory. However, if the download fails, the partially downloaded image file is moved to the ``invalid`` subdirectory.$sentinal$The ``queue``subdirectory is used for queuing images for download. This is used primarily by the cache-prefetcher, which can be scheduled as a periodic task like cache-pruner and cache-cleaner, to cache images ahead of their usage. Upon receiving the request to cache an image, Glance touches a file in the ``queue`` directory with the image id as the file name. The cache-prefetcher, when running, polls for the files in ``queue`` directory and starts downloading them in the order they were created. When the download is successful, the zero-sized file is deleted from the ``queue`` directory. If the download fails, the zero-sized file remains and it'll be retried the next time cache-prefetcher runs.$sentinal$Possible values: * A valid path$sentinal$Related options: * ``image_cache_sqlite_db``
* - ``image_cache_driver`` = ``sqlite``
- (String) The driver to use for image cache management.
- (String) The driver to use for image cache management.$sentinal$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.$sentinal$The essential functions of a driver are defined in the base class ``glance.image_cache.drivers.base.Driver``. All image-cache drivers (existing and prospective) must implement this interface. Currently available drivers are ``sqlite`` and ``xattr``. These drivers primarily differ in the way they store the information about cached images: * The ``sqlite`` driver uses a sqlite database (which sits on every glance node locally) to track the usage of cached images. * The ``xattr`` driver uses the extended attributes of files to store this information. It also requires a filesystem that sets ``atime`` on the files when accessed.$sentinal$Possible values: * sqlite * xattr$sentinal$Related options: * None
* - ``image_cache_max_size`` = ``10737418240``
- (Integer) The upper limit (the maximum size of accumulated cache in bytes) beyond which the cache pruner, if running, starts cleaning the image cache.
- (Integer) The upper limit on cache size, in bytes, after which the cache-pruner cleans up the image cache.$sentinal$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.$sentinal$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.$sentinal$Possible values: * Any non-negative integer$sentinal$Related options: * None
* - ``image_cache_sqlite_db`` = ``cache.db``
- (String) The path to the sqlite file database that will be used for image cache management.
- (String) The relative path to sqlite file database that will be used for image cache management.$sentinal$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``.$sentinal$This is a lightweight database with just one table.$sentinal$Possible values: * A valid relative path to sqlite file database$sentinal$Related options: * ``image_cache_dir``
* - ``image_cache_stall_time`` = ``86400``
- (Integer) The amount of time to let an incomplete image remain in the cache, before the cache cleaner, if running, will remove the incomplete image.
- (Integer) The amount of time, in seconds, an incomplete image remains in the cache.$sentinal$Incomplete images are images for which download is in progress. Please see the description of configuration option ``image_cache_dir`` for more detail. Sometimes, due to various reasons, it is possible the download may hang and the incompletely downloaded image remains in the ``incomplete`` directory. This configuration option sets a time limit on how long the incomplete images should remain in the ``incomplete`` directory before they are cleaned up. Once an incomplete image spends more time than is specified here, it'll be removed by cache-cleaner on its next run.$sentinal$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.$sentinal$Possible values: * Any non-negative integer$sentinal$Related options: * None
* - ``scrub_pool_size`` = ``1``
- (Integer) The size of thread pool to be used for scrubbing images. The default is one, which signifies serial scrubbing. Any value above one indicates the max number of images that may be scrubbed in parallel.
- (Integer) The size of thread pool to be used for scrubbing images.$sentinal$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.$sentinal$Possible values: * Any non-zero positive integer$sentinal$Related options: * ``delayed_delete``
* - ``scrub_time`` = ``0``
- (Integer) The amount of time in seconds to delay before performing a delete.
- (Integer) The amount of time, in seconds, to delay image scrubbing.$sentinal$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 into ``pending_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 in ``pending_delete`` state before it is available for scrubbing.$sentinal$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.$sentinal$Possible values: * Any non-negative integer$sentinal$Related options: * ``delayed_delete``

8
doc/config-reference/source/tables/glance-profiler.rst
View File

@ -18,9 +18,11 @@
- Description
* - **[profiler]**
-
* - ``connection_string`` = ``messaging://``
- (String) Connection string for a notifier backend. Default value is messaging:// which sets the notifier to oslo_messaging.$sentinal$Examples of possible values:$sentinal$* messaging://: use oslo_messaging driver for sending notifications.
* - ``enabled`` = ``False``
- (Boolean) If False fully disable profiling feature.
- (Boolean) Enables the profiling for all services on this node. Default value is False (fully disable the profiling feature).$sentinal$Possible values:$sentinal$* True: Enables the feature$sentinal$* 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.
* - ``hmac_keys`` = ``SECRET_KEY``
- (String) Secret key to use to sign Glance API and Glance Registry services tracing messages.
- (String) 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.$sentinal$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.
* - ``trace_sqlalchemy`` = ``False``
- (Boolean) If False doesn't trace SQL requests.
- (Boolean) Enables SQL requests profiling in services. Default value is False (SQL requests won't be traced).$sentinal$Possible values:$sentinal$* 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.$sentinal$* 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.

108
doc/config-reference/source/tables/glance-rabbitmq.rst
View File

@ -1,108 +0,0 @@
..
Warning: Do not edit this file. It is automatically generated from the
software project's code and your changes will be overwritten.
The tool to generate this file lives in openstack-doc-tools repository.
Please make any changes needed in the code, then run the
autogenerate-config-doc tool from the openstack-doc-tools repository, or
ask for help on the documentation mailing list, IRC channel or meeting.
.. _glance-rabbitmq:
.. list-table:: Description of RabbitMQ configuration options
:header-rows: 1
:class: config-ref-table
* - Configuration option = Default value
- Description
* - **[oslo_messaging_rabbit]**
-
* - ``amqp_auto_delete`` = ``False``
- (Boolean) Auto-delete queues in AMQP.
* - ``amqp_durable_queues`` = ``False``
- (Boolean) Use durable queues in AMQP.
* - ``channel_max`` = ``None``
- (Integer) Maximum number of channels to allow
* - ``default_notification_exchange`` = ``${control_exchange}_notification``
- (String) Exchange name for for sending notifications
* - ``default_notification_retry_attempts`` = ``-1``
- (Integer) Reconnecting retry count in case of connectivity problem during sending notification, -1 means infinite retry.
* - ``default_rpc_exchange`` = ``${control_exchange}_rpc``
- (String) Exchange name for sending RPC messages
* - ``default_rpc_retry_attempts`` = ``-1``
- (Integer) Reconnecting retry count in case of connectivity problem during sending RPC message, -1 means infinite retry. If actual retry attempts in not 0 the rpc request could be processed more then one time
* - ``fake_rabbit`` = ``False``
- (Boolean) Deprecated, use rpc_backend=kombu+memory or rpc_backend=fake
* - ``frame_max`` = ``None``
- (Integer) The maximum byte size for an AMQP frame
* - ``heartbeat_interval`` = ``1``
- (Integer) How often to send heartbeats for consumer's connections
* - ``heartbeat_rate`` = ``2``
- (Integer) How often times during the heartbeat_timeout_threshold we check the heartbeat.
* - ``heartbeat_timeout_threshold`` = ``60``
- (Integer) Number of seconds after which the Rabbit broker is considered down if heartbeat's keep-alive fails (0 disable the heartbeat). EXPERIMENTAL
* - ``host_connection_reconnect_delay`` = ``0.25``
- (Floating point) Set delay for reconnection to some host which has connection error
* - ``kombu_compression`` = ``None``
- (String) EXPERIMENTAL: Possible values are: gzip, bz2. If not set compression will not be used. This option may notbe available in future versions.
* - ``kombu_failover_strategy`` = ``round-robin``
- (String) 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.
* - ``kombu_missing_consumer_retry_timeout`` = ``60``
- (Integer) How long to wait a missing client before abandoning to send it its replies. This value should not be longer than rpc_response_timeout.
* - ``kombu_reconnect_delay`` = ``1.0``
- (Floating point) How long to wait before reconnecting in response to an AMQP consumer cancel notification.
* - ``kombu_ssl_ca_certs`` =
- (String) SSL certification authority file (valid only if SSL enabled).
* - ``kombu_ssl_certfile`` =
- (String) SSL cert file (valid only if SSL enabled).
* - ``kombu_ssl_keyfile`` =
- (String) SSL key file (valid only if SSL enabled).
* - ``kombu_ssl_version`` =
- (String) 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.
* - ``notification_listener_prefetch_count`` = ``100``
- (Integer) Max number of not acknowledged message which RabbitMQ can send to notification listener.
* - ``notification_persistence`` = ``False``
- (Boolean) Persist notification messages.
* - ``notification_retry_delay`` = ``0.25``
- (Floating point) Reconnecting retry delay in case of connectivity problem during sending notification message
* - ``pool_max_overflow`` = ``0``
- (Integer) Maximum number of connections to create above `pool_max_size`.
* - ``pool_max_size`` = ``10``
- (Integer) Maximum number of connections to keep queued.
* - ``pool_recycle`` = ``600``
- (Integer) Lifetime of a connection (since creation) in seconds or None for no recycling. Expired connections are closed on acquire.
* - ``pool_stale`` = ``60``
- (Integer) Threshold at which inactive (since release) connections are considered stale in seconds or None for no staleness. Stale connections are closed on acquire.
* - ``pool_timeout`` = ``30``
- (Integer) Default number of seconds to wait for a connections to available
* - ``rabbit_ha_queues`` = ``False``
- (Boolean) 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"}' "
* - ``rabbit_host`` = ``localhost``
- (String) The RabbitMQ broker address where a single node is used.
* - ``rabbit_hosts`` = ``$rabbit_host:$rabbit_port``
- (List) RabbitMQ HA cluster host:port pairs.
* - ``rabbit_interval_max`` = ``30``
- (Integer) Maximum interval of RabbitMQ connection retries. Default is 30 seconds.
* - ``rabbit_login_method`` = ``AMQPLAIN``
- (String) The RabbitMQ login method.
* - ``rabbit_max_retries`` = ``0``
- (Integer) Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry count).
* - ``rabbit_password`` = ``guest``
- (String) The RabbitMQ password.
* - ``rabbit_port`` = ``5672``
- (Port number) The RabbitMQ broker port where a single node is used.
* - ``rabbit_qos_prefetch_count`` = ``0``
- (Integer) Specifies the number of messages to prefetch. Setting to zero allows unlimited messages.
* - ``rabbit_retry_backoff`` = ``2``
- (Integer) How long to backoff for between retries when connecting to RabbitMQ.
* - ``rabbit_retry_interval`` = ``1``
- (Integer) How frequently to retry connecting with RabbitMQ.
* - ``rabbit_transient_queues_ttl`` = ``1800``
- (Integer) 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_use_ssl`` = ``False``
- (Boolean) Connect over SSL for RabbitMQ.
* - ``rabbit_userid`` = ``guest``
- (String) The RabbitMQ userid.
* - ``rabbit_virtual_host`` = ``/``
- (String) The RabbitMQ virtual host.

10
doc/config-reference/source/tables/glance-rbd.rst
View File

@ -19,12 +19,12 @@
* - **[glance_store]**
-
* - ``rados_connect_timeout`` = ``0``
- (Integer) Timeout value (in seconds) used when connecting to ceph cluster. If value <= 0, no timeout is set and default librados value is used.
- (Integer) Timeout value for connecting to Ceph cluster.$sentinal$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.$sentinal$Possible Values: * Any integer value$sentinal$Related options: * None
* - ``rbd_store_ceph_conf`` = ``/etc/ceph/ceph.conf``
- (String) Ceph configuration file path. If <None>, librados will locate the default config. If using cephx authentication, this file should include a reference to the right keyring in a client.<USER> section
- (String) Ceph configuration file path.$sentinal$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$sentinal$Possible Values: * A valid path to a configuration file$sentinal$Related options: * rbd_store_user
* - ``rbd_store_chunk_size`` = ``8``
- (Integer) RADOS images will be chunked into objects of this size (in megabytes). For best performance, this should be a power of two.
- (Integer) Size, in megabytes, to chunk RADOS images into.$sentinal$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.$sentinal$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.$sentinal$Possible Values: * Any positive integer value$sentinal$Related options: * None
* - ``rbd_store_pool`` = ``images``
- (String) RADOS pool in which images are stored.
- (String) RADOS pool in which images are stored.$sentinal$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'.$sentinal$More information on the RBD storage backend can be found here: http://ceph.com/planet/how-data-is-stored-in-ceph-cluster/$sentinal$Possible Values: * A valid pool name$sentinal$Related options: * None
* - ``rbd_store_user`` = ``None``
- (String) RADOS user to authenticate as (only applicable if using Cephx. If <None>, a default will be chosen based on the client. section in rbd_store_ceph_conf)
- (String) RADOS user to authenticate as.$sentinal$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.$sentinal$Possible Values: * A valid RADOS user$sentinal$Related options: * rbd_store_ceph_conf

72
doc/config-reference/source/tables/glance-registry.rst
View File

@ -31,74 +31,18 @@
* - ``auth_url`` = ``None``
- (String) DEPRECATED: The URL to the keystone service. If "use_user_token" is not in effect and using keystone auth, then URL of keystone can be specified. This option was considered harmful and has been deprecated in M release. It will be removed in O release. For more information read OSSN-0060. Related functionality with uploading big images has been implemented with Keystone trusts support.
* - ``registry_client_ca_file`` = ``/etc/ssl/cafile/file.ca``
- (String) Absolute path to the Certificate Authority file.
Provide a string value representing a valid absolute path to the certificate authority file to use for establishing a secure connection to the registry server.
NOTE: This option must be set if ``registry_client_protocol`` is set to ``https``. Alternatively, the GLANCE_CLIENT_CA_FILE environment variable may be set to a filepath of the CA file. This option is ignored if the ``registry_client_insecure`` option is set to ``True``.
Possible values: * String value representing a valid absolute path to the CA file.
Related options: * registry_client_protocol * registry_client_insecure
- (String) Absolute path to the Certificate Authority file.$sentinal$Provide a string value representing a valid absolute path to the certificate authority file to use for establishing a secure connection to the registry server.$sentinal$NOTE: This option must be set if ``registry_client_protocol`` is set to ``https``. Alternatively, the GLANCE_CLIENT_CA_FILE environment variable may be set to a filepath of the CA file. This option is ignored if the ``registry_client_insecure`` option is set to ``True``.$sentinal$Possible values: * String value representing a valid absolute path to the CA file.$sentinal$Related options: * registry_client_protocol * registry_client_insecure
* - ``registry_client_cert_file`` = ``/etc/ssl/certs/file.crt``
- (String) Absolute path to the certificate file.
Provide a string value representing a valid absolute path to the certificate file to use for establishing a secure connection to the registry server.
NOTE: This option must be set if ``registry_client_protocol`` is set to ``https``. Alternatively, the GLANCE_CLIENT_CERT_FILE environment variable may be set to a filepath of the certificate file.
Possible values: * String value representing a valid absolute path to the certificate file.
Related options: * registry_client_protocol
- (String) Absolute path to the certificate file.$sentinal$Provide a string value representing a valid absolute path to the certificate file to use for establishing a secure connection to the registry server.$sentinal$NOTE: This option must be set if ``registry_client_protocol`` is set to ``https``. Alternatively, the GLANCE_CLIENT_CERT_FILE environment variable may be set to a filepath of the certificate file.$sentinal$Possible values: * String value representing a valid absolute path to the certificate file.$sentinal$Related options: * registry_client_protocol
* - ``registry_client_insecure`` = ``False``
- (Boolean) Set verification of the registry server certificate.
Provide a boolean value to determine whether or not to validate SSL connections to the registry server. By default, this option is set to ``False`` and the SSL connections are validated.
If set to ``True``, the connection to the registry server is not validated via a certifying authority and the ``registry_client_ca_file`` option is ignored. This is the registry's equivalent of specifying --insecure on the command line using glanceclient for the API.
Possible values: * True * False
Related options: * registry_client_protocol * registry_client_ca_file
- (Boolean) Set verification of the registry server certificate.$sentinal$Provide a boolean value to determine whether or not to validate SSL connections to the registry server. By default, this option is set to ``False`` and the SSL connections are validated.$sentinal$If set to ``True``, the connection to the registry server is not validated via a certifying authority and the ``registry_client_ca_file`` option is ignored. This is the registry's equivalent of specifying --insecure on the command line using glanceclient for the API.$sentinal$Possible values: * True * False$sentinal$Related options: * registry_client_protocol * registry_client_ca_file
* - ``registry_client_key_file`` = ``/etc/ssl/key/key-file.pem``
- (String) Absolute path to the private key file.
Provide a string value representing a valid absolute path to the private key file to use for establishing a secure connection to the registry server.
NOTE: This option must be set if ``registry_client_protocol`` is set to ``https``. Alternatively, the GLANCE_CLIENT_KEY_FILE environment variable may be set to a filepath of the key file.
Possible values: * String value representing a valid absolute path to the key file.
Related options: * registry_client_protocol
- (String) Absolute path to the private key file.$sentinal$Provide a string value representing a valid absolute path to the private key file to use for establishing a secure connection to the registry server.$sentinal$NOTE: This option must be set if ``registry_client_protocol`` is set to ``https``. Alternatively, the GLANCE_CLIENT_KEY_FILE environment variable may be set to a filepath of the key file.$sentinal$Possible values: * String value representing a valid absolute path to the key file.$sentinal$Related options: * registry_client_protocol
* - ``registry_client_protocol`` = ``http``
- (String) Protocol to use for communication with the registry server.
Provide a string value representing the protocol to use for communication with the registry server. By default, this option is set to ``http`` and the connection is not secure.
This option can be set to ``https`` to establish a secure connection to the registry server. In this case, provide a key to use for the SSL connection using the ``registry_client_key_file`` option. Also include the CA file and cert file using the options ``registry_client_ca_file`` and ``registry_client_cert_file`` respectively.
Possible values: * http * https
Related options: * registry_client_key_file * registry_client_cert_file * registry_client_ca_file
- (String) Protocol to use for communication with the registry server.$sentinal$Provide a string value representing the protocol to use for communication with the registry server. By default, this option is set to ``http`` and the connection is not secure.$sentinal$This option can be set to ``https`` to establish a secure connection to the registry server. In this case, provide a key to use for the SSL connection using the ``registry_client_key_file`` option. Also include the CA file and cert file using the options ``registry_client_ca_file`` and ``registry_client_cert_file`` respectively.$sentinal$Possible values: * http * https$sentinal$Related options: * registry_client_key_file * registry_client_cert_file * registry_client_ca_file
* - ``registry_client_timeout`` = ``600``
- (Integer) Timeout value for registry requests.
Provide an integer value representing the period of time in seconds that the API server will wait for a registry request to complete. The default value is 600 seconds.
A value of 0 implies that a request will never timeout.
Possible values: * Zero * Positive integer
Related options: * None
- (Integer) Timeout value for registry requests.$sentinal$Provide an integer value representing the period of time in seconds that the API server will wait for a registry request to complete. The default value is 600 seconds.$sentinal$A value of 0 implies that a request will never timeout.$sentinal$Possible values: * Zero * Positive integer$sentinal$Related options: * None
* - ``registry_host`` = ``0.0.0.0``
- (String) Address the registry server is hosted on.
Possible values: * A valid IP or hostname
Related options: * None
- (String) Address the registry server is hosted on.$sentinal$Possible values: * A valid IP or hostname$sentinal$Related options: * None
* - ``registry_port`` = ``9191``
- (Port number) Port the registry server is listening on.
Possible values: * A valid port number
Related options: * None
- (Port number) Port the registry server is listening on.$sentinal$Possible values: * A valid port number$sentinal$Related options: * None

140
doc/config-reference/source/tables/glance-rpc.rst
View File

@ -1,140 +0,0 @@
..
Warning: Do not edit this file. It is automatically generated from the
software project's code and your changes will be overwritten.
The tool to generate this file lives in openstack-doc-tools repository.
Please make any changes needed in the code, then run the
autogenerate-config-doc tool from the openstack-doc-tools repository, or
ask for help on the documentation mailing list, IRC channel or meeting.
.. _glance-rpc:
.. list-table:: Description of RPC configuration options
:header-rows: 1
:class: config-ref-table
* - Configuration option = Default value
- Description
* - **[DEFAULT]**
-
* - ``allowed_rpc_exception_modules`` = ``glance.common.exception, builtins, exceptions``
- (List) List of allowed exception modules to handle RPC exceptions.
Provide a comma separated list of modules whose exceptions are permitted to be recreated upon receiving exception data via an RPC call made to Glance. The default list includes ``glance.common.exception``, ``builtins``, and ``exceptions``.
The RPC protocol permits interaction with Glance via calls across a network or within the same system. Including a list of exception namespaces with this option enables RPC to propagate the exceptions back to the users.
Possible values: * A comma separated list of valid exception modules
Related options: * None
* - ``rpc_backend`` = ``rabbit``
- (String) DEPRECATED: The messaging driver to use, defaults to rabbit. Other drivers include amqp and zmq. Replaced by [DEFAULT]/transport_url
* - ``rpc_cast_timeout`` = ``-1``
- (Integer) Seconds to wait before a cast expires (TTL). The default value of -1 specifies an infinite linger period. The value of 0 specifies no linger period. Pending messages shall be discarded immediately when the socket is closed. Only supported by impl_zmq.
* - ``rpc_conn_pool_size`` = ``30``
- (Integer) Size of RPC connection pool.
* - ``rpc_poll_timeout`` = ``1``
- (Integer) The default number of seconds that poll should wait. Poll raises timeout exception when timeout expired.
* - ``rpc_response_timeout`` = ``60``
- (Integer) Seconds to wait for a response from a call.
* - **[oslo_concurrency]**
-
* - ``disable_process_locking`` = ``False``
- (Boolean) Enables or disables inter-process locks.
* - ``lock_path`` = ``None``
- (String) 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.
* - **[oslo_messaging_amqp]**
-
* - ``addressing_mode`` = ``dynamic``
- (String) 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
* - ``allow_insecure_clients`` = ``False``
- (Boolean) Accept clients using either SSL or plain TCP
* - ``anycast_address`` = ``anycast``
- (String) 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.
* - ``broadcast_prefix`` = ``broadcast``
- (String) address prefix used when broadcasting to all servers
* - ``connection_retry_backoff`` = ``2``
- (Integer) Increase the connection_retry_interval by this many seconds after each unsuccessful failover attempt.
* - ``connection_retry_interval`` = ``1``
- (Integer) Seconds to pause before attempting to re-connect.
* - ``connection_retry_interval_max`` = ``30``
- (Integer) Maximum limit for connection_retry_interval + connection_retry_backoff
* - ``container_name`` = ``None``
- (String) Name for the AMQP container. must be globally unique. Defaults to a generated UUID
* - ``default_notification_exchange`` = ``None``
- (String) 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_notify_timeout`` = ``30``
- (Integer) The deadline for a sent notification message delivery. Only used when caller does not provide a timeout expiry.
* - ``default_reply_timeout`` = ``30``
- (Integer) The deadline for an rpc reply message delivery. Only used when caller does not provide a timeout expiry.
* - ``default_rpc_exchange`` = ``None``
- (String) 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'
* - ``default_send_timeout`` = ``30``
- (Integer) The deadline for an rpc cast or call message delivery. Only used when caller does not provide a timeout expiry.
* - ``group_request_prefix`` = ``unicast``
- (String) address prefix when sending to any server in group
* - ``idle_timeout`` = ``0``
- (Integer) Timeout for inactive connections (in seconds)
* - ``link_retry_delay`` = ``10``
- (Integer) Time to pause between re-connecting an AMQP 1.0 link that failed due to a recoverable error.
* - ``multicast_address`` = ``multicast``
- (String) Appended to the address prefix when sending a fanout message. Used by the message bus to identify fanout messages.
* - ``notify_address_prefix`` = ``openstack.org/om/notify``
- (String) Address prefix for all generated Notification addresses
* - ``notify_server_credit`` = ``100``
- (Integer) Window size for incoming Notification messages
* - ``password`` =
- (String) Password for message broker authentication
* - ``reply_link_credit`` = ``200``
- (Integer) Window size for incoming RPC Reply messages.
* - ``rpc_address_prefix`` = ``openstack.org/om/rpc``
- (String) Address prefix for all generated RPC addresses
* - ``rpc_server_credit`` = ``100``
- (Integer) Window size for incoming RPC Request messages
* - ``sasl_config_dir`` =
- (String) Path to directory that contains the SASL configuration
* - ``sasl_config_name`` =
- (String) Name of configuration file (without .conf suffix)
* - ``sasl_mechanisms`` =
- (String) Space separated list of acceptable SASL mechanisms
* - ``server_request_prefix`` = ``exclusive``
- (String) address prefix used when sending to a specific server
* - ``ssl_ca_file`` =
- (String) CA certificate PEM file to verify server certificate
* - ``ssl_cert_file`` =
- (String) Identifying certificate PEM file to present to clients
* - ``ssl_key_file`` =
- (String) Private key PEM file used to sign cert_file certificate
* - ``ssl_key_password`` = ``None``
- (String) Password for decrypting ssl_key_file (if encrypted)
* - ``trace`` = ``False``
- (Boolean) Debug: dump AMQP frames to stdout
* - ``unicast_address`` = ``unicast``
- (String) 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.
* - ``username`` =
- (String) User name for message broker authentication
* - **[oslo_messaging_rabbit]**
-
* - ``rpc_listener_prefetch_count`` = ``100``
- (Integer) Max number of not acknowledged message which RabbitMQ can send to rpc listener.
* - ``rpc_queue_expiration`` = ``60``
- (Integer) Time to live for rpc queues without consumers in seconds.
* - ``rpc_reply_exchange`` = ``${control_exchange}_rpc_reply``
- (String) Exchange name for receiving RPC replies
* - ``rpc_reply_listener_prefetch_count`` = ``100``
- (Integer) Max number of not acknowledged message which RabbitMQ can send to rpc reply listener.
* - ``rpc_reply_retry_attempts`` = ``-1``
- (Integer) Reconnecting retry count in case of connectivity problem during sending reply. -1 means infinite retry during rpc_timeout
* - ``rpc_reply_retry_delay`` = ``0.25``
- (Floating point) Reconnecting retry delay in case of connectivity problem during sending reply.
* - ``rpc_retry_delay`` = ``0.25``
- (Floating point) Reconnecting retry delay in case of connectivity problem during sending RPC message
* - ``socket_timeout`` = ``0.25``
- (Floating point) Set socket timeout in seconds for connection's socket
* - ``ssl`` = ``None``
- (Boolean) Enable SSL
* - ``ssl_options`` = ``None``
- (Dict) Arguments passed to ssl.wrap_socket
* - ``tcp_user_timeout`` = ``0.25``
- (Floating point) Set TCP_USER_TIMEOUT in seconds for connection's socket

50
doc/config-reference/source/tables/glance-s3.rst
View File

@ -1,50 +0,0 @@
..
Warning: Do not edit this file. It is automatically generated from the
software project's code and your changes will be overwritten.
The tool to generate this file lives in openstack-doc-tools repository.
Please make any changes needed in the code, then run the
autogenerate-config-doc tool from the openstack-doc-tools repository, or
ask for help on the documentation mailing list, IRC channel or meeting.
.. _glance-s3:
.. list-table:: Description of S3 configuration options
:header-rows: 1
:class: config-ref-table
* - Configuration option = Default value
- Description
* - **[glance_store]**
-
* - ``s3_store_access_key`` = ``None``
- (String) The S3 query token access key.
* - ``s3_store_bucket`` = ``None``
- (String) The S3 bucket to be used to store the Glance data.
* - ``s3_store_bucket_url_format`` = ``subdomain``
- (String) The S3 calling format used to determine the bucket. Either subdomain or path can be used.
* - ``s3_store_create_bucket_on_put`` = ``False``
- (Boolean) A boolean to determine if the S3 bucket should be created on upload if it does not exist or if an error should be returned to the user.
* - ``s3_store_enable_proxy`` = ``False``
- (Boolean) Enable the use of a proxy.
* - ``s3_store_host`` = ``None``
- (String) The host where the S3 server is listening.
* - ``s3_store_large_object_chunk_size`` = ``10``
- (Integer) What multipart upload part size, in MB, should S3 use when uploading parts. The size must be greater than or equal to 5M.
* - ``s3_store_large_object_size`` = ``100``
- (Integer) What size, in MB, should S3 start chunking image files and do a multipart upload in S3.
* - ``s3_store_object_buffer_dir`` = ``None``
- (String) The local directory where uploads will be staged before they are transferred into S3.
* - ``s3_store_proxy_host`` = ``None``
- (String) Address or hostname for the proxy server.
* - ``s3_store_proxy_password`` = ``None``
- (String) The password to use when connecting over a proxy.
* - ``s3_store_proxy_port`` = ``8080``
- (Integer) The port to use when connecting over a proxy.
* - ``s3_store_proxy_user`` = ``None``
- (String) The username to connect to the proxy.
* - ``s3_store_secret_key`` = ``None``
- (String) The S3 query token secret key.
* - ``s3_store_thread_pools`` = ``10``
- (Integer) The number of thread pools to perform a multipart upload in S3.

2
doc/config-reference/source/tables/glance-scrubber.rst
View File

@ -19,4 +19,4 @@
* - **[DEFAULT]**
-
* - ``wakeup_time`` = ``300``
- (Integer) Loop time between checking for new items to schedule for delete.
- (Integer) Time interval, in seconds, between scrubber runs in daemon mode.$sentinal$Scrubber can be run either as a cron job or daemon. When run as a daemon, this configuration time specifies the time period between two runs. When the scrubber wakes up, it fetches and scrubs all ``pending_delete`` images that are available for scrubbing after taking ``scrub_time`` into consideration.$sentinal$If the wakeup time is set to a large number, there may be a large number of images to be scrubbed for each run. Also, this impacts how quickly the backend storage is reclaimed.$sentinal$Possible values: * Any non-negative integer$sentinal$Related options: * ``daemon`` * ``delayed_delete``

32
doc/config-reference/source/tables/glance-sheepdog.rst
View File

@ -19,34 +19,8 @@
* - **[glance_store]**
-
* - ``sheepdog_store_address`` = ``127.0.0.1``
- (String) Address to bind the Sheepdog daemon to.
Provide a string value representing the address to bind the Sheepdog daemon to. The default address set for the 'sheep' is 127.0.0.1.
The Sheepdog daemon, also called 'sheep', manages the storage in the distributed cluster by writing objects across the storage network. It identifies and acts on the messages directed to the address set using ``sheepdog_store_address`` option to store chunks of Glance images.
Possible values: * A valid IPv4 address * A valid IPv6 address * A valid hostname
Related Options: * sheepdog_store_port
- (String) Address to bind the Sheepdog daemon to.$sentinal$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.$sentinal$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.$sentinal$Possible values: * A valid IPv4 address * A valid IPv6 address * A valid hostname$sentinal$Related Options: * sheepdog_store_port
* - ``sheepdog_store_chunk_size`` = ``64``
- (Integer) Chunk size for images to be stored in Sheepdog data store.
Provide an integer value representing the size in mebibyte (1048576 bytes) to chunk Glance images into. The default chunk size is 64 mebibytes.
When using Sheepdog distributed storage system, the images are chunked into objects of this size and then stored across the distributed data store to use for Glance.
Chunk sizes, if a power of two, help avoid fragmentation and enable improved performance.
Possible values: * Positive integer value representing size in mebibytes.
Related Options: * None
- (Integer) Chunk size for images to be stored in Sheepdog data store.$sentinal$Provide an integer value representing the size in mebibyte (1048576 bytes) to chunk Glance images into. The default chunk size is 64 mebibytes.$sentinal$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.$sentinal$Chunk sizes, if a power of two, help avoid fragmentation and enable improved performance.$sentinal$Possible values: * Positive integer value representing size in mebibytes.$sentinal$Related Options: * None
* - ``sheepdog_store_port`` = ``7000``
- (Port number) Port number on which the sheep daemon will listen.
Provide an integer value representing a valid port number on which you want the Sheepdog daemon to listen on. The default port is 7000.
The Sheepdog daemon, also called 'sheep', manages the storage in the distributed cluster by writing objects across the storage network. It identifies and acts on the messages it receives on the port number set using ``sheepdog_store_port`` option to store chunks of Glance images.
Possible values: * A valid port number (0 to 65535)
Related Options: * sheepdog_store_address
- (Port number) Port number on which the sheep daemon will listen.$sentinal$Provide an integer value representing a valid port number on which you want the Sheepdog daemon to listen on. The default port is 7000.$sentinal$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.$sentinal$Possible values: * A valid port number (0 to 65535)$sentinal$Related Options: * sheepdog_store_address

62
doc/config-reference/source/tables/glance-swift.rst
View File

@ -19,60 +19,60 @@
* - **[DEFAULT]**
-
* - ``default_swift_reference`` = ``ref1``
- (String) The reference to the default swift account/backing store parameters to use for adding new images.
- (String) Reference to default Swift account/backing store parameters.$sentinal$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.$sentinal$Possible values: * A valid string value$sentinal$Related options: * None
* - ``swift_store_auth_address`` = ``None``
- (String) The address where the Swift authentication service is listening.(deprecated)
- (String) The address where the Swift authentication service is listening.
* - ``swift_store_config_file`` = ``None``
- (String) The config file that has the swift account(s)configs.
- (String) File containing the swift account(s) configurations.$sentinal$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 diabled. Configuring this option is highly recommended while using Swift storage backend for image storage as it helps avoid storage of credentials in the database.$sentinal$Possible values: * None * String value representing a vaid configuration file path$sentinal$Related options: * None
* - ``swift_store_key`` = ``None``
- (String) Auth key for the user authenticating against the Swift authentication service. (deprecated)
- (String) Auth key for the user authenticating against the Swift authentication service.
* - ``swift_store_user`` = ``None``
- (String) The user to authenticate against the Swift authentication service (deprecated)
- (String) The user to authenticate against the Swift authentication service.
* - **[glance_store]**
-
* - ``default_swift_reference`` = ``ref1``
- (String) The reference to the default swift account/backing store parameters to use for adding new images.
- (String) Reference to default Swift account/backing store parameters.$sentinal$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.$sentinal$Possible values: * A valid string value$sentinal$Related options: * None
* - ``swift_store_admin_tenants`` =
- (List) A list of tenants that will be granted read/write access on all Swift containers created by Glance in multi-tenant mode.
- (List) List of tenants that will be granted admin access.$sentinal$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.$sentinal$Possible values: * A comma separated list of strings representing UUIDs of Keystone projects/tenants$sentinal$Related options: * None
* - ``swift_store_auth_address`` = ``None``
- (String) The address where the Swift authentication service is listening. (deprecated - use "auth_address" in swift_store_config_file)
- (String) DEPRECATED: The address where the Swift authentication service is listening. The option 'auth_address' in the Swift back-end configuration file is used instead.
* - ``swift_store_auth_insecure`` = ``False``
- (Boolean) If True, swiftclient won't check for a valid SSL certificate when authenticating.
- (Boolean) Set verification of the server certificate.$sentinal$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.$sentinal$Possible values: * True * False$sentinal$Related options: * swift_store_cacert
* - ``swift_store_auth_version`` = ``2``
- (String) Version of the authentication service to use. Valid versions are 2 and 3 for keystone and 1 (deprecated) for swauth and rackspace. (deprecated - use "auth_version" in swift_store_config_file)
* - ``swift_store_cacert`` = ``None``
- (String) A string giving the CA certificate file to use in SSL connections for verifying certs.
- (String) DEPRECATED: Version of the authentication service to use. Valid versions are 2 and 3 for keystone and 1 (deprecated) for swauth and rackspace. The option 'auth_version' in the Swift back-end configuration file is used instead.
* - ``swift_store_cacert`` = ``/etc/ssl/certs/ca-certificates.crt``
- (String) Path to the CA bundle file.$sentinal$This configuration option enables the operator to specify the path to a custom Certificate Authority file for SSL verification when connecting to Swift.$sentinal$Possible values: * A valid path to a CA file$sentinal$Related options: * swift_store_auth_insecure
* - ``swift_store_config_file`` = ``None``
- (String) The config file that has the swift account(s)configs.
- (String) Absolute path to the file containing the swift account(s) configurations.$sentinal$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.$sentinal$Possible values: * String value representing an absolute path on the glance-api node$sentinal$Related options: * None
* - ``swift_store_container`` = ``glance``
- (String) Container within the account that the account should use for storing images in Swift when using single container mode. In multiple container mode, this will be the prefix for all containers.
- (String) Name of single container to store images/name prefix for multiple containers$sentinal$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``.$sentinal$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``).$sentinal$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.``$sentinal$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.$sentinal$Related options: * ``swift_store_multiple_containers_seed`` * ``swift_store_multi_tenant`` * ``swift_store_create_container_on_put``
* - ``swift_store_create_container_on_put`` = ``False``
- (Boolean) A boolean value that determines if we create the container if it does not exist.
* - ``swift_store_endpoint`` = ``None``
- (String) If set, the configured endpoint will be used. If None, the storage url from the auth response will be used.
- (Boolean) Create container, if it doesn't already exist, when uploading image.$sentinal$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.$sentinal$Possible values: * True * False$sentinal$Related options: * None
* - ``swift_store_endpoint`` = ``https://swift.openstack.example.org/v1/path_not_including_container_name``
- (String) The URL endpoint to use for Swift backend storage.$sentinal$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.$sentinal$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.$sentinal$Possible values: * String value representing a valid URL path up to a Swift container$sentinal$Related Options: * None
* - ``swift_store_endpoint_type`` = ``publicURL``
- (String) A string giving the endpoint type of the swift service to use (publicURL, adminURL or internalURL). This setting is only used if swift_store_auth_version is 2.
- (String) Endpoint Type of Swift service.$sentinal$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.$sentinal$Possible values: * publicURL * adminURL * internalURL$sentinal$Related options: * swift_store_endpoint
* - ``swift_store_expire_soon_interval`` = ``60``
- (Integer) The period of time (in seconds) before token expirationwhen glance_store will try to reques new user token. Default value 60 sec means that if token is going to expire in 1 min then glance_store request new user token.
- (Integer) 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.$sentinal$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.$sentinal$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.$sentinal$Possible values: * Zero * Positive integer value$sentinal$Related Options: * None
* - ``swift_store_key`` = ``None``
- (String) Auth key for the user authenticating against the Swift authentication service. (deprecated - use "key" in swift_store_config_file)
- (String) DEPRECATED: Auth key for the user authenticating against the Swift authentication service. The option 'key' in the Swift back-end configuration file is used to set the authentication key instead.
* - ``swift_store_large_object_chunk_size`` = ``200``
- (Integer) The amount of data written to a temporary disk buffer during the process of chunking the image file.
- (Integer) The maximum size, in MB, of the segments when image data is segmented.$sentinal$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.$sentinal$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.$sentinal$Possible values: * A positive integer that is less than or equal to the large object limit enforced by Swift cluster in consideration.$sentinal$Related options: * ``swift_store_large_object_size``
* - ``swift_store_large_object_size`` = ``5120``
- (Integer) The size, in MB, that Glance will start chunking image files and do a large object manifest in Swift.
- (Integer) The size threshold, in MB, after which Glance will start segmenting image data.$sentinal$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 http://docs.openstack.org/developer/swift/overview_large_objects.html$sentinal$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.$sentinal$NOTE: This should be set by taking into account the large object limit enforced by the Swift cluster in consideration.$sentinal$Possible values: * A positive integer that is less than or equal to the large object limit enforced by the Swift cluster in consideration.$sentinal$Related options: * ``swift_store_large_object_chunk_size``
* - ``swift_store_multi_tenant`` = ``False``
- (Boolean) If set to True, enables multi-tenant storage mode which causes Glance images to be stored in tenant specific Swift accounts.
- (Boolean) Store images in tenant's Swift account.$sentinal$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$sentinal$Possible values: * True * False$sentinal$Related options: * None
* - ``swift_store_multiple_containers_seed`` = ``0``
- (Integer) When set to 0, a single-tenant store will only use one container to store all images. When set to an integer value between 1 and 32, a single-tenant store will use multiple containers to store images, and this value will determine how many containers are created.Used only when swift_store_multi_tenant is disabled. 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.
* - ``swift_store_region`` = ``None``
- (String) The region of the swift endpoint to be used for single tenant. This setting is only necessary if the tenant has multiple swift endpoints.
- (Integer) Seed indicating the number of containers to use for storing images.$sentinal$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.$sentinal$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$sentinal$NOTE: This is used only when swift_store_multi_tenant is disabled.$sentinal$Possible values: * A non-negative integer less than or equal to 32$sentinal$Related options: * ``swift_store_container`` * ``swift_store_multi_tenant`` * ``swift_store_create_container_on_put``
* - ``swift_store_region`` = ``RegionTwo``
- (String) The region of Swift endpoint to use by Glance.$sentinal$Provide a string value representing a Swift region where Glance can connect to for image storage. By default, there is no region set.$sentinal$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.$sentinal$This option can be configured for both single-tenant and multi-tenant storage.$sentinal$NOTE: Setting the region with ``swift_store_region`` is tenant-specific and is necessary ``only if`` the tenant has multiple endpoints across different regions.$sentinal$Possible values: * A string value representing a valid Swift region.$sentinal$Related Options: * None
* - ``swift_store_retry_get_count`` = ``0``
- (Integer) The number of times a Swift download will be retried before the request fails.
- (Integer) The number of times a Swift download will be retried before the request fails.$sentinal$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.$sentinal$Possible values: * Zero * Positive integer value$sentinal$Related Options: * None
* - ``swift_store_service_type`` = ``object-store``
- (String) A string giving the service type of the swift service to use. This setting is only used if swift_store_auth_version is 2.
- (String) Type of Swift service to use.$sentinal$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``.$sentinal$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.$sentinal$Possible values: * A string representing a valid service type for Swift storage.$sentinal$Related Options: * None
* - ``swift_store_ssl_compression`` = ``True``
- (Boolean) If set to False, disables SSL layer compression of https swift requests. Setting to False may improve performance for images which are already in a compressed format, eg qcow2.
- (Boolean) SSL layer compression for HTTPS Swift requests.$sentinal$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.$sentinal$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.$sentinal$Possible values: * True * False$sentinal$Related Options: * None
* - ``swift_store_use_trusts`` = ``True``
- (Boolean) If set to True create a trust for each add/get request to Multi-tenant store in order to prevent authentication token to be expired during uploading/downloading data. If set to False then user token is used for Swift connection (so no overhead on trust creation). Please note that this option is considered only and only if swift_store_multi_tenant=True
- (Boolean) Use trusts for multi-tenant Swift store.$sentinal$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.$sentinal$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.$sentinal$NOTE: This option is considered only when ``swift_store_multi_tenant`` is set to ``True`` $sentinal$Possible values: * True * False$sentinal$Related options: * swift_store_multi_tenant
* - ``swift_store_user`` = ``None``
- (String) The user to authenticate against the Swift authentication service (deprecated - use "user" in swift_store_config_file)
- (String) DEPRECATED: The user to authenticate against the Swift authentication service. The option 'user' in the Swift back-end configuration file is set instead.

28
doc/config-reference/source/tables/glance-taskflow.rst
View File

@ -19,30 +19,8 @@
* - **[taskflow_executor]**
-
* - ``conversion_format`` = ``raw``
- (String) 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`` and ``vmdk``. The ``raw`` 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. The ``vmdk`` is another common disk format supported by many common virtual machine monitors like VMWare Workstation.
Possible values: * qcow2 * raw * vmdk
Related options: * disk_formats
- (String) Set the desired image conversion format.$sentinal$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.$sentinal$By default, ``conversion_format`` is not set and must be set explicitly in the configuration file.$sentinal$The allowed values for this option are ``raw``, ``qcow2`` and ``vmdk``. The ``raw`` 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. The ``vmdk`` is another common disk format supported by many common virtual machine monitors like VMWare Workstation.$sentinal$Possible values: * qcow2 * raw * vmdk$sentinal$Related options: * disk_formats
* - ``engine_mode`` = ``parallel``
- (String) 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`` and ``parallel``. When set to ``serial``, the engine runs all the tasks in a single thread which results in serial execution of tasks. Setting this to ``parallel`` makes the engine run tasks in multiple threads. This results in parallel execution of tasks.
Possible values: * serial * parallel
Related options: * max_workers
- (String) Set the taskflow engine mode.$sentinal$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`` and ``parallel``. When set to ``serial``, the engine runs all the tasks in a single thread which results in serial execution of tasks. Setting this to ``parallel`` makes the engine run tasks in multiple threads. This results in parallel execution of tasks.$sentinal$Possible values: * serial * parallel$sentinal$Related options: * max_workers
* - ``max_workers`` = ``10``
- (Integer) 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
- (Integer) Set the number of engine executable tasks.$sentinal$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.$sentinal$Possible values: * Integer value greater than or equal to 1$sentinal$Related options: * engine_mode

16
doc/config-reference/source/tables/glance-testing.rst
View File

@ -19,18 +19,6 @@
* - **[DEFAULT]**
-
* - ``pydev_worker_debug_host`` = ``localhost``
- (String) 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
- (String) Host address of the pydev server.$sentinal$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.$sentinal$Possible values: * Valid hostname * Valid IP address$sentinal$Related options: * None
* - ``pydev_worker_debug_port`` = ``5678``
- (Port number) 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
- (Port number) Port number that the pydev server will listen on.$sentinal$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.$sentinal$Possible values: * A valid port number$sentinal$Related options: * None

78
doc/config-reference/source/tables/glance-vmware.rst
View File

@ -19,80 +19,20 @@
* - **[glance_store]**
-
* - ``vmware_api_retry_count`` = ``10``
- (Integer) 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
- (Integer) The number of VMware API retries.$sentinal$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'.$sentinal$Possible Values: * Any positive integer value$sentinal$Related options: * None
* - ``vmware_ca_file`` = ``/etc/ssl/certs/ca-certificates.crt``
- (String) 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
- (String) Absolute path to the CA bundle file.$sentinal$This configuration option enables the operator to use a custom Cerificate Authority File to verify the ESX/vCenter certificate.$sentinal$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.$sentinal$Possible Values: * Any string that is a valid absolute path to a CA file$sentinal$Related options: * vmware_insecure
* - ``vmware_datastores`` = ``None``
- (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: * Any string of the format: <datacenter_path>:<datastore_name>:<optional_weight>
Related options: * None
- (Multi-valued) The datastores where the image can be stored.$sentinal$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>.$sentinal$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.$sentinal$Possible Values: * Any string of the format: <datacenter_path>:<datastore_name>:<optional_weight>$sentinal$Related options: * None
* - ``vmware_insecure`` = ``False``
- (Boolean) 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
- (Boolean) Set verification of the ESX/vCenter server certificate.$sentinal$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.$sentinal$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 .$sentinal$Possible Values: * True * False$sentinal$Related options: * vmware_ca_file
* - ``vmware_server_host`` = ``127.0.0.1``
- (String) 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
- (String) Address of the ESX/ESXi or vCenter Server target system.$sentinal$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).$sentinal$Possible Values: * A valid IPv4 or IPv6 address * A valid DNS name$sentinal$Related options: * vmware_server_username * vmware_server_password
* - ``vmware_server_password`` = ``vmware``
- (String) 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
- (String) Server password.$sentinal$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.$sentinal$Possible Values: * Any string that is a password corresponding to the username specified using the "vmware_server_username" option$sentinal$Related options: * vmware_server_host * vmware_server_username
* - ``vmware_server_username`` = ``root``
- (String) 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
- (String) Server username.$sentinal$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.$sentinal$Possible Values: * Any string that is the username for a user with appropriate privileges$sentinal$Related options: * vmware_server_host * vmware_server_password
* - ``vmware_store_image_dir`` = ``/openstack_glance``
- (String) 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
- (String) The directory where the glance images will be stored in the datastore.$sentinal$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.$sentinal$Possible Values: * Any string that is a valid path to a directory$sentinal$Related options: * None
* - ``vmware_task_poll_interval`` = ``5``
- (Integer) 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
- (Integer) Interval in seconds used for polling remote tasks invoked on VMware ESX/VC server.$sentinal$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.$sentinal$Possible Values: * Any positive integer value$sentinal$Related options: * None

84
doc/config-reference/source/tables/glance-zeromq.rst
View File

@ -1,84 +0,0 @@
..
Warning: Do not edit this file. It is automatically generated from the
software project's code and your changes will be overwritten.
The tool to generate this file lives in openstack-doc-tools repository.
Please make any changes needed in the code, then run the
autogenerate-config-doc tool from the openstack-doc-tools repository, or
ask for help on the documentation mailing list, IRC channel or meeting.
.. _glance-zeromq:
.. list-table:: Description of ZeroMQ configuration options
:header-rows: 1
:class: config-ref-table
* - Configuration option = Default value
- Description
* - **[DEFAULT]**
-
* - ``rpc_zmq_bind_address`` = ``*``
- (String) ZeroMQ bind address. Should be a wildcard (*), an ethernet interface, or IP. The "host" option should point or resolve to this address.
* - ``rpc_zmq_bind_port_retries`` = ``100``
- (Integer) Number of retries to find free port number before fail with ZMQBindError.
* - ``rpc_zmq_contexts`` = ``1``
- (Integer) Number of ZeroMQ contexts, defaults to 1.
* - ``rpc_zmq_host`` = ``localhost``
- (String) Name of this node. Must be a valid hostname, FQDN, or IP address. Must match "host" option, if running Nova.
* - ``rpc_zmq_ipc_dir`` = ``/var/run/openstack``
- (String) Directory for holding IPC sockets.
* - ``rpc_zmq_matchmaker`` = ``redis``
- (String) MatchMaker driver.
* - ``rpc_zmq_max_port`` = ``65536``
- (Integer) Maximal port number for random ports range.
* - ``rpc_zmq_min_port`` = ``49153``
- (Port number) Minimal port number for random ports range.
* - ``rpc_zmq_serialization`` = ``json``
- (String) Default serialization mechanism for serializing/deserializing outgoing/incoming messages
* - ``rpc_zmq_topic_backlog`` = ``None``
- (Integer) Maximum number of ingress messages to locally buffer per topic. Default is unlimited.
* - ``use_pub_sub`` = ``True``
- (Boolean) Use PUB/SUB pattern for fanout methods. PUB/SUB always uses proxy.
* - ``zmq_immediate`` = ``False``
- (Boolean) This option configures round-robin mode in zmq socket. True means not keeping a queue when server side disconnects. False means to keep queue and messages even if server is disconnected, when the server appears we send all accumulated messages to it.
* - ``zmq_target_expire`` = ``300``
- (Integer) Expiration timeout in seconds of a name service record about existing target ( < 0 means no timeout).
* - ``zmq_target_update`` = ``180``
- (Integer) Update period in seconds of a name service record about existing target.
* - **[oslo_messaging_zmq]**
-
* - ``rpc_cast_timeout`` = ``-1``
- (Integer) Seconds to wait before a cast expires (TTL). The default value of -1 specifies an infinite linger period. The value of 0 specifies no linger period. Pending messages shall be discarded immediately when the socket is closed. Only supported by impl_zmq.
* - ``rpc_poll_timeout`` = ``1``
- (Integer) The default number of seconds that poll should wait. Poll raises timeout exception when timeout expired.
* - ``rpc_zmq_bind_address`` = ``*``
- (String) ZeroMQ bind address. Should be a wildcard (*), an ethernet interface, or IP. The "host" option should point or resolve to this address.
* - ``rpc_zmq_bind_port_retries`` = ``100``
- (Integer) Number of retries to find free port number before fail with ZMQBindError.
* - ``rpc_zmq_contexts`` = ``1``
- (Integer) Number of ZeroMQ contexts, defaults to 1.
* - ``rpc_zmq_host`` = ``localhost``
- (String) Name of this node. Must be a valid hostname, FQDN, or IP address. Must match "host" option, if running Nova.
* - ``rpc_zmq_ipc_dir`` = ``/var/run/openstack``
- (String) Directory for holding IPC sockets.
* - ``rpc_zmq_matchmaker`` = ``redis``
- (String) MatchMaker driver.
* - ``rpc_zmq_max_port`` = ``65536``
- (Integer) Maximal port number for random ports range.
* - ``rpc_zmq_min_port`` = ``49153``
- (Port number) Minimal port number for random ports range.
* - ``rpc_zmq_serialization`` = ``json``
- (String) Default serialization mechanism for serializing/deserializing outgoing/incoming messages
* - ``rpc_zmq_topic_backlog`` = ``None``
- (Integer) Maximum number of ingress messages to locally buffer per topic. Default is unlimited.
* - ``use_pub_sub`` = ``True``
- (Boolean) Use PUB/SUB pattern for fanout methods. PUB/SUB always uses proxy.
* - ``use_router_proxy`` = ``True``
- (Boolean) Use ROUTER remote proxy.
* - ``zmq_immediate`` = ``False``
- (Boolean) This option configures round-robin mode in zmq socket. True means not keeping a queue when server side disconnects. False means to keep queue and messages even if server is disconnected, when the server appears we send all accumulated messages to it.
* - ``zmq_target_expire`` = ``300``
- (Integer) Expiration timeout in seconds of a name service record about existing target ( < 0 means no timeout).
* - ``zmq_target_update`` = ``180``
- (Integer) Update period in seconds of a name service record about existing target.

272
tools/autogenerate-config-flagmappings/glance.flagmappings
View File

@ -4,7 +4,7 @@ admin_tenant_name registry
admin_user registry
allow_additional_image_properties common
allow_anonymous_access api
allowed_rpc_exception_modules rpc
allowed_rpc_exception_modules disable
api_limit_max common
args replicator
auth_region registry
@ -21,15 +21,15 @@ client_socket_timeout api
command replicator
conn_pool_min_size disable
conn_pool_ttl disable
control_exchange amqp
control_exchange disable
data_api common
debug disable
default_log_levels disable
default_publisher_id amqp
default_publisher_id disable
default_swift_reference swift
delayed_delete imagecache
digest_algorithm common
disabled_notifications amqp
disabled_notifications disable
dontreplicate replicator
enable_v1_api api
enable_v1_registry api
@ -84,21 +84,21 @@ registry_client_protocol registry
registry_client_timeout registry
registry_host registry
registry_port registry
rpc_backend rpc
rpc_cast_timeout rpc
rpc_conn_pool_size rpc
rpc_poll_timeout rpc
rpc_response_timeout rpc
rpc_zmq_bind_address zeromq
rpc_zmq_bind_port_retries zeromq
rpc_zmq_contexts zeromq
rpc_zmq_host zeromq
rpc_zmq_ipc_dir zeromq
rpc_zmq_matchmaker zeromq
rpc_zmq_max_port zeromq
rpc_zmq_min_port zeromq
rpc_zmq_serialization zeromq
rpc_zmq_topic_backlog zeromq
rpc_backend disable
rpc_cast_timeout disable
rpc_conn_pool_size disable
rpc_poll_timeout disable
rpc_response_timeout disable
rpc_zmq_bind_address disable
rpc_zmq_bind_port_retries disable
rpc_zmq_contexts disable
rpc_zmq_host disable
rpc_zmq_ipc_dir disable
rpc_zmq_matchmaker disable
rpc_zmq_max_port disable
rpc_zmq_min_port disable
rpc_zmq_serialization disable
rpc_zmq_topic_backlog disable
scrub_pool_size imagecache
scrub_time imagecache
secure_proxy_ssl_header api
@ -113,8 +113,8 @@ swift_store_user swift
syslog_log_facility disable
tcp_keepidle api
token replicator
transport_url amqp
use_pub_sub zeromq
transport_url disable
use_pub_sub disable
use_router_proxy disable
use_stderr disable
use_syslog disable
@ -124,9 +124,9 @@ verbose disable
wakeup_time scrubber
watch_log_file disable
workers common
zmq_immediate zeromq
zmq_target_expire zeromq
zmq_target_update zeromq
zmq_immediate disable
zmq_target_expire disable
zmq_target_update disable
cors/allow_credentials disable
cors/allow_headers disable
cors/allow_methods disable
@ -269,118 +269,118 @@ matchmaker_redis/sentinel_group_name redis
matchmaker_redis/sentinel_hosts redis
matchmaker_redis/socket_timeout redis
matchmaker_redis/wait_timeout redis
oslo_concurrency/disable_process_locking rpc
oslo_concurrency/lock_path rpc
oslo_messaging_amqp/addressing_mode rpc
oslo_messaging_amqp/allow_insecure_clients rpc
oslo_messaging_amqp/anycast_address rpc
oslo_messaging_amqp/broadcast_prefix rpc
oslo_messaging_amqp/connection_retry_backoff rpc
oslo_messaging_amqp/connection_retry_interval rpc
oslo_messaging_amqp/connection_retry_interval_max rpc
oslo_messaging_amqp/container_name rpc
oslo_messaging_amqp/default_notification_exchange rpc
oslo_messaging_amqp/default_notify_timeout rpc
oslo_messaging_amqp/default_reply_timeout rpc
oslo_messaging_amqp/default_rpc_exchange rpc
oslo_messaging_amqp/default_send_timeout rpc
oslo_messaging_amqp/group_request_prefix rpc
oslo_messaging_amqp/idle_timeout rpc
oslo_messaging_amqp/link_retry_delay rpc
oslo_messaging_amqp/multicast_address rpc
oslo_messaging_amqp/notify_address_prefix rpc
oslo_messaging_amqp/notify_server_credit rpc
oslo_messaging_amqp/password rpc
oslo_messaging_amqp/reply_link_credit rpc
oslo_messaging_amqp/rpc_address_prefix rpc
oslo_messaging_amqp/rpc_server_credit rpc
oslo_messaging_amqp/sasl_config_dir rpc
oslo_messaging_amqp/sasl_config_name rpc
oslo_messaging_amqp/sasl_mechanisms rpc
oslo_messaging_amqp/server_request_prefix rpc
oslo_messaging_amqp/ssl_ca_file rpc
oslo_messaging_amqp/ssl_cert_file rpc
oslo_messaging_amqp/ssl_key_file rpc
oslo_messaging_amqp/ssl_key_password rpc
oslo_messaging_amqp/trace rpc
oslo_messaging_amqp/unicast_address rpc
oslo_messaging_amqp/username rpc
oslo_messaging_notifications/driver amqp
oslo_messaging_notifications/topics amqp
oslo_messaging_notifications/transport_url amqp
oslo_messaging_rabbit/amqp_auto_delete rabbitmq
oslo_messaging_rabbit/amqp_durable_queues rabbitmq
oslo_messaging_rabbit/channel_max rabbitmq
oslo_messaging_rabbit/connection_factory rabbitmq
oslo_messaging_rabbit/default_notification_exchange rabbitmq
oslo_messaging_rabbit/default_notification_retry_attempts rabbitmq
oslo_messaging_rabbit/default_rpc_exchange rabbitmq
oslo_messaging_rabbit/default_rpc_retry_attempts rabbitmq
oslo_messaging_rabbit/fake_rabbit rabbitmq
oslo_messaging_rabbit/frame_max rabbitmq
oslo_messaging_rabbit/heartbeat_interval rabbitmq
oslo_messaging_rabbit/heartbeat_rate rabbitmq
oslo_messaging_rabbit/heartbeat_timeout_threshold rabbitmq
oslo_messaging_rabbit/host_connection_reconnect_delay rabbitmq
oslo_messaging_rabbit/kombu_compression rabbitmq
oslo_messaging_rabbit/kombu_failover_strategy rabbitmq
oslo_messaging_rabbit/kombu_missing_consumer_retry_timeout rabbitmq
oslo_messaging_rabbit/kombu_reconnect_delay rabbitmq
oslo_messaging_rabbit/kombu_ssl_ca_certs rabbitmq
oslo_messaging_rabbit/kombu_ssl_certfile rabbitmq
oslo_messaging_rabbit/kombu_ssl_keyfile rabbitmq
oslo_messaging_rabbit/kombu_ssl_version rabbitmq
oslo_messaging_rabbit/notification_listener_prefetch_count rabbitmq
oslo_messaging_rabbit/notification_persistence rabbitmq
oslo_messaging_rabbit/notification_retry_delay rabbitmq
oslo_messaging_rabbit/pool_max_overflow rabbitmq
oslo_messaging_rabbit/pool_max_size rabbitmq
oslo_messaging_rabbit/pool_recycle rabbitmq
oslo_messaging_rabbit/pool_stale rabbitmq
oslo_messaging_rabbit/pool_timeout rabbitmq
oslo_messaging_rabbit/rabbit_ha_queues rabbitmq
oslo_messaging_rabbit/rabbit_host rabbitmq
oslo_messaging_rabbit/rabbit_hosts rabbitmq
oslo_messaging_rabbit/rabbit_interval_max rabbitmq
oslo_messaging_rabbit/rabbit_login_method rabbitmq
oslo_messaging_rabbit/rabbit_max_retries rabbitmq
oslo_messaging_rabbit/rabbit_password rabbitmq
oslo_messaging_rabbit/rabbit_port rabbitmq
oslo_messaging_rabbit/rabbit_qos_prefetch_count rabbitmq
oslo_messaging_rabbit/rabbit_retry_backoff rabbitmq
oslo_messaging_rabbit/rabbit_retry_interval rabbitmq
oslo_messaging_rabbit/rabbit_transient_queues_ttl rabbitmq
oslo_messaging_rabbit/rabbit_use_ssl rabbitmq
oslo_messaging_rabbit/rabbit_userid rabbitmq
oslo_messaging_rabbit/rabbit_virtual_host rabbitmq
oslo_messaging_rabbit/rpc_listener_prefetch_count rpc
oslo_messaging_rabbit/rpc_queue_expiration rpc
oslo_messaging_rabbit/rpc_reply_exchange rpc
oslo_messaging_rabbit/rpc_reply_listener_prefetch_count rpc
oslo_messaging_rabbit/rpc_reply_retry_attempts rpc
oslo_messaging_rabbit/rpc_reply_retry_delay rpc
oslo_messaging_rabbit/rpc_retry_delay rpc
oslo_messaging_rabbit/socket_timeout rpc
oslo_messaging_rabbit/ssl rpc
oslo_messaging_rabbit/ssl_options rpc
oslo_messaging_rabbit/tcp_user_timeout rpc
oslo_messaging_zmq/rpc_cast_timeout zeromq
oslo_messaging_zmq/rpc_poll_timeout zeromq
oslo_messaging_zmq/rpc_zmq_bind_address zeromq
oslo_messaging_zmq/rpc_zmq_bind_port_retries zeromq
oslo_messaging_zmq/rpc_zmq_contexts zeromq
oslo_messaging_zmq/rpc_zmq_host zeromq
oslo_messaging_zmq/rpc_zmq_ipc_dir zeromq
oslo_messaging_zmq/rpc_zmq_matchmaker zeromq
oslo_messaging_zmq/rpc_zmq_max_port zeromq
oslo_messaging_zmq/rpc_zmq_min_port zeromq
oslo_messaging_zmq/rpc_zmq_serialization zeromq
oslo_messaging_zmq/rpc_zmq_topic_backlog zeromq
oslo_messaging_zmq/use_pub_sub zeromq
oslo_messaging_zmq/use_router_proxy zeromq
oslo_messaging_zmq/zmq_immediate zeromq
oslo_messaging_zmq/zmq_target_expire zeromq
oslo_messaging_zmq/zmq_target_update zeromq
oslo_concurrency/disable_process_locking disable
oslo_concurrency/lock_path disable
oslo_messaging_amqp/addressing_mode disable
oslo_messaging_amqp/allow_insecure_clients disable
oslo_messaging_amqp/anycast_address disable
oslo_messaging_amqp/broadcast_prefix disable
oslo_messaging_amqp/connection_retry_backoff disable
oslo_messaging_amqp/connection_retry_interval disable
oslo_messaging_amqp/connection_retry_interval_max disable
oslo_messaging_amqp/container_name disable
oslo_messaging_amqp/default_notification_exchange disable
oslo_messaging_amqp/default_notify_timeout disable
oslo_messaging_amqp/default_reply_timeout disable
oslo_messaging_amqp/default_rpc_exchange disable
oslo_messaging_amqp/default_send_timeout disable
oslo_messaging_amqp/group_request_prefix disable
oslo_messaging_amqp/idle_timeout disable
oslo_messaging_amqp/link_retry_delay disable
oslo_messaging_amqp/multicast_address disable
oslo_messaging_amqp/notify_address_prefix disable
oslo_messaging_amqp/notify_server_credit disable
oslo_messaging_amqp/password disable
oslo_messaging_amqp/reply_link_credit disable
oslo_messaging_amqp/rpc_address_prefix disable
oslo_messaging_amqp/rpc_server_credit disable
oslo_messaging_amqp/sasl_config_dir disable
oslo_messaging_amqp/sasl_config_name disable
oslo_messaging_amqp/sasl_mechanisms disable
oslo_messaging_amqp/server_request_prefix disable
oslo_messaging_amqp/ssl_ca_file disable
oslo_messaging_amqp/ssl_cert_file disable
oslo_messaging_amqp/ssl_key_file disable
oslo_messaging_amqp/ssl_key_password disable
oslo_messaging_amqp/trace disable
oslo_messaging_amqp/unicast_address disable
oslo_messaging_amqp/username disable
oslo_messaging_notifications/driver disable
oslo_messaging_notifications/topics disable
oslo_messaging_notifications/transport_url disable
oslo_messaging_rabbit/amqp_auto_delete disable
oslo_messaging_rabbit/amqp_durable_queues disable
oslo_messaging_rabbit/channel_max disable
oslo_messaging_rabbit/connection_factory disable
oslo_messaging_rabbit/default_notification_exchange disable
oslo_messaging_rabbit/default_notification_retry_attempts disable
oslo_messaging_rabbit/default_rpc_exchange disable
oslo_messaging_rabbit/default_rpc_retry_attempts disable
oslo_messaging_rabbit/fake_rabbit disable
oslo_messaging_rabbit/frame_max disable
oslo_messaging_rabbit/heartbeat_interval disable
oslo_messaging_rabbit/heartbeat_rate disable
oslo_messaging_rabbit/heartbeat_timeout_threshold disable
oslo_messaging_rabbit/host_connection_reconnect_delay disable
oslo_messaging_rabbit/kombu_compression disable
oslo_messaging_rabbit/kombu_failover_strategy disable
oslo_messaging_rabbit/kombu_missing_consumer_retry_timeout disable
oslo_messaging_rabbit/kombu_reconnect_delay disable
oslo_messaging_rabbit/kombu_ssl_ca_certs disable
oslo_messaging_rabbit/kombu_ssl_certfile disable
oslo_messaging_rabbit/kombu_ssl_keyfile disable
oslo_messaging_rabbit/kombu_ssl_version disable
oslo_messaging_rabbit/notification_listener_prefetch_count disable
oslo_messaging_rabbit/notification_persistence disable
oslo_messaging_rabbit/notification_retry_delay disable
oslo_messaging_rabbit/pool_max_overflow disable
oslo_messaging_rabbit/pool_max_size disable
oslo_messaging_rabbit/pool_recycle disable
oslo_messaging_rabbit/pool_stale disable
oslo_messaging_rabbit/pool_timeout disable
oslo_messaging_rabbit/rabbit_ha_queues disable
oslo_messaging_rabbit/rabbit_host disable
oslo_messaging_rabbit/rabbit_hosts disable
oslo_messaging_rabbit/rabbit_interval_max disable
oslo_messaging_rabbit/rabbit_login_method disable
oslo_messaging_rabbit/rabbit_max_retries disable
oslo_messaging_rabbit/rabbit_password disable
oslo_messaging_rabbit/rabbit_port disable
oslo_messaging_rabbit/rabbit_qos_prefetch_count disable
oslo_messaging_rabbit/rabbit_retry_backoff disable
oslo_messaging_rabbit/rabbit_retry_interval disable
oslo_messaging_rabbit/rabbit_transient_queues_ttl disable
oslo_messaging_rabbit/rabbit_use_ssl disable
oslo_messaging_rabbit/rabbit_userid disable
oslo_messaging_rabbit/rabbit_virtual_host disable
oslo_messaging_rabbit/rpc_listener_prefetch_count disable
oslo_messaging_rabbit/rpc_queue_expiration disable
oslo_messaging_rabbit/rpc_reply_exchange disable
oslo_messaging_rabbit/rpc_reply_listener_prefetch_count disable
oslo_messaging_rabbit/rpc_reply_retry_attempts disable
oslo_messaging_rabbit/rpc_reply_retry_delay disable
oslo_messaging_rabbit/rpc_retry_delay disable
oslo_messaging_rabbit/socket_timeout disable
oslo_messaging_rabbit/ssl disable
oslo_messaging_rabbit/ssl_options disable
oslo_messaging_rabbit/tcp_user_timeout disable
oslo_messaging_zmq/rpc_cast_timeout disable
oslo_messaging_zmq/rpc_poll_timeout disable
oslo_messaging_zmq/rpc_zmq_bind_address disable
oslo_messaging_zmq/rpc_zmq_bind_port_retries disable
oslo_messaging_zmq/rpc_zmq_contexts disable
oslo_messaging_zmq/rpc_zmq_host disable
oslo_messaging_zmq/rpc_zmq_ipc_dir disable
oslo_messaging_zmq/rpc_zmq_matchmaker disable
oslo_messaging_zmq/rpc_zmq_max_port disable
oslo_messaging_zmq/rpc_zmq_min_port disable
oslo_messaging_zmq/rpc_zmq_serialization disable
oslo_messaging_zmq/rpc_zmq_topic_backlog disable
oslo_messaging_zmq/use_pub_sub disable
oslo_messaging_zmq/use_router_proxy disable
oslo_messaging_zmq/zmq_immediate disable
oslo_messaging_zmq/zmq_target_expire disable
oslo_messaging_zmq/zmq_target_update disable
oslo_middleware/enable_proxy_headers_parsing api
oslo_middleware/max_request_body_size api
oslo_middleware/secure_proxy_ssl_header api

1
tools/autogenerate-config-flagmappings/glance.headers
View File

@ -1,5 +1,6 @@
elasticsearch Elasticsearch
filesystem filesystem
http HTTP
imagecache flagmappings
matchmaker matchmaker
rbd RADOS Block Devices (RBD)