openstack/openstack-manuals
Code Issues Proposed changes

[config-ref] Update glance tables

Browse Source 
Change-Id: I063acc08802ff40720183b27ba80b8307efecda8
This commit is contained in:
venkatamahesh 2016-09-03 17:30:35 +05:30
parent 44e31bf4f6
commit 0dcddcd7fa
14 changed files with 637 additions and 100 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -21,11 +21,25 @@
* - ``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 notifications.
- (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 disabled notifications. A notification can be given either as a notification type to disable a single event, or as a notification group prefix to disable all events within a group. Example: if this config option is set to ["image.create", "metadef_namespace"], then "image.create" notification will not be sent after image is created and none of the notifications for metadefinition namespaces will be sent.
- (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. If not set, we fall back to the rpc_backend option and driver specific configuration.
- (String) A URL representing the messaging driver to use and its full configuration.
* - **[oslo_messaging_notifications]**
-
* - ``driver`` = ``[]``

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

@ -20,67 +20,261 @@
-
* - ``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
* - ``allow_anonymous_access`` = ``False``
- (Boolean) Allow unauthenticated users to access the API with read-only privileges. This only applies when using ContextMiddleware.
- (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
* - ``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. If an incoming connection is idle for this number of seconds it will be closed. A value of '0' means wait forever.
- (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
* - ``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
* - ``enable_v1_registry`` = ``True``
- (Boolean) Deploy the v1 OpenStack Registry API.
- (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
* - ``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
* - ``enable_v2_registry`` = ``True``
- (Boolean) Deploy the v2 OpenStack Registry API.
- (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
* - ``http_keepalive`` = ``True``
- (Boolean) If False, server will return the header "Connection: close", If True, server will return "Connection: Keep-Alive" in its responses. In order to close the client socket connection explicitly after the response is sent and read successfully by the client, you simply have to set this option to False when you create a wsgi server.
- (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
* - ``image_size_cap`` = ``1099511627776``
- (Integer) Maximum size of image a user can upload in bytes. Defaults to 1099511627776 bytes (1 TB).WARNING: this value should only be increased after careful consideration and must be set to a value under 8 EB (9223372036854775808).
- (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
* - ``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) This value sets what strategy will be used to determine the image location order. Currently two strategies are packaged with Glance 'location_order' and 'store_type'.
- (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
* - ``max_header_line`` = ``16384``
- (Integer) Maximum line size of message headers to be accepted. max_header_line may need to be increased when using large tokens (typically those generated by the Keystone v3 API with big service catalogs
- (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
* - ``max_request_id_length`` = ``64``
- (Integer) Limits request ID length.
- (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
* - ``owner_is_tenant`` = ``True``
- (Boolean) When true, this option sets the owner of an image to be the tenant. Otherwise, the owner of the image will be the authenticated user issuing the request.
- (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
* - ``public_endpoint`` = ``None``
- (String) Public url to use for versions endpoint. The default is None, which will use the request's host_url attribute to populate the URL base. If Glance is operating behind a proxy, you will want to change this to represent the proxy's URL.
- (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
* - ``secure_proxy_ssl_header`` = ``None``
- (String) 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".
- (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) Whether to pass through headers containing user and tenant information when making requests to the registry. This allows the registry to use the context middleware without keystonemiddleware's auth_token middleware, removing calls to the keystone auth service. It is recommended that when using this option, secure communication between glance api and glance registry is ensured by means other than auth_token middleware.
- (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
* - ``show_multiple_locations`` = ``False``
- (Boolean) Whether to include the backend image locations in image properties. For example, if using the file system store a URL of "file:///path/to/image" will be returned to the user in the 'direct_url' meta-data field. Revealing storage location can be a security risk, so use this setting with caution! Setting this to true overrides the show_image_direct_url option.
- (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.
* - ``tcp_keepidle`` = ``600``
- (Integer) The value for the socket option TCP_KEEPIDLE. This is the time in seconds that the connection must be idle before TCP starts sending keepalive probes.
- (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
* - ``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) Default scheme to use to store image data. The scheme must be registered by one of the stores defined by the 'stores' config option.
- (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
* - ``store_capabilities_update_min_interval`` = ``0``
- (Integer) Minimum interval seconds to execute updating dynamic storage capabilities based on backend status then. It's not a periodic routine, the update logic will be executed only when interval seconds elapsed and an operation of store has triggered. The feature will be enabled only when the option value greater then zero.
- (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
* - ``stores`` = ``file, http``
- (List) List of stores enabled. Valid stores are: cinder, file, http, rbd, sheepdog, swift, s3, vsphere
- (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
* - **[oslo_middleware]**
-
* - ``enable_proxy_headers_parsing`` = ``False``
- (Boolean) Whether the application is behind a proxy or not. This determines if the middleware should parse the headers or not.
* - ``max_request_body_size`` = ``114688``
- (Integer) The maximum body size for each request, in bytes.
* - ``secure_proxy_ssl_header`` = ``X-Forwarded-Proto``
- (String) DEPRECATED: The HTTP Header that will be used to determine what the original request protocol scheme was, even if it was hidden by an SSL termination proxy.
- (String) DEPRECATED: The HTTP Header that will be used to determine what the original request protocol scheme was, even if it was hidden by a SSL termination proxy.
* - **[paste_deploy]**
-
* - ``config_file`` = ``None``
* - ``config_file`` = ``glance-api-paste.ini``
- (String) Name of the paste configuration file.
* - ``flavor`` = ``None``
- (String) Partial name of a pipeline in your paste configuration file with the service name removed. For example, if your paste section name is [pipeline:glance-api-keystone] use the value "keystone"
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
* - ``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
* - **[store_type_location_strategy]**
-
* - ``store_type_preference`` =
- (List) The store names to use to get store preference order. The name must be registered by one of the stores defined by the 'stores' config option. This option will be applied when you using 'store_type' option as image location strategy defined by the 'location_strategy' config option.
- (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

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

@ -18,9 +18,31 @@
- Description
* - **[DEFAULT]**
-
* - ``ca_file`` = ``None``
- (String) CA certificate file to use to verify connecting clients.
* - ``cert_file`` = ``None``
- (String) Certificate file to use when starting API server securely.
* - ``key_file`` = ``None``
- (String) Private key file to use when starting API server securely.
* - ``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
* - ``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
* - ``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

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

@ -19,8 +19,28 @@
* - **[glance_store]**
-
* - ``http_proxy_information`` = ``{}``
- (Dict) Specify 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. e.g. http:10.0.0.1:3128. You can specify proxies for multiple schemes by seperating the key value pairs with a comma.e.g. http:10.0.0.1:3128, https:10.0.0.1:1080.
- (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
* - ``https_ca_certificates_file`` = ``None``
- (String) Specify the path to the CA bundle file to use in verifying the remote server certificate.
- (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
* - ``https_insecure`` = ``True``
- (Boolean) If true, the remote server certificate is not verified. If false, then the default CA truststore is used for verification. This option is ignored if "https_ca_certificates_file" is set.
- (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

12
doc/config-reference/source/tables/glance-redis.rst
View File

@ -21,16 +21,16 @@
* - ``check_timeout`` = ``20000``
- (Integer) Time in ms to wait before the transaction is killed.
* - ``host`` = ``127.0.0.1``
- (String) Host to locate redis.
- (String) DEPRECATED: Host to locate redis. Replaced by [DEFAULT]/transport_url
* - ``password`` =
- (String) Password for Redis server (optional).
- (String) DEPRECATED: Password for Redis server (optional). Replaced by [DEFAULT]/transport_url
* - ``port`` = ``6379``
- (Port number) Use this port to connect to redis host.
- (Port number) DEPRECATED: Use this port to connect to redis host. Replaced by [DEFAULT]/transport_url
* - ``sentinel_group_name`` = ``oslo-messaging-zeromq``
- (String) Redis replica set name.
* - ``sentinel_hosts`` =
- (List) List of Redis Sentinel hosts (fault tolerance mode) e.g. [host:port, host1:port ... ]
* - ``socket_timeout`` = ``1000``
- (List) DEPRECATED: List of Redis Sentinel hosts (fault tolerance mode) e.g. [host:port, host1:port ... ] Replaced by [DEFAULT]/transport_url
* - ``socket_timeout`` = ``10000``
- (Integer) Timeout in ms on blocking socket operations
* - ``wait_timeout`` = ``500``
* - ``wait_timeout`` = ``2000``
- (Integer) Time in ms to wait between connection attempts.

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

@ -30,19 +30,75 @@
- (String) DEPRECATED: The strategy to use for authentication. If "use_user_token" is not in effect, then auth strategy 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.
* - ``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`` = ``None``
- (String) The path to the certifying authority cert file to use in SSL connections to the registry server, if any. Alternately, you may set the GLANCE_CLIENT_CA_FILE environment variable to a filepath of the CA cert file.
* - ``registry_client_cert_file`` = ``None``
- (String) The path to the cert file to use in SSL connections to the registry server, if any. Alternately, you may set the GLANCE_CLIENT_CERT_FILE environment variable to a filepath of the CA cert file
* - ``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
* - ``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
* - ``registry_client_insecure`` = ``False``
- (Boolean) When using SSL in connections to the registry server, do not require validation via a certifying authority. This is the registry's equivalent of specifying --insecure on the command line using glanceclient for the API.
* - ``registry_client_key_file`` = ``None``
- (String) The path to the key file to use in SSL connections to the registry server, if any. Alternately, you may set the GLANCE_CLIENT_KEY_FILE environment variable to a filepath of the key file
- (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
* - ``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
* - ``registry_client_protocol`` = ``http``
- (String) The protocol to use for communication with the registry server. Either http or https.
- (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
* - ``registry_client_timeout`` = ``600``
- (Integer) The period of time, in seconds, that the API server will wait for a registry request to complete. A value of 0 implies no timeout.
- (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
* - ``registry_host`` = ``0.0.0.0``
- (String) Address to find the registry server.
- (String) Address the registry server is hosted on.
Possible values: * A valid IP or hostname
Related options: * None
* - ``registry_port`` = ``9191``
- (Port number) Port the registry server is listening on.
Possible values: * A valid port number
Related options: * None

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

@ -19,7 +19,7 @@
* - **[DEFAULT]**
-
* - ``args`` = ``None``
- (List) Arguments for the command
- (Multi-valued) Arguments for the command
* - ``chunksize`` = ``65536``
- (Integer) Amount of data to transfer per HTTP write.
* - ``command`` = ``None``

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

@ -19,9 +19,17 @@
* - **[DEFAULT]**
-
* - ``allowed_rpc_exception_modules`` = ``glance.common.exception, builtins, exceptions``
- (List) Modules of exceptions that are permitted to be recreated upon receiving exception data from an rpc call.
- (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) The messaging driver to use, defaults to rabbit. Other drivers include amqp and zmq.
- (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``
@ -38,18 +46,52 @@
- (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
- (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`` =
@ -68,6 +110,8 @@
- (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]**

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

@ -18,9 +18,35 @@
- Description
* - **[glance_store]**
-
* - ``sheepdog_store_address`` = ``localhost``
- (String) IP address of sheep daemon.
* - ``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
* - ``sheepdog_store_chunk_size`` = ``64``
- (Integer) Images will be chunked into objects of this size (in megabytes). For best performance, this should be a power of two.
- (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
* - ``sheepdog_store_port`` = ``7000``
- (Integer) Port of sheep daemon.
- (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

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

@ -18,9 +18,31 @@
- Description
* - **[taskflow_executor]**
-
* - ``conversion_format`` = ``None``
- (String) The format to which images will be automatically converted. When using the RBD backend, this should be set to 'raw'
* - ``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
* - ``engine_mode`` = ``parallel``
- (String) The mode in which the engine will run. Can be 'serial' or '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
* - ``max_workers`` = ``10``
- (Integer) The number of parallel activities executed at the same time by the engine. The value can be greater than one when the engine mode is 'parallel'.
- (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

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

@ -18,7 +18,19 @@
- Description
* - **[DEFAULT]**
-
* - ``pydev_worker_debug_host`` = ``None``
- (String) The hostname/IP of the pydev process listening for debug connections
* - ``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
* - ``pydev_worker_debug_port`` = ``5678``
- (Port number) The port on which a pydev process is listening for connections.
- (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

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

@ -19,20 +19,80 @@
* - **[glance_store]**
-
* - ``vmware_api_retry_count`` = ``10``
- (Integer) Number of times VMware ESX/VC server API must be retried upon connection related issues.
* - ``vmware_ca_file`` = ``None``
- (String) Specify a CA bundle file to use in verifying the ESX/vCenter server certificate.
- (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
* - ``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
* - ``vmware_datastores`` = ``None``
- (Multi-valued) A list of datastores where the image can be stored. This option may be specified multiple times for specifying multiple datastores. The datastore name should be specified after its datacenter path, seperated by ":". An optional weight may be given after the datastore name, seperated again by ":". 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.
- (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
* - ``vmware_insecure`` = ``False``
- (Boolean) If true, the ESX/vCenter server certificate is not verified. If false, then the default CA truststore is used for verification. This option is ignored if "vmware_ca_file" is set.
* - ``vmware_server_host`` = ``None``
- (String) ESX/ESXi or vCenter Server target system. The server value can be an IP address or a DNS name.
* - ``vmware_server_password`` = ``None``
- (String) Password for authenticating with VMware ESX/VC server.
* - ``vmware_server_username`` = ``None``
- (String) Username for authenticating with VMware ESX/VC server.
- (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
* - ``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
* - ``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
* - ``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
* - ``vmware_store_image_dir`` = ``/openstack_glance``
- (String) The name of the directory where the glance images will be stored in the VMware datastore.
- (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
* - ``vmware_task_poll_interval`` = ``5``
- (Integer) The interval used for polling remote tasks invoked on VMware ESX/VC server.
- (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

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

@ -22,8 +22,6 @@
- (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_concurrency`` = ``eventlet``
- (String) Type of concurrency used. Either "native" or "eventlet"
* - ``rpc_zmq_contexts`` = ``1``
- (Integer) Number of ZeroMQ contexts, defaults to 1.
* - ``rpc_zmq_host`` = ``localhost``
@ -34,11 +32,53 @@
- (String) MatchMaker driver.
* - ``rpc_zmq_max_port`` = ``65536``
- (Integer) Maximal port number for random ports range.
* - ``rpc_zmq_min_port`` = ``49152``
* - ``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_target_expire`` = ``120``
* - ``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.

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

@ -19,6 +19,8 @@ cert_file ca
chunksize replicator
client_socket_timeout api
command replicator
conn_pool_min_size disable
conn_pool_ttl disable
control_exchange amqp
data_api common
debug disable
@ -64,7 +66,6 @@ logging_user_identity_format disable
mastertoken replicator
max_header_line api
max_request_id_length api
memcached_servers common
metadata_encryption_key common
metadata_source_path common
metaonly replicator
@ -90,13 +91,13 @@ rpc_poll_timeout rpc
rpc_response_timeout rpc
rpc_zmq_bind_address zeromq
rpc_zmq_bind_port_retries zeromq
rpc_zmq_concurrency 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
scrub_pool_size imagecache
scrub_time imagecache
@ -114,6 +115,7 @@ tcp_keepidle api
token replicator
transport_url amqp
use_pub_sub zeromq
use_router_proxy disable
use_stderr disable
use_syslog disable
use_user_token api
@ -122,7 +124,9 @@ verbose disable
wakeup_time scrubber
watch_log_file disable
workers common
zmq_immediate zeromq
zmq_target_expire zeromq
zmq_target_update zeromq
cors/allow_credentials disable
cors/allow_headers disable
cors/allow_methods disable
@ -181,21 +185,6 @@ glance_store/rbd_store_chunk_size rbd
glance_store/rbd_store_pool rbd
glance_store/rbd_store_user rbd
glance_store/rootwrap_config common
glance_store/s3_store_access_key s3
glance_store/s3_store_bucket s3
glance_store/s3_store_bucket_url_format s3
glance_store/s3_store_create_bucket_on_put s3
glance_store/s3_store_enable_proxy s3
glance_store/s3_store_host s3
glance_store/s3_store_large_object_chunk_size s3
glance_store/s3_store_large_object_size s3
glance_store/s3_store_object_buffer_dir s3
glance_store/s3_store_proxy_host s3
glance_store/s3_store_proxy_password s3
glance_store/s3_store_proxy_port s3
glance_store/s3_store_proxy_user s3
glance_store/s3_store_secret_key s3
glance_store/s3_store_thread_pools s3
glance_store/sheepdog_store_address sheepdog
glance_store/sheepdog_store_chunk_size sheepdog
glance_store/sheepdog_store_port sheepdog
@ -282,12 +271,29 @@ 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
@ -297,6 +303,7 @@ 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
@ -304,6 +311,7 @@ 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
@ -356,6 +364,24 @@ 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_middleware/enable_proxy_headers_parsing api
oslo_middleware/max_request_body_size api
oslo_middleware/secure_proxy_ssl_header api
oslo_policy/policy_default_rule disable
@ -363,6 +389,7 @@ oslo_policy/policy_dirs disable
oslo_policy/policy_file disable
paste_deploy/config_file api
paste_deploy/flavor api
profiler/connection_string profiler
profiler/enabled profiler
profiler/hmac_keys profiler
profiler/trace_sqlalchemy profiler