[config-ref] Tables update

Change-Id: Ia766f93b9ce5b1560ebe37da65bd70be61a0fdd1
This commit is contained in:
Gauvain Pocentek 2016-03-19 08:31:53 +01:00
parent 44df73dfa0
commit cce63f68aa
534 changed files with 7824 additions and 6681 deletions

View File

@ -10,77 +10,38 @@ The following tables provide a comprehensive list of the Bare metal
service configuration options.
.. include:: tables/ironic-agent.rst
.. include:: tables/ironic-amqp.rst
.. include:: tables/ironic-amt.rst
.. include:: tables/ironic-api.rst
.. include:: tables/ironic-auth_token.rst
.. include:: tables/ironic-auth.rst
.. include:: tables/ironic-cisco_ucs.rst
.. include:: tables/ironic-common.rst
.. include:: tables/ironic-conductor.rst
.. include:: tables/ironic-console.rst
.. include:: tables/ironic-database.rst
.. include:: tables/ironic-debug.rst
.. include:: tables/ironic-deploy.rst
.. include:: tables/ironic-dhcp.rst
.. include:: tables/ironic-disk_partitioner.rst
.. include:: tables/ironic-drac.rst
.. include:: tables/ironic-glance.rst
.. include:: tables/ironic-iboot.rst
.. include:: tables/ironic-ilo.rst
.. include:: tables/ironic-inspector.rst
.. include:: tables/ironic-ipmi.rst
.. include:: tables/ironic-irmc.rst
.. include:: tables/ironic-keystone.rst
.. include:: tables/ironic-logging.rst
.. include:: tables/ironic-neutron.rst
.. include:: tables/ironic-policy.rst
.. include:: tables/ironic-pxe.rst
.. include:: tables/ironic-redis.rst
.. include:: tables/ironic-rpc.rst
.. include:: tables/ironic-rabbitmq.rst
.. include:: tables/ironic-qpid.rst
.. include:: tables/ironic-seamicro.rst
.. include:: tables/ironic-snmp.rst
.. include:: tables/ironic-ssh.rst
.. include:: tables/ironic-swift.rst
.. include:: tables/ironic-virtualbox.rst
.. include:: tables/ironic-zeromq.rst
.. include:: tables/conf-changes/ironic.rst

View File

@ -40,12 +40,6 @@ described in this section.
Brocade Fibre Channel Zone Driver
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Brocade Fibre Channel Zone Driver performs zoning operations through
SSH. Configure Brocade Zone Driver and lookup service by specifying the
following parameters:
.. include:: ../tables/cinder-zoning_manager.rst
Configure SAN fabric parameters in the form of fabric groups as
described in the example below:

View File

@ -7,103 +7,54 @@ OpenStack Compute service, run
:command:`bin/nova-<servicename>` ``--help``.
.. include:: ../tables/nova-api.rst
.. include:: ../tables/nova-apiv21.rst
.. include:: ../tables/nova-authentication.rst
.. include:: ../tables/nova-auth_token.rst
.. include:: ../tables/nova-availabilityzones.rst
.. include:: ../tables/nova-barbican.rst
.. include:: ../tables/nova-ca.rst
.. include:: ../tables/nova-cache.rst
.. include:: ../tables/nova-cells.rst
.. include:: ../tables/nova-common.rst
.. include:: ../tables/nova-compute.rst
.. include:: ../tables/nova-conductor.rst
.. include:: ../tables/nova-configdrive.rst
.. include:: ../tables/nova-console.rst
.. include:: ../tables/nova-cors.rst
.. include:: ../tables/nova-database.rst
.. include:: ../tables/nova-debug.rst
.. include:: ../tables/nova-ephemeral_storage_encryption.rst
.. include:: ../tables/nova-fping.rst
.. include:: ../tables/nova-glance.rst
.. include:: ../tables/nova-hyperv.rst
.. include:: ../tables/nova-hypervisor.rst
.. include:: ../tables/nova-ironic.rst
.. include:: ../tables/nova-ipv6.rst
.. include:: ../tables/nova-keymgr.rst
.. include:: ../tables/nova-ldap.rst
.. include:: ../tables/nova-libvirt.rst
.. include:: ../tables/nova-livemigration.rst
.. include:: ../tables/nova-logging.rst
.. include:: ../tables/nova-metadata.rst
.. include:: ../tables/nova-network.rst
.. include:: ../tables/nova-neutron.rst
.. include:: ../tables/nova-pci.rst
.. include:: ../tables/nova-periodic.rst
.. include:: ../tables/nova-policy.rst
.. include:: ../tables/nova-quobyte.rst
.. include:: ../tables/nova-quota.rst
.. include:: ../tables/nova-rdp.rst
.. include:: ../tables/nova-redis.rst
.. include:: ../tables/nova-s3.rst
.. include:: ../tables/nova-scheduler.rst
.. include:: ../tables/nova-serial_console.rst
.. include:: ../tables/nova-spice.rst
.. include:: ../tables/nova-testing.rst
.. include:: ../tables/nova-trustedcomputing.rst
.. include:: ../tables/nova-upgrade_levels.rst
.. include:: ../tables/nova-varmour.rst
.. include:: ../tables/nova-vmware.rst
.. include:: ../tables/nova-vnc.rst
.. include:: ../tables/nova-volumes.rst
.. include:: ../tables/nova-vpn.rst
.. include:: ../tables/nova-xen.rst

View File

@ -23,9 +23,9 @@ service configuration options:
.. include:: tables/sahara-logging.rst
.. include:: tables/sahara-object_store_access.rst
.. include:: tables/sahara-policy.rst
.. include:: tables/sahara-qpid.rst
.. include:: tables/sahara-rabbitmq.rst
.. include:: tables/sahara-redis.rst
.. include:: tables/sahara-rpc.rst
.. include:: tables/sahara-timeouts.rst
.. include:: tables/sahara-varmour.rst
.. include:: tables/sahara-zeromq.rst

View File

@ -35,4 +35,5 @@ configuration options.
.. include:: tables/trove-swift.rst
.. include:: tables/trove-taskmanager.rst
.. include:: tables/trove-upgrades.rst
.. include:: tables/trove-varmour.rst
.. include:: tables/trove-volume.rst

View File

@ -7,6 +7,7 @@ Use the options to configure the used databases:
.. include:: ../tables/trove-database.rst
.. include:: ../tables/trove-db_cassandra.rst
.. include:: ../tables/trove-db_couchbase.rst
.. include:: ../tables/trove-db_couchdb.rst
.. include:: ../tables/trove-db_db2.rst
.. include:: ../tables/trove-db_mariadb.rst
.. include:: ../tables/trove-db_mongodb.rst

View File

@ -5,7 +5,7 @@ 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. OpenStack Trove RPC
supports three implementations of AMQP: RabbitMQ, Qpid, and ZeroMQ.
supports two implementations of AMQP: RabbitMQ and ZeroMQ.
Configure RabbitMQ
~~~~~~~~~~~~~~~~~~
@ -15,14 +15,6 @@ in the ``trove.conf`` file:
.. include:: ../tables/trove-rabbitmq.rst
Configure Qpid
~~~~~~~~~~~~~~
Use these options to configure the Qpid messaging system
in the ``trove.conf`` file:
.. include:: ../tables/trove-qpid.rst
Configure ZeroMQ
~~~~~~~~~~~~~~~~

View File

@ -39,7 +39,6 @@ service options.
.. include:: ../tables/keystone-trust.rst
.. include:: ../tables/keystone-rpc.rst
.. include:: ../tables/keystone-amqp.rst
.. include:: ../tables/keystone-qpid.rst
.. include:: ../tables/keystone-rabbitmq.rst
.. include:: ../tables/keystone-zeromq.rst
.. include:: ../tables/keystone-redis.rst

View File

@ -17,6 +17,7 @@ The following tables detail the options available for each.
.. include:: ../tables/glance-cinder.rst
.. include:: ../tables/glance-filesystem.rst
.. include:: ../tables/glance-http.rst
.. include:: ../tables/glance-rbd.rst
.. include:: ../tables/glance-s3.rst
.. include:: ../tables/glance-sheepdog.rst

View File

@ -16,4 +16,3 @@ in the ``glance-api.conf`` and ``glance-registry.conf`` files:
.. include:: ../tables/glance-amqp.rst
.. include:: ../tables/glance-rpc.rst
.. include:: ../tables/glance-rabbitmq.rst
.. include:: ../tables/glance-qpid.rst

View File

@ -24,11 +24,6 @@ L2-in-L3 tunneling or OpenFlow. These sections
detail the configuration options for the various
plug-ins.
Brocade configuration options
-----------------------------
.. include:: ../tables/neutron-brocade.rst
CISCO configuration options
---------------------------
@ -128,11 +123,6 @@ Modular Layer 2 (ml2) VXLAN Type configuration options
.. include:: ../tables/neutron-ml2_vxlan.rst
Modular Layer 2 (ml2) Brocade Mechanism configuration options
-------------------------------------------------------------
.. include:: ../tables/neutron-ml2_brocade.rst
Modular Layer 2 (ml2) Geneve Mechanism configuration options
-------------------------------------------------------------
@ -455,3 +445,9 @@ change security group settings.
security group. The migration that introduces this table has a
sanity check that verifies if a default security group is not
duplicated in any tenant.
Misc
~~~~
.. include:: ../tables/neutron-bgp.rst
.. include:: ../tables/neutron-qos.rst

View File

@ -5,7 +5,7 @@ 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. OpenStack Oslo RPC
supports three implementations of AMQP: RabbitMQ, Qpid, and ZeroMQ.
supports two implementations of AMQP: RabbitMQ and ZeroMQ.
Configure RabbitMQ
@ -31,58 +31,6 @@ file.
.. include:: ../tables/heat-rabbitmq.rst
Configure Qpid
~~~~~~~~~~~~~~
Use these options to configure the Qpid messaging system for OpenStack
Oslo RPC. Qpid is not the default messaging system, so you must enable
it by setting the ``rpc_backend`` option in the ``heat.conf`` file:
.. code-block:: ini
rpc_backend = heat.openstack.common.rpc.impl_qpid
This critical option points the compute nodes to the Qpid broker
(server). Set the ``qpid_hostname`` option to the host name where the
broker runs in the ``heat.conf`` file.
.. note::
The ``qpid_hostname`` option accepts a host name or IP address
value.
.. code-block:: ini
qpid_hostname = hostname.example.com
If the Qpid broker listens on a port other than the AMQP default of 5672,
you must set the ``qpid_port`` option to that value:
.. code-block:: ini
qpid_port = 12345
If you configure the Qpid broker to require authentication, you must
add a user name and password to the configuration:
.. code-block:: ini
qpid_username = username
qpid_password = password
By default, TCP is used as the transport. To enable SSL, set
the ``qpid_protocol`` option:
.. code-block:: ini
qpid_protocol = ssl
Use these additional options to configure the Qpid messaging
driver for OpenStack Oslo RPC. These options are used
infrequently in the ``heat.conf`` file.
.. include:: ../tables/heat-qpid.rst
Configure ZeroMQ
~~~~~~~~~~~~~~~~

View File

@ -8,16 +8,21 @@ These options can also be set in the ``manila.conf`` file.
.. include:: ../tables/manila-auth_token.rst
.. include:: ../tables/manila-auth.rst
.. include:: ../tables/manila-ca.rst
.. include:: ../tables/manila-cephfs.rst
.. include:: ../tables/manila-common.rst
.. include:: ../tables/manila-compute.rst
.. include:: ../tables/manila-cors.rst
.. include:: ../tables/manila-database.rst
.. include:: ../tables/manila-ganesha.rst
.. include:: ../tables/manila-hnas.rst
.. include:: ../tables/manila-logging.rst
.. include:: ../tables/manila-lvm.rst
.. include:: ../tables/manila-quota.rst
.. include:: ../tables/manila-redis.rst
.. include:: ../tables/manila-san.rst
.. include:: ../tables/manila-scheduler.rst
.. include:: ../tables/manila-share.rst
.. include:: ../tables/manila-tegile.rst
.. include:: ../tables/manila-winrm.rst
.. include:: ../tables/manila-zfs.rst
.. include:: ../tables/manila-zfssa.rst

View File

@ -14,5 +14,4 @@ middleware for the Shared File System service:
.. include:: ../tables/manila-amqp.rst
.. include:: ../tables/manila-rpc.rst
.. include:: ../tables/manila-rabbitmq.rst
.. include:: ../tables/manila-qpid.rst
.. include:: ../tables/manila-zeromq.rst

View File

@ -19,8 +19,8 @@
* - **[DEFAULT]**
-
* - ``control_exchange`` = ``openstack``
- (StrOpt) The default exchange under which topics are scoped. May be overridden by an exchange name specified in the transport_url option.
- (String) The default exchange under which topics are scoped. May be overridden by an exchange name specified in the transport_url option.
* - ``ipc_protocol`` = ``queue``
- (StrOpt) The protocol used to communicate between evaluator and notifier services.
- (String) The protocol used to communicate between evaluator and notifier services.
* - ``transport_url`` = ``None``
- (StrOpt) 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. If not set, we fall back to the rpc_backend option and driver specific configuration.

View File

@ -19,18 +19,18 @@
* - **[api]**
-
* - ``host`` = ``0.0.0.0``
- (StrOpt) The listen IP for the aodh API server.
- (String) The listen IP for the aodh API server.
* - ``paste_config`` = ``api_paste.ini``
- (StrOpt) Configuration file for WSGI definition of API.
- (String) Configuration file for WSGI definition of API.
* - ``pecan_debug`` = ``False``
- (BoolOpt) Toggle Pecan Debug Middleware.
- (Boolean) Toggle Pecan Debug Middleware.
* - ``port`` = ``8042``
- (PortOpt) The port for the aodh API server.
- (Unknown) The port for the aodh API server.
* - ``workers`` = ``1``
- (IntOpt) Number of workers for aodh API server.
- (Integer) Number of workers for aodh API server.
* - **[oslo_middleware]**
-
* - ``max_request_body_size`` = ``114688``
- (IntOpt) The maximum body size for each request, in bytes.
- (Integer) The maximum body size for each request, in bytes.
* - ``secure_proxy_ssl_header`` = ``X-Forwarded-Proto``
- (StrOpt) 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 an SSL termination proxy.

View File

@ -1,44 +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.
.. _aodh-auth:
.. list-table:: Description of authorization configuration options
:header-rows: 1
:class: config-ref-table
* - Configuration option = Default value
- Description
* - **[service_credentials]**
-
* - ``insecure`` = ``False``
- (BoolOpt) Disables X.509 certificate validation when an SSL connection to Identity Service is established.
* - ``os_auth_url`` = ``http://localhost:5000/v2.0``
- (StrOpt) Auth URL to use for OpenStack service access.
* - ``os_cacert`` = ``None``
- (StrOpt) Certificate chain for SSL validation.
* - ``os_endpoint_type`` = ``publicURL``
- (StrOpt) Type of endpoint in Identity service catalog to use for communication with OpenStack services.
* - ``os_password`` = ``admin``
- (StrOpt) Password to use for OpenStack service access.
* - ``os_project_domain_id`` = ``default``
- (StrOpt) The domain id of the user project
* - ``os_project_name`` = ``admin``
- (StrOpt) The user project name
* - ``os_region_name`` = ``None``
- (StrOpt) Region name to use for OpenStack service endpoints.
* - ``os_tenant_id`` =
- (StrOpt) Tenant ID to use for OpenStack service access.
* - ``os_tenant_name`` = ``admin``
- (StrOpt) Tenant name to use for OpenStack service access.
* - ``os_user_domain_id`` = ``default``
- (StrOpt) The domain id of the user
* - ``os_username`` = ``aodh``
- (StrOpt) User name to use for OpenStack service access.

View File

@ -19,78 +19,78 @@
* - **[keystone_authtoken]**
-
* - ``admin_password`` = ``None``
- (StrOpt) Service user password.
- (String) Service user password.
* - ``admin_tenant_name`` = ``admin``
- (StrOpt) Service tenant name.
- (String) Service tenant name.
* - ``admin_token`` = ``None``
- (StrOpt) This option is deprecated and may be removed in a future release. Single shared secret with the Keystone configuration used for bootstrapping a Keystone installation, or otherwise bypassing the normal authentication process. This option should not be used, use `admin_user` and `admin_password` instead.
- (String) This option is deprecated and may be removed in a future release. Single shared secret with the Keystone configuration used for bootstrapping a Keystone installation, or otherwise bypassing the normal authentication process. This option should not be used, use `admin_user` and `admin_password` instead.
* - ``admin_user`` = ``None``
- (StrOpt) Service username.
- (String) Service username.
* - ``auth_admin_prefix`` =
- (StrOpt) Prefix to prepend at the beginning of the path. Deprecated, use identity_uri.
- (String) Prefix to prepend at the beginning of the path. Deprecated, use identity_uri.
* - ``auth_host`` = ``127.0.0.1``
- (StrOpt) Host providing the admin Identity API endpoint. Deprecated, use identity_uri.
- (String) Host providing the admin Identity API endpoint. Deprecated, use identity_uri.
* - ``auth_port`` = ``35357``
- (IntOpt) Port of the admin Identity API endpoint. Deprecated, use identity_uri.
- (Integer) Port of the admin Identity API endpoint. Deprecated, use identity_uri.
* - ``auth_protocol`` = ``https``
- (StrOpt) Protocol of the admin Identity API endpoint. Deprecated, use identity_uri.
- (String) Protocol of the admin Identity API endpoint. Deprecated, use identity_uri.
* - ``auth_section`` = ``None``
- (Opt) Config Section from which to load plugin specific options
- (Unknown) Config Section from which to load plugin specific options
* - ``auth_type`` = ``None``
- (Opt) Authentication type to load
- (Unknown) Authentication type to load
* - ``auth_uri`` = ``None``
- (StrOpt) Complete public Identity API endpoint.
- (String) Complete public Identity API endpoint.
* - ``auth_version`` = ``None``
- (StrOpt) API version of the admin Identity API endpoint.
- (String) API version of the admin Identity API endpoint.
* - ``cache`` = ``None``
- (StrOpt) Env key for the swift cache.
- (String) Env key for the swift cache.
* - ``cafile`` = ``None``
- (StrOpt) A PEM encoded Certificate Authority to use when verifying HTTPs connections. Defaults to system CAs.
- (String) A PEM encoded Certificate Authority to use when verifying HTTPs connections. Defaults to system CAs.
* - ``certfile`` = ``None``
- (StrOpt) Required if identity server requires client certificate
- (String) Required if identity server requires client certificate
* - ``check_revocations_for_cached`` = ``False``
- (BoolOpt) If true, the revocation list will be checked for cached tokens. This requires that PKI tokens are configured on the identity server.
- (Boolean) If true, the revocation list will be checked for cached tokens. This requires that PKI tokens are configured on the identity server.
* - ``delay_auth_decision`` = ``False``
- (BoolOpt) Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components.
- (Boolean) Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components.
* - ``enforce_token_bind`` = ``permissive``
- (StrOpt) Used to control the use and type of token binding. Can be set to: "disabled" to not check token binding. "permissive" (default) to validate binding information if the bind type is of a form known to the server and ignore it if not. "strict" like "permissive" but if the bind type is unknown the token will be rejected. "required" any form of token binding is needed to be allowed. Finally the name of a binding method that must be present in tokens.
- (String) Used to control the use and type of token binding. Can be set to: "disabled" to not check token binding. "permissive" (default) to validate binding information if the bind type is of a form known to the server and ignore it if not. "strict" like "permissive" but if the bind type is unknown the token will be rejected. "required" any form of token binding is needed to be allowed. Finally the name of a binding method that must be present in tokens.
* - ``hash_algorithms`` = ``md5``
- (ListOpt) Hash algorithms to use for hashing PKI tokens. This may be a single algorithm or multiple. The algorithms are those supported by Python standard hashlib.new(). The hashes will be tried in the order given, so put the preferred one first for performance. The result of the first hash will be stored in the cache. This will typically be set to multiple values only while migrating from a less secure algorithm to a more secure one. Once all the old tokens are expired this option should be set to a single value for better performance.
- (List) Hash algorithms to use for hashing PKI tokens. This may be a single algorithm or multiple. The algorithms are those supported by Python standard hashlib.new(). The hashes will be tried in the order given, so put the preferred one first for performance. The result of the first hash will be stored in the cache. This will typically be set to multiple values only while migrating from a less secure algorithm to a more secure one. Once all the old tokens are expired this option should be set to a single value for better performance.
* - ``http_connect_timeout`` = ``None``
- (IntOpt) Request timeout value for communicating with Identity API server.
- (Integer) Request timeout value for communicating with Identity API server.
* - ``http_request_max_retries`` = ``3``
- (IntOpt) How many times are we trying to reconnect when communicating with Identity API Server.
- (Integer) How many times are we trying to reconnect when communicating with Identity API Server.
* - ``identity_uri`` = ``None``
- (StrOpt) Complete admin Identity API endpoint. This should specify the unversioned root endpoint e.g. https://localhost:35357/
- (String) Complete admin Identity API endpoint. This should specify the unversioned root endpoint e.g. https://localhost:35357/
* - ``include_service_catalog`` = ``True``
- (BoolOpt) (Optional) Indicate whether to set the X-Service-Catalog header. If False, middleware will not ask for service catalog on token validation and will not set the X-Service-Catalog header.
- (Boolean) (Optional) Indicate whether to set the X-Service-Catalog header. If False, middleware will not ask for service catalog on token validation and will not set the X-Service-Catalog header.
* - ``insecure`` = ``False``
- (BoolOpt) Verify HTTPS connections.
- (Boolean) Verify HTTPS connections.
* - ``keyfile`` = ``None``
- (StrOpt) Required if identity server requires client certificate
- (String) Required if identity server requires client certificate
* - ``memcache_pool_conn_get_timeout`` = ``10``
- (IntOpt) (Optional) Number of seconds that an operation will wait to get a memcached client connection from the pool.
- (Integer) (Optional) Number of seconds that an operation will wait to get a memcached client connection from the pool.
* - ``memcache_pool_dead_retry`` = ``300``
- (IntOpt) (Optional) Number of seconds memcached server is considered dead before it is tried again.
- (Integer) (Optional) Number of seconds memcached server is considered dead before it is tried again.
* - ``memcache_pool_maxsize`` = ``10``
- (IntOpt) (Optional) Maximum total number of open connections to every memcached server.
- (Integer) (Optional) Maximum total number of open connections to every memcached server.
* - ``memcache_pool_socket_timeout`` = ``3``
- (IntOpt) (Optional) Socket timeout in seconds for communicating with a memcached server.
- (Integer) (Optional) Socket timeout in seconds for communicating with a memcached server.
* - ``memcache_pool_unused_timeout`` = ``60``
- (IntOpt) (Optional) Number of seconds a connection to memcached is held unused in the pool before it is closed.
- (Integer) (Optional) Number of seconds a connection to memcached is held unused in the pool before it is closed.
* - ``memcache_secret_key`` = ``None``
- (StrOpt) (Optional, mandatory if memcache_security_strategy is defined) This string is used for key derivation.
- (String) (Optional, mandatory if memcache_security_strategy is defined) This string is used for key derivation.
* - ``memcache_security_strategy`` = ``None``
- (StrOpt) (Optional) If defined, indicate whether token data should be authenticated or authenticated and encrypted. If MAC, token data is authenticated (with HMAC) in the cache. If ENCRYPT, token data is encrypted and authenticated in the cache. If the value is not one of these options or empty, auth_token will raise an exception on initialization.
- (String) (Optional) If defined, indicate whether token data should be authenticated or authenticated and encrypted. If MAC, token data is authenticated (with HMAC) in the cache. If ENCRYPT, token data is encrypted and authenticated in the cache. If the value is not one of these options or empty, auth_token will raise an exception on initialization.
* - ``memcache_use_advanced_pool`` = ``False``
- (BoolOpt) (Optional) Use the advanced (eventlet safe) memcached client pool. The advanced pool will only work under python 2.x.
- (Boolean) (Optional) Use the advanced (eventlet safe) memcached client pool. The advanced pool will only work under python 2.x.
* - ``memcached_servers`` = ``None``
- (ListOpt) Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process.
- (List) Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process.
* - ``region_name`` = ``None``
- (StrOpt) The region in which the identity server can be found.
- (String) The region in which the identity server can be found.
* - ``revocation_cache_time`` = ``10``
- (IntOpt) Determines the frequency at which the list of revoked tokens is retrieved from the Identity service (in seconds). A high number of revocation events combined with a low cache duration may significantly reduce performance.
- (Integer) Determines the frequency at which the list of revoked tokens is retrieved from the Identity service (in seconds). A high number of revocation events combined with a low cache duration may significantly reduce performance.
* - ``signing_dir`` = ``None``
- (StrOpt) Directory used to cache files related to PKI tokens.
- (String) Directory used to cache files related to PKI tokens.
* - ``token_cache_time`` = ``300``
- (IntOpt) In order to prevent excessive effort spent validating tokens, the middleware caches previously-seen tokens for a configurable duration (in seconds). Set to -1 to disable caching completely.
- (Integer) In order to prevent excessive effort spent validating tokens, the middleware caches previously-seen tokens for a configurable duration (in seconds). Set to -1 to disable caching completely.

View File

@ -19,44 +19,44 @@
* - **[DEFAULT]**
-
* - ``alarm_max_actions`` = ``-1``
- (IntOpt) Maximum count of actions for each state of an alarm, non-positive number means no limit.
- (Integer) Maximum count of actions for each state of an alarm, non-positive number means no limit.
* - ``evaluation_interval`` = ``60``
- (IntOpt) Period of evaluation cycle, should be >= than configured pipeline interval for collection of underlying meters.
- (Integer) Period of evaluation cycle, should be >= than configured pipeline interval for collection of underlying meters.
* - ``event_alarm_cache_ttl`` = ``60``
- (IntOpt) TTL of event alarm caches, in seconds. Set to 0 to disable caching.
- (Integer) TTL of event alarm caches, in seconds. Set to 0 to disable caching.
* - ``event_alarm_topic`` = ``alarm.all``
- (StrOpt) The topic that aodh uses for event alarm evaluation.
- (String) The topic that aodh uses for event alarm evaluation.
* - ``executor_thread_pool_size`` = ``64``
- (IntOpt) Size of executor thread pool.
- (Integer) Size of executor thread pool.
* - ``gnocchi_url`` = ``None``
- (StrOpt) URL to Gnocchi. default: autodetection
- (String) DEPRECATED: URL to Gnocchi. default: autodetection
* - ``host`` = ``localhost``
- (StrOpt) Name of this node, which must be valid in an AMQP key. Can be an opaque identifier. For ZeroMQ only, must be a valid host name, FQDN, or IP address.
- (String) Name of this node, which must be valid in an AMQP key. Can be an opaque identifier. For ZeroMQ only, must be a valid host name, FQDN, or IP address.
* - ``http_timeout`` = ``600``
- (IntOpt) Timeout seconds for HTTP requests. Set it to None to disable timeout.
- (Integer) Timeout seconds for HTTP requests. Set it to None to disable timeout.
* - ``memcached_servers`` = ``None``
- (ListOpt) Memcached servers or None for in process cache.
- (List) Memcached servers or None for in process cache.
* - ``notifier_rpc_topic`` = ``alarm_notifier``
- (StrOpt) The topic that aodh uses for alarm notifier messages.
- (String) The topic that aodh uses for alarm notifier messages.
* - ``notifier_topic`` = ``alarming``
- (StrOpt) The topic that aodh uses for alarm notifier messages.
- (String) The topic that aodh uses for alarm notifier messages.
* - ``project_alarm_quota`` = ``None``
- (IntOpt) Maximum number of alarms defined for a project.
- (Integer) Maximum number of alarms defined for a project.
* - ``record_history`` = ``True``
- (BoolOpt) Record alarm change events.
- (Boolean) Record alarm change events.
* - ``rest_notifier_certificate_file`` =
- (StrOpt) SSL Client certificate for REST notifier.
- (String) SSL Client certificate for REST notifier.
* - ``rest_notifier_certificate_key`` =
- (StrOpt) SSL Client private key for REST notifier.
- (String) SSL Client private key for REST notifier.
* - ``rest_notifier_max_retries`` = ``0``
- (IntOpt) Number of retries for REST notifier
- (Integer) Number of retries for REST notifier
* - ``rest_notifier_ssl_verify`` = ``True``
- (BoolOpt) Whether to verify the SSL Server certificate when calling alarm action.
- (Boolean) Whether to verify the SSL Server certificate when calling alarm action.
* - ``user_alarm_quota`` = ``None``
- (IntOpt) Maximum number of alarms defined for a user.
- (Integer) Maximum number of alarms defined for a user.
* - **[service_credentials]**
-
* - ``interface`` = ``public``
- (StrOpt) Type of endpoint in Identity service catalog to use for communication with OpenStack services.
- (String) Type of endpoint in Identity service catalog to use for communication with OpenStack services.
* - ``region_name`` = ``None``
- (StrOpt) Region name to use for OpenStack service endpoints.
- (String) Region name to use for OpenStack service endpoints.

View File

@ -19,8 +19,8 @@
* - **[coordination]**
-
* - ``backend_url`` = ``None``
- (StrOpt) The backend URL to use for distributed coordination. If left empty, per-deployment central agent and per-host compute agent won't do workload partitioning and will only function correctly if a single instance of that service is running.
- (String) The backend URL to use for distributed coordination. If left empty, per-deployment central agent and per-host compute agent won't do workload partitioning and will only function correctly if a single instance of that service is running.
* - ``check_watchers`` = ``10.0``
- (FloatOpt) Number of seconds between checks to see if group membership has changed
- (Floating point) Number of seconds between checks to see if group membership has changed
* - ``heartbeat`` = ``1.0``
- (FloatOpt) Number of seconds between heartbeats for distributed coordination.
- (Floating point) Number of seconds between heartbeats for distributed coordination.

View File

@ -19,28 +19,28 @@
* - **[cors]**
-
* - ``allow_credentials`` = ``True``
- (BoolOpt) Indicate that the actual request can include user credentials
- (Boolean) Indicate that the actual request can include user credentials
* - ``allow_headers`` = ``Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma``
- (ListOpt) Indicate which header field names may be used during the actual request.
- (List) Indicate which header field names may be used during the actual request.
* - ``allow_methods`` = ``GET, POST, PUT, DELETE, OPTIONS``
- (ListOpt) Indicate which methods can be used during the actual request.
- (List) Indicate which methods can be used during the actual request.
* - ``allowed_origin`` = ``None``
- (ListOpt) Indicate whether this resource may be shared with the domain received in the requests "origin" header.
- (List) Indicate whether this resource may be shared with the domain received in the requests "origin" header.
* - ``expose_headers`` = ``Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma``
- (ListOpt) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers.
- (List) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers.
* - ``max_age`` = ``3600``
- (IntOpt) Maximum cache age of CORS preflight requests.
- (Integer) Maximum cache age of CORS preflight requests.
* - **[cors.subdomain]**
-
* - ``allow_credentials`` = ``True``
- (BoolOpt) Indicate that the actual request can include user credentials
- (Boolean) Indicate that the actual request can include user credentials
* - ``allow_headers`` = ``Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma``
- (ListOpt) Indicate which header field names may be used during the actual request.
- (List) Indicate which header field names may be used during the actual request.
* - ``allow_methods`` = ``GET, POST, PUT, DELETE, OPTIONS``
- (ListOpt) Indicate which methods can be used during the actual request.
- (List) Indicate which methods can be used during the actual request.
* - ``allowed_origin`` = ``None``
- (ListOpt) Indicate whether this resource may be shared with the domain received in the requests "origin" header.
- (List) Indicate whether this resource may be shared with the domain received in the requests "origin" header.
* - ``expose_headers`` = ``Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma``
- (ListOpt) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers.
- (List) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers.
* - ``max_age`` = ``3600``
- (IntOpt) Maximum cache age of CORS preflight requests.
- (Integer) Maximum cache age of CORS preflight requests.

View File

@ -19,46 +19,46 @@
* - **[database]**
-
* - ``alarm_connection`` = ``None``
- (StrOpt) The connection string used to connect to the alarm database - rather use ${database.connection}
- (String) DEPRECATED: The connection string used to connect to the alarm database - rather use ${database.connection}
* - ``alarm_history_time_to_live`` = ``-1``
- (IntOpt) Number of seconds that alarm histories are kept in the database for (<= 0 means forever).
- (Integer) Number of seconds that alarm histories are kept in the database for (<= 0 means forever).
* - ``backend`` = ``sqlalchemy``
- (StrOpt) The back end to use for the database.
- (String) The back end to use for the database.
* - ``connection`` = ``None``
- (StrOpt) The SQLAlchemy connection string to use to connect to the database.
- (String) The SQLAlchemy connection string to use to connect to the database.
* - ``connection_debug`` = ``0``
- (IntOpt) Verbosity of SQL debugging information: 0=None, 100=Everything.
- (Integer) Verbosity of SQL debugging information: 0=None, 100=Everything.
* - ``connection_trace`` = ``False``
- (BoolOpt) Add Python stack traces to SQL as comment strings.
- (Boolean) Add Python stack traces to SQL as comment strings.
* - ``db_inc_retry_interval`` = ``True``
- (BoolOpt) If True, increases the interval between retries of a database operation up to db_max_retry_interval.
- (Boolean) If True, increases the interval between retries of a database operation up to db_max_retry_interval.
* - ``db_max_retries`` = ``20``
- (IntOpt) Maximum retries in case of connection error or deadlock error before error is raised. Set to -1 to specify an infinite retry count.
- (Integer) Maximum retries in case of connection error or deadlock error before error is raised. Set to -1 to specify an infinite retry count.
* - ``db_max_retry_interval`` = ``10``
- (IntOpt) If db_inc_retry_interval is set, the maximum seconds between retries of a database operation.
- (Integer) If db_inc_retry_interval is set, the maximum seconds between retries of a database operation.
* - ``db_retry_interval`` = ``1``
- (IntOpt) Seconds between retries of a database transaction.
- (Integer) Seconds between retries of a database transaction.
* - ``idle_timeout`` = ``3600``
- (IntOpt) Timeout before idle SQL connections are reaped.
* - ``max_overflow`` = ``None``
- (IntOpt) If set, use this value for max_overflow with SQLAlchemy.
- (Integer) Timeout before idle SQL connections are reaped.
* - ``max_overflow`` = ``50``
- (Integer) If set, use this value for max_overflow with SQLAlchemy.
* - ``max_pool_size`` = ``None``
- (IntOpt) Maximum number of SQL connections to keep open in a pool.
- (Integer) Maximum number of SQL connections to keep open in a pool.
* - ``max_retries`` = ``10``
- (IntOpt) Maximum number of database connection retries during startup. Set to -1 to specify an infinite retry count.
- (Integer) Maximum number of database connection retries during startup. Set to -1 to specify an infinite retry count.
* - ``min_pool_size`` = ``1``
- (IntOpt) Minimum number of SQL connections to keep open in a pool.
- (Integer) Minimum number of SQL connections to keep open in a pool.
* - ``mysql_sql_mode`` = ``TRADITIONAL``
- (StrOpt) The SQL mode to be used for MySQL sessions. This option, including the default, overrides any server-set SQL mode. To use whatever SQL mode is set by the server configuration, set this to no value. Example: mysql_sql_mode=
- (String) The SQL mode to be used for MySQL sessions. This option, including the default, overrides any server-set SQL mode. To use whatever SQL mode is set by the server configuration, set this to no value. Example: mysql_sql_mode=
* - ``pool_timeout`` = ``None``
- (IntOpt) If set, use this value for pool_timeout with SQLAlchemy.
- (Integer) If set, use this value for pool_timeout with SQLAlchemy.
* - ``retry_interval`` = ``10``
- (IntOpt) Interval between retries of opening a SQL connection.
- (Integer) Interval between retries of opening a SQL connection.
* - ``slave_connection`` = ``None``
- (StrOpt) The SQLAlchemy connection string to use to connect to the slave database.
- (String) The SQLAlchemy connection string to use to connect to the slave database.
* - ``sqlite_db`` = ``oslo.sqlite``
- (StrOpt) The file name to use with SQLite.
- (String) The file name to use with SQLite.
* - ``sqlite_synchronous`` = ``True``
- (BoolOpt) If True, SQLite uses synchronous mode.
- (Boolean) If True, SQLite uses synchronous mode.
* - ``use_db_reconnect`` = ``False``
- (BoolOpt) Enable the experimental use of database reconnect on connection lost.
- (Boolean) Enable the experimental use of database reconnect on connection lost.

View File

@ -19,44 +19,42 @@
* - **[DEFAULT]**
-
* - ``debug`` = ``False``
- (BoolOpt) If set to true, the logging level will be set to DEBUG instead of the default INFO level.
- (Boolean) If set to true, the logging level will be set to DEBUG instead of the default INFO level.
* - ``default_log_levels`` = ``amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, oslo.messaging=INFO, iso8601=WARN, requests.packages.urllib3.connectionpool=WARN, urllib3.connectionpool=WARN, websocket=WARN, requests.packages.urllib3.util.retry=WARN, urllib3.util.retry=WARN, keystonemiddleware=WARN, routes.middleware=WARN, stevedore=WARN, taskflow=WARN, keystoneauth=WARN, oslo.cache=INFO, dogpile.core.dogpile=INFO``
- (ListOpt) List of package logging levels in logger=LEVEL pairs. This option is ignored if log_config_append is set.
- (List) List of package logging levels in logger=LEVEL pairs. This option is ignored if log_config_append is set.
* - ``fatal_deprecations`` = ``False``
- (BoolOpt) Enables or disables fatal status of deprecations.
- (Boolean) Enables or disables fatal status of deprecations.
* - ``instance_format`` = ``"[instance: %(uuid)s] "``
- (StrOpt) The format for an instance that is passed with the log message.
- (String) The format for an instance that is passed with the log message.
* - ``instance_uuid_format`` = ``"[instance: %(uuid)s] "``
- (StrOpt) The format for an instance UUID that is passed with the log message.
- (String) The format for an instance UUID that is passed with the log message.
* - ``log_config_append`` = ``None``
- (StrOpt) The name of a logging configuration file. This file is appended to any existing logging configuration files. For details about logging configuration files, see the Python logging module documentation. Note that when logging configuration files are used then all logging configuration is set in the configuration file and other logging configuration options are ignored (for example, logging_context_format_string).
- (String) The name of a logging configuration file. This file is appended to any existing logging configuration files. For details about logging configuration files, see the Python logging module documentation. Note that when logging configuration files are used then all logging configuration is set in the configuration file and other logging configuration options are ignored (for example, logging_context_format_string).
* - ``log_date_format`` = ``%Y-%m-%d %H:%M:%S``
- (StrOpt) Defines the format string for %%(asctime)s in log records. Default: %(default)s . This option is ignored if log_config_append is set.
- (String) Defines the format string for %%(asctime)s in log records. Default: %(default)s . This option is ignored if log_config_append is set.
* - ``log_dir`` = ``None``
- (StrOpt) (Optional) The base directory used for relative log_file paths. This option is ignored if log_config_append is set.
- (String) (Optional) The base directory used for relative log_file paths. This option is ignored if log_config_append is set.
* - ``log_file`` = ``None``
- (StrOpt) (Optional) Name of log file to send logging output to. If no default is set, logging will go to stderr as defined by use_stderr. This option is ignored if log_config_append is set.
- (String) (Optional) Name of log file to send logging output to. If no default is set, logging will go to stderr as defined by use_stderr. This option is ignored if log_config_append is set.
* - ``logging_context_format_string`` = ``%(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s``
- (StrOpt) Format string to use for log messages with context.
- (String) Format string to use for log messages with context.
* - ``logging_debug_format_suffix`` = ``%(funcName)s %(pathname)s:%(lineno)d``
- (StrOpt) Additional data to append to log message when logging level for the message is DEBUG.
- (String) Additional data to append to log message when logging level for the message is DEBUG.
* - ``logging_default_format_string`` = ``%(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s``
- (StrOpt) Format string to use for log messages when context is undefined.
- (String) Format string to use for log messages when context is undefined.
* - ``logging_exception_prefix`` = ``%(asctime)s.%(msecs)03d %(process)d ERROR %(name)s %(instance)s``
- (StrOpt) Prefix each line of exception output with this format.
- (String) Prefix each line of exception output with this format.
* - ``logging_user_identity_format`` = ``%(user)s %(tenant)s %(domain)s %(user_domain)s %(project_domain)s``
- (StrOpt) Defines the format string for %(user_identity)s that is used in logging_context_format_string.
- (String) Defines the format string for %(user_identity)s that is used in logging_context_format_string.
* - ``publish_errors`` = ``False``
- (BoolOpt) Enables or disables publication of error events.
- (Boolean) Enables or disables publication of error events.
* - ``syslog_log_facility`` = ``LOG_USER``
- (StrOpt) Syslog facility to receive log lines. This option is ignored if log_config_append is set.
- (String) Syslog facility to receive log lines. This option is ignored if log_config_append is set.
* - ``use_stderr`` = ``True``
- (BoolOpt) Log output to standard error. This option is ignored if log_config_append is set.
- (Boolean) Log output to standard error. This option is ignored if log_config_append is set.
* - ``use_syslog`` = ``False``
- (BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED and will be changed later to honor RFC5424. This option is ignored if log_config_append is set.
* - ``use_syslog_rfc_format`` = ``True``
- (BoolOpt) Enables or disables syslog rfc5424 format for logging. If enabled, prefixes the MSG part of the syslog message with APP-NAME (RFC5424). This option is ignored if log_config_append is set.
- (Boolean) Use syslog for logging. Existing syslog format is DEPRECATED and will be changed later to honor RFC5424. This option is ignored if log_config_append is set.
* - ``verbose`` = ``True``
- (BoolOpt) If set to false, the logging level will be set to WARNING instead of the default INFO level.
- (Boolean) DEPRECATED: If set to false, the logging level will be set to WARNING instead of the default INFO level.
* - ``watch_log_file`` = ``False``
- (BoolOpt) Uses logging handler designed to watch file system. When log file is moved or removed this handler will open a new log file with specified path instantaneously. It makes sense only if log_file option is specified and Linux platform is used. This option is ignored if log_config_append is set.
- (Boolean) Uses logging handler designed to watch file system. When log file is moved or removed this handler will open a new log file with specified path instantaneously. It makes sense only if log_file option is specified and Linux platform is used. This option is ignored if log_config_append is set.

View File

@ -19,8 +19,8 @@
* - **[oslo_policy]**
-
* - ``policy_default_rule`` = ``default``
- (StrOpt) Default rule. Enforced when a requested rule is not found.
- (String) Default rule. Enforced when a requested rule is not found.
* - ``policy_dirs`` = ``['policy.d']``
- (MultiStrOpt) Directories where policy configuration files are stored. They can be relative to any directory in the search path defined by the config_dir option, or absolute paths. The file defined by policy_file must exist for these directories to be searched. Missing or empty directories are ignored.
- (Multi-valued) Directories where policy configuration files are stored. They can be relative to any directory in the search path defined by the config_dir option, or absolute paths. The file defined by policy_file must exist for these directories to be searched. Missing or empty directories are ignored.
* - ``policy_file`` = ``policy.json``
- (StrOpt) The JSON file that defines policies.
- (String) The JSON file that defines policies.

View File

@ -1,48 +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.
.. _aodh-qpid:
.. list-table:: Description of Qpid configuration options
:header-rows: 1
:class: config-ref-table
* - Configuration option = Default value
- Description
* - **[oslo_messaging_qpid]**
-
* - ``amqp_auto_delete`` = ``False``
- (BoolOpt) Auto-delete queues in AMQP.
* - ``amqp_durable_queues`` = ``False``
- (BoolOpt) Use durable queues in AMQP.
* - ``qpid_heartbeat`` = ``60``
- (IntOpt) Seconds between connection keepalive heartbeats.
* - ``qpid_hostname`` = ``localhost``
- (StrOpt) Qpid broker hostname.
* - ``qpid_hosts`` = ``$qpid_hostname:$qpid_port``
- (ListOpt) Qpid HA cluster host:port pairs.
* - ``qpid_password`` =
- (StrOpt) Password for Qpid connection.
* - ``qpid_port`` = ``5672``
- (IntOpt) Qpid broker port.
* - ``qpid_protocol`` = ``tcp``
- (StrOpt) Transport to use, either 'tcp' or 'ssl'.
* - ``qpid_receiver_capacity`` = ``1``
- (IntOpt) The number of prefetched messages held by receiver.
* - ``qpid_sasl_mechanisms`` =
- (StrOpt) Space separated list of SASL mechanisms to use for auth.
* - ``qpid_tcp_nodelay`` = ``True``
- (BoolOpt) Whether to disable the Nagle algorithm.
* - ``qpid_topology_version`` = ``1``
- (IntOpt) The qpid topology version to use. Version 1 is what was originally used by impl_qpid. Version 2 includes some backwards-incompatible changes that allow broker federation to work. Users should update to version 2 when they are able to take everything down, as it requires a clean break.
* - ``qpid_username`` =
- (StrOpt) Username for Qpid connection.
* - ``send_single_reply`` = ``False``
- (BoolOpt) Send a single AMQP reply to call message. The current behaviour since oslo-incubator is to send two AMQP replies - first one with the payload, a second one to ensure the other have finish to send the payload. We are going to remove it in the N release, but we must keep backward compatible at the same time. This option provides such compatibility - it defaults to False in Liberty and can be turned on for early adopters with a new installations or for testing. Please note, that this option will be removed in the Mitaka release.

View File

@ -19,58 +19,90 @@
* - **[oslo_messaging_rabbit]**
-
* - ``amqp_auto_delete`` = ``False``
- (BoolOpt) Auto-delete queues in AMQP.
- (Boolean) Auto-delete queues in AMQP.
* - ``amqp_durable_queues`` = ``False``
- (BoolOpt) Use durable queues in AMQP.
- (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``
- (BoolOpt) Deprecated, use rpc_backend=kombu+memory or rpc_backend=fake
- (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``
- (IntOpt) How often times during the heartbeat_timeout_threshold we check the heartbeat.
- (Integer) How often times during the heartbeat_timeout_threshold we check the heartbeat.
* - ``heartbeat_timeout_threshold`` = ``60``
- (IntOpt) Number of seconds after which the Rabbit broker is considered down if heartbeat's keep-alive fails (0 disable the heartbeat). EXPERIMENTAL
- (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``
- (StrOpt) EXPERIMENTAL: Possible values are: gzip, bz2. If not set compression will not be used. This option may notbe available in future versions.
- (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``
- (StrOpt) 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.
- (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``
- (IntOpt) How long to wait a missing client beforce abandoning to send it its replies. This value should not be longer than rpc_response_timeout.
- (Integer) How long to wait a missing client beforce abandoning to send it its replies. This value should not be longer than rpc_response_timeout.
* - ``kombu_reconnect_delay`` = ``1.0``
- (FloatOpt) How long to wait before reconnecting in response to an AMQP consumer cancel notification.
- (Floating point) How long to wait before reconnecting in response to an AMQP consumer cancel notification.
* - ``kombu_ssl_ca_certs`` =
- (StrOpt) SSL certification authority file (valid only if SSL enabled).
- (String) SSL certification authority file (valid only if SSL enabled).
* - ``kombu_ssl_certfile`` =
- (StrOpt) SSL cert file (valid only if SSL enabled).
- (String) SSL cert file (valid only if SSL enabled).
* - ``kombu_ssl_keyfile`` =
- (StrOpt) SSL key file (valid only if SSL enabled).
- (String) SSL key file (valid only if SSL enabled).
* - ``kombu_ssl_version`` =
- (StrOpt) 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.
- (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``
- (BoolOpt) Use HA queues in RabbitMQ (x-ha-policy: all). If you change this option, you must wipe the RabbitMQ database.
- (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``
- (StrOpt) The RabbitMQ broker address where a single node is used.
- (String) The RabbitMQ broker address where a single node is used.
* - ``rabbit_hosts`` = ``$rabbit_host:$rabbit_port``
- (ListOpt) RabbitMQ HA cluster host:port pairs.
- (List) RabbitMQ HA cluster host:port pairs.
* - ``rabbit_interval_max`` = ``30``
- (IntOpt) Maximum interval of RabbitMQ connection retries. Default is 30 seconds.
- (Integer) Maximum interval of RabbitMQ connection retries. Default is 30 seconds.
* - ``rabbit_login_method`` = ``AMQPLAIN``
- (StrOpt) The RabbitMQ login method.
- (String) The RabbitMQ login method.
* - ``rabbit_max_retries`` = ``0``
- (IntOpt) Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry count).
- (Integer) Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry count).
* - ``rabbit_password`` = ``guest``
- (StrOpt) The RabbitMQ password.
- (String) The RabbitMQ password.
* - ``rabbit_port`` = ``5672``
- (PortOpt) The RabbitMQ broker port where a single node is used.
- (Unknown) The RabbitMQ broker port where a single node is used.
* - ``rabbit_qos_prefetch_count`` = ``0``
- (IntOpt) Specifies the number of messages to prefetch. Setting to zero allows unlimited messages.
- (Integer) Specifies the number of messages to prefetch. Setting to zero allows unlimited messages.
* - ``rabbit_retry_backoff`` = ``2``
- (IntOpt) How long to backoff for between retries when connecting to RabbitMQ.
- (Integer) How long to backoff for between retries when connecting to RabbitMQ.
* - ``rabbit_retry_interval`` = ``1``
- (IntOpt) How frequently to retry connecting with RabbitMQ.
* - ``rabbit_transient_queues_ttl`` = ``600``
- (IntOpt) 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.
- (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``
- (BoolOpt) Connect over SSL for RabbitMQ.
- (Boolean) Connect over SSL for RabbitMQ.
* - ``rabbit_userid`` = ``guest``
- (StrOpt) The RabbitMQ userid.
- (String) The RabbitMQ userid.
* - ``rabbit_virtual_host`` = ``/``
- (StrOpt) The RabbitMQ virtual host.
- (String) The RabbitMQ virtual host.

View File

@ -19,18 +19,18 @@
* - **[matchmaker_redis]**
-
* - ``check_timeout`` = ``20000``
- (IntOpt) Time in ms to wait before the transaction is killed.
- (Integer) Time in ms to wait before the transaction is killed.
* - ``host`` = ``127.0.0.1``
- (StrOpt) Host to locate redis.
- (String) Host to locate redis.
* - ``password`` =
- (StrOpt) Password for Redis server (optional).
- (String) Password for Redis server (optional).
* - ``port`` = ``6379``
- (PortOpt) Use this port to connect to redis host.
- (Unknown) Use this port to connect to redis host.
* - ``sentinel_group_name`` = ``oslo-messaging-zeromq``
- (StrOpt) Redis replica set name.
- (String) Redis replica set name.
* - ``sentinel_hosts`` =
- (ListOpt) List of Redis Sentinel hosts (fault tolerance mode) e.g. [host:port, host1:port ... ]
- (List) List of Redis Sentinel hosts (fault tolerance mode) e.g. [host:port, host1:port ... ]
* - ``socket_timeout`` = ``1000``
- (IntOpt) Timeout in ms on blocking socket operations
- (Integer) Timeout in ms on blocking socket operations
* - ``wait_timeout`` = ``500``
- (IntOpt) Time in ms to wait between connection attempts.
- (Integer) Time in ms to wait between connection attempts.

View File

@ -19,54 +19,78 @@
* - **[DEFAULT]**
-
* - ``rpc_backend`` = ``rabbit``
- (StrOpt) The messaging driver to use, defaults to rabbit. Other drivers include amqp and zmq.
- (String) The messaging driver to use, defaults to rabbit. Other drivers include amqp and zmq.
* - ``rpc_cast_timeout`` = ``-1``
- (IntOpt) 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.
- (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``
- (IntOpt) Size of RPC connection pool.
- (Integer) Size of RPC connection pool.
* - ``rpc_poll_timeout`` = ``1``
- (IntOpt) The default number of seconds that poll should wait. Poll raises timeout exception when timeout expired.
- (Integer) The default number of seconds that poll should wait. Poll raises timeout exception when timeout expired.
* - ``rpc_response_timeout`` = ``60``
- (IntOpt) Seconds to wait for a response from a call.
- (Integer) Seconds to wait for a response from a call.
* - **[oslo_messaging_amqp]**
-
* - ``allow_insecure_clients`` = ``False``
- (BoolOpt) Accept clients using either SSL or plain TCP
- (Boolean) Accept clients using either SSL or plain TCP
* - ``broadcast_prefix`` = ``broadcast``
- (StrOpt) address prefix used when broadcasting to all servers
- (String) address prefix used when broadcasting to all servers
* - ``container_name`` = ``None``
- (StrOpt) Name for the AMQP container
- (String) Name for the AMQP container
* - ``group_request_prefix`` = ``unicast``
- (StrOpt) address prefix when sending to any server in group
- (String) address prefix when sending to any server in group
* - ``idle_timeout`` = ``0``
- (IntOpt) Timeout for inactive connections (in seconds)
- (Integer) Timeout for inactive connections (in seconds)
* - ``password`` =
- (StrOpt) Password for message broker authentication
- (String) Password for message broker authentication
* - ``sasl_config_dir`` =
- (StrOpt) Path to directory that contains the SASL configuration
- (String) Path to directory that contains the SASL configuration
* - ``sasl_config_name`` =
- (StrOpt) Name of configuration file (without .conf suffix)
- (String) Name of configuration file (without .conf suffix)
* - ``sasl_mechanisms`` =
- (StrOpt) Space separated list of acceptable SASL mechanisms
- (String) Space separated list of acceptable SASL mechanisms
* - ``server_request_prefix`` = ``exclusive``
- (StrOpt) address prefix used when sending to a specific server
- (String) address prefix used when sending to a specific server
* - ``ssl_ca_file`` =
- (StrOpt) CA certificate PEM file to verify server certificate
- (String) CA certificate PEM file to verify server certificate
* - ``ssl_cert_file`` =
- (StrOpt) Identifying certificate PEM file to present to clients
- (String) Identifying certificate PEM file to present to clients
* - ``ssl_key_file`` =
- (StrOpt) Private key PEM file used to sign cert_file certificate
- (String) Private key PEM file used to sign cert_file certificate
* - ``ssl_key_password`` = ``None``
- (StrOpt) Password for decrypting ssl_key_file (if encrypted)
- (String) Password for decrypting ssl_key_file (if encrypted)
* - ``trace`` = ``False``
- (BoolOpt) Debug: dump AMQP frames to stdout
- (Boolean) Debug: dump AMQP frames to stdout
* - ``username`` =
- (StrOpt) User name for message broker authentication
- (String) User name for message broker authentication
* - **[oslo_messaging_notifications]**
-
* - ``driver`` = ``[]``
- (MultiStrOpt) The Drivers(s) to handle sending notifications. Possible values are messaging, messagingv2, routing, log, test, noop
- (Multi-valued) The Drivers(s) to handle sending notifications. Possible values are messaging, messagingv2, routing, log, test, noop
* - ``topics`` = ``notifications``
- (ListOpt) AMQP topic used for OpenStack notifications.
- (List) AMQP topic used for OpenStack notifications.
* - ``transport_url`` = ``None``
- (StrOpt) A URL representing the messaging driver to use for notifications. If not set, we fall back to the same configuration used for RPC.
- (String) A URL representing the messaging driver to use for notifications. If not set, we fall back to the same configuration used for RPC.
* - **[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

View File

@ -19,26 +19,26 @@
* - **[DEFAULT]**
-
* - ``rpc_zmq_bind_address`` = ``*``
- (StrOpt) ZeroMQ bind address. Should be a wildcard (*), an ethernet interface, or IP. The "host" option should point or resolve to this 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``
- (IntOpt) Number of retries to find free port number before fail with ZMQBindError.
- (Integer) Number of retries to find free port number before fail with ZMQBindError.
* - ``rpc_zmq_concurrency`` = ``eventlet``
- (StrOpt) Type of concurrency used. Either "native" or "eventlet"
- (String) Type of concurrency used. Either "native" or "eventlet"
* - ``rpc_zmq_contexts`` = ``1``
- (IntOpt) Number of ZeroMQ contexts, defaults to 1.
- (Integer) Number of ZeroMQ contexts, defaults to 1.
* - ``rpc_zmq_host`` = ``localhost``
- (StrOpt) Name of this node. Must be a valid hostname, FQDN, or IP address. Must match "host" option, if running Nova.
- (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``
- (StrOpt) Directory for holding IPC sockets.
- (String) Directory for holding IPC sockets.
* - ``rpc_zmq_matchmaker`` = ``redis``
- (StrOpt) MatchMaker driver.
- (String) MatchMaker driver.
* - ``rpc_zmq_max_port`` = ``65536``
- (IntOpt) Maximal port number for random ports range.
- (Integer) Maximal port number for random ports range.
* - ``rpc_zmq_min_port`` = ``49152``
- (PortOpt) Minimal port number for random ports range.
- (Unknown) Minimal port number for random ports range.
* - ``rpc_zmq_topic_backlog`` = ``None``
- (IntOpt) Maximum number of ingress messages to locally buffer per topic. Default is unlimited.
- (Integer) Maximum number of ingress messages to locally buffer per topic. Default is unlimited.
* - ``use_pub_sub`` = ``True``
- (BoolOpt) Use PUB/SUB pattern for fanout methods. PUB/SUB always uses proxy.
- (Boolean) Use PUB/SUB pattern for fanout methods. PUB/SUB always uses proxy.
* - ``zmq_target_expire`` = ``120``
- (IntOpt) Expiration timeout in seconds of a name service record about existing target ( < 0 means no timeout).
- (Integer) Expiration timeout in seconds of a name service record about existing target ( < 0 means no timeout).

View File

@ -19,6 +19,6 @@
* - **[DEFAULT]**
-
* - ``control_exchange`` = ``openstack``
- (StrOpt) The default exchange under which topics are scoped. May be overridden by an exchange name specified in the transport_url option.
- (String) The default exchange under which topics are scoped. May be overridden by an exchange name specified in the transport_url option.
* - ``transport_url`` = ``None``
- (StrOpt) 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. If not set, we fall back to the rpc_backend option and driver specific configuration.

View File

@ -19,44 +19,44 @@
* - **[DEFAULT]**
-
* - ``api_paste_config`` = ``api_paste.ini``
- (StrOpt) Configuration file for WSGI definition of API.
- (String) Configuration file for WSGI definition of API.
* - ``event_pipeline_cfg_file`` = ``event_pipeline.yaml``
- (StrOpt) Configuration file for event pipeline definition.
- (String) Configuration file for event pipeline definition.
* - ``pipeline_cfg_file`` = ``pipeline.yaml``
- (StrOpt) Configuration file for pipeline definition.
- (String) Configuration file for pipeline definition.
* - ``pipeline_polling_interval`` = ``20``
- (IntOpt) Polling interval for pipeline file configuration in seconds.
- (Integer) Polling interval for pipeline file configuration in seconds.
* - ``refresh_event_pipeline_cfg`` = ``False``
- (BoolOpt) Refresh Event Pipeline configuration on-the-fly.
- (Boolean) Refresh Event Pipeline configuration on-the-fly.
* - ``refresh_pipeline_cfg`` = ``False``
- (BoolOpt) Refresh Pipeline configuration on-the-fly.
- (Boolean) Refresh Pipeline configuration on-the-fly.
* - ``reserved_metadata_keys`` =
- (ListOpt) List of metadata keys reserved for metering use. And these keys are additional to the ones included in the namespace.
- (List) List of metadata keys reserved for metering use. And these keys are additional to the ones included in the namespace.
* - ``reserved_metadata_length`` = ``256``
- (IntOpt) Limit on length of reserved metadata values.
- (Integer) Limit on length of reserved metadata values.
* - ``reserved_metadata_namespace`` = ``metering.``
- (ListOpt) List of metadata prefixes reserved for metering use.
- (List) List of metadata prefixes reserved for metering use.
* - **[api]**
-
* - ``aodh_is_enabled`` = ``None``
- (BoolOpt) Set True to redirect alarms URLs to aodh. Default autodetection by querying keystone.
- (Boolean) Set True to redirect alarms URLs to aodh. Default autodetection by querying keystone.
* - ``aodh_url`` = ``None``
- (StrOpt) The endpoint of Aodh to redirect alarms URLs to Aodh API. Default autodetection by querying keystone.
- (String) The endpoint of Aodh to redirect alarms URLs to Aodh API. Default autodetection by querying keystone.
* - ``default_api_return_limit`` = ``100``
- (IntOpt) Default maximum number of items returned by API request.
- (Integer) Default maximum number of items returned by API request.
* - ``gnocchi_is_enabled`` = ``None``
- (BoolOpt) Set True to disable resource/meter/sample URLs. Default autodetection by querying keystone.
- (Boolean) Set True to disable resource/meter/sample URLs. Default autodetection by querying keystone.
* - ``host`` = ``0.0.0.0``
- (StrOpt) The listen IP for the ceilometer API server.
- (String) The listen IP for the ceilometer API server.
* - ``pecan_debug`` = ``False``
- (BoolOpt) Toggle Pecan Debug Middleware.
- (Boolean) Toggle Pecan Debug Middleware.
* - ``port`` = ``8777``
- (PortOpt) The port for the ceilometer API server.
- (Unknown) The port for the ceilometer API server.
* - ``workers`` = ``1``
- (IntOpt) Number of workers for api, default value is 1.
- (Integer) Number of workers for api, default value is 1.
* - **[oslo_middleware]**
-
* - ``max_request_body_size`` = ``114688``
- (IntOpt) The maximum body size for each request, in bytes.
- (Integer) The maximum body size for each request, in bytes.
* - ``secure_proxy_ssl_header`` = ``X-Forwarded-Proto``
- (StrOpt) 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 an SSL termination proxy.

View File

@ -19,20 +19,20 @@
* - **[service_credentials]**
-
* - ``auth_section`` = ``None``
- (Opt) Config Section from which to load plugin specific options
- (Unknown) Config Section from which to load plugin specific options
* - ``auth_type`` = ``None``
- (Opt) Authentication type to load
- (Unknown) Authentication type to load
* - ``cafile`` = ``None``
- (StrOpt) PEM encoded Certificate Authority to use when verifying HTTPs connections.
- (String) PEM encoded Certificate Authority to use when verifying HTTPs connections.
* - ``certfile`` = ``None``
- (StrOpt) PEM encoded client certificate cert file
- (String) PEM encoded client certificate cert file
* - ``insecure`` = ``False``
- (BoolOpt) Verify HTTPS connections.
- (Boolean) Verify HTTPS connections.
* - ``interface`` = ``public``
- (StrOpt) Type of endpoint in Identity service catalog to use for communication with OpenStack services.
- (String) Type of endpoint in Identity service catalog to use for communication with OpenStack services.
* - ``keyfile`` = ``None``
- (StrOpt) PEM encoded client certificate key file
- (String) PEM encoded client certificate key file
* - ``region_name`` = ``None``
- (StrOpt) Region name to use for OpenStack service endpoints.
- (String) Region name to use for OpenStack service endpoints.
* - ``timeout`` = ``None``
- (IntOpt) Timeout value for http requests
- (Integer) Timeout value for http requests

View File

@ -19,76 +19,76 @@
* - **[keystone_authtoken]**
-
* - ``admin_password`` = ``None``
- (StrOpt) Service user password.
- (String) Service user password.
* - ``admin_tenant_name`` = ``admin``
- (StrOpt) Service tenant name.
- (String) Service tenant name.
* - ``admin_token`` = ``None``
- (StrOpt) This option is deprecated and may be removed in a future release. Single shared secret with the Keystone configuration used for bootstrapping a Keystone installation, or otherwise bypassing the normal authentication process. This option should not be used, use `admin_user` and `admin_password` instead.
- (String) This option is deprecated and may be removed in a future release. Single shared secret with the Keystone configuration used for bootstrapping a Keystone installation, or otherwise bypassing the normal authentication process. This option should not be used, use `admin_user` and `admin_password` instead.
* - ``admin_user`` = ``None``
- (StrOpt) Service username.
- (String) Service username.
* - ``auth_admin_prefix`` =
- (StrOpt) Prefix to prepend at the beginning of the path. Deprecated, use identity_uri.
- (String) Prefix to prepend at the beginning of the path. Deprecated, use identity_uri.
* - ``auth_host`` = ``127.0.0.1``
- (StrOpt) Host providing the admin Identity API endpoint. Deprecated, use identity_uri.
- (String) Host providing the admin Identity API endpoint. Deprecated, use identity_uri.
* - ``auth_port`` = ``35357``
- (IntOpt) Port of the admin Identity API endpoint. Deprecated, use identity_uri.
- (Integer) Port of the admin Identity API endpoint. Deprecated, use identity_uri.
* - ``auth_protocol`` = ``https``
- (StrOpt) Protocol of the admin Identity API endpoint. Deprecated, use identity_uri.
- (String) Protocol of the admin Identity API endpoint. Deprecated, use identity_uri.
* - ``auth_section`` = ``None``
- (Opt) Config Section from which to load plugin specific options
- (Unknown) Config Section from which to load plugin specific options
* - ``auth_type`` = ``None``
- (Opt) Authentication type to load
- (Unknown) Authentication type to load
* - ``auth_uri`` = ``None``
- (StrOpt) Complete public Identity API endpoint.
- (String) Complete public Identity API endpoint.
* - ``auth_version`` = ``None``
- (StrOpt) API version of the admin Identity API endpoint.
- (String) API version of the admin Identity API endpoint.
* - ``cache`` = ``None``
- (StrOpt) Env key for the swift cache.
- (String) Env key for the swift cache.
* - ``cafile`` = ``None``
- (StrOpt) A PEM encoded Certificate Authority to use when verifying HTTPs connections. Defaults to system CAs.
- (String) A PEM encoded Certificate Authority to use when verifying HTTPs connections. Defaults to system CAs.
* - ``certfile`` = ``None``
- (StrOpt) Required if identity server requires client certificate
- (String) Required if identity server requires client certificate
* - ``check_revocations_for_cached`` = ``False``
- (BoolOpt) If true, the revocation list will be checked for cached tokens. This requires that PKI tokens are configured on the identity server.
- (Boolean) If true, the revocation list will be checked for cached tokens. This requires that PKI tokens are configured on the identity server.
* - ``delay_auth_decision`` = ``False``
- (BoolOpt) Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components.
- (Boolean) Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components.
* - ``enforce_token_bind`` = ``permissive``
- (StrOpt) Used to control the use and type of token binding. Can be set to: "disabled" to not check token binding. "permissive" (default) to validate binding information if the bind type is of a form known to the server and ignore it if not. "strict" like "permissive" but if the bind type is unknown the token will be rejected. "required" any form of token binding is needed to be allowed. Finally the name of a binding method that must be present in tokens.
- (String) Used to control the use and type of token binding. Can be set to: "disabled" to not check token binding. "permissive" (default) to validate binding information if the bind type is of a form known to the server and ignore it if not. "strict" like "permissive" but if the bind type is unknown the token will be rejected. "required" any form of token binding is needed to be allowed. Finally the name of a binding method that must be present in tokens.
* - ``hash_algorithms`` = ``md5``
- (ListOpt) Hash algorithms to use for hashing PKI tokens. This may be a single algorithm or multiple. The algorithms are those supported by Python standard hashlib.new(). The hashes will be tried in the order given, so put the preferred one first for performance. The result of the first hash will be stored in the cache. This will typically be set to multiple values only while migrating from a less secure algorithm to a more secure one. Once all the old tokens are expired this option should be set to a single value for better performance.
- (List) Hash algorithms to use for hashing PKI tokens. This may be a single algorithm or multiple. The algorithms are those supported by Python standard hashlib.new(). The hashes will be tried in the order given, so put the preferred one first for performance. The result of the first hash will be stored in the cache. This will typically be set to multiple values only while migrating from a less secure algorithm to a more secure one. Once all the old tokens are expired this option should be set to a single value for better performance.
* - ``http_connect_timeout`` = ``None``
- (IntOpt) Request timeout value for communicating with Identity API server.
- (Integer) Request timeout value for communicating with Identity API server.
* - ``http_request_max_retries`` = ``3``
- (IntOpt) How many times are we trying to reconnect when communicating with Identity API Server.
- (Integer) How many times are we trying to reconnect when communicating with Identity API Server.
* - ``identity_uri`` = ``None``
- (StrOpt) Complete admin Identity API endpoint. This should specify the unversioned root endpoint e.g. https://localhost:35357/
- (String) Complete admin Identity API endpoint. This should specify the unversioned root endpoint e.g. https://localhost:35357/
* - ``include_service_catalog`` = ``True``
- (BoolOpt) (Optional) Indicate whether to set the X-Service-Catalog header. If False, middleware will not ask for service catalog on token validation and will not set the X-Service-Catalog header.
- (Boolean) (Optional) Indicate whether to set the X-Service-Catalog header. If False, middleware will not ask for service catalog on token validation and will not set the X-Service-Catalog header.
* - ``insecure`` = ``False``
- (BoolOpt) Verify HTTPS connections.
- (Boolean) Verify HTTPS connections.
* - ``keyfile`` = ``None``
- (StrOpt) Required if identity server requires client certificate
- (String) Required if identity server requires client certificate
* - ``memcache_pool_conn_get_timeout`` = ``10``
- (IntOpt) (Optional) Number of seconds that an operation will wait to get a memcached client connection from the pool.
- (Integer) (Optional) Number of seconds that an operation will wait to get a memcached client connection from the pool.
* - ``memcache_pool_dead_retry`` = ``300``
- (IntOpt) (Optional) Number of seconds memcached server is considered dead before it is tried again.
- (Integer) (Optional) Number of seconds memcached server is considered dead before it is tried again.
* - ``memcache_pool_maxsize`` = ``10``
- (IntOpt) (Optional) Maximum total number of open connections to every memcached server.
- (Integer) (Optional) Maximum total number of open connections to every memcached server.
* - ``memcache_pool_socket_timeout`` = ``3``
- (IntOpt) (Optional) Socket timeout in seconds for communicating with a memcached server.
- (Integer) (Optional) Socket timeout in seconds for communicating with a memcached server.
* - ``memcache_pool_unused_timeout`` = ``60``
- (IntOpt) (Optional) Number of seconds a connection to memcached is held unused in the pool before it is closed.
- (Integer) (Optional) Number of seconds a connection to memcached is held unused in the pool before it is closed.
* - ``memcache_secret_key`` = ``None``
- (StrOpt) (Optional, mandatory if memcache_security_strategy is defined) This string is used for key derivation.
- (String) (Optional, mandatory if memcache_security_strategy is defined) This string is used for key derivation.
* - ``memcache_security_strategy`` = ``None``
- (StrOpt) (Optional) If defined, indicate whether token data should be authenticated or authenticated and encrypted. If MAC, token data is authenticated (with HMAC) in the cache. If ENCRYPT, token data is encrypted and authenticated in the cache. If the value is not one of these options or empty, auth_token will raise an exception on initialization.
- (String) (Optional) If defined, indicate whether token data should be authenticated or authenticated and encrypted. If MAC, token data is authenticated (with HMAC) in the cache. If ENCRYPT, token data is encrypted and authenticated in the cache. If the value is not one of these options or empty, auth_token will raise an exception on initialization.
* - ``memcache_use_advanced_pool`` = ``False``
- (BoolOpt) (Optional) Use the advanced (eventlet safe) memcached client pool. The advanced pool will only work under python 2.x.
- (Boolean) (Optional) Use the advanced (eventlet safe) memcached client pool. The advanced pool will only work under python 2.x.
* - ``region_name`` = ``None``
- (StrOpt) The region in which the identity server can be found.
- (String) The region in which the identity server can be found.
* - ``revocation_cache_time`` = ``10``
- (IntOpt) Determines the frequency at which the list of revoked tokens is retrieved from the Identity service (in seconds). A high number of revocation events combined with a low cache duration may significantly reduce performance.
- (Integer) Determines the frequency at which the list of revoked tokens is retrieved from the Identity service (in seconds). A high number of revocation events combined with a low cache duration may significantly reduce performance.
* - ``signing_dir`` = ``None``
- (StrOpt) Directory used to cache files related to PKI tokens.
- (String) Directory used to cache files related to PKI tokens.
* - ``token_cache_time`` = ``300``
- (IntOpt) In order to prevent excessive effort spent validating tokens, the middleware caches previously-seen tokens for a configurable duration (in seconds). Set to -1 to disable caching completely.
- (Integer) In order to prevent excessive effort spent validating tokens, the middleware caches previously-seen tokens for a configurable duration (in seconds). Set to -1 to disable caching completely.

View File

@ -19,24 +19,24 @@
* - **[collector]**
-
* - ``batch_size`` = ``1``
- (IntOpt) Number of notification messages to wait before dispatching them
- (Integer) Number of notification messages to wait before dispatching them
* - ``batch_timeout`` = ``None``
- (IntOpt) Number of seconds to wait before dispatching sampleswhen batch_size is not reached (None means indefinitely)
- (Integer) Number of seconds to wait before dispatching sampleswhen batch_size is not reached (None means indefinitely)
* - ``requeue_event_on_dispatcher_error`` = ``False``
- (BoolOpt) Requeue the event on the collector event queue when the collector fails to dispatch it.
- (Boolean) Requeue the event on the collector event queue when the collector fails to dispatch it.
* - ``requeue_sample_on_dispatcher_error`` = ``False``
- (BoolOpt) Requeue the sample on the collector sample queue when the collector fails to dispatch it. This is only valid if the sample come from the notifier publisher.
- (Boolean) Requeue the sample on the collector sample queue when the collector fails to dispatch it. This is only valid if the sample come from the notifier publisher.
* - ``udp_address`` = ``0.0.0.0``
- (StrOpt) Address to which the UDP socket is bound. Set to an empty string to disable.
- (String) Address to which the UDP socket is bound. Set to an empty string to disable.
* - ``udp_port`` = ``4952``
- (PortOpt) Port to which the UDP socket is bound.
- (Unknown) Port to which the UDP socket is bound.
* - ``workers`` = ``1``
- (IntOpt) Number of workers for collector service. default value is 1.
- (Integer) Number of workers for collector service. default value is 1.
* - **[dispatcher_file]**
-
* - ``backup_count`` = ``0``
- (IntOpt) The max number of the files to keep.
- (Integer) The max number of the files to keep.
* - ``file_path`` = ``None``
- (StrOpt) Name and the location of the file to record meters.
- (String) Name and the location of the file to record meters.
* - ``max_bytes`` = ``0``
- (IntOpt) The max size of the file.
- (Integer) The max size of the file.

View File

@ -19,46 +19,48 @@
* - **[DEFAULT]**
-
* - ``batch_polled_samples`` = ``True``
- (BoolOpt) To reduce polling agent load, samples are sent to the notification agent in a batch. To gain higher throughput at the cost of load set this to False.
- (Boolean) To reduce polling agent load, samples are sent to the notification agent in a batch. To gain higher throughput at the cost of load set this to False.
* - ``executor_thread_pool_size`` = ``64``
- (IntOpt) Size of executor thread pool.
- (Integer) Size of executor thread pool.
* - ``host`` = ``localhost``
- (StrOpt) Name of this node, which must be valid in an AMQP key. Can be an opaque identifier. For ZeroMQ only, must be a valid host name, FQDN, or IP address.
- (String) Name of this node, which must be valid in an AMQP key. Can be an opaque identifier. For ZeroMQ only, must be a valid host name, FQDN, or IP address.
* - ``http_timeout`` = ``600``
- (IntOpt) Timeout seconds for HTTP requests. Set it to None to disable timeout.
- (Integer) Timeout seconds for HTTP requests. Set it to None to disable timeout.
* - ``memcached_servers`` = ``None``
- (ListOpt) Memcached servers or None for in process cache.
- (List) Memcached servers or None for in process cache.
* - ``polling_namespaces`` = ``['compute', 'central']``
- (MultiChoicesOpt) Polling namespace(s) to be used while resource polling
- (Unknown) Polling namespace(s) to be used while resource polling
* - ``pollster_list`` = ``[]``
- (MultiChoicesOpt) List of pollsters (or wildcard templates) to be used while polling
- (Unknown) List of pollsters (or wildcard templates) to be used while polling
* - ``rootwrap_config`` = ``/etc/ceilometer/rootwrap.conf``
- (StrOpt) Path to the rootwrap configuration file touse for running commands as root
- (String) Path to the rootwrap configuration file touse for running commands as root
* - ``shuffle_time_before_polling_task`` = ``0``
- (IntOpt) To reduce large requests at same time to Nova or other components from different compute agents, shuffle start time of polling task.
- (Integer) To reduce large requests at same time to Nova or other components from different compute agents, shuffle start time of polling task.
* - ``sql_expire_samples_only`` = ``False``
- (BoolOpt) Indicates if expirer expires only samples. If set true, expired samples will be deleted, but residual resource and meter definition data will remain.
- (Boolean) Indicates if expirer expires only samples. If set true, expired samples will be deleted, but residual resource and meter definition data will remain.
* - **[compute]**
-
* - ``resource_update_interval`` = ``0``
- (Integer) New instances will be discovered periodically based on this option (in seconds). By default, the agent discovers instances according to pipeline polling interval. If option is greater than 0, the instance list to poll will be updated based on this option's interval. Measurements relating to the instances will match intervals defined in pipeline.
* - ``workload_partitioning`` = ``False``
- (BoolOpt) Enable work-load partitioning, allowing multiple compute agents to be run simultaneously.
- (Boolean) Enable work-load partitioning, allowing multiple compute agents to be run simultaneously.
* - **[coordination]**
-
* - ``backend_url`` = ``None``
- (StrOpt) The backend URL to use for distributed coordination. If left empty, per-deployment central agent and per-host compute agent won't do workload partitioning and will only function correctly if a single instance of that service is running.
- (String) The backend URL to use for distributed coordination. If left empty, per-deployment central agent and per-host compute agent won't do workload partitioning and will only function correctly if a single instance of that service is running.
* - ``check_watchers`` = ``10.0``
- (FloatOpt) Number of seconds between checks to see if group membership has changed
- (Floating point) Number of seconds between checks to see if group membership has changed
* - ``heartbeat`` = ``1.0``
- (FloatOpt) Number of seconds between heartbeats for distributed coordination.
- (Floating point) Number of seconds between heartbeats for distributed coordination.
* - **[keystone_authtoken]**
-
* - ``memcached_servers`` = ``None``
- (ListOpt) Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process.
- (List) Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process.
* - **[meter]**
-
* - ``meter_definitions_cfg_file`` = ``meters.yaml``
- (StrOpt) Configuration file for defining meter notifications.
- (String) Configuration file for defining meter notifications.
* - **[polling]**
-
* - ``partitioning_group_prefix`` = ``None``
- (StrOpt) Work-load partitioning group prefix. Use only if you want to run multiple polling agents with different config files. For each sub-group of the agent pool with the same partitioning_group_prefix a disjoint subset of pollsters should be loaded.
- (String) Work-load partitioning group prefix. Use only if you want to run multiple polling agents with different config files. For each sub-group of the agent pool with the same partitioning_group_prefix a disjoint subset of pollsters should be loaded.

View File

@ -19,28 +19,28 @@
* - **[cors]**
-
* - ``allow_credentials`` = ``True``
- (BoolOpt) Indicate that the actual request can include user credentials
- (Boolean) Indicate that the actual request can include user credentials
* - ``allow_headers`` = ``Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma``
- (ListOpt) Indicate which header field names may be used during the actual request.
- (List) Indicate which header field names may be used during the actual request.
* - ``allow_methods`` = ``GET, POST, PUT, DELETE, OPTIONS``
- (ListOpt) Indicate which methods can be used during the actual request.
- (List) Indicate which methods can be used during the actual request.
* - ``allowed_origin`` = ``None``
- (ListOpt) Indicate whether this resource may be shared with the domain received in the requests "origin" header.
- (List) Indicate whether this resource may be shared with the domain received in the requests "origin" header.
* - ``expose_headers`` = ``Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma``
- (ListOpt) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers.
- (List) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers.
* - ``max_age`` = ``3600``
- (IntOpt) Maximum cache age of CORS preflight requests.
- (Integer) Maximum cache age of CORS preflight requests.
* - **[cors.subdomain]**
-
* - ``allow_credentials`` = ``True``
- (BoolOpt) Indicate that the actual request can include user credentials
- (Boolean) Indicate that the actual request can include user credentials
* - ``allow_headers`` = ``Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma``
- (ListOpt) Indicate which header field names may be used during the actual request.
- (List) Indicate which header field names may be used during the actual request.
* - ``allow_methods`` = ``GET, POST, PUT, DELETE, OPTIONS``
- (ListOpt) Indicate which methods can be used during the actual request.
- (List) Indicate which methods can be used during the actual request.
* - ``allowed_origin`` = ``None``
- (ListOpt) Indicate whether this resource may be shared with the domain received in the requests "origin" header.
- (List) Indicate whether this resource may be shared with the domain received in the requests "origin" header.
* - ``expose_headers`` = ``Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma``
- (ListOpt) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers.
- (List) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers.
* - ``max_age`` = ``3600``
- (IntOpt) Maximum cache age of CORS preflight requests.
- (Integer) Maximum cache age of CORS preflight requests.

View File

@ -19,56 +19,56 @@
* - **[DEFAULT]**
-
* - ``database_connection`` = ``None``
- (StrOpt) DEPRECATED - Database connection string.
- (String) DEPRECATED - Database connection string.
* - **[database]**
-
* - ``backend`` = ``sqlalchemy``
- (StrOpt) The back end to use for the database.
- (String) The back end to use for the database.
* - ``connection`` = ``None``
- (StrOpt) The SQLAlchemy connection string to use to connect to the database.
- (String) The SQLAlchemy connection string to use to connect to the database.
* - ``connection_debug`` = ``0``
- (IntOpt) Verbosity of SQL debugging information: 0=None, 100=Everything.
- (Integer) Verbosity of SQL debugging information: 0=None, 100=Everything.
* - ``connection_trace`` = ``False``
- (BoolOpt) Add Python stack traces to SQL as comment strings.
- (Boolean) Add Python stack traces to SQL as comment strings.
* - ``db2nosql_resource_id_maxlen`` = ``512``
- (IntOpt) The max length of resources id in DB2 nosql, the value should be larger than len(hostname) * 2 as compute node's resource id is <hostname>_<nodename>.
- (Integer) The max length of resources id in DB2 nosql, the value should be larger than len(hostname) * 2 as compute node's resource id is <hostname>_<nodename>.
* - ``db_inc_retry_interval`` = ``True``
- (BoolOpt) If True, increases the interval between retries of a database operation up to db_max_retry_interval.
- (Boolean) If True, increases the interval between retries of a database operation up to db_max_retry_interval.
* - ``db_max_retries`` = ``20``
- (IntOpt) Maximum retries in case of connection error or deadlock error before error is raised. Set to -1 to specify an infinite retry count.
- (Integer) Maximum retries in case of connection error or deadlock error before error is raised. Set to -1 to specify an infinite retry count.
* - ``db_max_retry_interval`` = ``10``
- (IntOpt) If db_inc_retry_interval is set, the maximum seconds between retries of a database operation.
- (Integer) If db_inc_retry_interval is set, the maximum seconds between retries of a database operation.
* - ``db_retry_interval`` = ``1``
- (IntOpt) Seconds between retries of a database transaction.
- (Integer) Seconds between retries of a database transaction.
* - ``event_connection`` = ``None``
- (StrOpt) The connection string used to connect to the event database. (if unset, connection is used)
- (String) The connection string used to connect to the event database. (if unset, connection is used)
* - ``event_time_to_live`` = ``-1``
- (IntOpt) Number of seconds that events are kept in the database for (<= 0 means forever).
- (Integer) Number of seconds that events are kept in the database for (<= 0 means forever).
* - ``idle_timeout`` = ``3600``
- (IntOpt) Timeout before idle SQL connections are reaped.
* - ``max_overflow`` = ``None``
- (IntOpt) If set, use this value for max_overflow with SQLAlchemy.
- (Integer) Timeout before idle SQL connections are reaped.
* - ``max_overflow`` = ``50``
- (Integer) If set, use this value for max_overflow with SQLAlchemy.
* - ``max_pool_size`` = ``None``
- (IntOpt) Maximum number of SQL connections to keep open in a pool.
- (Integer) Maximum number of SQL connections to keep open in a pool.
* - ``max_retries`` = ``10``
- (IntOpt) Maximum number of database connection retries during startup. Set to -1 to specify an infinite retry count.
- (Integer) Maximum number of database connection retries during startup. Set to -1 to specify an infinite retry count.
* - ``metering_connection`` = ``None``
- (StrOpt) The connection string used to connect to the metering database. (if unset, connection is used)
- (String) The connection string used to connect to the metering database. (if unset, connection is used)
* - ``metering_time_to_live`` = ``-1``
- (IntOpt) Number of seconds that samples are kept in the database for (<= 0 means forever).
- (Integer) Number of seconds that samples are kept in the database for (<= 0 means forever).
* - ``min_pool_size`` = ``1``
- (IntOpt) Minimum number of SQL connections to keep open in a pool.
- (Integer) Minimum number of SQL connections to keep open in a pool.
* - ``mysql_sql_mode`` = ``TRADITIONAL``
- (StrOpt) The SQL mode to be used for MySQL sessions. This option, including the default, overrides any server-set SQL mode. To use whatever SQL mode is set by the server configuration, set this to no value. Example: mysql_sql_mode=
- (String) The SQL mode to be used for MySQL sessions. This option, including the default, overrides any server-set SQL mode. To use whatever SQL mode is set by the server configuration, set this to no value. Example: mysql_sql_mode=
* - ``pool_timeout`` = ``None``
- (IntOpt) If set, use this value for pool_timeout with SQLAlchemy.
- (Integer) If set, use this value for pool_timeout with SQLAlchemy.
* - ``retry_interval`` = ``10``
- (IntOpt) Interval between retries of opening a SQL connection.
- (Integer) Interval between retries of opening a SQL connection.
* - ``slave_connection`` = ``None``
- (StrOpt) The SQLAlchemy connection string to use to connect to the slave database.
- (String) The SQLAlchemy connection string to use to connect to the slave database.
* - ``sqlite_db`` = ``oslo.sqlite``
- (StrOpt) The file name to use with SQLite.
- (String) The file name to use with SQLite.
* - ``sqlite_synchronous`` = ``True``
- (BoolOpt) If True, SQLite uses synchronous mode.
- (Boolean) If True, SQLite uses synchronous mode.
* - ``use_db_reconnect`` = ``False``
- (BoolOpt) Enable the experimental use of database reconnect on connection lost.
- (Boolean) Enable the experimental use of database reconnect on connection lost.

View File

@ -19,4 +19,4 @@
* - **[DEFAULT]**
-
* - ``nova_http_log_debug`` = ``False``
- (BoolOpt) Allow novaclient's debug log output. (Use default_log_levels instead)
- (Boolean) DEPRECATED: Allow novaclient's debug log output. (Use default_log_levels instead)

View File

@ -19,12 +19,12 @@
* - **[dispatcher_gnocchi]**
-
* - ``archive_policy`` = ``None``
- (StrOpt) The archive policy to use when the dispatcher create a new metric.
- (String) The archive policy to use when the dispatcher create a new metric.
* - ``filter_project`` = ``gnocchi``
- (StrOpt) Gnocchi project used to filter out samples generated by Gnocchi service activity
- (String) Gnocchi project used to filter out samples generated by Gnocchi service activity
* - ``filter_service_activity`` = ``True``
- (BoolOpt) Filter out samples generated by Gnocchi service activity
- (Boolean) Filter out samples generated by Gnocchi service activity
* - ``resources_definition_file`` = ``gnocchi_resources.yaml``
- (StrOpt) The Yaml file that defines mapping between samples and gnocchi resources/metrics
- (String) The Yaml file that defines mapping between samples and gnocchi resources/metrics
* - ``url`` = ``None``
- (StrOpt) URL to Gnocchi. default: autodetection
- (String) DEPRECATED: URL to Gnocchi. default: autodetection

View File

@ -19,8 +19,8 @@
* - **[dispatcher_http]**
-
* - ``event_target`` = ``None``
- (StrOpt) The target for event data where the http request will be sent to. If this is not set, it will default to same as Sample target.
- (String) The target for event data where the http request will be sent to. If this is not set, it will default to same as Sample target.
* - ``target`` =
- (StrOpt) The target where the http request will be sent. If this is not set, no data will be posted. For example: target = http://hostname:1234/path
- (String) The target where the http request will be sent. If this is not set, no data will be posted. For example: target = http://hostname:1234/path
* - ``timeout`` = ``5``
- (IntOpt) The max time in seconds to wait for a request to timeout.
- (Integer) The max time in seconds to wait for a request to timeout.

View File

@ -19,6 +19,6 @@
* - **[DEFAULT]**
-
* - ``event_dispatchers`` = ``['database']``
- (MultiStrOpt) Dispatchers to process event data.
- (Multi-valued) Dispatchers to process event data.
* - ``meter_dispatchers`` = ``['database']``
- (MultiStrOpt) Dispatchers to process metering data.
- (Multi-valued) Dispatchers to process metering data.

View File

@ -19,18 +19,18 @@
* - **[event]**
-
* - ``definitions_cfg_file`` = ``event_definitions.yaml``
- (StrOpt) Configuration file for event definitions.
- (String) Configuration file for event definitions.
* - ``drop_unmatched_notifications`` = ``False``
- (BoolOpt) Drop notifications if no event definition matches. (Otherwise, we convert them with just the default traits)
- (Boolean) Drop notifications if no event definition matches. (Otherwise, we convert them with just the default traits)
* - ``store_raw`` = ``[]``
- (MultiStrOpt) Store the raw notification for select priority levels (info and/or error). By default, raw details are not captured.
- (Multi-valued) Store the raw notification for select priority levels (info and/or error). By default, raw details are not captured.
* - **[notification]**
-
* - ``ack_on_event_error`` = ``True``
- (BoolOpt) Acknowledge message when event persistence fails.
- (Boolean) Acknowledge message when event persistence fails.
* - ``store_events`` = ``False``
- (BoolOpt) Save event details.
- (Boolean) Save event details.
* - ``workers`` = ``1``
- (IntOpt) Number of workers for notification service, default value is 1.
- (Integer) Number of workers for notification service, default value is 1.
* - ``workload_partitioning`` = ``False``
- (BoolOpt) Enable workload partitioning, allowing multiple notification agents to be run simultaneously.
- (Boolean) Enable workload partitioning, allowing multiple notification agents to be run simultaneously.

View File

@ -19,32 +19,32 @@
* - **[DEFAULT]**
-
* - ``ceilometer_control_exchange`` = ``ceilometer``
- (StrOpt) Exchange name for ceilometer notifications.
- (String) Exchange name for ceilometer notifications.
* - ``cinder_control_exchange`` = ``cinder``
- (StrOpt) Exchange name for Cinder notifications.
- (String) Exchange name for Cinder notifications.
* - ``dns_control_exchange`` = ``central``
- (StrOpt) Exchange name for DNS notifications.
- (String) Exchange name for DNS service notifications.
* - ``glance_control_exchange`` = ``glance``
- (StrOpt) Exchange name for Glance notifications.
- (String) Exchange name for Glance notifications.
* - ``heat_control_exchange`` = ``heat``
- (StrOpt) Exchange name for Heat notifications
- (String) Exchange name for Heat notifications
* - ``http_control_exchanges`` = ``['nova', 'glance', 'neutron', 'cinder']``
- (MultiStrOpt) Exchanges name to listen for notifications.
- (Multi-valued) Exchanges name to listen for notifications.
* - ``ironic_exchange`` = ``ironic``
- (StrOpt) Exchange name for Ironic notifications.
- (String) Exchange name for Ironic notifications.
* - ``keystone_control_exchange`` = ``keystone``
- (StrOpt) Exchange name for Keystone notifications.
- (String) Exchange name for Keystone notifications.
* - ``magnum_control_exchange`` = ``magnum``
- (StrOpt) Exchange name for Magnum notifications.
- (String) Exchange name for Magnum notifications.
* - ``neutron_control_exchange`` = ``neutron``
- (StrOpt) Exchange name for Neutron notifications.
- (String) Exchange name for Neutron notifications.
* - ``nova_control_exchange`` = ``nova``
- (StrOpt) Exchange name for Nova notifications.
- (String) Exchange name for Nova notifications.
* - ``sahara_control_exchange`` = ``sahara``
- (StrOpt) Exchange name for Data Processing notifications.
- (String) Exchange name for Data Processing notifications.
* - ``sample_source`` = ``openstack``
- (StrOpt) Source for samples emitted on this instance.
- (String) Source for samples emitted on this instance.
* - ``swift_control_exchange`` = ``swift``
- (StrOpt) Exchange name for Swift notifications.
- (String) Exchange name for Swift notifications.
* - ``trove_control_exchange`` = ``trove``
- (StrOpt) Exchange name for DBaaS notifications.
- (String) Exchange name for DBaaS notifications.

View File

@ -19,4 +19,4 @@
* - **[DEFAULT]**
-
* - ``glance_page_size`` = ``0``
- (IntOpt) Number of items to request in each paginated Glance API request (parameter used by glancecelient). If this is less than or equal to 0, page size is not specified (default value in glanceclient is used).
- (Integer) Number of items to request in each paginated Glance API request (parameter used by glancecelient). If this is less than or equal to 0, page size is not specified (default value in glanceclient is used).

View File

@ -8,15 +8,15 @@
autogenerate-config-doc tool from the openstack-doc-tools repository, or
ask for help on the documentation mailing list, IRC channel or meeting.
.. _cinder-zoning_manager:
.. _ceilometer-hyperv:
.. list-table:: Description of zoning manager configuration options
.. list-table:: Description of HyperV configuration options
:header-rows: 1
:class: config-ref-table
* - Configuration option = Default value
- Description
* - **[fc-zone-manager]**
* - **[hyperv]**
-
* - ``brcd_sb_connector`` = ``cinder.zonemanager.drivers.brocade.brcd_fc_zone_client_cli.BrcdFCZoneClientCLI``
- (StrOpt) Southbound connector for zoning operation
* - ``force_volumeutils_v1`` = ``False``
- (Boolean) DEPRECATED: Force V1 volume utility class

View File

@ -19,8 +19,8 @@
* - **[DEFAULT]**
-
* - ``hypervisor_inspector`` = ``libvirt``
- (StrOpt) Inspector to use for inspecting the hypervisor layer. Known inspectors are libvirt, hyperv, vmware, xenapi and powervm.
- (String) Inspector to use for inspecting the hypervisor layer. Known inspectors are libvirt, hyperv, vmware, xenapi and powervm.
* - ``libvirt_type`` = ``kvm``
- (StrOpt) Libvirt domain type.
- (String) Libvirt domain type.
* - ``libvirt_uri`` =
- (StrOpt) Override the default libvirt URI (which is dependent on libvirt_type).
- (String) Override the default libvirt URI (which is dependent on libvirt_type).

View File

@ -19,6 +19,6 @@
* - **[ipmi]**
-
* - ``node_manager_init_retry`` = ``3``
- (IntOpt) Number of retries upon Intel Node Manager initialization failure
- (Integer) Number of retries upon Intel Node Manager initialization failure
* - ``polling_retry`` = ``3``
- (IntOpt) Tolerance of IPMI/NM polling failures before disable this pollster. Negative indicates retrying forever.
- (Integer) Tolerance of IPMI/NM polling failures before disable this pollster. Negative indicates retrying forever.

View File

@ -19,44 +19,42 @@
* - **[DEFAULT]**
-
* - ``debug`` = ``False``
- (BoolOpt) If set to true, the logging level will be set to DEBUG instead of the default INFO level.
- (Boolean) If set to true, the logging level will be set to DEBUG instead of the default INFO level.
* - ``default_log_levels`` = ``amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, oslo.messaging=INFO, iso8601=WARN, requests.packages.urllib3.connectionpool=WARN, urllib3.connectionpool=WARN, websocket=WARN, requests.packages.urllib3.util.retry=WARN, urllib3.util.retry=WARN, keystonemiddleware=WARN, routes.middleware=WARN, stevedore=WARN, taskflow=WARN, keystoneauth=WARN, oslo.cache=INFO, dogpile.core.dogpile=INFO``
- (ListOpt) List of package logging levels in logger=LEVEL pairs. This option is ignored if log_config_append is set.
- (List) List of package logging levels in logger=LEVEL pairs. This option is ignored if log_config_append is set.
* - ``fatal_deprecations`` = ``False``
- (BoolOpt) Enables or disables fatal status of deprecations.
- (Boolean) Enables or disables fatal status of deprecations.
* - ``instance_format`` = ``"[instance: %(uuid)s] "``
- (StrOpt) The format for an instance that is passed with the log message.
- (String) The format for an instance that is passed with the log message.
* - ``instance_uuid_format`` = ``"[instance: %(uuid)s] "``
- (StrOpt) The format for an instance UUID that is passed with the log message.
- (String) The format for an instance UUID that is passed with the log message.
* - ``log_config_append`` = ``None``
- (StrOpt) The name of a logging configuration file. This file is appended to any existing logging configuration files. For details about logging configuration files, see the Python logging module documentation. Note that when logging configuration files are used then all logging configuration is set in the configuration file and other logging configuration options are ignored (for example, logging_context_format_string).
- (String) The name of a logging configuration file. This file is appended to any existing logging configuration files. For details about logging configuration files, see the Python logging module documentation. Note that when logging configuration files are used then all logging configuration is set in the configuration file and other logging configuration options are ignored (for example, logging_context_format_string).
* - ``log_date_format`` = ``%Y-%m-%d %H:%M:%S``
- (StrOpt) Defines the format string for %%(asctime)s in log records. Default: %(default)s . This option is ignored if log_config_append is set.
- (String) Defines the format string for %%(asctime)s in log records. Default: %(default)s . This option is ignored if log_config_append is set.
* - ``log_dir`` = ``None``
- (StrOpt) (Optional) The base directory used for relative log_file paths. This option is ignored if log_config_append is set.
- (String) (Optional) The base directory used for relative log_file paths. This option is ignored if log_config_append is set.
* - ``log_file`` = ``None``
- (StrOpt) (Optional) Name of log file to send logging output to. If no default is set, logging will go to stderr as defined by use_stderr. This option is ignored if log_config_append is set.
- (String) (Optional) Name of log file to send logging output to. If no default is set, logging will go to stderr as defined by use_stderr. This option is ignored if log_config_append is set.
* - ``logging_context_format_string`` = ``%(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s``
- (StrOpt) Format string to use for log messages with context.
- (String) Format string to use for log messages with context.
* - ``logging_debug_format_suffix`` = ``%(funcName)s %(pathname)s:%(lineno)d``
- (StrOpt) Additional data to append to log message when logging level for the message is DEBUG.
- (String) Additional data to append to log message when logging level for the message is DEBUG.
* - ``logging_default_format_string`` = ``%(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s``
- (StrOpt) Format string to use for log messages when context is undefined.
- (String) Format string to use for log messages when context is undefined.
* - ``logging_exception_prefix`` = ``%(asctime)s.%(msecs)03d %(process)d ERROR %(name)s %(instance)s``
- (StrOpt) Prefix each line of exception output with this format.
- (String) Prefix each line of exception output with this format.
* - ``logging_user_identity_format`` = ``%(user)s %(tenant)s %(domain)s %(user_domain)s %(project_domain)s``
- (StrOpt) Defines the format string for %(user_identity)s that is used in logging_context_format_string.
- (String) Defines the format string for %(user_identity)s that is used in logging_context_format_string.
* - ``publish_errors`` = ``False``
- (BoolOpt) Enables or disables publication of error events.
- (Boolean) Enables or disables publication of error events.
* - ``syslog_log_facility`` = ``LOG_USER``
- (StrOpt) Syslog facility to receive log lines. This option is ignored if log_config_append is set.
- (String) Syslog facility to receive log lines. This option is ignored if log_config_append is set.
* - ``use_stderr`` = ``True``
- (BoolOpt) Log output to standard error. This option is ignored if log_config_append is set.
- (Boolean) Log output to standard error. This option is ignored if log_config_append is set.
* - ``use_syslog`` = ``False``
- (BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED and will be changed later to honor RFC5424. This option is ignored if log_config_append is set.
* - ``use_syslog_rfc_format`` = ``True``
- (BoolOpt) Enables or disables syslog rfc5424 format for logging. If enabled, prefixes the MSG part of the syslog message with APP-NAME (RFC5424). This option is ignored if log_config_append is set.
- (Boolean) Use syslog for logging. Existing syslog format is DEPRECATED and will be changed later to honor RFC5424. This option is ignored if log_config_append is set.
* - ``verbose`` = ``True``
- (BoolOpt) If set to false, the logging level will be set to WARNING instead of the default INFO level.
- (Boolean) DEPRECATED: If set to false, the logging level will be set to WARNING instead of the default INFO level.
* - ``watch_log_file`` = ``False``
- (BoolOpt) Uses logging handler designed to watch file system. When log file is moved or removed this handler will open a new log file with specified path instantaneously. It makes sense only if log_file option is specified and Linux platform is used. This option is ignored if log_config_append is set.
- (Boolean) Uses logging handler designed to watch file system. When log file is moved or removed this handler will open a new log file with specified path instantaneously. It makes sense only if log_file option is specified and Linux platform is used. This option is ignored if log_config_append is set.

View File

@ -19,4 +19,4 @@
* - **[DEFAULT]**
-
* - ``magnetodb_control_exchange`` = ``magnetodb``
- (StrOpt) Exchange name for Magnetodb notifications.
- (String) Exchange name for Magnetodb notifications.

View File

@ -19,10 +19,10 @@
* - **[notification]**
-
* - ``batch_size`` = ``1``
- (IntOpt) Number of notification messages to wait before publishing them
- (Integer) Number of notification messages to wait before publishing them
* - ``batch_timeout`` = ``None``
- (IntOpt) Number of seconds to wait before publishing sampleswhen batch_size is not reached (None means indefinitely)
- (Integer) Number of seconds to wait before publishing sampleswhen batch_size is not reached (None means indefinitely)
* - ``disable_non_metric_meters`` = ``True``
- (BoolOpt) WARNING: Ceilometer historically offered the ability to store events as meters. This usage is NOT advised as it can flood the metering database and cause performance degradation.
- (Boolean) WARNING: Ceilometer historically offered the ability to store events as meters. This usage is NOT advised as it can flood the metering database and cause performance degradation.
* - ``pipeline_processing_queues`` = ``10``
- (IntOpt) Number of queues to parallelize workload across. This value should be larger than the number of active notification agents for optimal results.
- (Integer) Number of queues to parallelize workload across. This value should be larger than the number of active notification agents for optimal results.

View File

@ -19,8 +19,8 @@
* - **[oslo_policy]**
-
* - ``policy_default_rule`` = ``default``
- (StrOpt) Default rule. Enforced when a requested rule is not found.
- (String) Default rule. Enforced when a requested rule is not found.
* - ``policy_dirs`` = ``['policy.d']``
- (MultiStrOpt) Directories where policy configuration files are stored. They can be relative to any directory in the search path defined by the config_dir option, or absolute paths. The file defined by policy_file must exist for these directories to be searched. Missing or empty directories are ignored.
- (Multi-valued) Directories where policy configuration files are stored. They can be relative to any directory in the search path defined by the config_dir option, or absolute paths. The file defined by policy_file must exist for these directories to be searched. Missing or empty directories are ignored.
* - ``policy_file`` = ``policy.json``
- (StrOpt) The JSON file that defines policies.
- (String) The JSON file that defines policies.

View File

@ -1,48 +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.
.. _ceilometer-qpid:
.. list-table:: Description of Qpid configuration options
:header-rows: 1
:class: config-ref-table
* - Configuration option = Default value
- Description
* - **[oslo_messaging_qpid]**
-
* - ``amqp_auto_delete`` = ``False``
- (BoolOpt) Auto-delete queues in AMQP.
* - ``amqp_durable_queues`` = ``False``
- (BoolOpt) Use durable queues in AMQP.
* - ``qpid_heartbeat`` = ``60``
- (IntOpt) Seconds between connection keepalive heartbeats.
* - ``qpid_hostname`` = ``localhost``
- (StrOpt) Qpid broker hostname.
* - ``qpid_hosts`` = ``$qpid_hostname:$qpid_port``
- (ListOpt) Qpid HA cluster host:port pairs.
* - ``qpid_password`` =
- (StrOpt) Password for Qpid connection.
* - ``qpid_port`` = ``5672``
- (IntOpt) Qpid broker port.
* - ``qpid_protocol`` = ``tcp``
- (StrOpt) Transport to use, either 'tcp' or 'ssl'.
* - ``qpid_receiver_capacity`` = ``1``
- (IntOpt) The number of prefetched messages held by receiver.
* - ``qpid_sasl_mechanisms`` =
- (StrOpt) Space separated list of SASL mechanisms to use for auth.
* - ``qpid_tcp_nodelay`` = ``True``
- (BoolOpt) Whether to disable the Nagle algorithm.
* - ``qpid_topology_version`` = ``1``
- (IntOpt) The qpid topology version to use. Version 1 is what was originally used by impl_qpid. Version 2 includes some backwards-incompatible changes that allow broker federation to work. Users should update to version 2 when they are able to take everything down, as it requires a clean break.
* - ``qpid_username`` =
- (StrOpt) Username for Qpid connection.
* - ``send_single_reply`` = ``False``
- (BoolOpt) Send a single AMQP reply to call message. The current behaviour since oslo-incubator is to send two AMQP replies - first one with the payload, a second one to ensure the other have finish to send the payload. We are going to remove it in the N release, but we must keep backward compatible at the same time. This option provides such compatibility - it defaults to False in Liberty and can be turned on for early adopters with a new installations or for testing. Please note, that this option will be removed in the Mitaka release.

View File

@ -19,58 +19,90 @@
* - **[oslo_messaging_rabbit]**
-
* - ``amqp_auto_delete`` = ``False``
- (BoolOpt) Auto-delete queues in AMQP.
- (Boolean) Auto-delete queues in AMQP.
* - ``amqp_durable_queues`` = ``False``
- (BoolOpt) Use durable queues in AMQP.
- (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``
- (BoolOpt) Deprecated, use rpc_backend=kombu+memory or rpc_backend=fake
- (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``
- (IntOpt) How often times during the heartbeat_timeout_threshold we check the heartbeat.
- (Integer) How often times during the heartbeat_timeout_threshold we check the heartbeat.
* - ``heartbeat_timeout_threshold`` = ``60``
- (IntOpt) Number of seconds after which the Rabbit broker is considered down if heartbeat's keep-alive fails (0 disable the heartbeat). EXPERIMENTAL
- (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``
- (StrOpt) EXPERIMENTAL: Possible values are: gzip, bz2. If not set compression will not be used. This option may notbe available in future versions.
- (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``
- (StrOpt) 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.
- (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``
- (IntOpt) How long to wait a missing client beforce abandoning to send it its replies. This value should not be longer than rpc_response_timeout.
- (Integer) How long to wait a missing client beforce abandoning to send it its replies. This value should not be longer than rpc_response_timeout.
* - ``kombu_reconnect_delay`` = ``1.0``
- (FloatOpt) How long to wait before reconnecting in response to an AMQP consumer cancel notification.
- (Floating point) How long to wait before reconnecting in response to an AMQP consumer cancel notification.
* - ``kombu_ssl_ca_certs`` =
- (StrOpt) SSL certification authority file (valid only if SSL enabled).
- (String) SSL certification authority file (valid only if SSL enabled).
* - ``kombu_ssl_certfile`` =
- (StrOpt) SSL cert file (valid only if SSL enabled).
- (String) SSL cert file (valid only if SSL enabled).
* - ``kombu_ssl_keyfile`` =
- (StrOpt) SSL key file (valid only if SSL enabled).
- (String) SSL key file (valid only if SSL enabled).
* - ``kombu_ssl_version`` =
- (StrOpt) 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.
- (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``
- (BoolOpt) Use HA queues in RabbitMQ (x-ha-policy: all). If you change this option, you must wipe the RabbitMQ database.
- (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``
- (StrOpt) The RabbitMQ broker address where a single node is used.
- (String) The RabbitMQ broker address where a single node is used.
* - ``rabbit_hosts`` = ``$rabbit_host:$rabbit_port``
- (ListOpt) RabbitMQ HA cluster host:port pairs.
- (List) RabbitMQ HA cluster host:port pairs.
* - ``rabbit_interval_max`` = ``30``
- (IntOpt) Maximum interval of RabbitMQ connection retries. Default is 30 seconds.
- (Integer) Maximum interval of RabbitMQ connection retries. Default is 30 seconds.
* - ``rabbit_login_method`` = ``AMQPLAIN``
- (StrOpt) The RabbitMQ login method.
- (String) The RabbitMQ login method.
* - ``rabbit_max_retries`` = ``0``
- (IntOpt) Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry count).
- (Integer) Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry count).
* - ``rabbit_password`` = ``guest``
- (StrOpt) The RabbitMQ password.
- (String) The RabbitMQ password.
* - ``rabbit_port`` = ``5672``
- (PortOpt) The RabbitMQ broker port where a single node is used.
- (Unknown) The RabbitMQ broker port where a single node is used.
* - ``rabbit_qos_prefetch_count`` = ``0``
- (IntOpt) Specifies the number of messages to prefetch. Setting to zero allows unlimited messages.
- (Integer) Specifies the number of messages to prefetch. Setting to zero allows unlimited messages.
* - ``rabbit_retry_backoff`` = ``2``
- (IntOpt) How long to backoff for between retries when connecting to RabbitMQ.
- (Integer) How long to backoff for between retries when connecting to RabbitMQ.
* - ``rabbit_retry_interval`` = ``1``
- (IntOpt) How frequently to retry connecting with RabbitMQ.
* - ``rabbit_transient_queues_ttl`` = ``600``
- (IntOpt) 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.
- (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``
- (BoolOpt) Connect over SSL for RabbitMQ.
- (Boolean) Connect over SSL for RabbitMQ.
* - ``rabbit_userid`` = ``guest``
- (StrOpt) The RabbitMQ userid.
- (String) The RabbitMQ userid.
* - ``rabbit_virtual_host`` = ``/``
- (StrOpt) The RabbitMQ virtual host.
- (String) The RabbitMQ virtual host.

View File

@ -19,18 +19,18 @@
* - **[matchmaker_redis]**
-
* - ``check_timeout`` = ``20000``
- (IntOpt) Time in ms to wait before the transaction is killed.
- (Integer) Time in ms to wait before the transaction is killed.
* - ``host`` = ``127.0.0.1``
- (StrOpt) Host to locate redis.
- (String) Host to locate redis.
* - ``password`` =
- (StrOpt) Password for Redis server (optional).
- (String) Password for Redis server (optional).
* - ``port`` = ``6379``
- (PortOpt) Use this port to connect to redis host.
- (Unknown) Use this port to connect to redis host.
* - ``sentinel_group_name`` = ``oslo-messaging-zeromq``
- (StrOpt) Redis replica set name.
- (String) Redis replica set name.
* - ``sentinel_hosts`` =
- (ListOpt) List of Redis Sentinel hosts (fault tolerance mode) e.g. [host:port, host1:port ... ]
- (List) List of Redis Sentinel hosts (fault tolerance mode) e.g. [host:port, host1:port ... ]
* - ``socket_timeout`` = ``1000``
- (IntOpt) Timeout in ms on blocking socket operations
- (Integer) Timeout in ms on blocking socket operations
* - ``wait_timeout`` = ``500``
- (IntOpt) Time in ms to wait between connection attempts.
- (Integer) Time in ms to wait between connection attempts.

View File

@ -19,6 +19,6 @@
* - **[rgw_admin_credentials]**
-
* - ``access_key`` = ``None``
- (StrOpt) Access key for Radosgw Admin.
- (String) Access key for Radosgw Admin.
* - ``secret_key`` = ``None``
- (StrOpt) Secret key for Radosgw Admin.
- (String) Secret key for Radosgw Admin.

View File

@ -19,76 +19,100 @@
* - **[DEFAULT]**
-
* - ``rpc_backend`` = ``rabbit``
- (StrOpt) The messaging driver to use, defaults to rabbit. Other drivers include amqp and zmq.
- (String) The messaging driver to use, defaults to rabbit. Other drivers include amqp and zmq.
* - ``rpc_cast_timeout`` = ``-1``
- (IntOpt) 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.
- (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``
- (IntOpt) Size of RPC connection pool.
- (Integer) Size of RPC connection pool.
* - ``rpc_poll_timeout`` = ``1``
- (IntOpt) The default number of seconds that poll should wait. Poll raises timeout exception when timeout expired.
- (Integer) The default number of seconds that poll should wait. Poll raises timeout exception when timeout expired.
* - ``rpc_response_timeout`` = ``60``
- (IntOpt) Seconds to wait for a response from a call.
- (Integer) Seconds to wait for a response from a call.
* - **[notification]**
-
* - ``messaging_urls`` = ``[]``
- (MultiStrOpt) Messaging URLs to listen for notifications. Example: transport://user:pass@host1:port[,hostN:portN]/virtual_host (DEFAULT/transport_url is used if empty)
- (Multi-valued) Messaging URLs to listen for notifications. Example: transport://user:pass@host1:port[,hostN:portN]/virtual_host (DEFAULT/transport_url is used if empty)
* - **[oslo_concurrency]**
-
* - ``disable_process_locking`` = ``False``
- (BoolOpt) Enables or disables inter-process locks.
- (Boolean) Enables or disables inter-process locks.
* - ``lock_path`` = ``None``
- (StrOpt) 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.
- (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]**
-
* - ``allow_insecure_clients`` = ``False``
- (BoolOpt) Accept clients using either SSL or plain TCP
- (Boolean) Accept clients using either SSL or plain TCP
* - ``broadcast_prefix`` = ``broadcast``
- (StrOpt) address prefix used when broadcasting to all servers
- (String) address prefix used when broadcasting to all servers
* - ``container_name`` = ``None``
- (StrOpt) Name for the AMQP container
- (String) Name for the AMQP container
* - ``group_request_prefix`` = ``unicast``
- (StrOpt) address prefix when sending to any server in group
- (String) address prefix when sending to any server in group
* - ``idle_timeout`` = ``0``
- (IntOpt) Timeout for inactive connections (in seconds)
- (Integer) Timeout for inactive connections (in seconds)
* - ``password`` =
- (StrOpt) Password for message broker authentication
- (String) Password for message broker authentication
* - ``sasl_config_dir`` =
- (StrOpt) Path to directory that contains the SASL configuration
- (String) Path to directory that contains the SASL configuration
* - ``sasl_config_name`` =
- (StrOpt) Name of configuration file (without .conf suffix)
- (String) Name of configuration file (without .conf suffix)
* - ``sasl_mechanisms`` =
- (StrOpt) Space separated list of acceptable SASL mechanisms
- (String) Space separated list of acceptable SASL mechanisms
* - ``server_request_prefix`` = ``exclusive``
- (StrOpt) address prefix used when sending to a specific server
- (String) address prefix used when sending to a specific server
* - ``ssl_ca_file`` =
- (StrOpt) CA certificate PEM file to verify server certificate
- (String) CA certificate PEM file to verify server certificate
* - ``ssl_cert_file`` =
- (StrOpt) Identifying certificate PEM file to present to clients
- (String) Identifying certificate PEM file to present to clients
* - ``ssl_key_file`` =
- (StrOpt) Private key PEM file used to sign cert_file certificate
- (String) Private key PEM file used to sign cert_file certificate
* - ``ssl_key_password`` = ``None``
- (StrOpt) Password for decrypting ssl_key_file (if encrypted)
- (String) Password for decrypting ssl_key_file (if encrypted)
* - ``trace`` = ``False``
- (BoolOpt) Debug: dump AMQP frames to stdout
- (Boolean) Debug: dump AMQP frames to stdout
* - ``username`` =
- (StrOpt) User name for message broker authentication
- (String) User name for message broker authentication
* - **[oslo_messaging_notifications]**
-
* - ``driver`` = ``[]``
- (MultiStrOpt) The Drivers(s) to handle sending notifications. Possible values are messaging, messagingv2, routing, log, test, noop
- (Multi-valued) The Drivers(s) to handle sending notifications. Possible values are messaging, messagingv2, routing, log, test, noop
* - ``topics`` = ``notifications``
- (ListOpt) AMQP topic used for OpenStack notifications.
- (List) AMQP topic used for OpenStack notifications.
* - ``transport_url`` = ``None``
- (StrOpt) A URL representing the messaging driver to use for notifications. If not set, we fall back to the same configuration used for RPC.
- (String) A URL representing the messaging driver to use for notifications. If not set, we fall back to the same configuration used for RPC.
* - **[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
* - **[publisher]**
-
* - ``telemetry_secret`` = ``change this for valid signing``
- (StrOpt) Secret value for signing messages. Set value empty if signing is not required to avoid computational overhead.
- (String) Secret value for signing messages. Set value empty if signing is not required to avoid computational overhead.
* - **[publisher_notifier]**
-
* - ``event_topic`` = ``event``
- (StrOpt) The topic that ceilometer uses for event notifications.
- (String) The topic that ceilometer uses for event notifications.
* - ``metering_topic`` = ``metering``
- (StrOpt) The topic that ceilometer uses for metering notifications.
- (String) The topic that ceilometer uses for metering notifications.
* - ``telemetry_driver`` = ``messagingv2``
- (StrOpt) The driver that ceilometer uses for metering notifications.
- (String) The driver that ceilometer uses for metering notifications.

View File

@ -19,14 +19,16 @@
* - **[service_types]**
-
* - ``glance`` = ``image``
- (StrOpt) Glance service type.
- (String) Glance service type.
* - ``kwapi`` = ``energy``
- (StrOpt) Kwapi service type.
- (String) Kwapi service type.
* - ``neutron`` = ``network``
- (StrOpt) Neutron service type.
- (String) Neutron service type.
* - ``neutron_lbaas_version`` = ``v2``
- (String) Neutron load balancer version.
* - ``nova`` = ``compute``
- (StrOpt) Nova service type.
- (String) Nova service type.
* - ``radosgw`` = ``object-store``
- (StrOpt) Radosgw service type.
- (String) Radosgw service type.
* - ``swift`` = ``object-store``
- (StrOpt) Swift service type.
- (String) Swift service type.

View File

@ -19,6 +19,6 @@
* - **[storage]**
-
* - ``max_retries`` = ``10``
- (IntOpt) Maximum number of connection retries during startup. Set to -1 to specify an infinite retry count.
- (Integer) Maximum number of connection retries during startup. Set to -1 to specify an infinite retry count.
* - ``retry_interval`` = ``10``
- (IntOpt) Interval (in seconds) between retries of connection.
- (Integer) Interval (in seconds) between retries of connection.

View File

@ -19,4 +19,4 @@
* - **[DEFAULT]**
-
* - ``reseller_prefix`` = ``AUTH_``
- (StrOpt) Swift reseller prefix. Must be on par with reseller_prefix in proxy-server.conf.
- (String) Swift reseller prefix. Must be on par with reseller_prefix in proxy-server.conf.

View File

@ -19,10 +19,10 @@
* - **[hardware]**
-
* - ``meter_definitions_file`` = ``snmp.yaml``
- (StrOpt) Configuration file for defining hardware snmp meters.
- (String) Configuration file for defining hardware snmp meters.
* - ``readonly_user_name`` = ``ro_snmp_user``
- (StrOpt) SNMPd user name of all nodes running in the cloud.
- (String) SNMPd user name of all nodes running in the cloud.
* - ``readonly_user_password`` = ``password``
- (StrOpt) SNMPd password of all the nodes running in the cloud.
- (String) SNMPd password of all the nodes running in the cloud.
* - ``url_scheme`` = ``snmp://``
- (StrOpt) URL scheme to use for hardware nodes.
- (String) URL scheme to use for hardware nodes.

View File

@ -19,20 +19,20 @@
* - **[vmware]**
-
* - ``api_retry_count`` = ``10``
- (IntOpt) Number of times a VMware vSphere API may be retried.
- (Integer) Number of times a VMware vSphere API may be retried.
* - ``ca_file`` = ``None``
- (StrOpt) CA bundle file to use in verifying the vCenter server certificate.
- (String) CA bundle file to use in verifying the vCenter server certificate.
* - ``host_ip`` =
- (StrOpt) IP address of the VMware vSphere host.
- (String) IP address of the VMware vSphere host.
* - ``host_password`` =
- (StrOpt) Password of VMware vSphere.
- (String) Password of VMware vSphere.
* - ``host_port`` = ``443``
- (PortOpt) Port of the VMware vSphere host.
- (Unknown) Port of the VMware vSphere host.
* - ``host_username`` =
- (StrOpt) Username of VMware vSphere.
- (String) Username of VMware vSphere.
* - ``insecure`` = ``False``
- (BoolOpt) If true, the vCenter server certificate is not verified. If false, then the default CA truststore is used for verification. This option is ignored if "ca_file" is set.
- (Boolean) If true, the vCenter server certificate is not verified. If false, then the default CA truststore is used for verification. This option is ignored if "ca_file" is set.
* - ``task_poll_interval`` = ``0.5``
- (FloatOpt) Sleep time in seconds for polling an ongoing async task.
- (Floating point) Sleep time in seconds for polling an ongoing async task.
* - ``wsdl_location`` = ``None``
- (StrOpt) Optional vim service WSDL location e.g http://<server>/vimService.wsdl. Optional over-ride to default location for bug work-arounds.
- (String) Optional vim service WSDL location e.g http://<server>/vimService.wsdl. Optional over-ride to default location for bug work-arounds.

View File

@ -19,8 +19,8 @@
* - **[xenapi]**
-
* - ``connection_password`` = ``None``
- (StrOpt) Password for connection to XenServer/Xen Cloud Platform.
- (String) Password for connection to XenServer/Xen Cloud Platform.
* - ``connection_url`` = ``None``
- (StrOpt) URL for connection to XenServer/Xen Cloud Platform.
- (String) URL for connection to XenServer/Xen Cloud Platform.
* - ``connection_username`` = ``root``
- (StrOpt) Username for connection to XenServer/Xen Cloud Platform.
- (String) Username for connection to XenServer/Xen Cloud Platform.

View File

@ -19,4 +19,4 @@
* - **[DEFAULT]**
-
* - ``zaqar_control_exchange`` = ``zaqar``
- (StrOpt) Exchange name for Messaging service notifications.
- (String) Exchange name for Messaging service notifications.

View File

@ -19,26 +19,26 @@
* - **[DEFAULT]**
-
* - ``rpc_zmq_bind_address`` = ``*``
- (StrOpt) ZeroMQ bind address. Should be a wildcard (*), an ethernet interface, or IP. The "host" option should point or resolve to this 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``
- (IntOpt) Number of retries to find free port number before fail with ZMQBindError.
- (Integer) Number of retries to find free port number before fail with ZMQBindError.
* - ``rpc_zmq_concurrency`` = ``eventlet``
- (StrOpt) Type of concurrency used. Either "native" or "eventlet"
- (String) Type of concurrency used. Either "native" or "eventlet"
* - ``rpc_zmq_contexts`` = ``1``
- (IntOpt) Number of ZeroMQ contexts, defaults to 1.
- (Integer) Number of ZeroMQ contexts, defaults to 1.
* - ``rpc_zmq_host`` = ``localhost``
- (StrOpt) Name of this node. Must be a valid hostname, FQDN, or IP address. Must match "host" option, if running Nova.
- (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``
- (StrOpt) Directory for holding IPC sockets.
- (String) Directory for holding IPC sockets.
* - ``rpc_zmq_matchmaker`` = ``redis``
- (StrOpt) MatchMaker driver.
- (String) MatchMaker driver.
* - ``rpc_zmq_max_port`` = ``65536``
- (IntOpt) Maximal port number for random ports range.
- (Integer) Maximal port number for random ports range.
* - ``rpc_zmq_min_port`` = ``49152``
- (PortOpt) Minimal port number for random ports range.
- (Unknown) Minimal port number for random ports range.
* - ``rpc_zmq_topic_backlog`` = ``None``
- (IntOpt) Maximum number of ingress messages to locally buffer per topic. Default is unlimited.
- (Integer) Maximum number of ingress messages to locally buffer per topic. Default is unlimited.
* - ``use_pub_sub`` = ``True``
- (BoolOpt) Use PUB/SUB pattern for fanout methods. PUB/SUB always uses proxy.
- (Boolean) Use PUB/SUB pattern for fanout methods. PUB/SUB always uses proxy.
* - ``zmq_target_expire`` = ``120``
- (IntOpt) Expiration timeout in seconds of a name service record about existing target ( < 0 means no timeout).
- (Integer) Expiration timeout in seconds of a name service record about existing target ( < 0 means no timeout).

View File

@ -19,4 +19,4 @@
* - **[DEFAULT]**
-
* - ``control_exchange`` = ``openstack``
- (StrOpt) The default exchange under which topics are scoped. May be overridden by an exchange name specified in the transport_url option.
- (String) The default exchange under which topics are scoped. May be overridden by an exchange name specified in the transport_url option.

View File

@ -19,78 +19,76 @@
* - **[DEFAULT]**
-
* - ``api_rate_limit`` = ``True``
- (BoolOpt) Enables or disables rate limit of the API.
- (Boolean) Enables or disables rate limit of the API.
* - ``az_cache_duration`` = ``3600``
- (IntOpt) Cache volume availability zones in memory for the provided duration in seconds
- (Integer) Cache volume availability zones in memory for the provided duration in seconds
* - ``backend_host`` = ``None``
- (StrOpt) Backend override of host value.
- (String) Backend override of host value.
* - ``default_timeout`` = ``525600``
- (IntOpt) Default timeout for CLI operations in minutes. For example, LUN migration is a typical long running operation, which depends on the LUN size and the load of the array. An upper bound in the specific deployment can be set to avoid unnecessary long wait. By default, it is 365 days long.
- (Integer) Default timeout for CLI operations in minutes. For example, LUN migration is a typical long running operation, which depends on the LUN size and the load of the array. An upper bound in the specific deployment can be set to avoid unnecessary long wait. By default, it is 365 days long.
* - ``enable_v1_api`` = ``True``
- (BoolOpt) DEPRECATED: Deploy v1 of the Cinder API.
- (Boolean) DEPRECATED: Deploy v1 of the Cinder API.
* - ``enable_v2_api`` = ``True``
- (BoolOpt) Deploy v2 of the Cinder API.
- (Boolean) DEPRECATED: Deploy v2 of the Cinder API.
* - ``enable_v3_api`` = ``True``
- (Boolean) Deploy v3 of the Cinder API.
* - ``extra_capabilities`` = ``{}``
- (StrOpt) User defined capabilities, a JSON formatted string specifying key/value pairs. The key/value pairs can be used by the CapabilitiesFilter to select between backends when requests specify volume types. For example, specifying a service level or the geographical location of a backend, then creating a volume type to allow the user to select by these different properties.
- (String) User defined capabilities, a JSON formatted string specifying key/value pairs. The key/value pairs can be used by the CapabilitiesFilter to select between backends when requests specify volume types. For example, specifying a service level or the geographical location of a backend, then creating a volume type to allow the user to select by these different properties.
* - ``ignore_pool_full_threshold`` = ``False``
- (BoolOpt) Force LUN creation even if the full threshold of pool is reached.
- (Boolean) Force LUN creation even if the full threshold of pool is reached.
* - ``management_ips`` =
- (StrOpt) List of Management IP addresses (separated by commas)
- (String) List of Management IP addresses (separated by commas)
* - ``osapi_max_limit`` = ``1000``
- (IntOpt) The maximum number of items that a collection resource returns in a single response
- (Integer) The maximum number of items that a collection resource returns in a single response
* - ``osapi_max_request_body_size`` = ``114688``
- (IntOpt) Max size for body of a request
- (Integer) Max size for body of a request
* - ``osapi_volume_base_URL`` = ``None``
- (StrOpt) Base URL that will be presented to users in links to the OpenStack Volume API
- (String) Base URL that will be presented to users in links to the OpenStack Volume API
* - ``osapi_volume_ext_list`` =
- (ListOpt) Specify list of extensions to load when using osapi_volume_extension option with cinder.api.contrib.select_extensions
- (List) Specify list of extensions to load when using osapi_volume_extension option with cinder.api.contrib.select_extensions
* - ``osapi_volume_extension`` = ``['cinder.api.contrib.standard_extensions']``
- (MultiStrOpt) osapi volume extension to load
- (Multi-valued) osapi volume extension to load
* - ``osapi_volume_listen`` = ``0.0.0.0``
- (StrOpt) IP address on which OpenStack Volume API listens
- (String) IP address on which OpenStack Volume API listens
* - ``osapi_volume_listen_port`` = ``8776``
- (PortOpt) Port on which OpenStack Volume API listens
- (Unknown) Port on which OpenStack Volume API listens
* - ``osapi_volume_workers`` = ``None``
- (IntOpt) Number of workers for OpenStack Volume API service. The default is equal to the number of CPUs available.
* - ``password`` =
- (StrOpt) Password for Redis server (optional).
- (Integer) Number of workers for OpenStack Volume API service. The default is equal to the number of CPUs available.
* - ``per_volume_size_limit`` = ``-1``
- (IntOpt) Max size allowed per volume, in gigabytes
* - ``port`` = ``6379``
- (PortOpt) Use this port to connect to redis host.
- (Integer) Max size allowed per volume, in gigabytes
* - ``public_endpoint`` = ``None``
- (StrOpt) 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 Cinder is operating behind a proxy, you will want to change this to represent the proxy's URL.
- (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 Cinder is operating behind a proxy, you will want to change this to represent the proxy's URL.
* - ``query_volume_filters`` = ``name, status, metadata, availability_zone, bootable``
- (ListOpt) Volume filter options which non-admin user could use to query volumes. Default values are: ['name', 'status', 'metadata', 'availability_zone','bootable']
- (List) Volume filter options which non-admin user could use to query volumes. Default values are: ['name', 'status', 'metadata', 'availability_zone' ,'bootable']
* - ``transfer_api_class`` = ``cinder.transfer.api.API``
- (StrOpt) The full class name of the volume transfer API class
- (String) The full class name of the volume transfer API class
* - ``volume_api_class`` = ``cinder.volume.api.API``
- (StrOpt) The full class name of the volume API class to use
- (String) The full class name of the volume API class to use
* - ``volume_name_prefix`` = ``openstack-``
- (StrOpt) Prefix before volume name to differenciate DISCO volume created through openstack and the other ones
- (String) Prefix before volume name to differenciate DISCO volume created through openstack and the other ones
* - ``volume_name_template`` = ``volume-%s``
- (StrOpt) Template string to be used to generate volume names
- (String) Template string to be used to generate volume names
* - ``volume_number_multiplier`` = ``-1.0``
- (FloatOpt) Multiplier used for weighing volume number. Negative numbers mean to spread vs stack.
- (Floating point) Multiplier used for weighing volume number. Negative numbers mean to spread vs stack.
* - ``volume_transfer_key_length`` = ``16``
- (IntOpt) The number of characters in the autogenerated auth key.
- (Integer) The number of characters in the autogenerated auth key.
* - ``volume_transfer_salt_length`` = ``8``
- (IntOpt) The number of characters in the salt.
- (Integer) The number of characters in the salt.
* - **[oslo_middleware]**
-
* - ``max_request_body_size`` = ``114688``
- (IntOpt) The maximum body size for each request, in bytes.
- (Integer) The maximum body size for each request, in bytes.
* - ``secure_proxy_ssl_header`` = ``X-Forwarded-Proto``
- (StrOpt) 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 an SSL termination proxy.
* - **[oslo_policy]**
-
* - ``policy_default_rule`` = ``default``
- (StrOpt) Default rule. Enforced when a requested rule is not found.
- (String) Default rule. Enforced when a requested rule is not found.
* - ``policy_dirs`` = ``['policy.d']``
- (MultiStrOpt) Directories where policy configuration files are stored. They can be relative to any directory in the search path defined by the config_dir option, or absolute paths. The file defined by policy_file must exist for these directories to be searched. Missing or empty directories are ignored.
- (Multi-valued) Directories where policy configuration files are stored. They can be relative to any directory in the search path defined by the config_dir option, or absolute paths. The file defined by policy_file must exist for these directories to be searched. Missing or empty directories are ignored.
* - ``policy_file`` = ``policy.json``
- (StrOpt) The JSON file that defines policies.
- (String) The JSON file that defines policies.
* - **[oslo_versionedobjects]**
-
* - ``fatal_exception_format_errors`` = ``False``
- (BoolOpt) Make exception message format errors fatal
- (Boolean) Make exception message format errors fatal

View File

@ -19,4 +19,4 @@
* - **[DEFAULT]**
-
* - ``auth_strategy`` = ``keystone``
- (StrOpt) The strategy to use for auth. Supports noauth or keystone.
- (String) The strategy to use for auth. Supports noauth or keystone.

View File

@ -19,76 +19,76 @@
* - **[keystone_authtoken]**
-
* - ``admin_password`` = ``None``
- (StrOpt) Service user password.
- (String) Service user password.
* - ``admin_tenant_name`` = ``admin``
- (StrOpt) Service tenant name.
- (String) Service tenant name.
* - ``admin_token`` = ``None``
- (StrOpt) This option is deprecated and may be removed in a future release. Single shared secret with the Keystone configuration used for bootstrapping a Keystone installation, or otherwise bypassing the normal authentication process. This option should not be used, use `admin_user` and `admin_password` instead.
- (String) This option is deprecated and may be removed in a future release. Single shared secret with the Keystone configuration used for bootstrapping a Keystone installation, or otherwise bypassing the normal authentication process. This option should not be used, use `admin_user` and `admin_password` instead.
* - ``admin_user`` = ``None``
- (StrOpt) Service username.
- (String) Service username.
* - ``auth_admin_prefix`` =
- (StrOpt) Prefix to prepend at the beginning of the path. Deprecated, use identity_uri.
- (String) Prefix to prepend at the beginning of the path. Deprecated, use identity_uri.
* - ``auth_host`` = ``127.0.0.1``
- (StrOpt) Host providing the admin Identity API endpoint. Deprecated, use identity_uri.
- (String) Host providing the admin Identity API endpoint. Deprecated, use identity_uri.
* - ``auth_port`` = ``35357``
- (IntOpt) Port of the admin Identity API endpoint. Deprecated, use identity_uri.
- (Integer) Port of the admin Identity API endpoint. Deprecated, use identity_uri.
* - ``auth_protocol`` = ``https``
- (StrOpt) Protocol of the admin Identity API endpoint. Deprecated, use identity_uri.
- (String) Protocol of the admin Identity API endpoint. Deprecated, use identity_uri.
* - ``auth_section`` = ``None``
- (Opt) Config Section from which to load plugin specific options
- (Unknown) Config Section from which to load plugin specific options
* - ``auth_type`` = ``None``
- (Opt) Authentication type to load
- (Unknown) Authentication type to load
* - ``auth_uri`` = ``None``
- (StrOpt) Complete public Identity API endpoint.
- (String) Complete public Identity API endpoint.
* - ``auth_version`` = ``None``
- (StrOpt) API version of the admin Identity API endpoint.
- (String) API version of the admin Identity API endpoint.
* - ``cache`` = ``None``
- (StrOpt) Env key for the swift cache.
- (String) Env key for the swift cache.
* - ``cafile`` = ``None``
- (StrOpt) A PEM encoded Certificate Authority to use when verifying HTTPs connections. Defaults to system CAs.
- (String) A PEM encoded Certificate Authority to use when verifying HTTPs connections. Defaults to system CAs.
* - ``certfile`` = ``None``
- (StrOpt) Required if identity server requires client certificate
- (String) Required if identity server requires client certificate
* - ``check_revocations_for_cached`` = ``False``
- (BoolOpt) If true, the revocation list will be checked for cached tokens. This requires that PKI tokens are configured on the identity server.
- (Boolean) If true, the revocation list will be checked for cached tokens. This requires that PKI tokens are configured on the identity server.
* - ``delay_auth_decision`` = ``False``
- (BoolOpt) Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components.
- (Boolean) Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components.
* - ``enforce_token_bind`` = ``permissive``
- (StrOpt) Used to control the use and type of token binding. Can be set to: "disabled" to not check token binding. "permissive" (default) to validate binding information if the bind type is of a form known to the server and ignore it if not. "strict" like "permissive" but if the bind type is unknown the token will be rejected. "required" any form of token binding is needed to be allowed. Finally the name of a binding method that must be present in tokens.
- (String) Used to control the use and type of token binding. Can be set to: "disabled" to not check token binding. "permissive" (default) to validate binding information if the bind type is of a form known to the server and ignore it if not. "strict" like "permissive" but if the bind type is unknown the token will be rejected. "required" any form of token binding is needed to be allowed. Finally the name of a binding method that must be present in tokens.
* - ``hash_algorithms`` = ``md5``
- (ListOpt) Hash algorithms to use for hashing PKI tokens. This may be a single algorithm or multiple. The algorithms are those supported by Python standard hashlib.new(). The hashes will be tried in the order given, so put the preferred one first for performance. The result of the first hash will be stored in the cache. This will typically be set to multiple values only while migrating from a less secure algorithm to a more secure one. Once all the old tokens are expired this option should be set to a single value for better performance.
- (List) Hash algorithms to use for hashing PKI tokens. This may be a single algorithm or multiple. The algorithms are those supported by Python standard hashlib.new(). The hashes will be tried in the order given, so put the preferred one first for performance. The result of the first hash will be stored in the cache. This will typically be set to multiple values only while migrating from a less secure algorithm to a more secure one. Once all the old tokens are expired this option should be set to a single value for better performance.
* - ``http_connect_timeout`` = ``None``
- (IntOpt) Request timeout value for communicating with Identity API server.
- (Integer) Request timeout value for communicating with Identity API server.
* - ``http_request_max_retries`` = ``3``
- (IntOpt) How many times are we trying to reconnect when communicating with Identity API Server.
- (Integer) How many times are we trying to reconnect when communicating with Identity API Server.
* - ``identity_uri`` = ``None``
- (StrOpt) Complete admin Identity API endpoint. This should specify the unversioned root endpoint e.g. https://localhost:35357/
- (String) Complete admin Identity API endpoint. This should specify the unversioned root endpoint e.g. https://localhost:35357/
* - ``include_service_catalog`` = ``True``
- (BoolOpt) (Optional) Indicate whether to set the X-Service-Catalog header. If False, middleware will not ask for service catalog on token validation and will not set the X-Service-Catalog header.
- (Boolean) (Optional) Indicate whether to set the X-Service-Catalog header. If False, middleware will not ask for service catalog on token validation and will not set the X-Service-Catalog header.
* - ``insecure`` = ``False``
- (BoolOpt) Verify HTTPS connections.
- (Boolean) Verify HTTPS connections.
* - ``keyfile`` = ``None``
- (StrOpt) Required if identity server requires client certificate
- (String) Required if identity server requires client certificate
* - ``memcache_pool_conn_get_timeout`` = ``10``
- (IntOpt) (Optional) Number of seconds that an operation will wait to get a memcached client connection from the pool.
- (Integer) (Optional) Number of seconds that an operation will wait to get a memcached client connection from the pool.
* - ``memcache_pool_dead_retry`` = ``300``
- (IntOpt) (Optional) Number of seconds memcached server is considered dead before it is tried again.
- (Integer) (Optional) Number of seconds memcached server is considered dead before it is tried again.
* - ``memcache_pool_maxsize`` = ``10``
- (IntOpt) (Optional) Maximum total number of open connections to every memcached server.
- (Integer) (Optional) Maximum total number of open connections to every memcached server.
* - ``memcache_pool_socket_timeout`` = ``3``
- (IntOpt) (Optional) Socket timeout in seconds for communicating with a memcached server.
- (Integer) (Optional) Socket timeout in seconds for communicating with a memcached server.
* - ``memcache_pool_unused_timeout`` = ``60``
- (IntOpt) (Optional) Number of seconds a connection to memcached is held unused in the pool before it is closed.
- (Integer) (Optional) Number of seconds a connection to memcached is held unused in the pool before it is closed.
* - ``memcache_secret_key`` = ``None``
- (StrOpt) (Optional, mandatory if memcache_security_strategy is defined) This string is used for key derivation.
- (String) (Optional, mandatory if memcache_security_strategy is defined) This string is used for key derivation.
* - ``memcache_security_strategy`` = ``None``
- (StrOpt) (Optional) If defined, indicate whether token data should be authenticated or authenticated and encrypted. If MAC, token data is authenticated (with HMAC) in the cache. If ENCRYPT, token data is encrypted and authenticated in the cache. If the value is not one of these options or empty, auth_token will raise an exception on initialization.
- (String) (Optional) If defined, indicate whether token data should be authenticated or authenticated and encrypted. If MAC, token data is authenticated (with HMAC) in the cache. If ENCRYPT, token data is encrypted and authenticated in the cache. If the value is not one of these options or empty, auth_token will raise an exception on initialization.
* - ``memcache_use_advanced_pool`` = ``False``
- (BoolOpt) (Optional) Use the advanced (eventlet safe) memcached client pool. The advanced pool will only work under python 2.x.
- (Boolean) (Optional) Use the advanced (eventlet safe) memcached client pool. The advanced pool will only work under python 2.x.
* - ``region_name`` = ``None``
- (StrOpt) The region in which the identity server can be found.
- (String) The region in which the identity server can be found.
* - ``revocation_cache_time`` = ``10``
- (IntOpt) Determines the frequency at which the list of revoked tokens is retrieved from the Identity service (in seconds). A high number of revocation events combined with a low cache duration may significantly reduce performance.
- (Integer) Determines the frequency at which the list of revoked tokens is retrieved from the Identity service (in seconds). A high number of revocation events combined with a low cache duration may significantly reduce performance.
* - ``signing_dir`` = ``None``
- (StrOpt) Directory used to cache files related to PKI tokens.
- (String) Directory used to cache files related to PKI tokens.
* - ``token_cache_time`` = ``300``
- (IntOpt) In order to prevent excessive effort spent validating tokens, the middleware caches previously-seen tokens for a configurable duration (in seconds). Set to -1 to disable caching completely.
- (Integer) In order to prevent excessive effort spent validating tokens, the middleware caches previously-seen tokens for a configurable duration (in seconds). Set to -1 to disable caching completely.

View File

@ -19,30 +19,32 @@
* - **[DEFAULT]**
-
* - ``backup_api_class`` = ``cinder.backup.api.API``
- (StrOpt) The full class name of the volume backup API class
- (String) The full class name of the volume backup API class
* - ``backup_compression_algorithm`` = ``zlib``
- (StrOpt) Compression algorithm (None to disable)
- (String) Compression algorithm (None to disable)
* - ``backup_driver`` = ``cinder.backup.drivers.swift``
- (StrOpt) Driver to use for backups.
- (String) Driver to use for backups.
* - ``backup_manager`` = ``cinder.backup.manager.BackupManager``
- (StrOpt) Full class name for the Manager for volume backup
- (String) Full class name for the Manager for volume backup
* - ``backup_metadata_version`` = ``2``
- (IntOpt) Backup metadata version to be used when backing up volume metadata. If this number is bumped, make sure the service doing the restore supports the new version.
- (Integer) Backup metadata version to be used when backing up volume metadata. If this number is bumped, make sure the service doing the restore supports the new version.
* - ``backup_name_template`` = ``backup-%s``
- (StrOpt) Template string to be used to generate backup names
- (String) Template string to be used to generate backup names
* - ``backup_object_number_per_notification`` = ``10``
- (IntOpt) The number of chunks or objects, for which one Ceilometer notification will be sent
- (Integer) The number of chunks or objects, for which one Ceilometer notification will be sent
* - ``backup_posix_path`` = ``$state_path/backup``
- (StrOpt) Path specifying where to store backups.
- (String) Path specifying where to store backups.
* - ``backup_service_inithost_offload`` = ``False``
- (BoolOpt) Offload pending backup delete during backup service startup.
- (Boolean) Offload pending backup delete during backup service startup.
* - ``backup_timer_interval`` = ``120``
- (IntOpt) Interval, in seconds, between two progress notifications reporting the backup status
- (Integer) Interval, in seconds, between two progress notifications reporting the backup status
* - ``backup_topic`` = ``cinder-backup``
- (StrOpt) The topic that volume backup nodes listen on
- (String) The topic that volume backup nodes listen on
* - ``backup_use_same_host`` = ``False``
- (Boolean) Backup services use same backend.
* - ``snapshot_check_timeout`` = ``3600``
- (IntOpt) How long we check whether a snapshot is finished before we give up
- (Integer) How long we check whether a snapshot is finished before we give up
* - ``snapshot_name_template`` = ``snapshot-%s``
- (StrOpt) Template string to be used to generate snapshot names
- (String) Template string to be used to generate snapshot names
* - ``snapshot_same_host`` = ``True``
- (BoolOpt) Create volume from snapshot at the host where snapshot resides
- (Boolean) Create volume from snapshot at the host where snapshot resides

View File

@ -19,16 +19,16 @@
* - **[DEFAULT]**
-
* - ``backup_ceph_chunk_size`` = ``134217728``
- (IntOpt) The chunk size, in bytes, that a backup is broken into before transfer to the Ceph object store.
- (Integer) The chunk size, in bytes, that a backup is broken into before transfer to the Ceph object store.
* - ``backup_ceph_conf`` = ``/etc/ceph/ceph.conf``
- (StrOpt) Ceph configuration file to use.
- (String) Ceph configuration file to use.
* - ``backup_ceph_pool`` = ``backups``
- (StrOpt) The Ceph pool where volume backups are stored.
- (String) The Ceph pool where volume backups are stored.
* - ``backup_ceph_stripe_count`` = ``0``
- (IntOpt) RBD stripe count to use when creating a backup image.
- (Integer) RBD stripe count to use when creating a backup image.
* - ``backup_ceph_stripe_unit`` = ``0``
- (IntOpt) RBD stripe unit to use when creating a backup image.
- (Integer) RBD stripe unit to use when creating a backup image.
* - ``backup_ceph_user`` = ``cinder``
- (StrOpt) The Ceph user to connect with. Default here is to use the same user as for Cinder volumes. If not using cephx this should be set to None.
- (String) The Ceph user to connect with. Default here is to use the same user as for Cinder volumes. If not using cephx this should be set to None.
* - ``restore_discard_excess_bytes`` = ``True``
- (BoolOpt) If True, always discard excess bytes when restoring volumes i.e. pad with zeroes.
- (Boolean) If True, always discard excess bytes when restoring volumes i.e. pad with zeroes.

View File

@ -19,28 +19,28 @@
* - **[DEFAULT]**
-
* - ``backup_gcs_block_size`` = ``32768``
- (IntOpt) The size in bytes that changes are tracked for incremental backups. backup_gcs_object_size has to be multiple of backup_gcs_block_size.
- (Integer) The size in bytes that changes are tracked for incremental backups. backup_gcs_object_size has to be multiple of backup_gcs_block_size.
* - ``backup_gcs_bucket`` = ``None``
- (StrOpt) The GCS bucket to use.
- (String) The GCS bucket to use.
* - ``backup_gcs_bucket_location`` = ``US``
- (StrOpt) Location of GCS bucket.
- (String) Location of GCS bucket.
* - ``backup_gcs_credential_file`` = ``None``
- (StrOpt) Absolute path of GCS service account credential file.
- (String) Absolute path of GCS service account credential file.
* - ``backup_gcs_enable_progress_timer`` = ``True``
- (BoolOpt) Enable or Disable the timer to send the periodic progress notifications to Ceilometer when backing up the volume to the GCS backend storage. The default value is True to enable the timer.
- (Boolean) Enable or Disable the timer to send the periodic progress notifications to Ceilometer when backing up the volume to the GCS backend storage. The default value is True to enable the timer.
* - ``backup_gcs_num_retries`` = ``3``
- (IntOpt) Number of times to retry.
- (Integer) Number of times to retry.
* - ``backup_gcs_object_size`` = ``52428800``
- (IntOpt) The size in bytes of GCS backup objects.
- (Integer) The size in bytes of GCS backup objects.
* - ``backup_gcs_project_id`` = ``None``
- (StrOpt) Owner project id for GCS bucket.
- (String) Owner project id for GCS bucket.
* - ``backup_gcs_reader_chunk_size`` = ``2097152``
- (IntOpt) GCS object will be downloaded in chunks of bytes.
- (Integer) GCS object will be downloaded in chunks of bytes.
* - ``backup_gcs_retry_error_codes`` = ``429``
- (ListOpt) List of GCS error codes.
- (List) List of GCS error codes.
* - ``backup_gcs_storage_class`` = ``NEARLINE``
- (StrOpt) Storage class of GCS bucket.
- (String) Storage class of GCS bucket.
* - ``backup_gcs_user_agent`` = ``gcscinder``
- (StrOpt) Http user-agent string for gcs api.
- (String) Http user-agent string for gcs api.
* - ``backup_gcs_writer_chunk_size`` = ``2097152``
- (IntOpt) GCS object will be uploaded in chunks of bytes. Pass in a value of -1 if the file is to be uploaded as a single chunk.
- (Integer) GCS object will be uploaded in chunks of bytes. Pass in a value of -1 if the file is to be uploaded as a single chunk.

View File

@ -19,16 +19,16 @@
* - **[DEFAULT]**
-
* - ``backup_container`` = ``None``
- (StrOpt) Custom directory to use for backups.
- (String) Custom directory to use for backups.
* - ``backup_enable_progress_timer`` = ``True``
- (BoolOpt) Enable or Disable the timer to send the periodic progress notifications to Ceilometer when backing up the volume to the backend storage. The default value is True to enable the timer.
- (Boolean) Enable or Disable the timer to send the periodic progress notifications to Ceilometer when backing up the volume to the backend storage. The default value is True to enable the timer.
* - ``backup_file_size`` = ``1999994880``
- (IntOpt) The maximum size in bytes of the files used to hold backups. If the volume being backed up exceeds this size, then it will be backed up into multiple files.backup_file_size must be a multiple of backup_sha_block_size_bytes.
- (Integer) The maximum size in bytes of the files used to hold backups. If the volume being backed up exceeds this size, then it will be backed up into multiple files.backup_file_size must be a multiple of backup_sha_block_size_bytes.
* - ``backup_mount_options`` = ``None``
- (StrOpt) Mount options passed to the NFS client. See NFS man page for details.
- (String) Mount options passed to the NFS client. See NFS man page for details.
* - ``backup_mount_point_base`` = ``$state_path/backup_mount``
- (StrOpt) Base dir containing mount point for NFS share.
- (String) Base dir containing mount point for NFS share.
* - ``backup_sha_block_size_bytes`` = ``32768``
- (IntOpt) The size in bytes that changes are tracked for incremental backups. backup_file_size has to be multiple of backup_sha_block_size_bytes.
- (Integer) The size in bytes that changes are tracked for incremental backups. backup_file_size has to be multiple of backup_sha_block_size_bytes.
* - ``backup_share`` = ``None``
- (StrOpt) NFS share in hostname:path, ipv4addr:path, or "[ipv6addr]:path" format.
- (String) NFS share in hostname:path, ipv4addr:path, or "[ipv6addr]:path" format.

View File

@ -19,32 +19,32 @@
* - **[DEFAULT]**
-
* - ``backup_swift_auth`` = ``per_user``
- (StrOpt) Swift authentication mechanism
- (String) Swift authentication mechanism
* - ``backup_swift_auth_version`` = ``1``
- (StrOpt) Swift authentication version. Specify "1" for auth 1.0, or "2" for auth 2.0
- (String) Swift authentication version. Specify "1" for auth 1.0, or "2" for auth 2.0
* - ``backup_swift_block_size`` = ``32768``
- (IntOpt) The size in bytes that changes are tracked for incremental backups. backup_swift_object_size has to be multiple of backup_swift_block_size.
- (Integer) The size in bytes that changes are tracked for incremental backups. backup_swift_object_size has to be multiple of backup_swift_block_size.
* - ``backup_swift_ca_cert_file`` = ``None``
- (StrOpt) Location of the CA certificate file to use for swift client requests.
- (String) Location of the CA certificate file to use for swift client requests.
* - ``backup_swift_container`` = ``volumebackups``
- (StrOpt) The default Swift container to use
- (String) The default Swift container to use
* - ``backup_swift_enable_progress_timer`` = ``True``
- (BoolOpt) Enable or Disable the timer to send the periodic progress notifications to Ceilometer when backing up the volume to the Swift backend storage. The default value is True to enable the timer.
- (Boolean) Enable or Disable the timer to send the periodic progress notifications to Ceilometer when backing up the volume to the Swift backend storage. The default value is True to enable the timer.
* - ``backup_swift_key`` = ``None``
- (StrOpt) Swift key for authentication
- (String) Swift key for authentication
* - ``backup_swift_object_size`` = ``52428800``
- (IntOpt) The size in bytes of Swift backup objects
- (Integer) The size in bytes of Swift backup objects
* - ``backup_swift_retry_attempts`` = ``3``
- (IntOpt) The number of retries to make for Swift operations
- (Integer) The number of retries to make for Swift operations
* - ``backup_swift_retry_backoff`` = ``2``
- (IntOpt) The backoff time in seconds between Swift retries
- (Integer) The backoff time in seconds between Swift retries
* - ``backup_swift_tenant`` = ``None``
- (StrOpt) Swift tenant/account name. Required when connecting to an auth 2.0 system
- (String) Swift tenant/account name. Required when connecting to an auth 2.0 system
* - ``backup_swift_url`` = ``None``
- (StrOpt) The URL of the Swift endpoint
- (String) The URL of the Swift endpoint
* - ``backup_swift_user`` = ``None``
- (StrOpt) Swift user name
- (String) Swift user name
* - ``keystone_catalog_info`` = ``identity:Identity Service:publicURL``
- (StrOpt) Info to match when looking for keystone in the service catalog. Format is: separated values of the form: <service_type>:<service_name>:<endpoint_type> - Only used if backup_swift_auth_url is unset
- (String) Info to match when looking for keystone in the service catalog. Format is: separated values of the form: <service_type>:<service_name>:<endpoint_type> - Only used if backup_swift_auth_url is unset
* - ``swift_catalog_info`` = ``object-store:swift:publicURL``
- (StrOpt) Info to match when looking for swift in the service catalog. Format is: separated values of the form: <service_type>:<service_name>:<endpoint_type> - Only used if backup_swift_url is unset
- (String) Info to match when looking for swift in the service catalog. Format is: separated values of the form: <service_type>:<service_name>:<endpoint_type> - Only used if backup_swift_url is unset

View File

@ -19,8 +19,8 @@
* - **[DEFAULT]**
-
* - ``backup_tsm_compression`` = ``True``
- (BoolOpt) Enable or Disable compression for backups
- (Boolean) Enable or Disable compression for backups
* - ``backup_tsm_password`` = ``password``
- (StrOpt) TSM password for the running username
- (String) TSM password for the running username
* - ``backup_tsm_volume_prefix`` = ``backup``
- (StrOpt) Volume prefix for the backup id when backing up to TSM
- (String) Volume prefix for the backup id when backing up to TSM

View File

@ -19,4 +19,4 @@
* - **[DEFAULT]**
-
* - ``available_devices`` =
- (ListOpt) List of all available devices
- (List) List of all available devices

View File

@ -19,18 +19,18 @@
* - **[DEFAULT]**
-
* - ``blockbridge_api_host`` = ``None``
- (StrOpt) IP address/hostname of Blockbridge API.
- (String) IP address/hostname of Blockbridge API.
* - ``blockbridge_api_port`` = ``None``
- (IntOpt) Override HTTPS port to connect to Blockbridge API server.
- (Integer) Override HTTPS port to connect to Blockbridge API server.
* - ``blockbridge_auth_password`` = ``None``
- (StrOpt) Blockbridge API password (for auth scheme 'password')
- (String) Blockbridge API password (for auth scheme 'password')
* - ``blockbridge_auth_scheme`` = ``token``
- (StrOpt) Blockbridge API authentication scheme (token or password)
- (String) Blockbridge API authentication scheme (token or password)
* - ``blockbridge_auth_token`` = ``None``
- (StrOpt) Blockbridge API token (for auth scheme 'token')
- (String) Blockbridge API token (for auth scheme 'token')
* - ``blockbridge_auth_user`` = ``None``
- (StrOpt) Blockbridge API user (for auth scheme 'password')
- (String) Blockbridge API user (for auth scheme 'password')
* - ``blockbridge_default_pool`` = ``None``
- (StrOpt) Default pool name if unspecified.
- (String) Default pool name if unspecified.
* - ``blockbridge_pools`` = ``{'OpenStack': '+openstack'}``
- (DictOpt) Defines the set of exposed pools and their associated backend query strings
- (Dict) Defines the set of exposed pools and their associated backend query strings

View File

@ -19,26 +19,26 @@
* - **[DEFAULT]**
-
* - ``cb_account_name`` = ``None``
- (StrOpt) CloudByte storage specific account name. This maps to a project name in OpenStack.
- (String) CloudByte storage specific account name. This maps to a project name in OpenStack.
* - ``cb_add_qosgroup`` = ``{'latency': '15', 'iops': '10', 'graceallowed': 'false', 'iopscontrol': 'true', 'memlimit': '0', 'throughput': '0', 'tpcontrol': 'false', 'networkspeed': '0'}``
- (DictOpt) These values will be used for CloudByte storage's addQos API call.
- (Dict) These values will be used for CloudByte storage's addQos API call.
* - ``cb_apikey`` = ``None``
- (StrOpt) Driver will use this API key to authenticate against the CloudByte storage's management interface.
- (String) Driver will use this API key to authenticate against the CloudByte storage's management interface.
* - ``cb_auth_group`` = ``None``
- (StrOpt) This corresponds to the discovery authentication group in CloudByte storage. Chap users are added to this group. Driver uses the first user found for this group. Default value is None.
- (String) This corresponds to the discovery authentication group in CloudByte storage. Chap users are added to this group. Driver uses the first user found for this group. Default value is None.
* - ``cb_confirm_volume_create_retries`` = ``3``
- (IntOpt) Will confirm a successful volume creation in CloudByte storage by making this many number of attempts.
- (Integer) Will confirm a successful volume creation in CloudByte storage by making this many number of attempts.
* - ``cb_confirm_volume_create_retry_interval`` = ``5``
- (IntOpt) A retry value in seconds. Will be used by the driver to check if volume creation was successful in CloudByte storage.
- (Integer) A retry value in seconds. Will be used by the driver to check if volume creation was successful in CloudByte storage.
* - ``cb_confirm_volume_delete_retries`` = ``3``
- (IntOpt) Will confirm a successful volume deletion in CloudByte storage by making this many number of attempts.
- (Integer) Will confirm a successful volume deletion in CloudByte storage by making this many number of attempts.
* - ``cb_confirm_volume_delete_retry_interval`` = ``5``
- (IntOpt) A retry value in seconds. Will be used by the driver to check if volume deletion was successful in CloudByte storage.
- (Integer) A retry value in seconds. Will be used by the driver to check if volume deletion was successful in CloudByte storage.
* - ``cb_create_volume`` = ``{'compression': 'off', 'deduplication': 'off', 'blocklength': '512B', 'sync': 'always', 'protocoltype': 'ISCSI', 'recordsize': '16k'}``
- (DictOpt) These values will be used for CloudByte storage's createVolume API call.
- (Dict) These values will be used for CloudByte storage's createVolume API call.
* - ``cb_tsm_name`` = ``None``
- (StrOpt) This corresponds to the name of Tenant Storage Machine (TSM) in CloudByte storage. A volume will be created in this TSM.
- (String) This corresponds to the name of Tenant Storage Machine (TSM) in CloudByte storage. A volume will be created in this TSM.
* - ``cb_update_file_system`` = ``compression, sync, noofcopies, readonly``
- (ListOpt) These values will be used for CloudByte storage's updateFileSystem API call.
- (List) These values will be used for CloudByte storage's updateFileSystem API call.
* - ``cb_update_qos_group`` = ``iops, latency, graceallowed``
- (ListOpt) These values will be used for CloudByte storage's updateQosGroup API call.
- (List) These values will be used for CloudByte storage's updateQosGroup API call.

View File

@ -19,4 +19,4 @@
* - **[DEFAULT]**
-
* - ``coho_rpc_port`` = ``2049``
- (IntOpt) RPC port to connect to Coha Data MicroArray
- (Integer) RPC port to connect to Coha Data MicroArray

View File

@ -19,112 +19,116 @@
* - **[DEFAULT]**
-
* - ``allow_availability_zone_fallback`` = ``False``
- (BoolOpt) If the requested Cinder availability zone is unavailable, fall back to the value of default_availability_zone, then storage_availability_zone, instead of failing.
- (Boolean) If the requested Cinder availability zone is unavailable, fall back to the value of default_availability_zone, then storage_availability_zone, instead of failing.
* - ``chap_password`` =
- (StrOpt) Password for specified CHAP account name.
- (String) Password for specified CHAP account name.
* - ``chap_username`` =
- (StrOpt) CHAP user name.
- (String) CHAP user name.
* - ``chiscsi_conf`` = ``/etc/chelsio-iscsi/chiscsi.conf``
- (StrOpt) Chiscsi (CXT) global defaults configuration file
- (String) Chiscsi (CXT) global defaults configuration file
* - ``cinder_internal_tenant_project_id`` = ``None``
- (StrOpt) ID of the project which will be used as the Cinder internal tenant.
- (String) ID of the project which will be used as the Cinder internal tenant.
* - ``cinder_internal_tenant_user_id`` = ``None``
- (StrOpt) ID of the user to be used in volume operations as the Cinder internal tenant.
- (String) ID of the user to be used in volume operations as the Cinder internal tenant.
* - ``compute_api_class`` = ``cinder.compute.nova.API``
- (StrOpt) The full class name of the compute API class to use
- (String) The full class name of the compute API class to use
* - ``consistencygroup_api_class`` = ``cinder.consistencygroup.api.API``
- (StrOpt) The full class name of the consistencygroup API class
- (String) The full class name of the consistencygroup API class
* - ``default_availability_zone`` = ``None``
- (StrOpt) Default availability zone for new volumes. If not set, the storage_availability_zone option value is used as the default for new volumes.
- (String) Default availability zone for new volumes. If not set, the storage_availability_zone option value is used as the default for new volumes.
* - ``default_volume_type`` = ``None``
- (StrOpt) Default volume type to use
- (String) Default volume type to use
* - ``driver_data_namespace`` = ``None``
- (StrOpt) Namespace for driver private data values to be saved in.
- (String) Namespace for driver private data values to be saved in.
* - ``driver_ssl_cert_path`` = ``None``
- (String) Can be used to specify a non default path to a CA_BUNDLE file or directory with certificates of trusted CAs, which will be used to validate the backend
* - ``driver_ssl_cert_verify`` = ``False``
- (BoolOpt) If set to True the http client will validate the SSL certificate of the backend endpoint.
- (Boolean) If set to True the http client will validate the SSL certificate of the backend endpoint.
* - ``enable_force_upload`` = ``False``
- (BoolOpt) Enables the Force option on upload_to_image. This enables running upload_volume on in-use volumes for backends that support it.
- (Boolean) Enables the Force option on upload_to_image. This enables running upload_volume on in-use volumes for backends that support it.
* - ``enable_new_services`` = ``True``
- (BoolOpt) Services to be added to the available pool on create
- (Boolean) Services to be added to the available pool on create
* - ``end_time`` = ``None``
- (StrOpt) If this option is specified then the end time specified is used instead of the end time of the last completed audit period.
- (String) If this option is specified then the end time specified is used instead of the end time of the last completed audit period.
* - ``enforce_multipath_for_image_xfer`` = ``False``
- (BoolOpt) If this is set to True, attachment of volumes for image transfer will be aborted when multipathd is not running. Otherwise, it will fallback to single path.
- (Boolean) If this is set to True, attachment of volumes for image transfer will be aborted when multipathd is not running. Otherwise, it will fallback to single path.
* - ``executor_thread_pool_size`` = ``64``
- (IntOpt) Size of executor thread pool.
- (Integer) Size of executor thread pool.
* - ``host`` = ``localhost``
- (StrOpt) Name of this node. This can be an opaque identifier. It is not necessarily a host name, FQDN, or IP address.
- (String) Name of this node. This can be an opaque identifier. It is not necessarily a host name, FQDN, or IP address.
* - ``iet_conf`` = ``/etc/iet/ietd.conf``
- (StrOpt) IET configuration file
- (String) IET configuration file
* - ``iscsi_secondary_ip_addresses`` =
- (ListOpt) The list of secondary IP addresses of the iSCSI daemon
- (List) The list of secondary IP addresses of the iSCSI daemon
* - ``max_over_subscription_ratio`` = ``20.0``
- (FloatOpt) Float representation of the over subscription ratio when thin provisioning is involved. Default ratio is 20.0, meaning provisioned capacity can be 20 times of the total physical capacity. If the ratio is 10.5, it means provisioned capacity can be 10.5 times of the total physical capacity. A ratio of 1.0 means provisioned capacity cannot exceed the total physical capacity. A ratio lower than 1.0 will be ignored and the default value will be used instead.
- (Floating point) Float representation of the over subscription ratio when thin provisioning is involved. Default ratio is 20.0, meaning provisioned capacity can be 20 times of the total physical capacity. If the ratio is 10.5, it means provisioned capacity can be 10.5 times of the total physical capacity. A ratio of 1.0 means provisioned capacity cannot exceed the total physical capacity. The ratio has to be a minimum of 1.0.
* - ``memcached_servers`` = ``None``
- (List) Memcached servers or None for in process cache.
* - ``monkey_patch`` = ``False``
- (BoolOpt) Enable monkey patching
- (Boolean) Enable monkey patching
* - ``monkey_patch_modules`` =
- (ListOpt) List of modules/decorators to monkey patch
- (List) List of modules/decorators to monkey patch
* - ``my_ip`` = ``10.0.0.1``
- (StrOpt) IP address of this host
- (String) IP address of this host
* - ``no_snapshot_gb_quota`` = ``False``
- (BoolOpt) Whether snapshots count against gigabyte quota
- (Boolean) Whether snapshots count against gigabyte quota
* - ``num_shell_tries`` = ``3``
- (IntOpt) Number of times to attempt to run flakey shell commands
- (Integer) Number of times to attempt to run flakey shell commands
* - ``os_privileged_user_auth_url`` = ``None``
- (StrOpt) Auth URL associated with the OpenStack privileged account.
- (String) Auth URL associated with the OpenStack privileged account.
* - ``os_privileged_user_name`` = ``None``
- (StrOpt) OpenStack privileged account username. Used for requests to other services (such as Nova) that require an account with special rights.
- (String) OpenStack privileged account username. Used for requests to other services (such as Nova) that require an account with special rights.
* - ``os_privileged_user_password`` = ``None``
- (StrOpt) Password associated with the OpenStack privileged account.
- (String) Password associated with the OpenStack privileged account.
* - ``os_privileged_user_tenant`` = ``None``
- (StrOpt) Tenant name associated with the OpenStack privileged account.
- (String) Tenant name associated with the OpenStack privileged account.
* - ``periodic_fuzzy_delay`` = ``60``
- (IntOpt) Range, in seconds, to randomly delay when starting the periodic task scheduler to reduce stampeding. (Disable by setting to 0)
- (Integer) Range, in seconds, to randomly delay when starting the periodic task scheduler to reduce stampeding. (Disable by setting to 0)
* - ``periodic_interval`` = ``60``
- (IntOpt) Interval, in seconds, between running periodic tasks
- (Integer) Interval, in seconds, between running periodic tasks
* - ``replication_api_class`` = ``cinder.replication.api.API``
- (StrOpt) The full class name of the volume replication API class
- (String) The full class name of the volume replication API class
* - ``replication_device`` = ``None``
- (MultiOpt) Multi opt of dictionaries to represent a replication target device. This option may be specified multiple times in a single config section to specify multiple replication target devices. Each entry takes the standard dict config form: replication_device = target_device_id:<required>,managed_backend_name:<host@backend_name>,key1:value1,key2:value2...
- (Unknown) Multi opt of dictionaries to represent a replication target device. This option may be specified multiple times in a single config section to specify multiple replication target devices. Each entry takes the standard dict config form: replication_device = target_device_id:<required>,key1:value1,key2:value2...
* - ``report_discard_supported`` = ``False``
- (BoolOpt) Report to clients of Cinder that the backend supports discard (aka. trim/unmap). This will not actually change the behavior of the backend or the client directly, it will only notify that it can be used.
- (Boolean) Report to clients of Cinder that the backend supports discard (aka. trim/unmap). This will not actually change the behavior of the backend or the client directly, it will only notify that it can be used.
* - ``report_interval`` = ``10``
- (IntOpt) Interval, in seconds, between nodes reporting state to datastore
- (Integer) Interval, in seconds, between nodes reporting state to datastore
* - ``reserved_percentage`` = ``0``
- (IntOpt) The percentage of backend capacity is reserved
- (Integer) The percentage of backend capacity is reserved
* - ``rootwrap_config`` = ``/etc/cinder/rootwrap.conf``
- (StrOpt) 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
* - ``send_actions`` = ``False``
- (BoolOpt) Send the volume and snapshot create and delete notifications generated in the specified period.
- (Boolean) Send the volume and snapshot create and delete notifications generated in the specified period.
* - ``service_down_time`` = ``60``
- (IntOpt) Maximum time since last check-in for a service to be considered up
* - ``sqlite_clean_db`` = ``clean.sqlite``
- (StrOpt) File name of clean sqlite db
- (Integer) Maximum time since last check-in for a service to be considered up
* - ``ssh_hosts_key_file`` = ``$state_path/ssh_known_hosts``
- (StrOpt) File containing SSH host keys for the systems with which Cinder needs to communicate. OPTIONAL: Default=$state_path/ssh_known_hosts
- (String) File containing SSH host keys for the systems with which Cinder needs to communicate. OPTIONAL: Default=$state_path/ssh_known_hosts
* - ``start_time`` = ``None``
- (StrOpt) If this option is specified then the start time specified is used instead of the start time of the last completed audit period.
- (String) If this option is specified then the start time specified is used instead of the start time of the last completed audit period.
* - ``state_path`` = ``/var/lib/cinder``
- (StrOpt) Top-level directory for maintaining cinder's state
- (String) Top-level directory for maintaining cinder's state
* - ``storage_availability_zone`` = ``nova``
- (StrOpt) Availability zone of this node
- (String) Availability zone of this node
* - ``strict_ssh_host_key_policy`` = ``False``
- (BoolOpt) Option to enable strict host key checking. When set to "True" Cinder will only connect to systems with a host key present in the configured "ssh_hosts_key_file". When set to "False" the host key will be saved upon first connection and used for subsequent connections. Default=False
- (Boolean) Option to enable strict host key checking. When set to "True" Cinder will only connect to systems with a host key present in the configured "ssh_hosts_key_file". When set to "False" the host key will be saved upon first connection and used for subsequent connections. Default=False
* - ``suppress_requests_ssl_warnings`` = ``False``
- (Boolean) Suppress requests library SSL certificate warnings.
* - ``tcp_keepalive`` = ``True``
- (BoolOpt) Sets the value of TCP_KEEPALIVE (True/False) for each server socket.
- (Boolean) Sets the value of TCP_KEEPALIVE (True/False) for each server socket.
* - ``tcp_keepalive_count`` = ``None``
- (IntOpt) Sets the value of TCP_KEEPCNT for each server socket. Not supported on OS X.
- (Integer) Sets the value of TCP_KEEPCNT for each server socket. Not supported on OS X.
* - ``tcp_keepalive_interval`` = ``None``
- (IntOpt) Sets the value of TCP_KEEPINTVL in seconds for each server socket. Not supported on OS X.
- (Integer) Sets the value of TCP_KEEPINTVL in seconds for each server socket. Not supported on OS X.
* - ``until_refresh`` = ``0``
- (IntOpt) Count of reservations until usage is refreshed
- (Integer) Count of reservations until usage is refreshed
* - ``use_chap_auth`` = ``False``
- (BoolOpt) Option to enable/disable CHAP authentication for targets.
- (Boolean) Option to enable/disable CHAP authentication for targets.
* - ``use_forwarded_for`` = ``False``
- (BoolOpt) Treat X-Forwarded-For as the canonical remote address. Only enable this if you have a sanitizing proxy.
- (Boolean) Treat X-Forwarded-For as the canonical remote address. Only enable this if you have a sanitizing proxy.
* - ``watch_log_file`` = ``False``
- (BoolOpt) Uses logging handler designed to watch file system. When log file is moved or removed this handler will open a new log file with specified path instantaneously. It makes sense only if log_file option is specified and Linux platform is used. This option is ignored if log_config_append is set.
- (Boolean) Uses logging handler designed to watch file system. When log file is moved or removed this handler will open a new log file with specified path instantaneously. It makes sense only if log_file option is specified and Linux platform is used. This option is ignored if log_config_append is set.
* - **[keystone_authtoken]**
-
* - ``memcached_servers`` = ``None``
- (ListOpt) Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process.
- (List) Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process.

View File

@ -19,16 +19,16 @@
* - **[DEFAULT]**
-
* - ``nova_api_insecure`` = ``False``
- (BoolOpt) Allow to perform insecure SSL requests to nova
- (Boolean) Allow to perform insecure SSL requests to nova
* - ``nova_ca_certificates_file`` = ``None``
- (StrOpt) Location of ca certificates file to use for nova client requests.
- (String) Location of ca certificates file to use for nova client requests.
* - ``nova_catalog_admin_info`` = ``compute:Compute Service:adminURL``
- (StrOpt) Same as nova_catalog_info, but for admin endpoint.
- (String) Same as nova_catalog_info, but for admin endpoint.
* - ``nova_catalog_info`` = ``compute:Compute Service:publicURL``
- (StrOpt) Match this value when searching for nova in the service catalog. Format is: separated values of the form: <service_type>:<service_name>:<endpoint_type>
- (String) Match this value when searching for nova in the service catalog. Format is: separated values of the form: <service_type>:<service_name>:<endpoint_type>
* - ``nova_endpoint_admin_template`` = ``None``
- (StrOpt) Same as nova_endpoint_template, but for admin endpoint.
- (String) Same as nova_endpoint_template, but for admin endpoint.
* - ``nova_endpoint_template`` = ``None``
- (StrOpt) Override service catalog lookup with template for nova endpoint e.g. http://localhost:8774/v2/%(project_id)s
- (String) Override service catalog lookup with template for nova endpoint e.g. http://localhost:8774/v2/%(project_id)s
* - ``os_region_name`` = ``None``
- (StrOpt) Region name of this node
- (String) Region name of this node

View File

@ -19,10 +19,10 @@
* - **[coordination]**
-
* - ``backend_url`` = ``file://$state_path``
- (StrOpt) The backend URL to use for distributed coordination.
- (String) The backend URL to use for distributed coordination.
* - ``heartbeat`` = ``1.0``
- (FloatOpt) Number of seconds between heartbeats for distributed coordination.
- (Floating point) Number of seconds between heartbeats for distributed coordination.
* - ``initial_reconnect_backoff`` = ``0.1``
- (FloatOpt) Initial number of seconds to wait after failed reconnection.
- (Floating point) Initial number of seconds to wait after failed reconnection.
* - ``max_reconnect_backoff`` = ``60.0``
- (FloatOpt) Maximum number of seconds between sequential reconnection retries.
- (Floating point) Maximum number of seconds between sequential reconnection retries.

View File

@ -19,28 +19,28 @@
* - **[cors]**
-
* - ``allow_credentials`` = ``True``
- (BoolOpt) Indicate that the actual request can include user credentials
- (Boolean) Indicate that the actual request can include user credentials
* - ``allow_headers`` = ``Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma``
- (ListOpt) Indicate which header field names may be used during the actual request.
- (List) Indicate which header field names may be used during the actual request.
* - ``allow_methods`` = ``GET, POST, PUT, DELETE, OPTIONS``
- (ListOpt) Indicate which methods can be used during the actual request.
- (List) Indicate which methods can be used during the actual request.
* - ``allowed_origin`` = ``None``
- (ListOpt) Indicate whether this resource may be shared with the domain received in the requests "origin" header.
- (List) Indicate whether this resource may be shared with the domain received in the requests "origin" header.
* - ``expose_headers`` = ``Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma``
- (ListOpt) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers.
- (List) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers.
* - ``max_age`` = ``3600``
- (IntOpt) Maximum cache age of CORS preflight requests.
- (Integer) Maximum cache age of CORS preflight requests.
* - **[cors.subdomain]**
-
* - ``allow_credentials`` = ``True``
- (BoolOpt) Indicate that the actual request can include user credentials
- (Boolean) Indicate that the actual request can include user credentials
* - ``allow_headers`` = ``Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma``
- (ListOpt) Indicate which header field names may be used during the actual request.
- (List) Indicate which header field names may be used during the actual request.
* - ``allow_methods`` = ``GET, POST, PUT, DELETE, OPTIONS``
- (ListOpt) Indicate which methods can be used during the actual request.
- (List) Indicate which methods can be used during the actual request.
* - ``allowed_origin`` = ``None``
- (ListOpt) Indicate whether this resource may be shared with the domain received in the requests "origin" header.
- (List) Indicate whether this resource may be shared with the domain received in the requests "origin" header.
* - ``expose_headers`` = ``Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma``
- (ListOpt) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers.
- (List) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers.
* - ``max_age`` = ``3600``
- (IntOpt) Maximum cache age of CORS preflight requests.
- (Integer) Maximum cache age of CORS preflight requests.

View File

@ -19,48 +19,48 @@
* - **[DEFAULT]**
-
* - ``db_driver`` = ``cinder.db``
- (StrOpt) Driver to use for database access
- (String) Driver to use for database access
* - **[database]**
-
* - ``backend`` = ``sqlalchemy``
- (StrOpt) The back end to use for the database.
- (String) The back end to use for the database.
* - ``connection`` = ``None``
- (StrOpt) The SQLAlchemy connection string to use to connect to the database.
- (String) The SQLAlchemy connection string to use to connect to the database.
* - ``connection_debug`` = ``0``
- (IntOpt) Verbosity of SQL debugging information: 0=None, 100=Everything.
- (Integer) Verbosity of SQL debugging information: 0=None, 100=Everything.
* - ``connection_trace`` = ``False``
- (BoolOpt) Add Python stack traces to SQL as comment strings.
- (Boolean) Add Python stack traces to SQL as comment strings.
* - ``db_inc_retry_interval`` = ``True``
- (BoolOpt) If True, increases the interval between retries of a database operation up to db_max_retry_interval.
- (Boolean) If True, increases the interval between retries of a database operation up to db_max_retry_interval.
* - ``db_max_retries`` = ``20``
- (IntOpt) Maximum retries in case of connection error or deadlock error before error is raised. Set to -1 to specify an infinite retry count.
- (Integer) Maximum retries in case of connection error or deadlock error before error is raised. Set to -1 to specify an infinite retry count.
* - ``db_max_retry_interval`` = ``10``
- (IntOpt) If db_inc_retry_interval is set, the maximum seconds between retries of a database operation.
- (Integer) If db_inc_retry_interval is set, the maximum seconds between retries of a database operation.
* - ``db_retry_interval`` = ``1``
- (IntOpt) Seconds between retries of a database transaction.
- (Integer) Seconds between retries of a database transaction.
* - ``idle_timeout`` = ``3600``
- (IntOpt) Timeout before idle SQL connections are reaped.
* - ``max_overflow`` = ``None``
- (IntOpt) If set, use this value for max_overflow with SQLAlchemy.
- (Integer) Timeout before idle SQL connections are reaped.
* - ``max_overflow`` = ``50``
- (Integer) If set, use this value for max_overflow with SQLAlchemy.
* - ``max_pool_size`` = ``None``
- (IntOpt) Maximum number of SQL connections to keep open in a pool.
- (Integer) Maximum number of SQL connections to keep open in a pool.
* - ``max_retries`` = ``10``
- (IntOpt) Maximum number of database connection retries during startup. Set to -1 to specify an infinite retry count.
- (Integer) Maximum number of database connection retries during startup. Set to -1 to specify an infinite retry count.
* - ``min_pool_size`` = ``1``
- (IntOpt) Minimum number of SQL connections to keep open in a pool.
- (Integer) Minimum number of SQL connections to keep open in a pool.
* - ``mysql_sql_mode`` = ``TRADITIONAL``
- (StrOpt) The SQL mode to be used for MySQL sessions. This option, including the default, overrides any server-set SQL mode. To use whatever SQL mode is set by the server configuration, set this to no value. Example: mysql_sql_mode=
- (String) The SQL mode to be used for MySQL sessions. This option, including the default, overrides any server-set SQL mode. To use whatever SQL mode is set by the server configuration, set this to no value. Example: mysql_sql_mode=
* - ``pool_timeout`` = ``None``
- (IntOpt) If set, use this value for pool_timeout with SQLAlchemy.
- (Integer) If set, use this value for pool_timeout with SQLAlchemy.
* - ``retry_interval`` = ``10``
- (IntOpt) Interval between retries of opening a SQL connection.
- (Integer) Interval between retries of opening a SQL connection.
* - ``slave_connection`` = ``None``
- (StrOpt) The SQLAlchemy connection string to use to connect to the slave database.
- (String) The SQLAlchemy connection string to use to connect to the slave database.
* - ``sqlite_db`` = ``oslo.sqlite``
- (StrOpt) The file name to use with SQLite.
- (String) The file name to use with SQLite.
* - ``sqlite_synchronous`` = ``True``
- (BoolOpt) If True, SQLite uses synchronous mode.
- (Boolean) If True, SQLite uses synchronous mode.
* - ``use_db_reconnect`` = ``False``
- (BoolOpt) Enable the experimental use of database reconnect on connection lost.
- (Boolean) Enable the experimental use of database reconnect on connection lost.
* - ``use_tpool`` = ``False``
- (BoolOpt) Enable the experimental use of thread pooling for all DB API calls
- (Boolean) Enable the experimental use of thread pooling for all DB API calls

View File

@ -19,14 +19,12 @@
* - **[DEFAULT]**
-
* - ``datera_api_port`` = ``7717``
- (StrOpt) Datera API port.
* - ``datera_api_token`` = ``None``
- (StrOpt) DEPRECATED: This will be removed in the Liberty release. Use san_login and san_password instead. This directly sets the Datera API token.
* - ``datera_api_version`` = ``1``
- (StrOpt) Datera API version.
* - ``datera_num_replicas`` = ``3``
- (StrOpt) Number of replicas to create of an inode.
- (String) Datera API port.
* - ``datera_api_version`` = ``2``
- (String) Datera API version.
* - ``datera_num_replicas`` = ``1``
- (String) Number of replicas to create of an inode.
* - ``driver_client_cert`` = ``None``
- (StrOpt) The path to the client certificate for verification, if the driver supports it.
- (String) The path to the client certificate for verification, if the driver supports it.
* - ``driver_client_cert_key`` = ``None``
- (StrOpt) The path to the client certificate key for verification, if the driver supports it.
- (String) The path to the client certificate key for verification, if the driver supports it.

View File

@ -19,4 +19,4 @@
* - **[DEFAULT]**
-
* - ``trace_flags`` = ``None``
- (ListOpt) List of options that control which trace info is written to the DEBUG log level to assist developers. Valid values are method and api.
- (List) List of options that control which trace info is written to the DEBUG log level to assist developers. Valid values are method and api.

View File

@ -19,12 +19,12 @@
* - **[DEFAULT]**
-
* - ``dell_sc_api_port`` = ``3033``
- (PortOpt) Dell API port
- (Unknown) Dell API port
* - ``dell_sc_server_folder`` = ``openstack``
- (StrOpt) Name of the server folder to use on the Storage Center
- (String) Name of the server folder to use on the Storage Center
* - ``dell_sc_ssn`` = ``64702``
- (IntOpt) Storage Center System Serial Number
- (Integer) Storage Center System Serial Number
* - ``dell_sc_verify_cert`` = ``False``
- (BoolOpt) Enable HTTPS SC certificate verification.
- (Boolean) Enable HTTPS SC certificate verification.
* - ``dell_sc_volume_folder`` = ``openstack``
- (StrOpt) Name of the volume folder to use on the Storage Center
- (String) Name of the volume folder to use on the Storage Center

View File

@ -19,14 +19,14 @@
* - **[DEFAULT]**
-
* - ``clone_check_timeout`` = ``3600``
- (IntOpt) How long we check whether a clone is finished before we give up
- (Integer) How long we check whether a clone is finished before we give up
* - ``disco_client`` = ``127.0.0.1``
- (IPOpt) The IP of DMS client socket server
- (Unknown) The IP of DMS client socket server
* - ``disco_client_port`` = ``9898``
- (PortOpt) The port to connect DMS client socket server
- (Unknown) The port to connect DMS client socket server
* - ``disco_wsdl_path`` = ``/etc/cinder/DISCOService.wsdl``
- (StrOpt) Path to the wsdl file to communicate with DISCO request manager
- (String) Path to the wsdl file to communicate with DISCO request manager
* - ``restore_check_timeout`` = ``3600``
- (IntOpt) How long we check whether a restore is finished before we give up
- (Integer) How long we check whether a restore is finished before we give up
* - ``retry_interval`` = ``1``
- (IntOpt) How long we wait before retrying to get an item detail
- (Integer) How long we wait before retrying to get an item detail

View File

@ -19,14 +19,14 @@
* - **[DEFAULT]**
-
* - ``dothill_api_protocol`` = ``https``
- (StrOpt) DotHill API interface protocol.
- (String) DotHill API interface protocol.
* - ``dothill_backend_name`` = ``A``
- (StrOpt) Pool or Vdisk name to use for volume creation.
- (String) Pool or Vdisk name to use for volume creation.
* - ``dothill_backend_type`` = ``virtual``
- (StrOpt) linear (for Vdisk) or virtual (for Pool).
- (String) linear (for Vdisk) or virtual (for Pool).
* - ``dothill_iscsi_ips`` =
- (ListOpt) List of comma-separated target iSCSI IP addresses.
- (List) List of comma-separated target iSCSI IP addresses.
* - ``dothill_verify_certificate`` = ``False``
- (BoolOpt) Whether to verify DotHill array SSL certificate.
- (Boolean) Whether to verify DotHill array SSL certificate.
* - ``dothill_verify_certificate_path`` = ``None``
- (StrOpt) DotHill array SSL certificate path.
- (String) DotHill array SSL certificate path.

View File

@ -19,6 +19,18 @@
* - **[DEFAULT]**
-
* - ``drbdmanage_devs_on_controller`` = ``True``
- (BoolOpt) If set, the c-vol node will receive a useable /dev/drbdX device, even if the actual data is stored on other nodes only. This is useful for debugging, maintenance, and to be able to do the iSCSI export from the c-vol node.
- (Boolean) If set, the c-vol node will receive a useable /dev/drbdX device, even if the actual data is stored on other nodes only. This is useful for debugging, maintenance, and to be able to do the iSCSI export from the c-vol node.
* - ``drbdmanage_redundancy`` = ``1``
- (IntOpt) Number of nodes that should replicate the data.
- (Integer) Number of nodes that should replicate the data.
* - ``drbdmanage_resize_plugin`` = ``drbdmanage.plugins.plugins.wait_for.WaitForVolumeSize``
- (String) Volume resize completion wait plugin.
* - ``drbdmanage_resize_policy`` = ``{"timeout": "60"}``
- (String) Volume resize completion wait policy.
* - ``drbdmanage_resource_plugin`` = ``drbdmanage.plugins.plugins.wait_for.WaitForResource``
- (String) Resource deployment completion wait plugin.
* - ``drbdmanage_resource_policy`` = ``{"ratio": "0.51", "timeout": "60"}``
- (String) Resource deployment completion wait policy.
* - ``drbdmanage_snapshot_plugin`` = ``drbdmanage.plugins.plugins.wait_for.WaitForSnapshot``
- (String) Snapshot completion wait plugin.
* - ``drbdmanage_snapshot_policy`` = ``{"count": "1", "timeout": "60"}``
- (String) Snapshot completion wait policy.

View File

@ -19,36 +19,36 @@
* - **[DEFAULT]**
-
* - ``check_max_pool_luns_threshold`` = ``False``
- (BoolOpt) Report free_capacity_gb as 0 when the limit to maximum number of pool LUNs is reached. By default, the value is False.
- (Boolean) Report free_capacity_gb as 0 when the limit to maximum number of pool LUNs is reached. By default, the value is False.
* - ``cinder_emc_config_file`` = ``/etc/cinder/cinder_emc_config.xml``
- (StrOpt) use this file for cinder emc plugin config data
- (String) use this file for cinder emc plugin config data
* - ``destroy_empty_storage_group`` = ``False``
- (BoolOpt) To destroy storage group when the last LUN is removed from it. By default, the value is False.
- (Boolean) To destroy storage group when the last LUN is removed from it. By default, the value is False.
* - ``force_delete_lun_in_storagegroup`` = ``False``
- (BoolOpt) Delete a LUN even if it is in Storage Groups.
- (Boolean) Delete a LUN even if it is in Storage Groups.
* - ``initiator_auto_deregistration`` = ``False``
- (BoolOpt) Automatically deregister initiators after the related storage group is destroyed. By default, the value is False.
- (Boolean) Automatically deregister initiators after the related storage group is destroyed. By default, the value is False.
* - ``initiator_auto_registration`` = ``False``
- (BoolOpt) Automatically register initiators. By default, the value is False.
- (Boolean) Automatically register initiators. By default, the value is False.
* - ``io_port_list`` = ``*``
- (StrOpt) Comma separated iSCSI or FC ports to be used in Nova or Cinder.
- (String) Comma separated iSCSI or FC ports to be used in Nova or Cinder.
* - ``iscsi_initiators`` =
- (StrOpt) Mapping between hostname and its iSCSI initiator IP addresses.
- (String) Mapping between hostname and its iSCSI initiator IP addresses.
* - ``max_luns_per_storage_group`` = ``255``
- (IntOpt) Default max number of LUNs in a storage group. By default, the value is 255.
- (Integer) Default max number of LUNs in a storage group. By default, the value is 255.
* - ``naviseccli_path`` =
- (StrOpt) Naviseccli Path.
- (String) Naviseccli Path.
* - ``storage_vnx_authentication_type`` = ``global``
- (StrOpt) VNX authentication scope type.
- (String) VNX authentication scope type.
* - ``storage_vnx_pool_names`` = ``None``
- (StrOpt) Comma-separated list of storage pool names to be used.
- (String) Comma-separated list of storage pool names to be used.
* - ``storage_vnx_security_file_dir`` = ``None``
- (StrOpt) Directory path that contains the VNX security file. Make sure the security file is generated first.
- (String) Directory path that contains the VNX security file. Make sure the security file is generated first.
* - ``xtremio_array_busy_retry_count`` = ``5``
- (IntOpt) Number of retries in case array is busy
- (Integer) Number of retries in case array is busy
* - ``xtremio_array_busy_retry_interval`` = ``5``
- (IntOpt) Interval between retries in case array is busy
- (Integer) Interval between retries in case array is busy
* - ``xtremio_cluster_name`` =
- (StrOpt) XMS cluster id in multi-cluster environment
- (String) XMS cluster id in multi-cluster environment
* - ``xtremio_volumes_per_glance_cache`` = ``100``
- (IntOpt) Number of volumes created from each cached glance image
- (Integer) Number of volumes created from each cached glance image

View File

@ -18,25 +18,23 @@
- Description
* - **[DEFAULT]**
-
* - ``sio_force_delete`` = ``False``
- (BoolOpt) Whether to allow force delete.
* - ``sio_protection_domain_id`` = ``None``
- (StrOpt) Protection domain id.
- (String) Protection Domain ID.
* - ``sio_protection_domain_name`` = ``None``
- (StrOpt) Protection domain name.
- (String) Protection Domain name.
* - ``sio_rest_server_port`` = ``443``
- (StrOpt) REST server port.
- (String) REST server port.
* - ``sio_round_volume_capacity`` = ``True``
- (BoolOpt) Whether to round volume capacity.
- (Boolean) Round up volume capacity.
* - ``sio_server_certificate_path`` = ``None``
- (StrOpt) Server certificate path.
- (String) Server certificate path.
* - ``sio_storage_pool_id`` = ``None``
- (StrOpt) Storage pool id.
- (String) Storage Pool ID.
* - ``sio_storage_pool_name`` = ``None``
- (StrOpt) Storage pool name.
- (String) Storage Pool name.
* - ``sio_storage_pools`` = ``None``
- (StrOpt) Storage pools.
- (String) Storage Pools.
* - ``sio_unmap_volume_before_deletion`` = ``False``
- (BoolOpt) Whether to unmap volume before deletion.
- (Boolean) Unmap volume before deletion.
* - ``sio_verify_server_certificate`` = ``False``
- (BoolOpt) Whether to verify server certificate.
- (Boolean) Verify server certificate.

View File

@ -19,16 +19,16 @@
* - **[DEFAULT]**
-
* - ``eqlx_chap_login`` = ``admin``
- (StrOpt) Existing CHAP account name. Note that this option is deprecated in favour of "chap_username" as specified in cinder/volume/driver.py and will be removed in next release.
- (String) Existing CHAP account name. Note that this option is deprecated in favour of "chap_username" as specified in cinder/volume/driver.py and will be removed in next release.
* - ``eqlx_chap_password`` = ``password``
- (StrOpt) Password for specified CHAP account name. Note that this option is deprecated in favour of "chap_password" as specified in cinder/volume/driver.py and will be removed in the next release
- (String) Password for specified CHAP account name. Note that this option is deprecated in favour of "chap_password" as specified in cinder/volume/driver.py and will be removed in the next release
* - ``eqlx_cli_max_retries`` = ``5``
- (IntOpt) Maximum retry count for reconnection. Default is 5.
- (Integer) Maximum retry count for reconnection. Default is 5.
* - ``eqlx_cli_timeout`` = ``30``
- (IntOpt) Timeout for the Group Manager cli command execution. Default is 30. Note that this option is deprecated in favour of "ssh_conn_timeout" as specified in cinder/volume/drivers/san/san.py and will be removed in M release.
- (Integer) Timeout for the Group Manager cli command execution. Default is 30. Note that this option is deprecated in favour of "ssh_conn_timeout" as specified in cinder/volume/drivers/san/san.py and will be removed in M release.
* - ``eqlx_group_name`` = ``group-0``
- (StrOpt) Group name to use for creating volumes. Defaults to "group-0".
- (String) Group name to use for creating volumes. Defaults to "group-0".
* - ``eqlx_pool`` = ``default``
- (StrOpt) Pool in which volumes will be created. Defaults to "default".
- (String) Pool in which volumes will be created. Defaults to "default".
* - ``eqlx_use_chap`` = ``False``
- (BoolOpt) Use CHAP authentication for targets. Note that this option is deprecated in favour of "use_chap_auth" as specified in cinder/volume/driver.py and will be removed in next release.
- (Boolean) Use CHAP authentication for targets. Note that this option is deprecated in favour of "use_chap_auth" as specified in cinder/volume/driver.py and will be removed in next release.

View File

@ -19,4 +19,4 @@
* - **[DEFAULT]**
-
* - ``cinder_eternus_config_file`` = ``/etc/cinder/cinder_fujitsu_eternus_dx.xml``
- (StrOpt) config file for cinder eternus_dx volume driver
- (String) config file for cinder eternus_dx volume driver

View File

@ -19,10 +19,10 @@
* - **[DEFAULT]**
-
* - ``flashsystem_connection_protocol`` = ``FC``
- (StrOpt) Connection protocol should be FC. (Default is FC.)
- (String) Connection protocol should be FC. (Default is FC.)
* - ``flashsystem_iscsi_portid`` = ``0``
- (IntOpt) Default iSCSI Port ID of FlashSystem. (Default port is 0.)
- (Integer) Default iSCSI Port ID of FlashSystem. (Default port is 0.)
* - ``flashsystem_multihostmap_enabled`` = ``True``
- (BoolOpt) Allows vdisk to multi host mapping. (Default is True)
- (Boolean) Allows vdisk to multi host mapping. (Default is True)
* - ``flashsystem_multipath_enabled`` = ``False``
- (BoolOpt) This option no longer has any affect. It is deprecated and will be removed in the next release.
- (Boolean) DEPRECATED: This option no longer has any affect. It is deprecated and will be removed in the next release.

View File

@ -19,6 +19,6 @@
* - **[DEFAULT]**
-
* - ``hds_hnas_iscsi_config_file`` = ``/opt/hds/hnas/cinder_iscsi_conf.xml``
- (StrOpt) Configuration file for HDS iSCSI cinder plugin
- (String) Configuration file for HDS iSCSI cinder plugin
* - ``hds_hnas_nfs_config_file`` = ``/opt/hds/hnas/cinder_nfs_conf.xml``
- (StrOpt) Configuration file for HDS NFS cinder plugin
- (String) Configuration file for HDS NFS cinder plugin

View File

@ -19,14 +19,14 @@
* - **[DEFAULT]**
-
* - ``hgst_net`` = ``Net 1 (IPv4)``
- (StrOpt) Space network name to use for data transfer
- (String) Space network name to use for data transfer
* - ``hgst_redundancy`` = ``0``
- (StrOpt) Should spaces be redundantly stored (1/0)
- (String) Should spaces be redundantly stored (1/0)
* - ``hgst_space_group`` = ``disk``
- (StrOpt) Group to own created spaces
- (String) Group to own created spaces
* - ``hgst_space_mode`` = ``0600``
- (StrOpt) UNIX mode for created spaces
- (String) UNIX mode for created spaces
* - ``hgst_space_user`` = ``root``
- (StrOpt) User to own created spaces
- (String) User to own created spaces
* - ``hgst_storage_servers`` = ``os:gbd0``
- (StrOpt) Comma separated list of Space storage servers:devices. ex: os1_stor:gbd0,os2_stor:gbd0
- (String) Comma separated list of Space storage servers:devices. ex: os1_stor:gbd0,os2_stor:gbd0

View File

@ -19,46 +19,46 @@
* - **[DEFAULT]**
-
* - ``hitachi_add_chap_user`` = ``False``
- (BoolOpt) Add CHAP user
- (Boolean) Add CHAP user
* - ``hitachi_async_copy_check_interval`` = ``10``
- (IntOpt) Interval to check copy asynchronously
- (Integer) Interval to check copy asynchronously
* - ``hitachi_auth_method`` = ``None``
- (StrOpt) iSCSI authentication method
- (String) iSCSI authentication method
* - ``hitachi_auth_password`` = ``HBSD-CHAP-password``
- (StrOpt) iSCSI authentication password
- (String) iSCSI authentication password
* - ``hitachi_auth_user`` = ``HBSD-CHAP-user``
- (StrOpt) iSCSI authentication username
- (String) iSCSI authentication username
* - ``hitachi_copy_check_interval`` = ``3``
- (IntOpt) Interval to check copy
- (Integer) Interval to check copy
* - ``hitachi_copy_speed`` = ``3``
- (IntOpt) Copy speed of storage system
- (Integer) Copy speed of storage system
* - ``hitachi_default_copy_method`` = ``FULL``
- (StrOpt) Default copy method of storage system
- (String) Default copy method of storage system
* - ``hitachi_group_range`` = ``None``
- (StrOpt) Range of group number
- (String) Range of group number
* - ``hitachi_group_request`` = ``False``
- (BoolOpt) Request for creating HostGroup or iSCSI Target
- (Boolean) Request for creating HostGroup or iSCSI Target
* - ``hitachi_horcm_add_conf`` = ``True``
- (BoolOpt) Add to HORCM configuration
- (Boolean) Add to HORCM configuration
* - ``hitachi_horcm_numbers`` = ``200,201``
- (StrOpt) Instance numbers for HORCM
- (String) Instance numbers for HORCM
* - ``hitachi_horcm_password`` = ``None``
- (StrOpt) Password of storage system for HORCM
- (String) Password of storage system for HORCM
* - ``hitachi_horcm_resource_lock_timeout`` = ``600``
- (IntOpt) Timeout until a resource lock is released, in seconds. The value must be between 0 and 7200.
- (Integer) Timeout until a resource lock is released, in seconds. The value must be between 0 and 7200.
* - ``hitachi_horcm_user`` = ``None``
- (StrOpt) Username of storage system for HORCM
- (String) Username of storage system for HORCM
* - ``hitachi_ldev_range`` = ``None``
- (StrOpt) Range of logical device of storage system
- (String) Range of logical device of storage system
* - ``hitachi_pool_id`` = ``None``
- (IntOpt) Pool ID of storage system
- (Integer) Pool ID of storage system
* - ``hitachi_serial_number`` = ``None``
- (StrOpt) Serial number of storage system
- (String) Serial number of storage system
* - ``hitachi_target_ports`` = ``None``
- (StrOpt) Control port names for HostGroup or iSCSI Target
- (String) Control port names for HostGroup or iSCSI Target
* - ``hitachi_thin_pool_id`` = ``None``
- (IntOpt) Thin pool ID of storage system
- (Integer) Thin pool ID of storage system
* - ``hitachi_unit_name`` = ``None``
- (StrOpt) Name of an array unit
- (String) Name of an array unit
* - ``hitachi_zoning_request`` = ``False``
- (BoolOpt) Request for FC Zone creating HostGroup
- (Boolean) Request for FC Zone creating HostGroup

View File

@ -19,22 +19,22 @@
* - **[DEFAULT]**
-
* - ``hpe3par_api_url`` =
- (StrOpt) 3PAR WSAPI Server Url like https://<3par ip>:8080/api/v1
- (String) 3PAR WSAPI Server Url like https://<3par ip>:8080/api/v1
* - ``hpe3par_cpg`` = ``OpenStack``
- (ListOpt) List of the CPG(s) to use for volume creation
- (List) List of the CPG(s) to use for volume creation
* - ``hpe3par_cpg_snap`` =
- (StrOpt) The CPG to use for Snapshots for volumes. If empty the userCPG will be used.
- (String) The CPG to use for Snapshots for volumes. If empty the userCPG will be used.
* - ``hpe3par_debug`` = ``False``
- (BoolOpt) Enable HTTP debugging to 3PAR
- (Boolean) Enable HTTP debugging to 3PAR
* - ``hpe3par_iscsi_chap_enabled`` = ``False``
- (BoolOpt) Enable CHAP authentication for iSCSI connections.
- (Boolean) Enable CHAP authentication for iSCSI connections.
* - ``hpe3par_iscsi_ips`` =
- (ListOpt) List of target iSCSI addresses to use.
- (List) List of target iSCSI addresses to use.
* - ``hpe3par_password`` =
- (StrOpt) 3PAR password for the user specified in hpe3par_username
- (String) 3PAR password for the user specified in hpe3par_username
* - ``hpe3par_snapshot_expiration`` =
- (StrOpt) The time in hours when a snapshot expires and is deleted. This must be larger than expiration
- (String) The time in hours when a snapshot expires and is deleted. This must be larger than expiration
* - ``hpe3par_snapshot_retention`` =
- (StrOpt) The time in hours to retain a snapshot. You can't delete it before this expires.
- (String) The time in hours to retain a snapshot. You can't delete it before this expires.
* - ``hpe3par_username`` =
- (StrOpt) 3PAR username with the 'edit' role
- (String) 3PAR username with the 'edit' role

View File

@ -19,16 +19,16 @@
* - **[DEFAULT]**
-
* - ``hpelefthand_api_url`` = ``None``
- (StrOpt) HPE LeftHand WSAPI Server Url like https://<LeftHand ip>:8081/lhos
- (String) HPE LeftHand WSAPI Server Url like https://<LeftHand ip>:8081/lhos
* - ``hpelefthand_clustername`` = ``None``
- (StrOpt) HPE LeftHand cluster name
- (String) HPE LeftHand cluster name
* - ``hpelefthand_debug`` = ``False``
- (BoolOpt) Enable HTTP debugging to LeftHand
- (Boolean) Enable HTTP debugging to LeftHand
* - ``hpelefthand_iscsi_chap_enabled`` = ``False``
- (BoolOpt) Configure CHAP authentication for iSCSI connections (Default: Disabled)
- (Boolean) Configure CHAP authentication for iSCSI connections (Default: Disabled)
* - ``hpelefthand_password`` = ``None``
- (StrOpt) HPE LeftHand Super user password
- (String) HPE LeftHand Super user password
* - ``hpelefthand_ssh_port`` = ``16022``
- (PortOpt) Port number of SSH service.
- (Unknown) Port number of SSH service.
* - ``hpelefthand_username`` = ``None``
- (StrOpt) HPE LeftHand Super user username
- (String) HPE LeftHand Super user username

View File

@ -19,38 +19,38 @@
* - **[DEFAULT]**
-
* - ``hpexp_async_copy_check_interval`` = ``10``
- (IntOpt) Interval to check copy asynchronously
- (Integer) Interval to check copy asynchronously
* - ``hpexp_compute_target_ports`` = ``None``
- (ListOpt) Target port names of compute node for host group or iSCSI target
- (List) Target port names of compute node for host group or iSCSI target
* - ``hpexp_copy_check_interval`` = ``3``
- (IntOpt) Interval to check copy
- (Integer) Interval to check copy
* - ``hpexp_copy_speed`` = ``3``
- (IntOpt) Copy speed of storage system
- (Integer) Copy speed of storage system
* - ``hpexp_default_copy_method`` = ``FULL``
- (StrOpt) Default copy method of storage system. There are two valid values: "FULL" specifies that a full copy; "THIN" specifies that a thin copy. Default value is "FULL"
- (String) Default copy method of storage system. There are two valid values: "FULL" specifies that a full copy; "THIN" specifies that a thin copy. Default value is "FULL"
* - ``hpexp_group_request`` = ``False``
- (BoolOpt) Request for creating host group or iSCSI target
- (Boolean) Request for creating host group or iSCSI target
* - ``hpexp_horcm_add_conf`` = ``True``
- (BoolOpt) Add to HORCM configuration
- (Boolean) Add to HORCM configuration
* - ``hpexp_horcm_name_only_discovery`` = ``False``
- (BoolOpt) Only discover a specific name of host group or iSCSI target
- (Boolean) Only discover a specific name of host group or iSCSI target
* - ``hpexp_horcm_numbers`` = ``200, 201``
- (ListOpt) Instance numbers for HORCM
- (List) Instance numbers for HORCM
* - ``hpexp_horcm_resource_name`` = ``meta_resource``
- (StrOpt) Resource group name of storage system for HORCM
- (String) Resource group name of storage system for HORCM
* - ``hpexp_horcm_user`` = ``None``
- (StrOpt) Username of storage system for HORCM
- (String) Username of storage system for HORCM
* - ``hpexp_ldev_range`` = ``None``
- (StrOpt) Logical device range of storage system
- (String) Logical device range of storage system
* - ``hpexp_pool`` = ``None``
- (StrOpt) Pool of storage system
- (String) Pool of storage system
* - ``hpexp_storage_cli`` = ``None``
- (StrOpt) Type of storage command line interface
- (String) Type of storage command line interface
* - ``hpexp_storage_id`` = ``None``
- (StrOpt) ID of storage system
- (String) ID of storage system
* - ``hpexp_target_ports`` = ``None``
- (ListOpt) Target port names for host group or iSCSI target
- (List) Target port names for host group or iSCSI target
* - ``hpexp_thin_pool`` = ``None``
- (StrOpt) Thin pool of storage system
- (String) Thin pool of storage system
* - ``hpexp_zoning_request`` = ``False``
- (BoolOpt) Request for FC Zone creating host group
- (Boolean) Request for FC Zone creating host group

Some files were not shown because too many files have changed in this diff Show More