diff --git a/doc/config-reference/source/bare-metal.rst b/doc/config-reference/source/bare-metal.rst index 33d0d2a6b5..27d065a4a7 100644 --- a/doc/config-reference/source/bare-metal.rst +++ b/doc/config-reference/source/bare-metal.rst @@ -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 diff --git a/doc/config-reference/source/block-storage/fc-zoning.rst b/doc/config-reference/source/block-storage/fc-zoning.rst index abdd538681..21894bcc42 100644 --- a/doc/config-reference/source/block-storage/fc-zoning.rst +++ b/doc/config-reference/source/block-storage/fc-zoning.rst @@ -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: diff --git a/doc/config-reference/source/compute/config-options.rst b/doc/config-reference/source/compute/config-options.rst index 5379be178c..a4bdc70189 100644 --- a/doc/config-reference/source/compute/config-options.rst +++ b/doc/config-reference/source/compute/config-options.rst @@ -7,103 +7,54 @@ OpenStack Compute service, run :command:`bin/nova-` ``--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 diff --git a/doc/config-reference/source/data-processing-service.rst b/doc/config-reference/source/data-processing-service.rst index efea99940b..63d2cf475c 100644 --- a/doc/config-reference/source/data-processing-service.rst +++ b/doc/config-reference/source/data-processing-service.rst @@ -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 diff --git a/doc/config-reference/source/database-service.rst b/doc/config-reference/source/database-service.rst index 921697fd46..857d840ce7 100644 --- a/doc/config-reference/source/database-service.rst +++ b/doc/config-reference/source/database-service.rst @@ -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 diff --git a/doc/config-reference/source/database-service/databaseservice_db.rst b/doc/config-reference/source/database-service/databaseservice_db.rst index ba14c30492..6043c36914 100644 --- a/doc/config-reference/source/database-service/databaseservice_db.rst +++ b/doc/config-reference/source/database-service/databaseservice_db.rst @@ -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 diff --git a/doc/config-reference/source/database-service/databaseservice_rpc.rst b/doc/config-reference/source/database-service/databaseservice_rpc.rst index 41a0e7934c..2a35758c6b 100644 --- a/doc/config-reference/source/database-service/databaseservice_rpc.rst +++ b/doc/config-reference/source/database-service/databaseservice_rpc.rst @@ -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 ~~~~~~~~~~~~~~~~ diff --git a/doc/config-reference/source/identity/options.rst b/doc/config-reference/source/identity/options.rst index bfeb172783..5ced8270ad 100644 --- a/doc/config-reference/source/identity/options.rst +++ b/doc/config-reference/source/identity/options.rst @@ -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 diff --git a/doc/config-reference/source/image-service/image_service_backends.rst b/doc/config-reference/source/image-service/image_service_backends.rst index 10b174bf9e..dbd48825eb 100644 --- a/doc/config-reference/source/image-service/image_service_backends.rst +++ b/doc/config-reference/source/image-service/image_service_backends.rst @@ -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 diff --git a/doc/config-reference/source/image-service/image_service_rpc.rst b/doc/config-reference/source/image-service/image_service_rpc.rst index d8d6b6c649..6fb9aa4297 100644 --- a/doc/config-reference/source/image-service/image_service_rpc.rst +++ b/doc/config-reference/source/image-service/image_service_rpc.rst @@ -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 diff --git a/doc/config-reference/source/networking/networking_options_reference.rst b/doc/config-reference/source/networking/networking_options_reference.rst index bdb88adae9..6a716bfb0d 100644 --- a/doc/config-reference/source/networking/networking_options_reference.rst +++ b/doc/config-reference/source/networking/networking_options_reference.rst @@ -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 diff --git a/doc/config-reference/source/orchestration/orchestration_rpc.rst b/doc/config-reference/source/orchestration/orchestration_rpc.rst index 515482bb9f..df19ae0242 100644 --- a/doc/config-reference/source/orchestration/orchestration_rpc.rst +++ b/doc/config-reference/source/orchestration/orchestration_rpc.rst @@ -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 ~~~~~~~~~~~~~~~~ diff --git a/doc/config-reference/source/shared-file-systems/misc.rst b/doc/config-reference/source/shared-file-systems/misc.rst index 7f8f86c78b..ddbcb35c7c 100644 --- a/doc/config-reference/source/shared-file-systems/misc.rst +++ b/doc/config-reference/source/shared-file-systems/misc.rst @@ -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 diff --git a/doc/config-reference/source/shared-file-systems/rpc.rst b/doc/config-reference/source/shared-file-systems/rpc.rst index f2e113b04e..a48390032e 100644 --- a/doc/config-reference/source/shared-file-systems/rpc.rst +++ b/doc/config-reference/source/shared-file-systems/rpc.rst @@ -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 diff --git a/doc/config-reference/source/tables/aodh-amqp.rst b/doc/config-reference/source/tables/aodh-amqp.rst index 55895f6b44..045803d222 100644 --- a/doc/config-reference/source/tables/aodh-amqp.rst +++ b/doc/config-reference/source/tables/aodh-amqp.rst @@ -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. diff --git a/doc/config-reference/source/tables/aodh-api.rst b/doc/config-reference/source/tables/aodh-api.rst index b8535707dc..783eb30182 100644 --- a/doc/config-reference/source/tables/aodh-api.rst +++ b/doc/config-reference/source/tables/aodh-api.rst @@ -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. diff --git a/doc/config-reference/source/tables/aodh-auth.rst b/doc/config-reference/source/tables/aodh-auth.rst deleted file mode 100644 index 4b9470675c..0000000000 --- a/doc/config-reference/source/tables/aodh-auth.rst +++ /dev/null @@ -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. diff --git a/doc/config-reference/source/tables/aodh-auth_token.rst b/doc/config-reference/source/tables/aodh-auth_token.rst index aaacb72c0d..8c1a5d2a83 100644 --- a/doc/config-reference/source/tables/aodh-auth_token.rst +++ b/doc/config-reference/source/tables/aodh-auth_token.rst @@ -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. diff --git a/doc/config-reference/source/tables/aodh-common.rst b/doc/config-reference/source/tables/aodh-common.rst index 901f718578..bbd86ce405 100644 --- a/doc/config-reference/source/tables/aodh-common.rst +++ b/doc/config-reference/source/tables/aodh-common.rst @@ -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. diff --git a/doc/config-reference/source/tables/aodh-coordination.rst b/doc/config-reference/source/tables/aodh-coordination.rst index a7d5ca9960..5c8c4db306 100644 --- a/doc/config-reference/source/tables/aodh-coordination.rst +++ b/doc/config-reference/source/tables/aodh-coordination.rst @@ -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. diff --git a/doc/config-reference/source/tables/aodh-cors.rst b/doc/config-reference/source/tables/aodh-cors.rst index e6a3db7f12..add4015426 100644 --- a/doc/config-reference/source/tables/aodh-cors.rst +++ b/doc/config-reference/source/tables/aodh-cors.rst @@ -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. diff --git a/doc/config-reference/source/tables/aodh-database.rst b/doc/config-reference/source/tables/aodh-database.rst index 8a343453b3..71735204db 100644 --- a/doc/config-reference/source/tables/aodh-database.rst +++ b/doc/config-reference/source/tables/aodh-database.rst @@ -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. diff --git a/doc/config-reference/source/tables/aodh-logging.rst b/doc/config-reference/source/tables/aodh-logging.rst index c186e88298..4f0802810a 100644 --- a/doc/config-reference/source/tables/aodh-logging.rst +++ b/doc/config-reference/source/tables/aodh-logging.rst @@ -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. diff --git a/doc/config-reference/source/tables/aodh-policy.rst b/doc/config-reference/source/tables/aodh-policy.rst index e3900553b6..9418e112c4 100644 --- a/doc/config-reference/source/tables/aodh-policy.rst +++ b/doc/config-reference/source/tables/aodh-policy.rst @@ -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. diff --git a/doc/config-reference/source/tables/aodh-qpid.rst b/doc/config-reference/source/tables/aodh-qpid.rst deleted file mode 100644 index 9ed2457770..0000000000 --- a/doc/config-reference/source/tables/aodh-qpid.rst +++ /dev/null @@ -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. diff --git a/doc/config-reference/source/tables/aodh-rabbitmq.rst b/doc/config-reference/source/tables/aodh-rabbitmq.rst index bffad0d9e9..c13f6948b0 100644 --- a/doc/config-reference/source/tables/aodh-rabbitmq.rst +++ b/doc/config-reference/source/tables/aodh-rabbitmq.rst @@ -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. diff --git a/doc/config-reference/source/tables/aodh-redis.rst b/doc/config-reference/source/tables/aodh-redis.rst index 7261e2df9c..abbccf4c81 100644 --- a/doc/config-reference/source/tables/aodh-redis.rst +++ b/doc/config-reference/source/tables/aodh-redis.rst @@ -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. diff --git a/doc/config-reference/source/tables/aodh-rpc.rst b/doc/config-reference/source/tables/aodh-rpc.rst index 76c5653f28..ca43adb473 100644 --- a/doc/config-reference/source/tables/aodh-rpc.rst +++ b/doc/config-reference/source/tables/aodh-rpc.rst @@ -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 diff --git a/doc/config-reference/source/tables/aodh-zeromq.rst b/doc/config-reference/source/tables/aodh-zeromq.rst index ee9e0bce86..16fa6d9f21 100644 --- a/doc/config-reference/source/tables/aodh-zeromq.rst +++ b/doc/config-reference/source/tables/aodh-zeromq.rst @@ -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). diff --git a/doc/config-reference/source/tables/ceilometer-amqp.rst b/doc/config-reference/source/tables/ceilometer-amqp.rst index c7a006fdbe..138186eb25 100644 --- a/doc/config-reference/source/tables/ceilometer-amqp.rst +++ b/doc/config-reference/source/tables/ceilometer-amqp.rst @@ -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. diff --git a/doc/config-reference/source/tables/ceilometer-api.rst b/doc/config-reference/source/tables/ceilometer-api.rst index 09acaa8302..58806582ff 100644 --- a/doc/config-reference/source/tables/ceilometer-api.rst +++ b/doc/config-reference/source/tables/ceilometer-api.rst @@ -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. diff --git a/doc/config-reference/source/tables/ceilometer-auth.rst b/doc/config-reference/source/tables/ceilometer-auth.rst index bfd5a32f88..e4705c7266 100644 --- a/doc/config-reference/source/tables/ceilometer-auth.rst +++ b/doc/config-reference/source/tables/ceilometer-auth.rst @@ -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 diff --git a/doc/config-reference/source/tables/ceilometer-auth_token.rst b/doc/config-reference/source/tables/ceilometer-auth_token.rst index a1e865903f..52e79dad0a 100644 --- a/doc/config-reference/source/tables/ceilometer-auth_token.rst +++ b/doc/config-reference/source/tables/ceilometer-auth_token.rst @@ -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. diff --git a/doc/config-reference/source/tables/ceilometer-collector.rst b/doc/config-reference/source/tables/ceilometer-collector.rst index 0489c21fdd..fd8d97691c 100644 --- a/doc/config-reference/source/tables/ceilometer-collector.rst +++ b/doc/config-reference/source/tables/ceilometer-collector.rst @@ -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. diff --git a/doc/config-reference/source/tables/ceilometer-common.rst b/doc/config-reference/source/tables/ceilometer-common.rst index d607b3cc56..b02e08f03e 100644 --- a/doc/config-reference/source/tables/ceilometer-common.rst +++ b/doc/config-reference/source/tables/ceilometer-common.rst @@ -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. diff --git a/doc/config-reference/source/tables/ceilometer-cors.rst b/doc/config-reference/source/tables/ceilometer-cors.rst index 8cc168c14a..14922c9a58 100644 --- a/doc/config-reference/source/tables/ceilometer-cors.rst +++ b/doc/config-reference/source/tables/ceilometer-cors.rst @@ -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. diff --git a/doc/config-reference/source/tables/ceilometer-database.rst b/doc/config-reference/source/tables/ceilometer-database.rst index 8027b300e4..96b910a7e4 100644 --- a/doc/config-reference/source/tables/ceilometer-database.rst +++ b/doc/config-reference/source/tables/ceilometer-database.rst @@ -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 _. + - (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 _. * - ``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. diff --git a/doc/config-reference/source/tables/ceilometer-debug.rst b/doc/config-reference/source/tables/ceilometer-debug.rst index 0db00836c7..f9f18a615a 100644 --- a/doc/config-reference/source/tables/ceilometer-debug.rst +++ b/doc/config-reference/source/tables/ceilometer-debug.rst @@ -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) diff --git a/doc/config-reference/source/tables/ceilometer-dispatcher_gnocchi.rst b/doc/config-reference/source/tables/ceilometer-dispatcher_gnocchi.rst index 43db90ec27..139546295f 100644 --- a/doc/config-reference/source/tables/ceilometer-dispatcher_gnocchi.rst +++ b/doc/config-reference/source/tables/ceilometer-dispatcher_gnocchi.rst @@ -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 diff --git a/doc/config-reference/source/tables/ceilometer-dispatcher_http.rst b/doc/config-reference/source/tables/ceilometer-dispatcher_http.rst index 6b01518b90..ff22aeb234 100644 --- a/doc/config-reference/source/tables/ceilometer-dispatcher_http.rst +++ b/doc/config-reference/source/tables/ceilometer-dispatcher_http.rst @@ -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. diff --git a/doc/config-reference/source/tables/ceilometer-dispatchers.rst b/doc/config-reference/source/tables/ceilometer-dispatchers.rst index 96e124e838..83048f22ed 100644 --- a/doc/config-reference/source/tables/ceilometer-dispatchers.rst +++ b/doc/config-reference/source/tables/ceilometer-dispatchers.rst @@ -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. diff --git a/doc/config-reference/source/tables/ceilometer-events.rst b/doc/config-reference/source/tables/ceilometer-events.rst index 46f1a1d755..80319721f6 100644 --- a/doc/config-reference/source/tables/ceilometer-events.rst +++ b/doc/config-reference/source/tables/ceilometer-events.rst @@ -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. diff --git a/doc/config-reference/source/tables/ceilometer-exchange.rst b/doc/config-reference/source/tables/ceilometer-exchange.rst index 1f99ed6379..1d96c63225 100644 --- a/doc/config-reference/source/tables/ceilometer-exchange.rst +++ b/doc/config-reference/source/tables/ceilometer-exchange.rst @@ -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. diff --git a/doc/config-reference/source/tables/ceilometer-glance.rst b/doc/config-reference/source/tables/ceilometer-glance.rst index 65ab7d5c73..d2ddc06472 100644 --- a/doc/config-reference/source/tables/ceilometer-glance.rst +++ b/doc/config-reference/source/tables/ceilometer-glance.rst @@ -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). diff --git a/doc/config-reference/source/tables/cinder-zoning_manager.rst b/doc/config-reference/source/tables/ceilometer-hyperv.rst similarity index 65% rename from doc/config-reference/source/tables/cinder-zoning_manager.rst rename to doc/config-reference/source/tables/ceilometer-hyperv.rst index fbd3ecdf35..b4e848d791 100644 --- a/doc/config-reference/source/tables/cinder-zoning_manager.rst +++ b/doc/config-reference/source/tables/ceilometer-hyperv.rst @@ -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 diff --git a/doc/config-reference/source/tables/ceilometer-inspector.rst b/doc/config-reference/source/tables/ceilometer-inspector.rst index f97768b3ad..fd309114a2 100644 --- a/doc/config-reference/source/tables/ceilometer-inspector.rst +++ b/doc/config-reference/source/tables/ceilometer-inspector.rst @@ -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). diff --git a/doc/config-reference/source/tables/ceilometer-ipmi.rst b/doc/config-reference/source/tables/ceilometer-ipmi.rst index 1b97329560..d66da1cd40 100644 --- a/doc/config-reference/source/tables/ceilometer-ipmi.rst +++ b/doc/config-reference/source/tables/ceilometer-ipmi.rst @@ -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. diff --git a/doc/config-reference/source/tables/ceilometer-logging.rst b/doc/config-reference/source/tables/ceilometer-logging.rst index 7a12a7730c..e810c9d37a 100644 --- a/doc/config-reference/source/tables/ceilometer-logging.rst +++ b/doc/config-reference/source/tables/ceilometer-logging.rst @@ -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. diff --git a/doc/config-reference/source/tables/ceilometer-magnetodb.rst b/doc/config-reference/source/tables/ceilometer-magnetodb.rst index 1150fe314a..7e2a63fa78 100644 --- a/doc/config-reference/source/tables/ceilometer-magnetodb.rst +++ b/doc/config-reference/source/tables/ceilometer-magnetodb.rst @@ -19,4 +19,4 @@ * - **[DEFAULT]** - * - ``magnetodb_control_exchange`` = ``magnetodb`` - - (StrOpt) Exchange name for Magnetodb notifications. + - (String) Exchange name for Magnetodb notifications. diff --git a/doc/config-reference/source/tables/ceilometer-notification.rst b/doc/config-reference/source/tables/ceilometer-notification.rst index e20a552f14..274ae4ebe9 100644 --- a/doc/config-reference/source/tables/ceilometer-notification.rst +++ b/doc/config-reference/source/tables/ceilometer-notification.rst @@ -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. diff --git a/doc/config-reference/source/tables/ceilometer-policy.rst b/doc/config-reference/source/tables/ceilometer-policy.rst index a95a62e8f4..1f5426d2ee 100644 --- a/doc/config-reference/source/tables/ceilometer-policy.rst +++ b/doc/config-reference/source/tables/ceilometer-policy.rst @@ -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. diff --git a/doc/config-reference/source/tables/ceilometer-qpid.rst b/doc/config-reference/source/tables/ceilometer-qpid.rst deleted file mode 100644 index e978deb22a..0000000000 --- a/doc/config-reference/source/tables/ceilometer-qpid.rst +++ /dev/null @@ -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. diff --git a/doc/config-reference/source/tables/ceilometer-rabbitmq.rst b/doc/config-reference/source/tables/ceilometer-rabbitmq.rst index 84f2d0d959..dda35d3532 100644 --- a/doc/config-reference/source/tables/ceilometer-rabbitmq.rst +++ b/doc/config-reference/source/tables/ceilometer-rabbitmq.rst @@ -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. diff --git a/doc/config-reference/source/tables/ceilometer-redis.rst b/doc/config-reference/source/tables/ceilometer-redis.rst index eee450125f..775efad11d 100644 --- a/doc/config-reference/source/tables/ceilometer-redis.rst +++ b/doc/config-reference/source/tables/ceilometer-redis.rst @@ -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. diff --git a/doc/config-reference/source/tables/ceilometer-rgw.rst b/doc/config-reference/source/tables/ceilometer-rgw.rst index e361d99fa7..9ebdfbaf60 100644 --- a/doc/config-reference/source/tables/ceilometer-rgw.rst +++ b/doc/config-reference/source/tables/ceilometer-rgw.rst @@ -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. diff --git a/doc/config-reference/source/tables/ceilometer-rpc.rst b/doc/config-reference/source/tables/ceilometer-rpc.rst index 0d29ccd881..c1278e2aa8 100644 --- a/doc/config-reference/source/tables/ceilometer-rpc.rst +++ b/doc/config-reference/source/tables/ceilometer-rpc.rst @@ -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. diff --git a/doc/config-reference/source/tables/ceilometer-service_types.rst b/doc/config-reference/source/tables/ceilometer-service_types.rst index 654c92c4e2..5bfb4db453 100644 --- a/doc/config-reference/source/tables/ceilometer-service_types.rst +++ b/doc/config-reference/source/tables/ceilometer-service_types.rst @@ -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. diff --git a/doc/config-reference/source/tables/ceilometer-storage.rst b/doc/config-reference/source/tables/ceilometer-storage.rst index ccb92e0758..ba994f8c18 100644 --- a/doc/config-reference/source/tables/ceilometer-storage.rst +++ b/doc/config-reference/source/tables/ceilometer-storage.rst @@ -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. diff --git a/doc/config-reference/source/tables/ceilometer-swift.rst b/doc/config-reference/source/tables/ceilometer-swift.rst index 06d2066136..a34ac84aaf 100644 --- a/doc/config-reference/source/tables/ceilometer-swift.rst +++ b/doc/config-reference/source/tables/ceilometer-swift.rst @@ -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. diff --git a/doc/config-reference/source/tables/ceilometer-tripleo.rst b/doc/config-reference/source/tables/ceilometer-tripleo.rst index df0fd5a8c3..35a45323d6 100644 --- a/doc/config-reference/source/tables/ceilometer-tripleo.rst +++ b/doc/config-reference/source/tables/ceilometer-tripleo.rst @@ -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. diff --git a/doc/config-reference/source/tables/ceilometer-vmware.rst b/doc/config-reference/source/tables/ceilometer-vmware.rst index b3e55d32c4..e81877e5a6 100644 --- a/doc/config-reference/source/tables/ceilometer-vmware.rst +++ b/doc/config-reference/source/tables/ceilometer-vmware.rst @@ -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:///vimService.wsdl. Optional over-ride to default location for bug work-arounds. + - (String) Optional vim service WSDL location e.g http:///vimService.wsdl. Optional over-ride to default location for bug work-arounds. diff --git a/doc/config-reference/source/tables/ceilometer-xenapi.rst b/doc/config-reference/source/tables/ceilometer-xenapi.rst index cbf3127779..2a3e0a66f1 100644 --- a/doc/config-reference/source/tables/ceilometer-xenapi.rst +++ b/doc/config-reference/source/tables/ceilometer-xenapi.rst @@ -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. diff --git a/doc/config-reference/source/tables/ceilometer-zaqar.rst b/doc/config-reference/source/tables/ceilometer-zaqar.rst index 45251c0ebf..06eb79eae5 100644 --- a/doc/config-reference/source/tables/ceilometer-zaqar.rst +++ b/doc/config-reference/source/tables/ceilometer-zaqar.rst @@ -19,4 +19,4 @@ * - **[DEFAULT]** - * - ``zaqar_control_exchange`` = ``zaqar`` - - (StrOpt) Exchange name for Messaging service notifications. + - (String) Exchange name for Messaging service notifications. diff --git a/doc/config-reference/source/tables/ceilometer-zeromq.rst b/doc/config-reference/source/tables/ceilometer-zeromq.rst index 866c7071fc..eeb4bbc03e 100644 --- a/doc/config-reference/source/tables/ceilometer-zeromq.rst +++ b/doc/config-reference/source/tables/ceilometer-zeromq.rst @@ -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). diff --git a/doc/config-reference/source/tables/cinder-amqp.rst b/doc/config-reference/source/tables/cinder-amqp.rst index 97462fe198..2a86d2a238 100644 --- a/doc/config-reference/source/tables/cinder-amqp.rst +++ b/doc/config-reference/source/tables/cinder-amqp.rst @@ -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. diff --git a/doc/config-reference/source/tables/cinder-api.rst b/doc/config-reference/source/tables/cinder-api.rst index 3188663007..2574e0cdca 100644 --- a/doc/config-reference/source/tables/cinder-api.rst +++ b/doc/config-reference/source/tables/cinder-api.rst @@ -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 diff --git a/doc/config-reference/source/tables/cinder-auth.rst b/doc/config-reference/source/tables/cinder-auth.rst index ecdc83ef2e..d5d6f5d9f6 100644 --- a/doc/config-reference/source/tables/cinder-auth.rst +++ b/doc/config-reference/source/tables/cinder-auth.rst @@ -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. diff --git a/doc/config-reference/source/tables/cinder-auth_token.rst b/doc/config-reference/source/tables/cinder-auth_token.rst index f9bd7c2f1f..29a8e50fa0 100644 --- a/doc/config-reference/source/tables/cinder-auth_token.rst +++ b/doc/config-reference/source/tables/cinder-auth_token.rst @@ -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. diff --git a/doc/config-reference/source/tables/cinder-backups.rst b/doc/config-reference/source/tables/cinder-backups.rst index e9b70f17c3..cda0a5a5bc 100644 --- a/doc/config-reference/source/tables/cinder-backups.rst +++ b/doc/config-reference/source/tables/cinder-backups.rst @@ -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 diff --git a/doc/config-reference/source/tables/cinder-backups_ceph.rst b/doc/config-reference/source/tables/cinder-backups_ceph.rst index b12a30d414..c28f75cf57 100644 --- a/doc/config-reference/source/tables/cinder-backups_ceph.rst +++ b/doc/config-reference/source/tables/cinder-backups_ceph.rst @@ -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. diff --git a/doc/config-reference/source/tables/cinder-backups_gcs.rst b/doc/config-reference/source/tables/cinder-backups_gcs.rst index 9c1d7fa09c..1efbb97564 100644 --- a/doc/config-reference/source/tables/cinder-backups_gcs.rst +++ b/doc/config-reference/source/tables/cinder-backups_gcs.rst @@ -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. diff --git a/doc/config-reference/source/tables/cinder-backups_nfs.rst b/doc/config-reference/source/tables/cinder-backups_nfs.rst index f3b64cd6bc..53436a95f8 100644 --- a/doc/config-reference/source/tables/cinder-backups_nfs.rst +++ b/doc/config-reference/source/tables/cinder-backups_nfs.rst @@ -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. diff --git a/doc/config-reference/source/tables/cinder-backups_swift.rst b/doc/config-reference/source/tables/cinder-backups_swift.rst index 324f4eaa80..8f28ebc293 100644 --- a/doc/config-reference/source/tables/cinder-backups_swift.rst +++ b/doc/config-reference/source/tables/cinder-backups_swift.rst @@ -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: :: - 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: :: - 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: :: - 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: :: - Only used if backup_swift_url is unset diff --git a/doc/config-reference/source/tables/cinder-backups_tsm.rst b/doc/config-reference/source/tables/cinder-backups_tsm.rst index 60e675f89b..a3cd05228f 100644 --- a/doc/config-reference/source/tables/cinder-backups_tsm.rst +++ b/doc/config-reference/source/tables/cinder-backups_tsm.rst @@ -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 diff --git a/doc/config-reference/source/tables/cinder-block-device.rst b/doc/config-reference/source/tables/cinder-block-device.rst index 633e3e40d1..dcbf53d029 100644 --- a/doc/config-reference/source/tables/cinder-block-device.rst +++ b/doc/config-reference/source/tables/cinder-block-device.rst @@ -19,4 +19,4 @@ * - **[DEFAULT]** - * - ``available_devices`` = - - (ListOpt) List of all available devices + - (List) List of all available devices diff --git a/doc/config-reference/source/tables/cinder-blockbridge.rst b/doc/config-reference/source/tables/cinder-blockbridge.rst index 7c7294575e..f828eab768 100644 --- a/doc/config-reference/source/tables/cinder-blockbridge.rst +++ b/doc/config-reference/source/tables/cinder-blockbridge.rst @@ -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 diff --git a/doc/config-reference/source/tables/cinder-cloudbyte.rst b/doc/config-reference/source/tables/cinder-cloudbyte.rst index 4cddad87a2..74d7e87a6c 100644 --- a/doc/config-reference/source/tables/cinder-cloudbyte.rst +++ b/doc/config-reference/source/tables/cinder-cloudbyte.rst @@ -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. diff --git a/doc/config-reference/source/tables/cinder-coho.rst b/doc/config-reference/source/tables/cinder-coho.rst index 5f9a66aaff..df53ace1c3 100644 --- a/doc/config-reference/source/tables/cinder-coho.rst +++ b/doc/config-reference/source/tables/cinder-coho.rst @@ -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 diff --git a/doc/config-reference/source/tables/cinder-common.rst b/doc/config-reference/source/tables/cinder-common.rst index 6ba92d345a..2baab10609 100644 --- a/doc/config-reference/source/tables/cinder-common.rst +++ b/doc/config-reference/source/tables/cinder-common.rst @@ -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:,managed_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:,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. diff --git a/doc/config-reference/source/tables/cinder-compute.rst b/doc/config-reference/source/tables/cinder-compute.rst index f466c71591..99e411fc1b 100644 --- a/doc/config-reference/source/tables/cinder-compute.rst +++ b/doc/config-reference/source/tables/cinder-compute.rst @@ -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: :: + - (String) Match this value when searching for nova in the service catalog. Format is: separated values of the form: :: * - ``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 diff --git a/doc/config-reference/source/tables/cinder-coordination.rst b/doc/config-reference/source/tables/cinder-coordination.rst index 92f050f7a7..0b5eb8d388 100644 --- a/doc/config-reference/source/tables/cinder-coordination.rst +++ b/doc/config-reference/source/tables/cinder-coordination.rst @@ -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. diff --git a/doc/config-reference/source/tables/cinder-cors.rst b/doc/config-reference/source/tables/cinder-cors.rst index dc1f7d66c8..c885a8fe4a 100644 --- a/doc/config-reference/source/tables/cinder-cors.rst +++ b/doc/config-reference/source/tables/cinder-cors.rst @@ -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. diff --git a/doc/config-reference/source/tables/cinder-database.rst b/doc/config-reference/source/tables/cinder-database.rst index 0f1642c89e..bae147a28c 100644 --- a/doc/config-reference/source/tables/cinder-database.rst +++ b/doc/config-reference/source/tables/cinder-database.rst @@ -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 diff --git a/doc/config-reference/source/tables/cinder-datera.rst b/doc/config-reference/source/tables/cinder-datera.rst index 2ce2e08faf..c55f58f60c 100644 --- a/doc/config-reference/source/tables/cinder-datera.rst +++ b/doc/config-reference/source/tables/cinder-datera.rst @@ -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. diff --git a/doc/config-reference/source/tables/cinder-debug.rst b/doc/config-reference/source/tables/cinder-debug.rst index ce5e97d855..97ff1c9e14 100644 --- a/doc/config-reference/source/tables/cinder-debug.rst +++ b/doc/config-reference/source/tables/cinder-debug.rst @@ -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. diff --git a/doc/config-reference/source/tables/cinder-dellsc.rst b/doc/config-reference/source/tables/cinder-dellsc.rst index 24595f36b8..fdefcd6604 100644 --- a/doc/config-reference/source/tables/cinder-dellsc.rst +++ b/doc/config-reference/source/tables/cinder-dellsc.rst @@ -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 diff --git a/doc/config-reference/source/tables/cinder-disco.rst b/doc/config-reference/source/tables/cinder-disco.rst index bedaa02cc4..9553b2e803 100644 --- a/doc/config-reference/source/tables/cinder-disco.rst +++ b/doc/config-reference/source/tables/cinder-disco.rst @@ -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 diff --git a/doc/config-reference/source/tables/cinder-dothill.rst b/doc/config-reference/source/tables/cinder-dothill.rst index 9d8ec295b5..b796abc910 100644 --- a/doc/config-reference/source/tables/cinder-dothill.rst +++ b/doc/config-reference/source/tables/cinder-dothill.rst @@ -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. diff --git a/doc/config-reference/source/tables/cinder-drbd.rst b/doc/config-reference/source/tables/cinder-drbd.rst index 6fbfe475f5..96ea155089 100644 --- a/doc/config-reference/source/tables/cinder-drbd.rst +++ b/doc/config-reference/source/tables/cinder-drbd.rst @@ -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. diff --git a/doc/config-reference/source/tables/cinder-emc.rst b/doc/config-reference/source/tables/cinder-emc.rst index 43ff039ca5..63e43166ac 100644 --- a/doc/config-reference/source/tables/cinder-emc.rst +++ b/doc/config-reference/source/tables/cinder-emc.rst @@ -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 diff --git a/doc/config-reference/source/tables/cinder-emc_sio.rst b/doc/config-reference/source/tables/cinder-emc_sio.rst index 69d39cf9e0..11ed0cec92 100644 --- a/doc/config-reference/source/tables/cinder-emc_sio.rst +++ b/doc/config-reference/source/tables/cinder-emc_sio.rst @@ -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. diff --git a/doc/config-reference/source/tables/cinder-eqlx.rst b/doc/config-reference/source/tables/cinder-eqlx.rst index c8e05a5c2a..1f7e327153 100644 --- a/doc/config-reference/source/tables/cinder-eqlx.rst +++ b/doc/config-reference/source/tables/cinder-eqlx.rst @@ -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. diff --git a/doc/config-reference/source/tables/cinder-eternus.rst b/doc/config-reference/source/tables/cinder-eternus.rst index 29bc972b37..6c3faeb379 100644 --- a/doc/config-reference/source/tables/cinder-eternus.rst +++ b/doc/config-reference/source/tables/cinder-eternus.rst @@ -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 diff --git a/doc/config-reference/source/tables/cinder-flashsystem.rst b/doc/config-reference/source/tables/cinder-flashsystem.rst index 31e38cf599..ad6c141e40 100644 --- a/doc/config-reference/source/tables/cinder-flashsystem.rst +++ b/doc/config-reference/source/tables/cinder-flashsystem.rst @@ -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. diff --git a/doc/config-reference/source/tables/cinder-hds-hnas.rst b/doc/config-reference/source/tables/cinder-hds-hnas.rst index 461c666f37..5e30de9c63 100644 --- a/doc/config-reference/source/tables/cinder-hds-hnas.rst +++ b/doc/config-reference/source/tables/cinder-hds-hnas.rst @@ -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 diff --git a/doc/config-reference/source/tables/cinder-hgst.rst b/doc/config-reference/source/tables/cinder-hgst.rst index a4b8bcd1b5..49ff3288b7 100644 --- a/doc/config-reference/source/tables/cinder-hgst.rst +++ b/doc/config-reference/source/tables/cinder-hgst.rst @@ -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 diff --git a/doc/config-reference/source/tables/cinder-hitachi-hbsd.rst b/doc/config-reference/source/tables/cinder-hitachi-hbsd.rst index 95e964b5a4..544f518436 100644 --- a/doc/config-reference/source/tables/cinder-hitachi-hbsd.rst +++ b/doc/config-reference/source/tables/cinder-hitachi-hbsd.rst @@ -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 diff --git a/doc/config-reference/source/tables/cinder-hpe3par.rst b/doc/config-reference/source/tables/cinder-hpe3par.rst index 769ac5d70a..418663ccda 100644 --- a/doc/config-reference/source/tables/cinder-hpe3par.rst +++ b/doc/config-reference/source/tables/cinder-hpe3par.rst @@ -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 diff --git a/doc/config-reference/source/tables/cinder-hpelefthand.rst b/doc/config-reference/source/tables/cinder-hpelefthand.rst index f16e39e45d..06dd7178bc 100644 --- a/doc/config-reference/source/tables/cinder-hpelefthand.rst +++ b/doc/config-reference/source/tables/cinder-hpelefthand.rst @@ -19,16 +19,16 @@ * - **[DEFAULT]** - * - ``hpelefthand_api_url`` = ``None`` - - (StrOpt) HPE LeftHand WSAPI Server Url like https://:8081/lhos + - (String) HPE LeftHand WSAPI Server Url like https://: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 diff --git a/doc/config-reference/source/tables/cinder-hpexp.rst b/doc/config-reference/source/tables/cinder-hpexp.rst index 64b05870ad..319105eb1c 100644 --- a/doc/config-reference/source/tables/cinder-hpexp.rst +++ b/doc/config-reference/source/tables/cinder-hpexp.rst @@ -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 diff --git a/doc/config-reference/source/tables/cinder-hpmsa.rst b/doc/config-reference/source/tables/cinder-hpmsa.rst index 7621bfd0f2..08362f8dcb 100644 --- a/doc/config-reference/source/tables/cinder-hpmsa.rst +++ b/doc/config-reference/source/tables/cinder-hpmsa.rst @@ -19,14 +19,14 @@ * - **[DEFAULT]** - * - ``hpmsa_api_protocol`` = ``https`` - - (StrOpt) HPMSA API interface protocol. + - (String) HPMSA API interface protocol. * - ``hpmsa_backend_name`` = ``A`` - - (StrOpt) Pool or Vdisk name to use for volume creation. + - (String) Pool or Vdisk name to use for volume creation. * - ``hpmsa_backend_type`` = ``virtual`` - - (StrOpt) linear (for Vdisk) or virtual (for Pool). + - (String) linear (for Vdisk) or virtual (for Pool). * - ``hpmsa_iscsi_ips`` = - - (ListOpt) List of comma-separated target iSCSI IP addresses. + - (List) List of comma-separated target iSCSI IP addresses. * - ``hpmsa_verify_certificate`` = ``False`` - - (BoolOpt) Whether to verify HPMSA array SSL certificate. + - (Boolean) Whether to verify HPMSA array SSL certificate. * - ``hpmsa_verify_certificate_path`` = ``None`` - - (StrOpt) HPMSA array SSL certificate path. + - (String) HPMSA array SSL certificate path. diff --git a/doc/config-reference/source/tables/cinder-huawei.rst b/doc/config-reference/source/tables/cinder-huawei.rst index 73902015d9..7a1ebb2f51 100644 --- a/doc/config-reference/source/tables/cinder-huawei.rst +++ b/doc/config-reference/source/tables/cinder-huawei.rst @@ -19,6 +19,6 @@ * - **[DEFAULT]** - * - ``cinder_huawei_conf_file`` = ``/etc/cinder/cinder_huawei_conf.xml`` - - (StrOpt) The configuration file for the Cinder Huawei driver. + - (String) The configuration file for the Cinder Huawei driver. * - ``hypermetro_devices`` = ``None`` - - (StrOpt) The remote device hypermetro will use. + - (String) The remote device hypermetro will use. diff --git a/doc/config-reference/source/tables/cinder-hyperv.rst b/doc/config-reference/source/tables/cinder-hyperv.rst index 7073b8e3fd..62bd65c3c4 100644 --- a/doc/config-reference/source/tables/cinder-hyperv.rst +++ b/doc/config-reference/source/tables/cinder-hyperv.rst @@ -19,4 +19,4 @@ * - **[hyperv]** - * - ``force_volumeutils_v1`` = ``False`` - - (BoolOpt) Force V1 volume utility class + - (Boolean) DEPRECATED: Force V1 volume utility class diff --git a/doc/config-reference/source/tables/cinder-images.rst b/doc/config-reference/source/tables/cinder-images.rst index 764c591621..01b47ac0eb 100644 --- a/doc/config-reference/source/tables/cinder-images.rst +++ b/doc/config-reference/source/tables/cinder-images.rst @@ -19,38 +19,38 @@ * - **[DEFAULT]** - * - ``allowed_direct_url_schemes`` = - - (ListOpt) A list of url schemes that can be downloaded directly via the direct_url. Currently supported schemes: [file]. + - (List) A list of url schemes that can be downloaded directly via the direct_url. Currently supported schemes: [file]. * - ``glance_api_insecure`` = ``False`` - - (BoolOpt) Allow to perform insecure SSL (https) requests to glance + - (Boolean) Allow to perform insecure SSL (https) requests to glance * - ``glance_api_servers`` = ``$glance_host:$glance_port`` - - (ListOpt) A list of the URLs of glance API servers available to cinder ([http[s]://][hostname|ip]:port). If protocol is not specified it defaults to http. + - (List) A list of the URLs of glance API servers available to cinder ([http[s]://][hostname|ip]:port). If protocol is not specified it defaults to http. * - ``glance_api_ssl_compression`` = ``False`` - - (BoolOpt) Enables or disables negotiation of SSL layer compression. In some cases disabling compression can improve data throughput, such as when high network bandwidth is available and you use compressed image formats like qcow2. + - (Boolean) Enables or disables negotiation of SSL layer compression. In some cases disabling compression can improve data throughput, such as when high network bandwidth is available and you use compressed image formats like qcow2. * - ``glance_api_version`` = ``1`` - - (IntOpt) Version of the glance API to use + - (Integer) Version of the glance API to use * - ``glance_ca_certificates_file`` = ``None`` - - (StrOpt) Location of ca certificates file to use for glance client requests. + - (String) Location of ca certificates file to use for glance client requests. * - ``glance_core_properties`` = ``checksum, container_format, disk_format, image_name, image_id, min_disk, min_ram, name, size`` - - (ListOpt) Default core properties of image + - (List) Default core properties of image * - ``glance_host`` = ``$my_ip`` - - (StrOpt) Default glance host name or IP + - (String) Default glance host name or IP * - ``glance_num_retries`` = ``0`` - - (IntOpt) Number retries when downloading an image from glance + - (Integer) Number retries when downloading an image from glance * - ``glance_port`` = ``9292`` - - (IntOpt) Default glance port + - (Integer) Default glance port * - ``glance_request_timeout`` = ``None`` - - (IntOpt) http/https timeout value for glance operations. If no value (None) is supplied here, the glanceclient default value is used. + - (Integer) http/https timeout value for glance operations. If no value (None) is supplied here, the glanceclient default value is used. * - ``image_conversion_dir`` = ``$state_path/conversion`` - - (StrOpt) Directory used for temporary storage during image conversion + - (String) Directory used for temporary storage during image conversion * - ``image_upload_use_cinder_backend`` = ``False`` - - (BoolOpt) If set to True, upload-to-image in raw format will create a cloned volume and register its location to the image service, instead of uploading the volume content. The cinder backend and locations support must be enabled in the image service, and glance_api_version must be set to 2. + - (Boolean) If set to True, upload-to-image in raw format will create a cloned volume and register its location to the image service, instead of uploading the volume content. The cinder backend and locations support must be enabled in the image service, and glance_api_version must be set to 2. * - ``image_upload_use_internal_tenant`` = ``False`` - - (BoolOpt) If set to True, the image volume created by upload-to-image will be placed in the internal tenant. Otherwise, the image volume is created in the current context's tenant. + - (Boolean) If set to True, the image volume created by upload-to-image will be placed in the internal tenant. Otherwise, the image volume is created in the current context's tenant. * - ``image_volume_cache_enabled`` = ``False`` - - (BoolOpt) Enable the image volume cache for this backend. + - (Boolean) Enable the image volume cache for this backend. * - ``image_volume_cache_max_count`` = ``0`` - - (IntOpt) Max number of entries allowed in the image volume cache. 0 => unlimited. + - (Integer) Max number of entries allowed in the image volume cache. 0 => unlimited. * - ``image_volume_cache_max_size_gb`` = ``0`` - - (IntOpt) Max size of the image volume cache for this backend in GB. 0 => unlimited. + - (Integer) Max size of the image volume cache for this backend in GB. 0 => unlimited. * - ``use_multipath_for_image_xfer`` = ``False`` - - (BoolOpt) Do we attach/detach volumes in cinder using multipath for volume to image and image to volume transfers? + - (Boolean) Do we attach/detach volumes in cinder using multipath for volume to image and image to volume transfers? diff --git a/doc/config-reference/source/tables/cinder-infortrend.rst b/doc/config-reference/source/tables/cinder-infortrend.rst index 4d531726f9..7319c573ac 100644 --- a/doc/config-reference/source/tables/cinder-infortrend.rst +++ b/doc/config-reference/source/tables/cinder-infortrend.rst @@ -19,18 +19,18 @@ * - **[DEFAULT]** - * - ``infortrend_cli_max_retries`` = ``5`` - - (IntOpt) Maximum retry time for cli. Default is 5. + - (Integer) Maximum retry time for cli. Default is 5. * - ``infortrend_cli_path`` = ``/opt/bin/Infortrend/raidcmd_ESDS10.jar`` - - (StrOpt) The Infortrend CLI absolute path. By default, it is at /opt/bin/Infortrend/raidcmd_ESDS10.jar + - (String) The Infortrend CLI absolute path. By default, it is at /opt/bin/Infortrend/raidcmd_ESDS10.jar * - ``infortrend_cli_timeout`` = ``30`` - - (IntOpt) Default timeout for CLI copy operations in minutes. Support: migrate volume, create cloned volume and create volume from snapshot. By Default, it is 30 minutes. + - (Integer) Default timeout for CLI copy operations in minutes. Support: migrate volume, create cloned volume and create volume from snapshot. By Default, it is 30 minutes. * - ``infortrend_pools_name`` = - - (StrOpt) Infortrend raid pool name list. It is separated with comma. + - (String) Infortrend raid pool name list. It is separated with comma. * - ``infortrend_provisioning`` = ``full`` - - (StrOpt) Let the volume use specific provisioning. By default, it is the full provisioning. The supported options are full or thin. + - (String) Let the volume use specific provisioning. By default, it is the full provisioning. The supported options are full or thin. * - ``infortrend_slots_a_channels_id`` = ``0,1,2,3,4,5,6,7`` - - (StrOpt) Infortrend raid channel ID list on Slot A for OpenStack usage. It is separated with comma. By default, it is the channel 0~7. + - (String) Infortrend raid channel ID list on Slot A for OpenStack usage. It is separated with comma. By default, it is the channel 0~7. * - ``infortrend_slots_b_channels_id`` = ``0,1,2,3,4,5,6,7`` - - (StrOpt) Infortrend raid channel ID list on Slot B for OpenStack usage. It is separated with comma. By default, it is the channel 0~7. + - (String) Infortrend raid channel ID list on Slot B for OpenStack usage. It is separated with comma. By default, it is the channel 0~7. * - ``infortrend_tiering`` = ``0`` - - (StrOpt) Let the volume use specific tiering level. By default, it is the level 0. The supported levels are 0,2,3,4. + - (String) Let the volume use specific tiering level. By default, it is the level 0. The supported levels are 0,2,3,4. diff --git a/doc/config-reference/source/tables/cinder-keymgr.rst b/doc/config-reference/source/tables/cinder-keymgr.rst index 0aecce89b1..816392f529 100644 --- a/doc/config-reference/source/tables/cinder-keymgr.rst +++ b/doc/config-reference/source/tables/cinder-keymgr.rst @@ -19,10 +19,10 @@ * - **[keymgr]** - * - ``api_class`` = ``cinder.keymgr.conf_key_mgr.ConfKeyManager`` - - (StrOpt) The full class name of the key manager API class + - (String) The full class name of the key manager API class * - ``encryption_api_url`` = ``http://localhost:9311/v1`` - - (StrOpt) Url for encryption service. + - (String) Url for encryption service. * - ``encryption_auth_url`` = ``http://localhost:5000/v3`` - - (StrOpt) Authentication url for encryption service. + - (String) Authentication url for encryption service. * - ``fixed_key`` = ``None`` - - (StrOpt) Fixed key returned by key manager, specified in hex + - (String) Fixed key returned by key manager, specified in hex diff --git a/doc/config-reference/source/tables/cinder-lenovo.rst b/doc/config-reference/source/tables/cinder-lenovo.rst index 6263bee575..f67b0a1542 100644 --- a/doc/config-reference/source/tables/cinder-lenovo.rst +++ b/doc/config-reference/source/tables/cinder-lenovo.rst @@ -19,14 +19,14 @@ * - **[DEFAULT]** - * - ``lenovo_api_protocol`` = ``https`` - - (StrOpt) Lenovo api interface protocol. + - (String) Lenovo api interface protocol. * - ``lenovo_backend_name`` = ``A`` - - (StrOpt) Pool or Vdisk name to use for volume creation. + - (String) Pool or Vdisk name to use for volume creation. * - ``lenovo_backend_type`` = ``virtual`` - - (StrOpt) linear (for VDisk) or virtual (for Pool). + - (String) linear (for VDisk) or virtual (for Pool). * - ``lenovo_iscsi_ips`` = - - (ListOpt) List of comma-separated target iSCSI IP addresses. + - (List) List of comma-separated target iSCSI IP addresses. * - ``lenovo_verify_certificate`` = ``False`` - - (BoolOpt) Whether to verify Lenovo array SSL certificate. + - (Boolean) Whether to verify Lenovo array SSL certificate. * - ``lenovo_verify_certificate_path`` = ``None`` - - (StrOpt) Lenovo array SSL certificate path. + - (String) Lenovo array SSL certificate path. diff --git a/doc/config-reference/source/tables/cinder-logging.rst b/doc/config-reference/source/tables/cinder-logging.rst index 019e2d3df0..f718310be4 100644 --- a/doc/config-reference/source/tables/cinder-logging.rst +++ b/doc/config-reference/source/tables/cinder-logging.rst @@ -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. - * - ``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`` - - (ListOpt) List of package logging levels in logger=LEVEL pairs. This option is ignored if log_config_append is set. + - (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`` + - (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. * - ``fatal_exception_format_errors`` = ``False`` - - (BoolOpt) Make exception message format errors fatal. + - (Boolean) Make exception message format errors fatal. * - ``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 all logging configuration is defined in the configuration file and other logging configuration options are ignored. + - (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). The format without the APP-NAME is deprecated in Kilo, and will be removed in Mitaka, along with this option. 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. diff --git a/doc/config-reference/source/tables/cinder-lvm.rst b/doc/config-reference/source/tables/cinder-lvm.rst index 448061b87d..8b18fa7af3 100644 --- a/doc/config-reference/source/tables/cinder-lvm.rst +++ b/doc/config-reference/source/tables/cinder-lvm.rst @@ -19,12 +19,12 @@ * - **[DEFAULT]** - * - ``lvm_conf_file`` = ``/etc/cinder/lvm.conf`` - - (StrOpt) LVM conf file to use for the LVM driver in Cinder; this setting is ignored if the specified file does not exist (You can also specify 'None' to not use a conf file even if one exists). + - (String) LVM conf file to use for the LVM driver in Cinder; this setting is ignored if the specified file does not exist (You can also specify 'None' to not use a conf file even if one exists). * - ``lvm_max_over_subscription_ratio`` = ``1.0`` - - (FloatOpt) max_over_subscription_ratio setting for the LVM driver. If set, this takes precedence over the general max_over_subscription_ratio option. If None, the general option is used. + - (Floating point) max_over_subscription_ratio setting for the LVM driver. If set, this takes precedence over the general max_over_subscription_ratio option. If None, the general option is used. * - ``lvm_mirrors`` = ``0`` - - (IntOpt) If >0, create LVs with multiple mirrors. Note that this requires lvm_mirrors + 2 PVs with available space + - (Integer) If >0, create LVs with multiple mirrors. Note that this requires lvm_mirrors + 2 PVs with available space * - ``lvm_type`` = ``default`` - - (StrOpt) Type of LVM volumes to deploy; (default, thin, or auto). Auto defaults to thin if thin is supported. + - (String) Type of LVM volumes to deploy; (default, thin, or auto). Auto defaults to thin if thin is supported. * - ``volume_group`` = ``cinder-volumes`` - - (StrOpt) Name for the VG that will contain exported volumes + - (String) Name for the VG that will contain exported volumes diff --git a/doc/config-reference/source/tables/cinder-nas.rst b/doc/config-reference/source/tables/cinder-nas.rst index 296a0a7e03..681fab4630 100644 --- a/doc/config-reference/source/tables/cinder-nas.rst +++ b/doc/config-reference/source/tables/cinder-nas.rst @@ -19,20 +19,20 @@ * - **[DEFAULT]** - * - ``nas_ip`` = - - (StrOpt) IP address or Hostname of NAS system. + - (String) IP address or Hostname of NAS system. * - ``nas_login`` = ``admin`` - - (StrOpt) User name to connect to NAS system. + - (String) User name to connect to NAS system. * - ``nas_mount_options`` = ``None`` - - (StrOpt) Options used to mount the storage backend file system where Cinder volumes are stored. + - (String) Options used to mount the storage backend file system where Cinder volumes are stored. * - ``nas_password`` = - - (StrOpt) Password to connect to NAS system. + - (String) Password to connect to NAS system. * - ``nas_private_key`` = - - (StrOpt) Filename of private key to use for SSH authentication. + - (String) Filename of private key to use for SSH authentication. * - ``nas_secure_file_operations`` = ``auto`` - - (StrOpt) Allow network-attached storage systems to operate in a secure environment where root level access is not permitted. If set to False, access is as the root user and insecure. If set to True, access is not as root. If set to auto, a check is done to determine if this is a new installation: True is used if so, otherwise False. Default is auto. + - (String) Allow network-attached storage systems to operate in a secure environment where root level access is not permitted. If set to False, access is as the root user and insecure. If set to True, access is not as root. If set to auto, a check is done to determine if this is a new installation: True is used if so, otherwise False. Default is auto. * - ``nas_secure_file_permissions`` = ``auto`` - - (StrOpt) Set more secure file permissions on network-attached storage volume files to restrict broad other/world access. If set to False, volumes are created with open permissions. If set to True, volumes are created with permissions for the cinder user and group (660). If set to auto, a check is done to determine if this is a new installation: True is used if so, otherwise False. Default is auto. + - (String) Set more secure file permissions on network-attached storage volume files to restrict broad other/world access. If set to False, volumes are created with open permissions. If set to True, volumes are created with permissions for the cinder user and group (660). If set to auto, a check is done to determine if this is a new installation: True is used if so, otherwise False. Default is auto. * - ``nas_share_path`` = - - (StrOpt) Path to the share to use for storing Cinder volumes. For example: "/srv/export1" for an NFS server export available at 10.0.5.10:/srv/export1 . + - (String) Path to the share to use for storing Cinder volumes. For example: "/srv/export1" for an NFS server export available at 10.0.5.10:/srv/export1 . * - ``nas_ssh_port`` = ``22`` - - (PortOpt) SSH port to use to connect to NAS system. + - (Unknown) SSH port to use to connect to NAS system. diff --git a/doc/config-reference/source/tables/cinder-netapp_7mode_iscsi.rst b/doc/config-reference/source/tables/cinder-netapp_7mode_iscsi.rst index bf16a69d21..c9530ae7ef 100644 --- a/doc/config-reference/source/tables/cinder-netapp_7mode_iscsi.rst +++ b/doc/config-reference/source/tables/cinder-netapp_7mode_iscsi.rst @@ -19,24 +19,24 @@ * - **[DEFAULT]** - * - ``netapp_login`` = ``None`` - - (StrOpt) Administrative user account name used to access the storage system or proxy server. + - (String) Administrative user account name used to access the storage system or proxy server. * - ``netapp_partner_backend_name`` = ``None`` - - (StrOpt) The name of the config.conf stanza for a Data ONTAP (7-mode) HA partner. This option is only used by the driver when connecting to an instance with a storage family of Data ONTAP operating in 7-Mode, and it is required if the storage protocol selected is FC. + - (String) The name of the config.conf stanza for a Data ONTAP (7-mode) HA partner. This option is only used by the driver when connecting to an instance with a storage family of Data ONTAP operating in 7-Mode, and it is required if the storage protocol selected is FC. * - ``netapp_password`` = ``None`` - - (StrOpt) Password for the administrative user account specified in the netapp_login option. + - (String) Password for the administrative user account specified in the netapp_login option. * - ``netapp_pool_name_search_pattern`` = ``(.+)`` - - (StrOpt) This option is used to restrict provisioning to the specified pools. Specify the value of this option to be a regular expression which will be applied to the names of objects from the storage backend which represent pools in Cinder. This option is only utilized when the storage protocol is configured to use iSCSI or FC. + - (String) This option is used to restrict provisioning to the specified pools. Specify the value of this option to be a regular expression which will be applied to the names of objects from the storage backend which represent pools in Cinder. This option is only utilized when the storage protocol is configured to use iSCSI or FC. * - ``netapp_server_hostname`` = ``None`` - - (StrOpt) The hostname (or IP address) for the storage system or proxy server. + - (String) The hostname (or IP address) for the storage system or proxy server. * - ``netapp_server_port`` = ``None`` - - (IntOpt) The TCP port to use for communication with the storage system or proxy server. If not specified, Data ONTAP drivers will use 80 for HTTP and 443 for HTTPS; E-Series will use 8080 for HTTP and 8443 for HTTPS. + - (Integer) The TCP port to use for communication with the storage system or proxy server. If not specified, Data ONTAP drivers will use 80 for HTTP and 443 for HTTPS; E-Series will use 8080 for HTTP and 8443 for HTTPS. * - ``netapp_size_multiplier`` = ``1.2`` - - (FloatOpt) The quantity to be multiplied by the requested volume size to ensure enough space is available on the virtual storage server (Vserver) to fulfill the volume creation request. Note: this option is deprecated and will be removed in favor of "reserved_percentage" in the Mitaka release. + - (Floating point) The quantity to be multiplied by the requested volume size to ensure enough space is available on the virtual storage server (Vserver) to fulfill the volume creation request. Note: this option is deprecated and will be removed in favor of "reserved_percentage" in the Mitaka release. * - ``netapp_storage_family`` = ``ontap_cluster`` - - (StrOpt) The storage family type used on the storage system; valid values are ontap_7mode for using Data ONTAP operating in 7-Mode, ontap_cluster for using clustered Data ONTAP, or eseries for using E-Series. + - (String) The storage family type used on the storage system; valid values are ontap_7mode for using Data ONTAP operating in 7-Mode, ontap_cluster for using clustered Data ONTAP, or eseries for using E-Series. * - ``netapp_storage_protocol`` = ``None`` - - (StrOpt) The storage protocol to be used on the data path with the storage system. + - (String) The storage protocol to be used on the data path with the storage system. * - ``netapp_transport_type`` = ``http`` - - (StrOpt) The transport protocol used when communicating with the storage system or proxy server. + - (String) The transport protocol used when communicating with the storage system or proxy server. * - ``netapp_vfiler`` = ``None`` - - (StrOpt) The vFiler unit on which provisioning of block storage volumes will be done. This option is only used by the driver when connecting to an instance with a storage family of Data ONTAP operating in 7-Mode. Only use this option when utilizing the MultiStore feature on the NetApp storage system. + - (String) The vFiler unit on which provisioning of block storage volumes will be done. This option is only used by the driver when connecting to an instance with a storage family of Data ONTAP operating in 7-Mode. Only use this option when utilizing the MultiStore feature on the NetApp storage system. diff --git a/doc/config-reference/source/tables/cinder-netapp_7mode_nfs.rst b/doc/config-reference/source/tables/cinder-netapp_7mode_nfs.rst index 29e06ebcdb..84e9a69fa3 100644 --- a/doc/config-reference/source/tables/cinder-netapp_7mode_nfs.rst +++ b/doc/config-reference/source/tables/cinder-netapp_7mode_nfs.rst @@ -19,28 +19,28 @@ * - **[DEFAULT]** - * - ``expiry_thres_minutes`` = ``720`` - - (IntOpt) This option specifies the threshold for last access time for images in the NFS image cache. When a cache cleaning cycle begins, images in the cache that have not been accessed in the last M minutes, where M is the value of this parameter, will be deleted from the cache to create free space on the NFS share. + - (Integer) This option specifies the threshold for last access time for images in the NFS image cache. When a cache cleaning cycle begins, images in the cache that have not been accessed in the last M minutes, where M is the value of this parameter, will be deleted from the cache to create free space on the NFS share. * - ``netapp_login`` = ``None`` - - (StrOpt) Administrative user account name used to access the storage system or proxy server. + - (String) Administrative user account name used to access the storage system or proxy server. * - ``netapp_partner_backend_name`` = ``None`` - - (StrOpt) The name of the config.conf stanza for a Data ONTAP (7-mode) HA partner. This option is only used by the driver when connecting to an instance with a storage family of Data ONTAP operating in 7-Mode, and it is required if the storage protocol selected is FC. + - (String) The name of the config.conf stanza for a Data ONTAP (7-mode) HA partner. This option is only used by the driver when connecting to an instance with a storage family of Data ONTAP operating in 7-Mode, and it is required if the storage protocol selected is FC. * - ``netapp_password`` = ``None`` - - (StrOpt) Password for the administrative user account specified in the netapp_login option. + - (String) Password for the administrative user account specified in the netapp_login option. * - ``netapp_pool_name_search_pattern`` = ``(.+)`` - - (StrOpt) This option is used to restrict provisioning to the specified pools. Specify the value of this option to be a regular expression which will be applied to the names of objects from the storage backend which represent pools in Cinder. This option is only utilized when the storage protocol is configured to use iSCSI or FC. + - (String) This option is used to restrict provisioning to the specified pools. Specify the value of this option to be a regular expression which will be applied to the names of objects from the storage backend which represent pools in Cinder. This option is only utilized when the storage protocol is configured to use iSCSI or FC. * - ``netapp_server_hostname`` = ``None`` - - (StrOpt) The hostname (or IP address) for the storage system or proxy server. + - (String) The hostname (or IP address) for the storage system or proxy server. * - ``netapp_server_port`` = ``None`` - - (IntOpt) The TCP port to use for communication with the storage system or proxy server. If not specified, Data ONTAP drivers will use 80 for HTTP and 443 for HTTPS; E-Series will use 8080 for HTTP and 8443 for HTTPS. + - (Integer) The TCP port to use for communication with the storage system or proxy server. If not specified, Data ONTAP drivers will use 80 for HTTP and 443 for HTTPS; E-Series will use 8080 for HTTP and 8443 for HTTPS. * - ``netapp_storage_family`` = ``ontap_cluster`` - - (StrOpt) The storage family type used on the storage system; valid values are ontap_7mode for using Data ONTAP operating in 7-Mode, ontap_cluster for using clustered Data ONTAP, or eseries for using E-Series. + - (String) The storage family type used on the storage system; valid values are ontap_7mode for using Data ONTAP operating in 7-Mode, ontap_cluster for using clustered Data ONTAP, or eseries for using E-Series. * - ``netapp_storage_protocol`` = ``None`` - - (StrOpt) The storage protocol to be used on the data path with the storage system. + - (String) The storage protocol to be used on the data path with the storage system. * - ``netapp_transport_type`` = ``http`` - - (StrOpt) The transport protocol used when communicating with the storage system or proxy server. + - (String) The transport protocol used when communicating with the storage system or proxy server. * - ``netapp_vfiler`` = ``None`` - - (StrOpt) The vFiler unit on which provisioning of block storage volumes will be done. This option is only used by the driver when connecting to an instance with a storage family of Data ONTAP operating in 7-Mode. Only use this option when utilizing the MultiStore feature on the NetApp storage system. + - (String) The vFiler unit on which provisioning of block storage volumes will be done. This option is only used by the driver when connecting to an instance with a storage family of Data ONTAP operating in 7-Mode. Only use this option when utilizing the MultiStore feature on the NetApp storage system. * - ``thres_avl_size_perc_start`` = ``20`` - - (IntOpt) If the percentage of available space for an NFS share has dropped below the value specified by this option, the NFS image cache will be cleaned. + - (Integer) If the percentage of available space for an NFS share has dropped below the value specified by this option, the NFS image cache will be cleaned. * - ``thres_avl_size_perc_stop`` = ``60`` - - (IntOpt) When the percentage of available space on an NFS share has reached the percentage specified by this option, the driver will stop clearing files from the NFS image cache that have not been accessed in the last M minutes, where M is the value of the expiry_thres_minutes configuration option. + - (Integer) When the percentage of available space on an NFS share has reached the percentage specified by this option, the driver will stop clearing files from the NFS image cache that have not been accessed in the last M minutes, where M is the value of the expiry_thres_minutes configuration option. diff --git a/doc/config-reference/source/tables/cinder-netapp_cdot_iscsi.rst b/doc/config-reference/source/tables/cinder-netapp_cdot_iscsi.rst index 32f7bc4fb8..42166d2e1b 100644 --- a/doc/config-reference/source/tables/cinder-netapp_cdot_iscsi.rst +++ b/doc/config-reference/source/tables/cinder-netapp_cdot_iscsi.rst @@ -19,28 +19,28 @@ * - **[DEFAULT]** - * - ``netapp_login`` = ``None`` - - (StrOpt) Administrative user account name used to access the storage system or proxy server. + - (String) Administrative user account name used to access the storage system or proxy server. * - ``netapp_lun_ostype`` = ``None`` - - (StrOpt) This option defines the type of operating system that will access a LUN exported from Data ONTAP; it is assigned to the LUN at the time it is created. + - (String) This option defines the type of operating system that will access a LUN exported from Data ONTAP; it is assigned to the LUN at the time it is created. * - ``netapp_lun_space_reservation`` = ``enabled`` - - (StrOpt) This option determines if storage space is reserved for LUN allocation. If enabled, LUNs are thick provisioned. If space reservation is disabled, storage space is allocated on demand. + - (String) This option determines if storage space is reserved for LUN allocation. If enabled, LUNs are thick provisioned. If space reservation is disabled, storage space is allocated on demand. * - ``netapp_partner_backend_name`` = ``None`` - - (StrOpt) The name of the config.conf stanza for a Data ONTAP (7-mode) HA partner. This option is only used by the driver when connecting to an instance with a storage family of Data ONTAP operating in 7-Mode, and it is required if the storage protocol selected is FC. + - (String) The name of the config.conf stanza for a Data ONTAP (7-mode) HA partner. This option is only used by the driver when connecting to an instance with a storage family of Data ONTAP operating in 7-Mode, and it is required if the storage protocol selected is FC. * - ``netapp_password`` = ``None`` - - (StrOpt) Password for the administrative user account specified in the netapp_login option. + - (String) Password for the administrative user account specified in the netapp_login option. * - ``netapp_pool_name_search_pattern`` = ``(.+)`` - - (StrOpt) This option is used to restrict provisioning to the specified pools. Specify the value of this option to be a regular expression which will be applied to the names of objects from the storage backend which represent pools in Cinder. This option is only utilized when the storage protocol is configured to use iSCSI or FC. + - (String) This option is used to restrict provisioning to the specified pools. Specify the value of this option to be a regular expression which will be applied to the names of objects from the storage backend which represent pools in Cinder. This option is only utilized when the storage protocol is configured to use iSCSI or FC. * - ``netapp_server_hostname`` = ``None`` - - (StrOpt) The hostname (or IP address) for the storage system or proxy server. + - (String) The hostname (or IP address) for the storage system or proxy server. * - ``netapp_server_port`` = ``None`` - - (IntOpt) The TCP port to use for communication with the storage system or proxy server. If not specified, Data ONTAP drivers will use 80 for HTTP and 443 for HTTPS; E-Series will use 8080 for HTTP and 8443 for HTTPS. + - (Integer) The TCP port to use for communication with the storage system or proxy server. If not specified, Data ONTAP drivers will use 80 for HTTP and 443 for HTTPS; E-Series will use 8080 for HTTP and 8443 for HTTPS. * - ``netapp_size_multiplier`` = ``1.2`` - - (FloatOpt) The quantity to be multiplied by the requested volume size to ensure enough space is available on the virtual storage server (Vserver) to fulfill the volume creation request. Note: this option is deprecated and will be removed in favor of "reserved_percentage" in the Mitaka release. + - (Floating point) The quantity to be multiplied by the requested volume size to ensure enough space is available on the virtual storage server (Vserver) to fulfill the volume creation request. Note: this option is deprecated and will be removed in favor of "reserved_percentage" in the Mitaka release. * - ``netapp_storage_family`` = ``ontap_cluster`` - - (StrOpt) The storage family type used on the storage system; valid values are ontap_7mode for using Data ONTAP operating in 7-Mode, ontap_cluster for using clustered Data ONTAP, or eseries for using E-Series. + - (String) The storage family type used on the storage system; valid values are ontap_7mode for using Data ONTAP operating in 7-Mode, ontap_cluster for using clustered Data ONTAP, or eseries for using E-Series. * - ``netapp_storage_protocol`` = ``None`` - - (StrOpt) The storage protocol to be used on the data path with the storage system. + - (String) The storage protocol to be used on the data path with the storage system. * - ``netapp_transport_type`` = ``http`` - - (StrOpt) The transport protocol used when communicating with the storage system or proxy server. + - (String) The transport protocol used when communicating with the storage system or proxy server. * - ``netapp_vserver`` = ``None`` - - (StrOpt) This option specifies the virtual storage server (Vserver) name on the storage cluster on which provisioning of block storage volumes should occur. + - (String) This option specifies the virtual storage server (Vserver) name on the storage cluster on which provisioning of block storage volumes should occur. diff --git a/doc/config-reference/source/tables/cinder-netapp_cdot_nfs.rst b/doc/config-reference/source/tables/cinder-netapp_cdot_nfs.rst index a407cc03f8..7424fae13f 100644 --- a/doc/config-reference/source/tables/cinder-netapp_cdot_nfs.rst +++ b/doc/config-reference/source/tables/cinder-netapp_cdot_nfs.rst @@ -19,36 +19,36 @@ * - **[DEFAULT]** - * - ``expiry_thres_minutes`` = ``720`` - - (IntOpt) This option specifies the threshold for last access time for images in the NFS image cache. When a cache cleaning cycle begins, images in the cache that have not been accessed in the last M minutes, where M is the value of this parameter, will be deleted from the cache to create free space on the NFS share. + - (Integer) This option specifies the threshold for last access time for images in the NFS image cache. When a cache cleaning cycle begins, images in the cache that have not been accessed in the last M minutes, where M is the value of this parameter, will be deleted from the cache to create free space on the NFS share. * - ``netapp_copyoffload_tool_path`` = ``None`` - - (StrOpt) This option specifies the path of the NetApp copy offload tool binary. Ensure that the binary has execute permissions set which allow the effective user of the cinder-volume process to execute the file. + - (String) This option specifies the path of the NetApp copy offload tool binary. Ensure that the binary has execute permissions set which allow the effective user of the cinder-volume process to execute the file. * - ``netapp_host_type`` = ``None`` - - (StrOpt) This option defines the type of operating system for all initiators that can access a LUN. This information is used when mapping LUNs to individual hosts or groups of hosts. + - (String) This option defines the type of operating system for all initiators that can access a LUN. This information is used when mapping LUNs to individual hosts or groups of hosts. * - ``netapp_host_type`` = ``None`` - - (StrOpt) This option defines the type of operating system for all initiators that can access a LUN. This information is used when mapping LUNs to individual hosts or groups of hosts. + - (String) This option defines the type of operating system for all initiators that can access a LUN. This information is used when mapping LUNs to individual hosts or groups of hosts. * - ``netapp_login`` = ``None`` - - (StrOpt) Administrative user account name used to access the storage system or proxy server. + - (String) Administrative user account name used to access the storage system or proxy server. * - ``netapp_lun_ostype`` = ``None`` - - (StrOpt) This option defines the type of operating system that will access a LUN exported from Data ONTAP; it is assigned to the LUN at the time it is created. + - (String) This option defines the type of operating system that will access a LUN exported from Data ONTAP; it is assigned to the LUN at the time it is created. * - ``netapp_partner_backend_name`` = ``None`` - - (StrOpt) The name of the config.conf stanza for a Data ONTAP (7-mode) HA partner. This option is only used by the driver when connecting to an instance with a storage family of Data ONTAP operating in 7-Mode, and it is required if the storage protocol selected is FC. + - (String) The name of the config.conf stanza for a Data ONTAP (7-mode) HA partner. This option is only used by the driver when connecting to an instance with a storage family of Data ONTAP operating in 7-Mode, and it is required if the storage protocol selected is FC. * - ``netapp_password`` = ``None`` - - (StrOpt) Password for the administrative user account specified in the netapp_login option. + - (String) Password for the administrative user account specified in the netapp_login option. * - ``netapp_pool_name_search_pattern`` = ``(.+)`` - - (StrOpt) This option is used to restrict provisioning to the specified pools. Specify the value of this option to be a regular expression which will be applied to the names of objects from the storage backend which represent pools in Cinder. This option is only utilized when the storage protocol is configured to use iSCSI or FC. + - (String) This option is used to restrict provisioning to the specified pools. Specify the value of this option to be a regular expression which will be applied to the names of objects from the storage backend which represent pools in Cinder. This option is only utilized when the storage protocol is configured to use iSCSI or FC. * - ``netapp_server_hostname`` = ``None`` - - (StrOpt) The hostname (or IP address) for the storage system or proxy server. + - (String) The hostname (or IP address) for the storage system or proxy server. * - ``netapp_server_port`` = ``None`` - - (IntOpt) The TCP port to use for communication with the storage system or proxy server. If not specified, Data ONTAP drivers will use 80 for HTTP and 443 for HTTPS; E-Series will use 8080 for HTTP and 8443 for HTTPS. + - (Integer) The TCP port to use for communication with the storage system or proxy server. If not specified, Data ONTAP drivers will use 80 for HTTP and 443 for HTTPS; E-Series will use 8080 for HTTP and 8443 for HTTPS. * - ``netapp_storage_family`` = ``ontap_cluster`` - - (StrOpt) The storage family type used on the storage system; valid values are ontap_7mode for using Data ONTAP operating in 7-Mode, ontap_cluster for using clustered Data ONTAP, or eseries for using E-Series. + - (String) The storage family type used on the storage system; valid values are ontap_7mode for using Data ONTAP operating in 7-Mode, ontap_cluster for using clustered Data ONTAP, or eseries for using E-Series. * - ``netapp_storage_protocol`` = ``None`` - - (StrOpt) The storage protocol to be used on the data path with the storage system. + - (String) The storage protocol to be used on the data path with the storage system. * - ``netapp_transport_type`` = ``http`` - - (StrOpt) The transport protocol used when communicating with the storage system or proxy server. + - (String) The transport protocol used when communicating with the storage system or proxy server. * - ``netapp_vserver`` = ``None`` - - (StrOpt) This option specifies the virtual storage server (Vserver) name on the storage cluster on which provisioning of block storage volumes should occur. + - (String) This option specifies the virtual storage server (Vserver) name on the storage cluster on which provisioning of block storage volumes should occur. * - ``thres_avl_size_perc_start`` = ``20`` - - (IntOpt) If the percentage of available space for an NFS share has dropped below the value specified by this option, the NFS image cache will be cleaned. + - (Integer) If the percentage of available space for an NFS share has dropped below the value specified by this option, the NFS image cache will be cleaned. * - ``thres_avl_size_perc_stop`` = ``60`` - - (IntOpt) When the percentage of available space on an NFS share has reached the percentage specified by this option, the driver will stop clearing files from the NFS image cache that have not been accessed in the last M minutes, where M is the value of the expiry_thres_minutes configuration option. + - (Integer) When the percentage of available space on an NFS share has reached the percentage specified by this option, the driver will stop clearing files from the NFS image cache that have not been accessed in the last M minutes, where M is the value of the expiry_thres_minutes configuration option. diff --git a/doc/config-reference/source/tables/cinder-netapp_eseries_iscsi.rst b/doc/config-reference/source/tables/cinder-netapp_eseries_iscsi.rst index 5a8bbcd556..5fbcb915b7 100644 --- a/doc/config-reference/source/tables/cinder-netapp_eseries_iscsi.rst +++ b/doc/config-reference/source/tables/cinder-netapp_eseries_iscsi.rst @@ -19,28 +19,28 @@ * - **[DEFAULT]** - * - ``netapp_controller_ips`` = ``None`` - - (StrOpt) This option is only utilized when the storage family is configured to eseries. This option is used to restrict provisioning to the specified controllers. Specify the value of this option to be a comma separated list of controller hostnames or IP addresses to be used for provisioning. + - (String) This option is only utilized when the storage family is configured to eseries. This option is used to restrict provisioning to the specified controllers. Specify the value of this option to be a comma separated list of controller hostnames or IP addresses to be used for provisioning. * - ``netapp_enable_multiattach`` = ``False`` - - (BoolOpt) This option specifies whether the driver should allow operations that require multiple attachments to a volume. An example would be live migration of servers that have volumes attached. When enabled, this backend is limited to 256 total volumes in order to guarantee volumes can be accessed by more than one host. + - (Boolean) This option specifies whether the driver should allow operations that require multiple attachments to a volume. An example would be live migration of servers that have volumes attached. When enabled, this backend is limited to 256 total volumes in order to guarantee volumes can be accessed by more than one host. * - ``netapp_host_type`` = ``None`` - - (StrOpt) This option defines the type of operating system for all initiators that can access a LUN. This information is used when mapping LUNs to individual hosts or groups of hosts. + - (String) This option defines the type of operating system for all initiators that can access a LUN. This information is used when mapping LUNs to individual hosts or groups of hosts. * - ``netapp_login`` = ``None`` - - (StrOpt) Administrative user account name used to access the storage system or proxy server. + - (String) Administrative user account name used to access the storage system or proxy server. * - ``netapp_partner_backend_name`` = ``None`` - - (StrOpt) The name of the config.conf stanza for a Data ONTAP (7-mode) HA partner. This option is only used by the driver when connecting to an instance with a storage family of Data ONTAP operating in 7-Mode, and it is required if the storage protocol selected is FC. + - (String) The name of the config.conf stanza for a Data ONTAP (7-mode) HA partner. This option is only used by the driver when connecting to an instance with a storage family of Data ONTAP operating in 7-Mode, and it is required if the storage protocol selected is FC. * - ``netapp_password`` = ``None`` - - (StrOpt) Password for the administrative user account specified in the netapp_login option. + - (String) Password for the administrative user account specified in the netapp_login option. * - ``netapp_pool_name_search_pattern`` = ``(.+)`` - - (StrOpt) This option is used to restrict provisioning to the specified pools. Specify the value of this option to be a regular expression which will be applied to the names of objects from the storage backend which represent pools in Cinder. This option is only utilized when the storage protocol is configured to use iSCSI or FC. + - (String) This option is used to restrict provisioning to the specified pools. Specify the value of this option to be a regular expression which will be applied to the names of objects from the storage backend which represent pools in Cinder. This option is only utilized when the storage protocol is configured to use iSCSI or FC. * - ``netapp_sa_password`` = ``None`` - - (StrOpt) Password for the NetApp E-Series storage array. + - (String) Password for the NetApp E-Series storage array. * - ``netapp_server_hostname`` = ``None`` - - (StrOpt) The hostname (or IP address) for the storage system or proxy server. + - (String) The hostname (or IP address) for the storage system or proxy server. * - ``netapp_server_port`` = ``None`` - - (IntOpt) The TCP port to use for communication with the storage system or proxy server. If not specified, Data ONTAP drivers will use 80 for HTTP and 443 for HTTPS; E-Series will use 8080 for HTTP and 8443 for HTTPS. + - (Integer) The TCP port to use for communication with the storage system or proxy server. If not specified, Data ONTAP drivers will use 80 for HTTP and 443 for HTTPS; E-Series will use 8080 for HTTP and 8443 for HTTPS. * - ``netapp_storage_family`` = ``ontap_cluster`` - - (StrOpt) The storage family type used on the storage system; valid values are ontap_7mode for using Data ONTAP operating in 7-Mode, ontap_cluster for using clustered Data ONTAP, or eseries for using E-Series. + - (String) The storage family type used on the storage system; valid values are ontap_7mode for using Data ONTAP operating in 7-Mode, ontap_cluster for using clustered Data ONTAP, or eseries for using E-Series. * - ``netapp_transport_type`` = ``http`` - - (StrOpt) The transport protocol used when communicating with the storage system or proxy server. + - (String) The transport protocol used when communicating with the storage system or proxy server. * - ``netapp_webservice_path`` = ``/devmgr/v2`` - - (StrOpt) This option is used to specify the path to the E-Series proxy application on a proxy server. The value is combined with the value of the netapp_transport_type, netapp_server_hostname, and netapp_server_port options to create the URL used by the driver to connect to the proxy application. + - (String) This option is used to specify the path to the E-Series proxy application on a proxy server. The value is combined with the value of the netapp_transport_type, netapp_server_hostname, and netapp_server_port options to create the URL used by the driver to connect to the proxy application. diff --git a/doc/config-reference/source/tables/cinder-nexenta.rst b/doc/config-reference/source/tables/cinder-nexenta.rst index f0f6b204a8..56d8842872 100644 --- a/doc/config-reference/source/tables/cinder-nexenta.rst +++ b/doc/config-reference/source/tables/cinder-nexenta.rst @@ -19,62 +19,62 @@ * - **[DEFAULT]** - * - ``nexenta_blocksize`` = ``4096`` - - (StrOpt) Block size for datasets + - (Integer) Block size for datasets * - ``nexenta_chunksize`` = ``16384`` - - (StrOpt) NexentaEdge iSCSI LUN object chunk size + - (Integer) NexentaEdge iSCSI LUN object chunk size * - ``nexenta_client_address`` = - - (StrOpt) NexentaEdge iSCSI Gateway client address for non-VIP service + - (String) NexentaEdge iSCSI Gateway client address for non-VIP service * - ``nexenta_dataset_compression`` = ``on`` - - (StrOpt) Compression value for new ZFS folders. + - (String) Compression value for new ZFS folders. * - ``nexenta_dataset_dedup`` = ``off`` - - (StrOpt) Deduplication value for new ZFS folders. + - (String) Deduplication value for new ZFS folders. * - ``nexenta_dataset_description`` = - - (StrOpt) Human-readable description for the folder. + - (String) Human-readable description for the folder. * - ``nexenta_host`` = - - (StrOpt) IP address of Nexenta SA + - (String) IP address of Nexenta SA * - ``nexenta_iscsi_service`` = - - (StrOpt) NexentaEdge iSCSI service name + - (String) NexentaEdge iSCSI service name * - ``nexenta_iscsi_target_portal_port`` = ``3260`` - - (IntOpt) Nexenta target portal port + - (Integer) Nexenta target portal port * - ``nexenta_lun_container`` = - - (StrOpt) NexentaEdge logical path of bucket for LUNs + - (String) NexentaEdge logical path of bucket for LUNs * - ``nexenta_mount_point_base`` = ``$state_path/mnt`` - - (StrOpt) Base directory that contains NFS share mount points + - (String) Base directory that contains NFS share mount points * - ``nexenta_nms_cache_volroot`` = ``True`` - - (BoolOpt) If set True cache NexentaStor appliance volroot option value. + - (Boolean) If set True cache NexentaStor appliance volroot option value. * - ``nexenta_ns5_blocksize`` = ``32`` - - (IntOpt) Block size for datasets + - (Integer) Block size for datasets * - ``nexenta_password`` = ``nexenta`` - - (StrOpt) Password to connect to Nexenta SA + - (String) Password to connect to Nexenta SA * - ``nexenta_rest_address`` = - - (StrOpt) IP address of NexentaEdge management REST API endpoint + - (String) IP address of NexentaEdge management REST API endpoint * - ``nexenta_rest_password`` = ``nexenta`` - - (StrOpt) Password to connect to NexentaEdge + - (String) Password to connect to NexentaEdge * - ``nexenta_rest_port`` = ``8080`` - - (IntOpt) HTTP port to connect to Nexenta REST API server + - (Integer) HTTP port to connect to Nexenta REST API server * - ``nexenta_rest_protocol`` = ``auto`` - - (StrOpt) Use http or https for REST connection (default auto) + - (String) Use http or https for REST connection (default auto) * - ``nexenta_rest_user`` = ``admin`` - - (StrOpt) User name to connect to NexentaEdge + - (String) User name to connect to NexentaEdge * - ``nexenta_rrmgr_compression`` = ``0`` - - (IntOpt) Enable stream compression, level 1..9. 1 - gives best speed; 9 - gives best compression. + - (Integer) Enable stream compression, level 1..9. 1 - gives best speed; 9 - gives best compression. * - ``nexenta_rrmgr_connections`` = ``2`` - - (IntOpt) Number of TCP connections. + - (Integer) Number of TCP connections. * - ``nexenta_rrmgr_tcp_buf_size`` = ``4096`` - - (IntOpt) TCP Buffer size in KiloBytes. + - (Integer) TCP Buffer size in KiloBytes. * - ``nexenta_shares_config`` = ``/etc/cinder/nfs_shares`` - - (StrOpt) File with the list of available nfs shares + - (String) File with the list of available nfs shares * - ``nexenta_sparse`` = ``False`` - - (BoolOpt) Enables or disables the creation of sparse datasets + - (Boolean) Enables or disables the creation of sparse datasets * - ``nexenta_sparsed_volumes`` = ``True`` - - (BoolOpt) Enables or disables the creation of volumes as sparsed files that take no space. If disabled (False), volume is created as a regular file, which takes a long time. + - (Boolean) Enables or disables the creation of volumes as sparsed files that take no space. If disabled (False), volume is created as a regular file, which takes a long time. * - ``nexenta_target_group_prefix`` = ``cinder/`` - - (StrOpt) Prefix for iSCSI target groups on SA + - (String) Prefix for iSCSI target groups on SA * - ``nexenta_target_prefix`` = ``iqn.1986-03.com.sun:02:cinder-`` - - (StrOpt) IQN prefix for iSCSI targets + - (String) IQN prefix for iSCSI targets * - ``nexenta_user`` = ``admin`` - - (StrOpt) User name to connect to Nexenta SA + - (String) User name to connect to Nexenta SA * - ``nexenta_volume`` = ``cinder`` - - (StrOpt) SA Pool that holds all volumes + - (String) SA Pool that holds all volumes * - ``nexenta_volume_group`` = ``iscsi`` - - (StrOpt) Volume group for ns5 + - (String) Volume group for ns5 diff --git a/doc/config-reference/source/tables/cinder-nimble.rst b/doc/config-reference/source/tables/cinder-nimble.rst index 1b9b61ee4a..52b50e0189 100644 --- a/doc/config-reference/source/tables/cinder-nimble.rst +++ b/doc/config-reference/source/tables/cinder-nimble.rst @@ -19,6 +19,6 @@ * - **[DEFAULT]** - * - ``nimble_pool_name`` = ``default`` - - (StrOpt) Nimble Controller pool name + - (String) Nimble Controller pool name * - ``nimble_subnet_label`` = ``*`` - - (StrOpt) Nimble Subnet Label + - (String) Nimble Subnet Label diff --git a/doc/config-reference/source/tables/cinder-profiler.rst b/doc/config-reference/source/tables/cinder-profiler.rst index 1b7f913bfc..6ea1ca3094 100644 --- a/doc/config-reference/source/tables/cinder-profiler.rst +++ b/doc/config-reference/source/tables/cinder-profiler.rst @@ -18,9 +18,9 @@ - Description * - **[profiler]** - + * - ``enabled`` = ``False`` + - (Boolean) Enables the profiling for all services on this node. Default value is False (fully disable the profiling feature). Possible values: * True: Enables the feature * False: Disables the feature. The profiling cannot be started via this project operations. If the profiling is triggered by another project, this project part will be empty. * - ``hmac_keys`` = ``SECRET_KEY`` - - (StrOpt) Secret key to use to sign tracing messages. - * - ``profiler_enabled`` = ``False`` - - (BoolOpt) If False fully disable profiling feature. + - (String) Secret key(s) to use for encrypting context data for performance profiling. This string value should have the following format: [,,...], where each key is some random string. A user who triggers the profiling via the REST API has to set one of these keys in the headers of the REST API call to include profiling results of this node for this particular project. Both "enabled" flag and "hmac_keys" config options should be set to enable profiling. Also, to generate correct profiling information across all services at least one key needs to be consistent between OpenStack projects. This ensures it can be used from client side to generate the trace, containing information from all possible resources. * - ``trace_sqlalchemy`` = ``False`` - - (BoolOpt) If False doesn't trace SQL requests. + - (Boolean) Enables SQL requests profiling in services. Default value is False (SQL requests won't be traced). Possible values: * True: Enables SQL requests profiling. Each SQL query will be part of the trace and can the be analyzed by how much time was spent for that. * False: Disables SQL requests profiling. The spent time is only shown on a higher level of operations. Single SQL queries cannot be analyzed this way. diff --git a/doc/config-reference/source/tables/cinder-prophetstor_dpl.rst b/doc/config-reference/source/tables/cinder-prophetstor_dpl.rst index e3080311ca..e5e60ed07c 100644 --- a/doc/config-reference/source/tables/cinder-prophetstor_dpl.rst +++ b/doc/config-reference/source/tables/cinder-prophetstor_dpl.rst @@ -19,16 +19,16 @@ * - **[DEFAULT]** - * - ``dpl_pool`` = - - (StrOpt) DPL pool uuid in which DPL volumes are stored. + - (String) DPL pool uuid in which DPL volumes are stored. * - ``dpl_port`` = ``8357`` - - (PortOpt) DPL port number. + - (Unknown) DPL port number. * - ``iscsi_port`` = ``3260`` - - (PortOpt) The port that the iSCSI daemon is listening on + - (Unknown) The port that the iSCSI daemon is listening on * - ``san_ip`` = - - (StrOpt) IP address of SAN controller + - (String) IP address of SAN controller * - ``san_login`` = ``admin`` - - (StrOpt) Username for SAN controller + - (String) Username for SAN controller * - ``san_password`` = - - (StrOpt) Password for SAN controller + - (String) Password for SAN controller * - ``san_thin_provision`` = ``True`` - - (BoolOpt) Use thin provisioning for SAN volumes? + - (Boolean) Use thin provisioning for SAN volumes? diff --git a/doc/config-reference/source/tables/cinder-pure.rst b/doc/config-reference/source/tables/cinder-pure.rst index 71c980eee0..5b26a99db9 100644 --- a/doc/config-reference/source/tables/cinder-pure.rst +++ b/doc/config-reference/source/tables/cinder-pure.rst @@ -19,6 +19,16 @@ * - **[DEFAULT]** - * - ``pure_api_token`` = ``None`` - - (StrOpt) REST API authorization token. + - (String) REST API authorization token. * - ``pure_automatic_max_oversubscription_ratio`` = ``True`` - - (BoolOpt) Automatically determine an oversubscription ratio based on the current total data reduction values. If used this calculated value will override the max_over_subscription_ratio config option. + - (Boolean) Automatically determine an oversubscription ratio based on the current total data reduction values. If used this calculated value will override the max_over_subscription_ratio config option. + * - ``pure_eradicate_on_delete`` = ``False`` + - (Boolean) When enabled, all Pure volumes, snapshots, and protection groups will be eradicated at the time of deletion in Cinder. Data will NOT be recoverable after a delete with this set to True! When disabled, volumes and snapshots will go into pending eradication state and can be recovered. + * - ``pure_replica_interval_default`` = ``900`` + - (Integer) Snapshot replication interval in seconds. + * - ``pure_replica_retention_long_term_default`` = ``7`` + - (Integer) Retain snapshots per day on target for this time (in days.) + * - ``pure_replica_retention_long_term_per_day_default`` = ``3`` + - (Integer) Retain how many snapshots for each day. + * - ``pure_replica_retention_short_term_default`` = ``14400`` + - (Integer) Retain all snapshots on target for this time (in seconds.) diff --git a/doc/config-reference/source/tables/cinder-quobyte.rst b/doc/config-reference/source/tables/cinder-quobyte.rst index 523f421c7d..4369952b1a 100644 --- a/doc/config-reference/source/tables/cinder-quobyte.rst +++ b/doc/config-reference/source/tables/cinder-quobyte.rst @@ -19,12 +19,12 @@ * - **[DEFAULT]** - * - ``quobyte_client_cfg`` = ``None`` - - (StrOpt) Path to a Quobyte Client configuration file. + - (String) Path to a Quobyte Client configuration file. * - ``quobyte_mount_point_base`` = ``$state_path/mnt`` - - (StrOpt) Base dir containing the mount point for the Quobyte volume. + - (String) Base dir containing the mount point for the Quobyte volume. * - ``quobyte_qcow2_volumes`` = ``True`` - - (BoolOpt) Create volumes as QCOW2 files rather than raw files. + - (Boolean) Create volumes as QCOW2 files rather than raw files. * - ``quobyte_sparsed_volumes`` = ``True`` - - (BoolOpt) Create volumes as sparse files which take no space. If set to False, volume is created as regular file.In such case volume creation takes a lot of time. + - (Boolean) Create volumes as sparse files which take no space. If set to False, volume is created as regular file.In such case volume creation takes a lot of time. * - ``quobyte_volume_url`` = ``None`` - - (StrOpt) URL to the Quobyte volume e.g., quobyte:/// + - (String) URL to the Quobyte volume e.g., quobyte:/// diff --git a/doc/config-reference/source/tables/cinder-quota.rst b/doc/config-reference/source/tables/cinder-quota.rst index b3e8dda06c..c8baa88e1e 100644 --- a/doc/config-reference/source/tables/cinder-quota.rst +++ b/doc/config-reference/source/tables/cinder-quota.rst @@ -19,22 +19,22 @@ * - **[DEFAULT]** - * - ``max_age`` = ``0`` - - (IntOpt) Number of seconds between subsequent usage refreshes + - (Integer) Number of seconds between subsequent usage refreshes * - ``quota_backup_gigabytes`` = ``1000`` - - (IntOpt) Total amount of storage, in gigabytes, allowed for backups per project + - (Integer) Total amount of storage, in gigabytes, allowed for backups per project * - ``quota_backups`` = ``10`` - - (IntOpt) Number of volume backups allowed per project + - (Integer) Number of volume backups allowed per project * - ``quota_consistencygroups`` = ``10`` - - (IntOpt) Number of consistencygroups allowed per project + - (Integer) Number of consistencygroups allowed per project * - ``quota_driver`` = ``cinder.quota.DbQuotaDriver`` - - (StrOpt) Default driver to use for quota checks + - (String) Default driver to use for quota checks * - ``quota_gigabytes`` = ``1000`` - - (IntOpt) Total amount of storage, in gigabytes, allowed for volumes and snapshots per project + - (Integer) Total amount of storage, in gigabytes, allowed for volumes and snapshots per project * - ``quota_snapshots`` = ``10`` - - (IntOpt) Number of volume snapshots allowed per project + - (Integer) Number of volume snapshots allowed per project * - ``quota_volumes`` = ``10`` - - (IntOpt) Number of volumes allowed per project + - (Integer) Number of volumes allowed per project * - ``reservation_expire`` = ``86400`` - - (IntOpt) Number of seconds until a reservation expires + - (Integer) Number of seconds until a reservation expires * - ``use_default_quota_class`` = ``True`` - - (BoolOpt) Enables or disables use of default quota class with default quota. + - (Boolean) Enables or disables use of default quota class with default quota. diff --git a/doc/config-reference/source/tables/cinder-rabbitmq.rst b/doc/config-reference/source/tables/cinder-rabbitmq.rst index 2e39b12589..fdd5c92d49 100644 --- a/doc/config-reference/source/tables/cinder-rabbitmq.rst +++ b/doc/config-reference/source/tables/cinder-rabbitmq.rst @@ -19,50 +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`` + - (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`` + - (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`` + - (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. + - (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. diff --git a/doc/config-reference/source/tables/cinder-redis.rst b/doc/config-reference/source/tables/cinder-redis.rst index 6b77c80ca4..55f4c0036a 100644 --- a/doc/config-reference/source/tables/cinder-redis.rst +++ b/doc/config-reference/source/tables/cinder-redis.rst @@ -18,9 +18,19 @@ - Description * - **[matchmaker_redis]** - + * - ``check_timeout`` = ``20000`` + - (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`` + - (String) Redis replica set name. + * - ``sentinel_hosts`` = + - (List) List of Redis Sentinel hosts (fault tolerance mode) e.g. [host:port, host1:port ... ] + * - ``socket_timeout`` = ``1000`` + - (Integer) Timeout in ms on blocking socket operations + * - ``wait_timeout`` = ``500`` + - (Integer) Time in ms to wait between connection attempts. diff --git a/doc/config-reference/source/tables/cinder-rpc.rst b/doc/config-reference/source/tables/cinder-rpc.rst index 2d62814d0f..c5cc347f07 100644 --- a/doc/config-reference/source/tables/cinder-rpc.rst +++ b/doc/config-reference/source/tables/cinder-rpc.rst @@ -19,62 +19,86 @@ * - **[DEFAULT]** - * - ``rpc_backend`` = ``rabbit`` - - (StrOpt) The messaging driver to use, defaults to rabbit. Other drivers include amqp and zmq. - * - ``rpc_cast_timeout`` = ``30`` - - (IntOpt) Seconds to wait before a cast expires (TTL). Only supported by impl_zmq. + - (String) The messaging driver to use, defaults to rabbit. Other drivers include amqp and zmq. + * - ``rpc_cast_timeout`` = ``-1`` + - (Integer) Seconds to wait before a cast expires (TTL). The default value of -1 specifies an infinite linger period. The value of 0 specifies no linger period. Pending messages shall be discarded immediately when the socket is closed. Only supported by impl_zmq. * - ``rpc_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. * - ``volume_topic`` = ``cinder-volume`` - - (StrOpt) The topic that volume nodes listen on + - (String) The topic that volume nodes listen on * - **[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 and its full configuration. If not set, we fall back to the rpc_backend option and driver specific configuration. + * - **[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 diff --git a/doc/config-reference/source/tables/cinder-san.rst b/doc/config-reference/source/tables/cinder-san.rst index 632bb0c476..8d3eba74e0 100644 --- a/doc/config-reference/source/tables/cinder-san.rst +++ b/doc/config-reference/source/tables/cinder-san.rst @@ -19,26 +19,26 @@ * - **[DEFAULT]** - * - ``san_clustername`` = - - (StrOpt) Cluster name to use for creating volumes + - (String) Cluster name to use for creating volumes * - ``san_ip`` = - - (StrOpt) IP address of SAN controller + - (String) IP address of SAN controller * - ``san_is_local`` = ``False`` - - (BoolOpt) Execute commands locally instead of over SSH; use if the volume service is running on the SAN device + - (Boolean) Execute commands locally instead of over SSH; use if the volume service is running on the SAN device * - ``san_login`` = ``admin`` - - (StrOpt) Username for SAN controller + - (String) Username for SAN controller * - ``san_password`` = - - (StrOpt) Password for SAN controller + - (String) Password for SAN controller * - ``san_private_key`` = - - (StrOpt) Filename of private key to use for SSH authentication + - (String) Filename of private key to use for SSH authentication * - ``san_secondary_ip`` = ``None`` - - (StrOpt) VNX secondary SP IP Address. + - (String) VNX secondary SP IP Address. * - ``san_ssh_port`` = ``22`` - - (PortOpt) SSH port to use with SAN + - (Unknown) SSH port to use with SAN * - ``san_thin_provision`` = ``True`` - - (BoolOpt) Use thin provisioning for SAN volumes? + - (Boolean) Use thin provisioning for SAN volumes? * - ``ssh_conn_timeout`` = ``30`` - - (IntOpt) SSH connection timeout in seconds + - (Integer) SSH connection timeout in seconds * - ``ssh_max_pool_conn`` = ``5`` - - (IntOpt) Maximum ssh connections in the pool + - (Integer) Maximum ssh connections in the pool * - ``ssh_min_pool_conn`` = ``1`` - - (IntOpt) Minimum ssh connections in the pool + - (Integer) Minimum ssh connections in the pool diff --git a/doc/config-reference/source/tables/cinder-scality.rst b/doc/config-reference/source/tables/cinder-scality.rst index 582d1a39a9..9234579510 100644 --- a/doc/config-reference/source/tables/cinder-scality.rst +++ b/doc/config-reference/source/tables/cinder-scality.rst @@ -19,8 +19,8 @@ * - **[DEFAULT]** - * - ``scality_sofs_config`` = ``None`` - - (StrOpt) Path or URL to Scality SOFS configuration file + - (String) Path or URL to Scality SOFS configuration file * - ``scality_sofs_mount_point`` = ``$state_path/scality`` - - (StrOpt) Base dir where Scality SOFS shall be mounted + - (String) Base dir where Scality SOFS shall be mounted * - ``scality_sofs_volume_dir`` = ``cinder/volumes`` - - (StrOpt) Path from Scality SOFS root to volume dir + - (String) Path from Scality SOFS root to volume dir diff --git a/doc/config-reference/source/tables/cinder-scheduler.rst b/doc/config-reference/source/tables/cinder-scheduler.rst index f3fd506b46..bfcad6a9eb 100644 --- a/doc/config-reference/source/tables/cinder-scheduler.rst +++ b/doc/config-reference/source/tables/cinder-scheduler.rst @@ -19,22 +19,22 @@ * - **[DEFAULT]** - * - ``filter_function`` = ``None`` - - (StrOpt) String representation for an equation that will be used to filter hosts. Only used when the driver filter is set to be used by the Cinder scheduler. + - (String) String representation for an equation that will be used to filter hosts. Only used when the driver filter is set to be used by the Cinder scheduler. * - ``goodness_function`` = ``None`` - - (StrOpt) String representation for an equation that will be used to determine the goodness of a host. Only used when using the goodness weigher is set to be used by the Cinder scheduler. + - (String) String representation for an equation that will be used to determine the goodness of a host. Only used when using the goodness weigher is set to be used by the Cinder scheduler. * - ``scheduler_default_filters`` = ``AvailabilityZoneFilter, CapacityFilter, CapabilitiesFilter`` - - (ListOpt) Which filter class names to use for filtering hosts when not specified in the request. + - (List) Which filter class names to use for filtering hosts when not specified in the request. * - ``scheduler_default_weighers`` = ``CapacityWeigher`` - - (ListOpt) Which weigher class names to use for weighing hosts. + - (List) Which weigher class names to use for weighing hosts. * - ``scheduler_driver`` = ``cinder.scheduler.filter_scheduler.FilterScheduler`` - - (StrOpt) Default scheduler driver to use + - (String) Default scheduler driver to use * - ``scheduler_host_manager`` = ``cinder.scheduler.host_manager.HostManager`` - - (StrOpt) The scheduler host manager class to use + - (String) The scheduler host manager class to use * - ``scheduler_json_config_location`` = - - (StrOpt) Absolute path to scheduler configuration JSON file. + - (String) Absolute path to scheduler configuration JSON file. * - ``scheduler_manager`` = ``cinder.scheduler.manager.SchedulerManager`` - - (StrOpt) Full class name for the Manager for scheduler + - (String) Full class name for the Manager for scheduler * - ``scheduler_max_attempts`` = ``3`` - - (IntOpt) Maximum number of attempts to schedule a volume + - (Integer) Maximum number of attempts to schedule a volume * - ``scheduler_topic`` = ``cinder-scheduler`` - - (StrOpt) The topic that scheduler nodes listen on + - (String) The topic that scheduler nodes listen on diff --git a/doc/config-reference/source/tables/cinder-scst.rst b/doc/config-reference/source/tables/cinder-scst.rst index 158ed3c1c9..a23d0bacc8 100644 --- a/doc/config-reference/source/tables/cinder-scst.rst +++ b/doc/config-reference/source/tables/cinder-scst.rst @@ -19,6 +19,6 @@ * - **[DEFAULT]** - * - ``scst_target_driver`` = ``iscsi`` - - (StrOpt) SCST target implementation can choose from multiple SCST target drivers. + - (String) SCST target implementation can choose from multiple SCST target drivers. * - ``scst_target_iqn_name`` = ``None`` - - (StrOpt) Certain ISCSI targets have predefined target names, SCST target driver uses this name. + - (String) Certain ISCSI targets have predefined target names, SCST target driver uses this name. diff --git a/doc/config-reference/source/tables/cinder-sheepdog.rst b/doc/config-reference/source/tables/cinder-sheepdog.rst index 1c54617147..ffffbed23d 100644 --- a/doc/config-reference/source/tables/cinder-sheepdog.rst +++ b/doc/config-reference/source/tables/cinder-sheepdog.rst @@ -19,6 +19,6 @@ * - **[DEFAULT]** - * - ``sheepdog_store_address`` = ``127.0.0.1`` - - (StrOpt) IP address of sheep daemon. + - (String) IP address of sheep daemon. * - ``sheepdog_store_port`` = ``7000`` - - (PortOpt) Port of sheep daemon. + - (Unknown) Port of sheep daemon. diff --git a/doc/config-reference/source/tables/cinder-smbfs.rst b/doc/config-reference/source/tables/cinder-smbfs.rst index f67e48c0fd..00869cd1dd 100644 --- a/doc/config-reference/source/tables/cinder-smbfs.rst +++ b/doc/config-reference/source/tables/cinder-smbfs.rst @@ -19,18 +19,18 @@ * - **[DEFAULT]** - * - ``smbfs_allocation_info_file_path`` = ``$state_path/allocation_data`` - - (StrOpt) The path of the automatically generated file containing information about volume disk space allocation. + - (String) The path of the automatically generated file containing information about volume disk space allocation. * - ``smbfs_default_volume_format`` = ``qcow2`` - - (StrOpt) Default format that will be used when creating volumes if no volume format is specified. + - (String) Default format that will be used when creating volumes if no volume format is specified. * - ``smbfs_mount_options`` = ``noperm,file_mode=0775,dir_mode=0775`` - - (StrOpt) Mount options passed to the smbfs client. See mount.cifs man page for details. + - (String) Mount options passed to the smbfs client. See mount.cifs man page for details. * - ``smbfs_mount_point_base`` = ``$state_path/mnt`` - - (StrOpt) Base dir containing mount points for smbfs shares. + - (String) Base dir containing mount points for smbfs shares. * - ``smbfs_oversub_ratio`` = ``1.0`` - - (FloatOpt) This will compare the allocated to available space on the volume destination. If the ratio exceeds this number, the destination will no longer be valid. + - (Floating point) This will compare the allocated to available space on the volume destination. If the ratio exceeds this number, the destination will no longer be valid. * - ``smbfs_shares_config`` = ``/etc/cinder/smbfs_shares`` - - (StrOpt) File with the list of available smbfs shares. + - (String) File with the list of available smbfs shares. * - ``smbfs_sparsed_volumes`` = ``True`` - - (BoolOpt) Create volumes as sparsed files which take no space rather than regular files when using raw format, in which case volume creation takes lot of time. + - (Boolean) Create volumes as sparsed files which take no space rather than regular files when using raw format, in which case volume creation takes lot of time. * - ``smbfs_used_ratio`` = ``0.95`` - - (FloatOpt) Percent of ACTUAL usage of the underlying volume before no new volumes can be allocated to the volume destination. + - (Floating point) Percent of ACTUAL usage of the underlying volume before no new volumes can be allocated to the volume destination. diff --git a/doc/config-reference/source/tables/cinder-solidfire.rst b/doc/config-reference/source/tables/cinder-solidfire.rst index 0714cedd9f..f0b741463c 100644 --- a/doc/config-reference/source/tables/cinder-solidfire.rst +++ b/doc/config-reference/source/tables/cinder-solidfire.rst @@ -19,22 +19,22 @@ * - **[DEFAULT]** - * - ``sf_account_prefix`` = ``None`` - - (StrOpt) Create SolidFire accounts with this prefix. Any string can be used here, but the string "hostname" is special and will create a prefix using the cinder node hostname (previous default behavior). The default is NO prefix. + - (String) Create SolidFire accounts with this prefix. Any string can be used here, but the string "hostname" is special and will create a prefix using the cinder node hostname (previous default behavior). The default is NO prefix. * - ``sf_allow_template_caching`` = ``True`` - - (BoolOpt) Create an internal cache of copy of images when a bootable volume is created to eliminate fetch from glance and qemu-conversion on subsequent calls. + - (Boolean) Create an internal cache of copy of images when a bootable volume is created to eliminate fetch from glance and qemu-conversion on subsequent calls. * - ``sf_allow_tenant_qos`` = ``False`` - - (BoolOpt) Allow tenants to specify QOS on create + - (Boolean) Allow tenants to specify QOS on create * - ``sf_api_port`` = ``443`` - - (PortOpt) SolidFire API port. Useful if the device api is behind a proxy on a different port. + - (Unknown) SolidFire API port. Useful if the device api is behind a proxy on a different port. * - ``sf_emulate_512`` = ``True`` - - (BoolOpt) Set 512 byte emulation on volume creation; + - (Boolean) Set 512 byte emulation on volume creation; * - ``sf_enable_vag`` = ``False`` - - (BoolOpt) Utilize volume access groups on a per-tenant basis. + - (Boolean) Utilize volume access groups on a per-tenant basis. * - ``sf_enable_volume_mapping`` = ``True`` - - (BoolOpt) Create an internal mapping of volume IDs and account. Optimizes lookups and performance at the expense of memory, very large deployments may want to consider setting to False. + - (Boolean) Create an internal mapping of volume IDs and account. Optimizes lookups and performance at the expense of memory, very large deployments may want to consider setting to False. * - ``sf_svip`` = ``None`` - - (StrOpt) Overrides default cluster SVIP with the one specified. This is required or deployments that have implemented the use of VLANs for iSCSI networks in their cloud. + - (String) Overrides default cluster SVIP with the one specified. This is required or deployments that have implemented the use of VLANs for iSCSI networks in their cloud. * - ``sf_template_account_name`` = ``openstack-vtemplate`` - - (StrOpt) Account name on the SolidFire Cluster to use as owner of template/cache volumes (created if does not exist). + - (String) Account name on the SolidFire Cluster to use as owner of template/cache volumes (created if does not exist). * - ``sf_volume_prefix`` = ``UUID-`` - - (StrOpt) Create SolidFire volumes with this prefix. Volume names are of the form . The default is to use a prefix of 'UUID-'. + - (String) Create SolidFire volumes with this prefix. Volume names are of the form . The default is to use a prefix of 'UUID-'. diff --git a/doc/config-reference/source/tables/cinder-storage.rst b/doc/config-reference/source/tables/cinder-storage.rst index 3574d6b07e..8f37c2f5e4 100644 --- a/doc/config-reference/source/tables/cinder-storage.rst +++ b/doc/config-reference/source/tables/cinder-storage.rst @@ -19,62 +19,62 @@ * - **[DEFAULT]** - * - ``allocated_capacity_weight_multiplier`` = ``-1.0`` - - (FloatOpt) Multiplier used for weighing volume capacity. Negative numbers mean to stack vs spread. + - (Floating point) Multiplier used for weighing allocated capacity. Positive numbers mean to stack vs spread. * - ``capacity_weight_multiplier`` = ``1.0`` - - (FloatOpt) Multiplier used for weighing volume capacity. Negative numbers mean to stack vs spread. + - (Floating point) Multiplier used for weighing free capacity. Negative numbers mean to stack vs spread. * - ``enabled_backends`` = ``None`` - - (ListOpt) A list of backend names to use. These backend names should be backed by a unique [CONFIG] group with its options + - (List) A list of backend names to use. These backend names should be backed by a unique [CONFIG] group with its options * - ``iscsi_helper`` = ``tgtadm`` - - (StrOpt) iSCSI target user-land tool to use. tgtadm is default, use lioadm for LIO iSCSI support, scstadmin for SCST target support, iseradm for the ISER protocol, ietadm for iSCSI Enterprise Target, iscsictl for Chelsio iSCSI Target or fake for testing. + - (String) iSCSI target user-land tool to use. tgtadm is default, use lioadm for LIO iSCSI support, scstadmin for SCST target support, iseradm for the ISER protocol, ietadm for iSCSI Enterprise Target, iscsictl for Chelsio iSCSI Target or fake for testing. * - ``iscsi_iotype`` = ``fileio`` - - (StrOpt) Sets the behavior of the iSCSI target to either perform blockio or fileio optionally, auto can be set and Cinder will autodetect type of backing device + - (String) Sets the behavior of the iSCSI target to either perform blockio or fileio optionally, auto can be set and Cinder will autodetect type of backing device * - ``iscsi_ip_address`` = ``$my_ip`` - - (StrOpt) The IP address that the iSCSI daemon is listening on + - (String) The IP address that the iSCSI daemon is listening on * - ``iscsi_port`` = ``3260`` - - (PortOpt) The port that the iSCSI daemon is listening on + - (Unknown) The port that the iSCSI daemon is listening on * - ``iscsi_protocol`` = ``iscsi`` - - (StrOpt) Determines the iSCSI protocol for new iSCSI volumes, created with tgtadm or lioadm target helpers. In order to enable RDMA, this parameter should be set with the value "iser". The supported iSCSI protocol values are "iscsi" and "iser". + - (String) Determines the iSCSI protocol for new iSCSI volumes, created with tgtadm or lioadm target helpers. In order to enable RDMA, this parameter should be set with the value "iser". The supported iSCSI protocol values are "iscsi" and "iser". * - ``iscsi_target_flags`` = - - (StrOpt) Sets the target-specific flags for the iSCSI target. Only used for tgtadm to specify backing device flags using bsoflags option. The specified string is passed as is to the underlying tool. + - (String) Sets the target-specific flags for the iSCSI target. Only used for tgtadm to specify backing device flags using bsoflags option. The specified string is passed as is to the underlying tool. * - ``iscsi_target_prefix`` = ``iqn.2010-10.org.openstack:`` - - (StrOpt) Prefix for iSCSI volumes + - (String) Prefix for iSCSI volumes * - ``iscsi_write_cache`` = ``on`` - - (StrOpt) Sets the behavior of the iSCSI target to either perform write-back(on) or write-through(off). This parameter is valid if iscsi_helper is set to tgtadm or iseradm. + - (String) Sets the behavior of the iSCSI target to either perform write-back(on) or write-through(off). This parameter is valid if iscsi_helper is set to tgtadm or iseradm. * - ``iser_helper`` = ``tgtadm`` - - (StrOpt) The name of the iSER target user-land tool to use + - (String) The name of the iSER target user-land tool to use * - ``iser_ip_address`` = ``$my_ip`` - - (StrOpt) The IP address that the iSER daemon is listening on + - (String) The IP address that the iSER daemon is listening on * - ``iser_port`` = ``3260`` - - (PortOpt) The port that the iSER daemon is listening on + - (Unknown) The port that the iSER daemon is listening on * - ``iser_target_prefix`` = ``iqn.2010-10.org.openstack:`` - - (StrOpt) Prefix for iSER volumes + - (String) Prefix for iSER volumes * - ``migration_create_volume_timeout_secs`` = ``300`` - - (IntOpt) Timeout for creating the volume to migrate to when performing volume migration (seconds) + - (Integer) Timeout for creating the volume to migrate to when performing volume migration (seconds) * - ``num_iser_scan_tries`` = ``3`` - - (IntOpt) The maximum number of times to rescan iSER targetto find volume + - (Integer) The maximum number of times to rescan iSER targetto find volume * - ``num_volume_device_scan_tries`` = ``3`` - - (IntOpt) The maximum number of times to rescan targets to find volume + - (Integer) The maximum number of times to rescan targets to find volume * - ``volume_backend_name`` = ``None`` - - (StrOpt) The backend name for a given driver implementation + - (String) The backend name for a given driver implementation * - ``volume_clear`` = ``zero`` - - (StrOpt) Method used to wipe old volumes + - (String) Method used to wipe old volumes * - ``volume_clear_ionice`` = ``None`` - - (StrOpt) The flag to pass to ionice to alter the i/o priority of the process used to zero a volume after deletion, for example "-c3" for idle only priority. + - (String) The flag to pass to ionice to alter the i/o priority of the process used to zero a volume after deletion, for example "-c3" for idle only priority. * - ``volume_clear_size`` = ``0`` - - (IntOpt) Size in MiB to wipe at start of old volumes. 0 => all + - (Integer) Size in MiB to wipe at start of old volumes. 0 => all * - ``volume_copy_blkio_cgroup_name`` = ``cinder-volume-copy`` - - (StrOpt) The blkio cgroup name to be used to limit bandwidth of volume copy + - (String) The blkio cgroup name to be used to limit bandwidth of volume copy * - ``volume_copy_bps_limit`` = ``0`` - - (IntOpt) The upper limit of bandwidth of volume copy. 0 => unlimited + - (Integer) The upper limit of bandwidth of volume copy. 0 => unlimited * - ``volume_dd_blocksize`` = ``1M`` - - (StrOpt) The default block size used when copying/clearing volumes + - (String) The default block size used when copying/clearing volumes * - ``volume_driver`` = ``cinder.volume.drivers.lvm.LVMVolumeDriver`` - - (StrOpt) Driver to use for volume creation + - (String) Driver to use for volume creation * - ``volume_manager`` = ``cinder.volume.manager.VolumeManager`` - - (StrOpt) Full class name for the Manager for volume + - (String) Full class name for the Manager for volume * - ``volume_service_inithost_offload`` = ``False`` - - (BoolOpt) Offload pending volume delete during volume service startup + - (Boolean) Offload pending volume delete during volume service startup * - ``volume_usage_audit_period`` = ``month`` - - (StrOpt) Time period for which to generate volume usages. The options are hour, day, month, or year. + - (String) Time period for which to generate volume usages. The options are hour, day, month, or year. * - ``volumes_dir`` = ``$state_path/volumes`` - - (StrOpt) Volume configuration file storage directory + - (String) Volume configuration file storage directory diff --git a/doc/config-reference/source/tables/cinder-storage_ceph.rst b/doc/config-reference/source/tables/cinder-storage_ceph.rst index 672d03e852..7d225eaf8c 100644 --- a/doc/config-reference/source/tables/cinder-storage_ceph.rst +++ b/doc/config-reference/source/tables/cinder-storage_ceph.rst @@ -19,26 +19,26 @@ * - **[DEFAULT]** - * - ``rados_connect_timeout`` = ``-1`` - - (IntOpt) Timeout value (in seconds) used when connecting to ceph cluster. If value < 0, no timeout is set and default librados value is used. + - (Integer) Timeout value (in seconds) used when connecting to ceph cluster. If value < 0, no timeout is set and default librados value is used. * - ``rados_connection_interval`` = ``5`` - - (IntOpt) Interval value (in seconds) between connection retries to ceph cluster. + - (Integer) Interval value (in seconds) between connection retries to ceph cluster. * - ``rados_connection_retries`` = ``3`` - - (IntOpt) Number of retries if connection to ceph cluster failed. + - (Integer) Number of retries if connection to ceph cluster failed. * - ``rbd_ceph_conf`` = - - (StrOpt) Path to the ceph configuration file + - (String) Path to the ceph configuration file * - ``rbd_cluster_name`` = ``ceph`` - - (StrOpt) The name of ceph cluster + - (String) The name of ceph cluster * - ``rbd_flatten_volume_from_snapshot`` = ``False`` - - (BoolOpt) Flatten volumes created from snapshots to remove dependency from volume to snapshot + - (Boolean) Flatten volumes created from snapshots to remove dependency from volume to snapshot * - ``rbd_max_clone_depth`` = ``5`` - - (IntOpt) Maximum number of nested volume clones that are taken before a flatten occurs. Set to 0 to disable cloning. + - (Integer) Maximum number of nested volume clones that are taken before a flatten occurs. Set to 0 to disable cloning. * - ``rbd_pool`` = ``rbd`` - - (StrOpt) The RADOS pool where rbd volumes are stored + - (String) The RADOS pool where rbd volumes are stored * - ``rbd_secret_uuid`` = ``None`` - - (StrOpt) The libvirt uuid of the secret for the rbd_user volumes + - (String) The libvirt uuid of the secret for the rbd_user volumes * - ``rbd_store_chunk_size`` = ``4`` - - (IntOpt) Volumes will be chunked into objects of this size (in megabytes). + - (Integer) Volumes will be chunked into objects of this size (in megabytes). * - ``rbd_user`` = ``None`` - - (StrOpt) The RADOS client name for accessing rbd volumes - only set when using cephx authentication + - (String) The RADOS client name for accessing rbd volumes - only set when using cephx authentication * - ``volume_tmp_dir`` = ``None`` - - (StrOpt) Directory where temporary image files are stored when the volume driver does not write them directly to the volume. Warning: this option is now deprecated, please use image_conversion_dir instead. + - (String) Directory where temporary image files are stored when the volume driver does not write them directly to the volume. Warning: this option is now deprecated, please use image_conversion_dir instead. diff --git a/doc/config-reference/source/tables/cinder-storage_glusterfs.rst b/doc/config-reference/source/tables/cinder-storage_glusterfs.rst index e87ba43f01..800a9a4ec0 100644 --- a/doc/config-reference/source/tables/cinder-storage_glusterfs.rst +++ b/doc/config-reference/source/tables/cinder-storage_glusterfs.rst @@ -19,12 +19,12 @@ * - **[DEFAULT]** - * - ``glusterfs_backup_mount_point`` = ``$state_path/backup_mount`` - - (StrOpt) Base dir containing mount point for gluster share. + - (String) Base dir containing mount point for gluster share. * - ``glusterfs_backup_share`` = ``None`` - - (StrOpt) GlusterFS share in : format. Eg: 1.2.3.4:backup_vol + - (String) GlusterFS share in : format. Eg: 1.2.3.4:backup_vol * - ``glusterfs_mount_point_base`` = ``$state_path/mnt`` - - (StrOpt) Base dir containing mount points for gluster shares. + - (String) Base dir containing mount points for gluster shares. * - ``glusterfs_shares_config`` = ``/etc/cinder/glusterfs_shares`` - - (StrOpt) File with the list of available gluster shares + - (String) File with the list of available gluster shares * - ``nas_volume_prov_type`` = ``thin`` - - (StrOpt) Provisioning type that will be used when creating volumes. + - (String) Provisioning type that will be used when creating volumes. diff --git a/doc/config-reference/source/tables/cinder-storage_gpfs.rst b/doc/config-reference/source/tables/cinder-storage_gpfs.rst index a403a720e7..0f8b0cbd83 100644 --- a/doc/config-reference/source/tables/cinder-storage_gpfs.rst +++ b/doc/config-reference/source/tables/cinder-storage_gpfs.rst @@ -19,24 +19,24 @@ * - **[DEFAULT]** - * - ``gpfs_images_dir`` = ``None`` - - (StrOpt) Specifies the path of the Image service repository in GPFS. Leave undefined if not storing images in GPFS. + - (String) Specifies the path of the Image service repository in GPFS. Leave undefined if not storing images in GPFS. * - ``gpfs_images_share_mode`` = ``None`` - - (StrOpt) Specifies the type of image copy to be used. Set this when the Image service repository also uses GPFS so that image files can be transferred efficiently from the Image service to the Block Storage service. There are two valid values: "copy" specifies that a full copy of the image is made; "copy_on_write" specifies that copy-on-write optimization strategy is used and unmodified blocks of the image file are shared efficiently. + - (String) Specifies the type of image copy to be used. Set this when the Image service repository also uses GPFS so that image files can be transferred efficiently from the Image service to the Block Storage service. There are two valid values: "copy" specifies that a full copy of the image is made; "copy_on_write" specifies that copy-on-write optimization strategy is used and unmodified blocks of the image file are shared efficiently. * - ``gpfs_max_clone_depth`` = ``0`` - - (IntOpt) Specifies an upper limit on the number of indirections required to reach a specific block due to snapshots or clones. A lengthy chain of copy-on-write snapshots or clones can have a negative impact on performance, but improves space utilization. 0 indicates unlimited clone depth. + - (Integer) Specifies an upper limit on the number of indirections required to reach a specific block due to snapshots or clones. A lengthy chain of copy-on-write snapshots or clones can have a negative impact on performance, but improves space utilization. 0 indicates unlimited clone depth. * - ``gpfs_mount_point_base`` = ``None`` - - (StrOpt) Specifies the path of the GPFS directory where Block Storage volume and snapshot files are stored. + - (String) Specifies the path of the GPFS directory where Block Storage volume and snapshot files are stored. * - ``gpfs_sparse_volumes`` = ``True`` - - (BoolOpt) Specifies that volumes are created as sparse files which initially consume no space. If set to False, the volume is created as a fully allocated file, in which case, creation may take a significantly longer time. + - (Boolean) Specifies that volumes are created as sparse files which initially consume no space. If set to False, the volume is created as a fully allocated file, in which case, creation may take a significantly longer time. * - ``gpfs_storage_pool`` = ``system`` - - (StrOpt) Specifies the storage pool that volumes are assigned to. By default, the system storage pool is used. + - (String) Specifies the storage pool that volumes are assigned to. By default, the system storage pool is used. * - ``nas_ip`` = - - (StrOpt) IP address or Hostname of NAS system. + - (String) IP address or Hostname of NAS system. * - ``nas_login`` = ``admin`` - - (StrOpt) User name to connect to NAS system. + - (String) User name to connect to NAS system. * - ``nas_password`` = - - (StrOpt) Password to connect to NAS system. + - (String) Password to connect to NAS system. * - ``nas_private_key`` = - - (StrOpt) Filename of private key to use for SSH authentication. + - (String) Filename of private key to use for SSH authentication. * - ``nas_ssh_port`` = ``22`` - - (PortOpt) SSH port to use to connect to NAS system. + - (Unknown) SSH port to use to connect to NAS system. diff --git a/doc/config-reference/source/tables/cinder-storage_nfs.rst b/doc/config-reference/source/tables/cinder-storage_nfs.rst index efb78f0d8d..855ea0bc60 100644 --- a/doc/config-reference/source/tables/cinder-storage_nfs.rst +++ b/doc/config-reference/source/tables/cinder-storage_nfs.rst @@ -19,16 +19,12 @@ * - **[DEFAULT]** - * - ``nfs_mount_attempts`` = ``3`` - - (IntOpt) The number of attempts to mount NFS shares before raising an error. At least one attempt will be made to mount an NFS share, regardless of the value specified. + - (Integer) The number of attempts to mount NFS shares before raising an error. At least one attempt will be made to mount an NFS share, regardless of the value specified. * - ``nfs_mount_options`` = ``None`` - - (StrOpt) Mount options passed to the NFS client. See section of the NFS man page for details. + - (String) Mount options passed to the NFS client. See section of the NFS man page for details. * - ``nfs_mount_point_base`` = ``$state_path/mnt`` - - (StrOpt) Base dir containing mount points for NFS shares. - * - ``nfs_oversub_ratio`` = ``1.0`` - - (FloatOpt) This will compare the allocated to available space on the volume destination. If the ratio exceeds this number, the destination will no longer be valid. Note that this option is deprecated in favor of "max_oversubscription_ratio" and will be removed in the Mitaka release. + - (String) Base dir containing mount points for NFS shares. * - ``nfs_shares_config`` = ``/etc/cinder/nfs_shares`` - - (StrOpt) File with the list of available NFS shares + - (String) File with the list of available NFS shares * - ``nfs_sparsed_volumes`` = ``True`` - - (BoolOpt) Create volumes as sparsed files which take no space.If set to False volume is created as regular file.In such case volume creation takes a lot of time. - * - ``nfs_used_ratio`` = ``0.95`` - - (FloatOpt) Percent of ACTUAL usage of the underlying volume before no new volumes can be allocated to the volume destination. Note that this option is deprecated in favor of "reserved_percentage" and will be removed in the Mitaka release. + - (Boolean) Create volumes as sparsed files which take no space.If set to False volume is created as regular file.In such case volume creation takes a lot of time. diff --git a/doc/config-reference/source/tables/cinder-storwize.rst b/doc/config-reference/source/tables/cinder-storwize.rst index b5b66ff2a7..7d1c9083a8 100644 --- a/doc/config-reference/source/tables/cinder-storwize.rst +++ b/doc/config-reference/source/tables/cinder-storwize.rst @@ -18,35 +18,37 @@ - Description * - **[DEFAULT]** - + * - ``storwize_san_secondary_ip`` = ``None`` + - (String) Specifies secondary management IP or hostname to be used if san_ip is invalid or becomes inaccessible. * - ``storwize_svc_allow_tenant_qos`` = ``False`` - - (BoolOpt) Allow tenants to specify QOS on create + - (Boolean) Allow tenants to specify QOS on create * - ``storwize_svc_flashcopy_rate`` = ``50`` - - (IntOpt) Specifies the Storwize FlashCopy copy rate to be used when creating a full volume copy. The default is rate is 50, and the valid rates are 1-100. + - (Integer) Specifies the Storwize FlashCopy copy rate to be used when creating a full volume copy. The default is rate is 50, and the valid rates are 1-100. * - ``storwize_svc_flashcopy_timeout`` = ``120`` - - (IntOpt) Maximum number of seconds to wait for FlashCopy to be prepared. + - (Integer) Maximum number of seconds to wait for FlashCopy to be prepared. * - ``storwize_svc_iscsi_chap_enabled`` = ``True`` - - (BoolOpt) Configure CHAP authentication for iSCSI connections (Default: Enabled) + - (Boolean) Configure CHAP authentication for iSCSI connections (Default: Enabled) * - ``storwize_svc_multihostmap_enabled`` = ``True`` - - (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. * - ``storwize_svc_multipath_enabled`` = ``False`` - - (BoolOpt) Connect with multipath (FC only; iSCSI multipath is controlled by Nova) + - (Boolean) Connect with multipath (FC only; iSCSI multipath is controlled by Nova) * - ``storwize_svc_stretched_cluster_partner`` = ``None`` - - (StrOpt) If operating in stretched cluster mode, specify the name of the pool in which mirrored copies are stored.Example: "pool2" + - (String) If operating in stretched cluster mode, specify the name of the pool in which mirrored copies are stored.Example: "pool2" * - ``storwize_svc_vol_autoexpand`` = ``True`` - - (BoolOpt) Storage system autoexpand parameter for volumes (True/False) + - (Boolean) Storage system autoexpand parameter for volumes (True/False) * - ``storwize_svc_vol_compression`` = ``False`` - - (BoolOpt) Storage system compression option for volumes + - (Boolean) Storage system compression option for volumes * - ``storwize_svc_vol_easytier`` = ``True`` - - (BoolOpt) Enable Easy Tier for volumes + - (Boolean) Enable Easy Tier for volumes * - ``storwize_svc_vol_grainsize`` = ``256`` - - (IntOpt) Storage system grain size parameter for volumes (32/64/128/256) + - (Integer) Storage system grain size parameter for volumes (32/64/128/256) * - ``storwize_svc_vol_iogrp`` = ``0`` - - (IntOpt) The I/O group in which to allocate volumes + - (Integer) The I/O group in which to allocate volumes * - ``storwize_svc_vol_nofmtdisk`` = ``False`` - - (BoolOpt) Specifies that the volume not be formatted during creation. + - (Boolean) Specifies that the volume not be formatted during creation. * - ``storwize_svc_vol_rsize`` = ``2`` - - (IntOpt) Storage system space-efficiency parameter for volumes (percentage) + - (Integer) Storage system space-efficiency parameter for volumes (percentage) * - ``storwize_svc_vol_warning`` = ``0`` - - (IntOpt) Storage system threshold for volume capacity warnings (percentage) + - (Integer) Storage system threshold for volume capacity warnings (percentage) * - ``storwize_svc_volpool_name`` = ``volpool`` - - (StrOpt) Storage system storage pool for volumes + - (List) Comma separated list of storage system storage pools for volumes. diff --git a/doc/config-reference/source/tables/cinder-swift.rst b/doc/config-reference/source/tables/cinder-swift.rst index 908931d847..da5125c4d3 100644 --- a/doc/config-reference/source/tables/cinder-swift.rst +++ b/doc/config-reference/source/tables/cinder-swift.rst @@ -19,6 +19,6 @@ * - **[DEFAULT]** - * - ``backup_swift_auth_insecure`` = ``False`` - - (BoolOpt) Bypass verification of server certificate when making SSL connection to Swift. + - (Boolean) Bypass verification of server certificate when making SSL connection to Swift. * - ``backup_swift_auth_url`` = ``None`` - - (StrOpt) The URL of the Keystone endpoint + - (String) The URL of the Keystone endpoint diff --git a/doc/config-reference/source/tables/cinder-tegile.rst b/doc/config-reference/source/tables/cinder-tegile.rst index ac4e59bf16..a98feb90c5 100644 --- a/doc/config-reference/source/tables/cinder-tegile.rst +++ b/doc/config-reference/source/tables/cinder-tegile.rst @@ -19,6 +19,6 @@ * - **[DEFAULT]** - * - ``tegile_default_pool`` = ``None`` - - (StrOpt) Create volumes in this pool + - (String) Create volumes in this pool * - ``tegile_default_project`` = ``None`` - - (StrOpt) Create volumes in this project + - (String) Create volumes in this project diff --git a/doc/config-reference/source/tables/cinder-tintri.rst b/doc/config-reference/source/tables/cinder-tintri.rst index 4ee48fdfa7..19666b204b 100644 --- a/doc/config-reference/source/tables/cinder-tintri.rst +++ b/doc/config-reference/source/tables/cinder-tintri.rst @@ -19,10 +19,14 @@ * - **[DEFAULT]** - * - ``tintri_api_version`` = ``v310`` - - (StrOpt) API version for the storage system + - (String) API version for the storage system + * - ``tintri_image_cache_expiry_days`` = ``30`` + - (Integer) Delete unused image snapshots older than mentioned days + * - ``tintri_image_shares_config`` = ``None`` + - (String) Path to image nfs shares file * - ``tintri_server_hostname`` = ``None`` - - (StrOpt) The hostname (or IP address) for the storage system + - (String) The hostname (or IP address) for the storage system * - ``tintri_server_password`` = ``None`` - - (StrOpt) Password for the storage system + - (String) Password for the storage system * - ``tintri_server_username`` = ``None`` - - (StrOpt) User name for the storage system + - (String) User name for the storage system diff --git a/doc/config-reference/source/tables/cinder-violin.rst b/doc/config-reference/source/tables/cinder-violin.rst index 6beaeb15be..8b4accc528 100644 --- a/doc/config-reference/source/tables/cinder-violin.rst +++ b/doc/config-reference/source/tables/cinder-violin.rst @@ -19,4 +19,4 @@ * - **[DEFAULT]** - * - ``violin_request_timeout`` = ``300`` - - (IntOpt) Global backend request timeout, in seconds. + - (Integer) Global backend request timeout, in seconds. diff --git a/doc/config-reference/source/tables/cinder-vmware.rst b/doc/config-reference/source/tables/cinder-vmware.rst index 4feb09f2e7..84b0e51be9 100644 --- a/doc/config-reference/source/tables/cinder-vmware.rst +++ b/doc/config-reference/source/tables/cinder-vmware.rst @@ -19,30 +19,30 @@ * - **[DEFAULT]** - * - ``vmware_api_retry_count`` = ``10`` - - (IntOpt) Number of times VMware vCenter server API must be retried upon connection related issues. + - (Integer) Number of times VMware vCenter server API must be retried upon connection related issues. * - ``vmware_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. * - ``vmware_cluster_name`` = ``None`` - - (MultiStrOpt) Name of a vCenter compute cluster where volumes should be created. + - (Multi-valued) Name of a vCenter compute cluster where volumes should be created. * - ``vmware_host_ip`` = ``None`` - - (StrOpt) IP address for connecting to VMware vCenter server. + - (String) IP address for connecting to VMware vCenter server. * - ``vmware_host_password`` = ``None`` - - (StrOpt) Password for authenticating with VMware vCenter server. + - (String) Password for authenticating with VMware vCenter server. * - ``vmware_host_username`` = ``None`` - - (StrOpt) Username for authenticating with VMware vCenter server. + - (String) Username for authenticating with VMware vCenter server. * - ``vmware_host_version`` = ``None`` - - (StrOpt) Optional string specifying the VMware vCenter server version. The driver attempts to retrieve the version from VMware vCenter server. Set this configuration only if you want to override the vCenter server version. + - (String) Optional string specifying the VMware vCenter server version. The driver attempts to retrieve the version from VMware vCenter server. Set this configuration only if you want to override the vCenter server version. * - ``vmware_image_transfer_timeout_secs`` = ``7200`` - - (IntOpt) Timeout in seconds for VMDK volume transfer between Cinder and Glance. + - (Integer) Timeout in seconds for VMDK volume transfer between Cinder and Glance. * - ``vmware_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 "vmware_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 "vmware_ca_file" is set. * - ``vmware_max_objects_retrieval`` = ``100`` - - (IntOpt) Max number of objects to be retrieved per batch. Query results will be obtained in batches from the server and not in one shot. Server may still limit the count to something less than the configured value. + - (Integer) Max number of objects to be retrieved per batch. Query results will be obtained in batches from the server and not in one shot. Server may still limit the count to something less than the configured value. * - ``vmware_task_poll_interval`` = ``0.5`` - - (FloatOpt) The interval (in seconds) for polling remote tasks invoked on VMware vCenter server. + - (Floating point) The interval (in seconds) for polling remote tasks invoked on VMware vCenter server. * - ``vmware_tmp_dir`` = ``/tmp`` - - (StrOpt) Directory where virtual disks are stored during volume backup and restore. + - (String) Directory where virtual disks are stored during volume backup and restore. * - ``vmware_volume_folder`` = ``Volumes`` - - (StrOpt) Name of the vCenter inventory folder that will contain Cinder volumes. This folder will be created under "OpenStack/", where project_folder is of format "Project ()". + - (String) Name of the vCenter inventory folder that will contain Cinder volumes. This folder will be created under "OpenStack/", where project_folder is of format "Project ()". * - ``vmware_wsdl_location`` = ``None`` - - (StrOpt) Optional VIM service WSDL Location e.g http:///vimService.wsdl. Optional over-ride to default location for bug work-arounds. + - (String) Optional VIM service WSDL Location e.g http:///vimService.wsdl. Optional over-ride to default location for bug work-arounds. diff --git a/doc/config-reference/source/tables/cinder-vzstorage.rst b/doc/config-reference/source/tables/cinder-vzstorage.rst index 52bc10eb2b..b5260ff8f8 100644 --- a/doc/config-reference/source/tables/cinder-vzstorage.rst +++ b/doc/config-reference/source/tables/cinder-vzstorage.rst @@ -19,12 +19,12 @@ * - **[DEFAULT]** - * - ``vzstorage_mount_options`` = ``None`` - - (ListOpt) Mount options passed to the vzstorage client. See section of the pstorage-mount man page for details. + - (List) Mount options passed to the vzstorage client. See section of the pstorage-mount man page for details. * - ``vzstorage_mount_point_base`` = ``$state_path/mnt`` - - (StrOpt) Base dir containing mount points for vzstorage shares. + - (String) Base dir containing mount points for vzstorage shares. * - ``vzstorage_shares_config`` = ``/etc/cinder/vzstorage_shares`` - - (StrOpt) File with the list of available vzstorage shares. + - (String) File with the list of available vzstorage shares. * - ``vzstorage_sparsed_volumes`` = ``True`` - - (BoolOpt) Create volumes as sparsed files which take no space rather than regular files when using raw format, in which case volume creation takes lot of time. + - (Boolean) Create volumes as sparsed files which take no space rather than regular files when using raw format, in which case volume creation takes lot of time. * - ``vzstorage_used_ratio`` = ``0.95`` - - (FloatOpt) Percent of ACTUAL usage of the underlying volume before no new volumes can be allocated to the volume destination. + - (Floating point) Percent of ACTUAL usage of the underlying volume before no new volumes can be allocated to the volume destination. diff --git a/doc/config-reference/source/tables/cinder-windows.rst b/doc/config-reference/source/tables/cinder-windows.rst index 73b713843b..a263e3e339 100644 --- a/doc/config-reference/source/tables/cinder-windows.rst +++ b/doc/config-reference/source/tables/cinder-windows.rst @@ -19,4 +19,4 @@ * - **[DEFAULT]** - * - ``windows_iscsi_lun_path`` = ``C:\iSCSIVirtualDisks`` - - (StrOpt) Path to store VHD backed volumes + - (String) Path to store VHD backed volumes diff --git a/doc/config-reference/source/tables/cinder-xio.rst b/doc/config-reference/source/tables/cinder-xio.rst index 707ab77cfc..0efaaf2323 100644 --- a/doc/config-reference/source/tables/cinder-xio.rst +++ b/doc/config-reference/source/tables/cinder-xio.rst @@ -19,14 +19,14 @@ * - **[DEFAULT]** - * - ``driver_use_ssl`` = ``False`` - - (BoolOpt) Tell driver to use SSL for connection to backend storage if the driver supports it. + - (Boolean) Tell driver to use SSL for connection to backend storage if the driver supports it. * - ``ise_completion_retries`` = ``30`` - - (IntOpt) Number on retries to get completion status after issuing a command to ISE. + - (Integer) Number on retries to get completion status after issuing a command to ISE. * - ``ise_connection_retries`` = ``5`` - - (IntOpt) Number of retries (per port) when establishing connection to ISE management port. + - (Integer) Number of retries (per port) when establishing connection to ISE management port. * - ``ise_raid`` = ``1`` - - (IntOpt) Raid level for ISE volumes. + - (Integer) Raid level for ISE volumes. * - ``ise_retry_interval`` = ``1`` - - (IntOpt) Interval (secs) between retries. + - (Integer) Interval (secs) between retries. * - ``ise_storage_pool`` = ``1`` - - (IntOpt) Default storage pool for volumes. + - (Integer) Default storage pool for volumes. diff --git a/doc/config-reference/source/tables/cinder-xiv.rst b/doc/config-reference/source/tables/cinder-xiv.rst index a5b252f4c4..9234434eb6 100644 --- a/doc/config-reference/source/tables/cinder-xiv.rst +++ b/doc/config-reference/source/tables/cinder-xiv.rst @@ -19,16 +19,16 @@ * - **[DEFAULT]** - * - ``san_clustername`` = - - (StrOpt) Cluster name to use for creating volumes + - (String) Cluster name to use for creating volumes * - ``san_ip`` = - - (StrOpt) IP address of SAN controller + - (String) IP address of SAN controller * - ``san_login`` = ``admin`` - - (StrOpt) Username for SAN controller + - (String) Username for SAN controller * - ``san_password`` = - - (StrOpt) Password for SAN controller + - (String) Password for SAN controller * - ``xiv_chap`` = ``disabled`` - - (StrOpt) CHAP authentication mode, effective only for iscsi (disabled|enabled) + - (String) CHAP authentication mode, effective only for iscsi (disabled|enabled) * - ``xiv_ds8k_connection_type`` = ``iscsi`` - - (StrOpt) Connection type to the IBM Storage Array + - (String) Connection type to the IBM Storage Array * - ``xiv_ds8k_proxy`` = ``xiv_ds8k_openstack.nova_proxy.XIVDS8KNovaProxy`` - - (StrOpt) Proxy driver that connects to the IBM Storage Array + - (String) Proxy driver that connects to the IBM Storage Array diff --git a/doc/config-reference/source/tables/cinder-zeromq.rst b/doc/config-reference/source/tables/cinder-zeromq.rst index 566619d404..0d1c3a3dca 100644 --- a/doc/config-reference/source/tables/cinder-zeromq.rst +++ b/doc/config-reference/source/tables/cinder-zeromq.rst @@ -18,27 +18,27 @@ - Description * - **[DEFAULT]** - - * - ``direct_over_proxy`` = ``True`` - - (BoolOpt) Configures zmq-messaging to use proxy with non PUB/SUB patterns. * - ``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`` + - (Integer) Expiration timeout in seconds of a name service record about existing target ( < 0 means no timeout). diff --git a/doc/config-reference/source/tables/cinder-zfssa-iscsi.rst b/doc/config-reference/source/tables/cinder-zfssa-iscsi.rst index 8b3186bdb1..a6b81d915b 100644 --- a/doc/config-reference/source/tables/cinder-zfssa-iscsi.rst +++ b/doc/config-reference/source/tables/cinder-zfssa-iscsi.rst @@ -19,38 +19,38 @@ * - **[DEFAULT]** - * - ``zfssa_initiator`` = - - (StrOpt) iSCSI initiator IQNs. (comma separated) + - (String) iSCSI initiator IQNs. (comma separated) * - ``zfssa_initiator_config`` = - - (StrOpt) iSCSI initiators configuration. + - (String) iSCSI initiators configuration. * - ``zfssa_initiator_group`` = - - (StrOpt) iSCSI initiator group. + - (String) iSCSI initiator group. * - ``zfssa_initiator_password`` = - - (StrOpt) Secret of the iSCSI initiator CHAP user. + - (String) Secret of the iSCSI initiator CHAP user. * - ``zfssa_initiator_user`` = - - (StrOpt) iSCSI initiator CHAP user (name). + - (String) iSCSI initiator CHAP user (name). * - ``zfssa_lun_compression`` = ``off`` - - (StrOpt) Data compression. + - (String) Data compression. * - ``zfssa_lun_logbias`` = ``latency`` - - (StrOpt) Synchronous write bias. + - (String) Synchronous write bias. * - ``zfssa_lun_sparse`` = ``False`` - - (BoolOpt) Flag to enable sparse (thin-provisioned): True, False. + - (Boolean) Flag to enable sparse (thin-provisioned): True, False. * - ``zfssa_lun_volblocksize`` = ``8k`` - - (StrOpt) Block size. + - (String) Block size. * - ``zfssa_pool`` = ``None`` - - (StrOpt) Storage pool name. + - (String) Storage pool name. * - ``zfssa_project`` = ``None`` - - (StrOpt) Project name. + - (String) Project name. * - ``zfssa_replication_ip`` = - - (StrOpt) IP address used for replication data. (maybe the same as data ip) + - (String) IP address used for replication data. (maybe the same as data ip) * - ``zfssa_rest_timeout`` = ``None`` - - (IntOpt) REST connection timeout. (seconds) + - (Integer) REST connection timeout. (seconds) * - ``zfssa_target_group`` = ``tgt-grp`` - - (StrOpt) iSCSI target group name. + - (String) iSCSI target group name. * - ``zfssa_target_interfaces`` = ``None`` - - (StrOpt) Network interfaces of iSCSI targets. (comma separated) + - (String) Network interfaces of iSCSI targets. (comma separated) * - ``zfssa_target_password`` = - - (StrOpt) Secret of the iSCSI target CHAP user. + - (String) Secret of the iSCSI target CHAP user. * - ``zfssa_target_portal`` = ``None`` - - (StrOpt) iSCSI target portal (Data-IP:Port, w.x.y.z:3260). + - (String) iSCSI target portal (Data-IP:Port, w.x.y.z:3260). * - ``zfssa_target_user`` = - - (StrOpt) iSCSI target CHAP user (name). + - (String) iSCSI target CHAP user (name). diff --git a/doc/config-reference/source/tables/cinder-zfssa-nfs.rst b/doc/config-reference/source/tables/cinder-zfssa-nfs.rst index 52229f488e..623e514ac4 100644 --- a/doc/config-reference/source/tables/cinder-zfssa-nfs.rst +++ b/doc/config-reference/source/tables/cinder-zfssa-nfs.rst @@ -19,26 +19,28 @@ * - **[DEFAULT]** - * - ``zfssa_cache_directory`` = ``os-cinder-cache`` - - (StrOpt) Name of directory inside zfssa_nfs_share where cache volumes are stored. + - (String) Name of directory inside zfssa_nfs_share where cache volumes are stored. * - ``zfssa_cache_project`` = ``os-cinder-cache`` - - (StrOpt) Name of ZFSSA project where cache volumes are stored. + - (String) Name of ZFSSA project where cache volumes are stored. * - ``zfssa_data_ip`` = ``None`` - - (StrOpt) Data path IP address + - (String) Data path IP address * - ``zfssa_enable_local_cache`` = ``True`` - - (BoolOpt) Flag to enable local caching: True, False. + - (Boolean) Flag to enable local caching: True, False. * - ``zfssa_https_port`` = ``443`` - - (StrOpt) HTTPS port number + - (String) HTTPS port number + * - ``zfssa_manage_policy`` = ``loose`` + - (String) Driver policy for volume manage. * - ``zfssa_nfs_mount_options`` = - - (StrOpt) Options to be passed while mounting share over nfs + - (String) Options to be passed while mounting share over nfs * - ``zfssa_nfs_pool`` = - - (StrOpt) Storage pool name. + - (String) Storage pool name. * - ``zfssa_nfs_project`` = ``NFSProject`` - - (StrOpt) Project name. + - (String) Project name. * - ``zfssa_nfs_share`` = ``nfs_share`` - - (StrOpt) Share name. + - (String) Share name. * - ``zfssa_nfs_share_compression`` = ``off`` - - (StrOpt) Data compression. + - (String) Data compression. * - ``zfssa_nfs_share_logbias`` = ``latency`` - - (StrOpt) Synchronous write bias-latency, throughput. + - (String) Synchronous write bias-latency, throughput. * - ``zfssa_rest_timeout`` = ``None`` - - (IntOpt) REST connection timeout. (seconds) + - (Integer) REST connection timeout. (seconds) diff --git a/doc/config-reference/source/tables/cinder-zones.rst b/doc/config-reference/source/tables/cinder-zones.rst index c9b16e108d..672af8d33b 100644 --- a/doc/config-reference/source/tables/cinder-zones.rst +++ b/doc/config-reference/source/tables/cinder-zones.rst @@ -19,4 +19,4 @@ * - **[DEFAULT]** - * - ``cloned_volume_same_az`` = ``True`` - - (BoolOpt) Ensure that the new volumes are the same AZ as snapshot or source volume + - (Boolean) Ensure that the new volumes are the same AZ as snapshot or source volume diff --git a/doc/config-reference/source/tables/cinder-zoning.rst b/doc/config-reference/source/tables/cinder-zoning.rst index 6ce84bb26c..59858052e1 100644 --- a/doc/config-reference/source/tables/cinder-zoning.rst +++ b/doc/config-reference/source/tables/cinder-zoning.rst @@ -19,14 +19,18 @@ * - **[DEFAULT]** - * - ``zoning_mode`` = ``None`` - - (StrOpt) FC Zoning mode configured + - (String) FC Zoning mode configured * - **[fc-zone-manager]** - + * - ``brcd_sb_connector`` = ``HTTP`` + - (String) South bound connector for zoning operation + * - ``cisco_sb_connector`` = ``cinder.zonemanager.drivers.cisco.cisco_fc_zone_client_cli.CiscoFCZoneClientCLI`` + - (String) Southbound connector for zoning operation * - ``fc_fabric_names`` = ``None`` - - (StrOpt) Comma separated list of Fibre Channel fabric names. This list of names is used to retrieve other SAN credentials for connecting to each SAN fabric + - (String) Comma separated list of Fibre Channel fabric names. This list of names is used to retrieve other SAN credentials for connecting to each SAN fabric * - ``fc_san_lookup_service`` = ``cinder.zonemanager.drivers.brocade.brcd_fc_san_lookup_service.BrcdFCSanLookupService`` - - (StrOpt) FC SAN Lookup Service + - (String) FC SAN Lookup Service * - ``zone_driver`` = ``cinder.zonemanager.drivers.brocade.brcd_fc_zone_driver.BrcdFCZoneDriver`` - - (StrOpt) FC Zone Driver responsible for zone management + - (String) FC Zone Driver responsible for zone management * - ``zoning_policy`` = ``initiator-target`` - - (StrOpt) Zoning policy configured by user; valid values include "initiator-target" or "initiator" + - (String) Zoning policy configured by user; valid values include "initiator-target" or "initiator" diff --git a/doc/config-reference/source/tables/cinder-zoning_fabric.rst b/doc/config-reference/source/tables/cinder-zoning_fabric.rst index fa60f7977b..eb12234d8d 100644 --- a/doc/config-reference/source/tables/cinder-zoning_fabric.rst +++ b/doc/config-reference/source/tables/cinder-zoning_fabric.rst @@ -19,18 +19,42 @@ * - **[BRCD_FABRIC_EXAMPLE]** - * - ``fc_fabric_address`` = - - (StrOpt) Management IP of fabric + - (String) Management IP of fabric. * - ``fc_fabric_password`` = - - (StrOpt) Password for user + - (String) Password for user. * - ``fc_fabric_port`` = ``22`` - - (PortOpt) Connecting port + - (Unknown) Connecting port + * - ``fc_fabric_ssh_cert_path`` = + - (String) Local SSH certificate Path. * - ``fc_fabric_user`` = - - (StrOpt) Fabric user ID + - (String) Fabric user ID. + * - ``fc_southbound_protocol`` = ``HTTP`` + - (String) South bound connector for the fabric. + * - ``fc_virtual_fabric_id`` = ``None`` + - (String) Virtual Fabric ID. * - ``principal_switch_wwn`` = ``None`` - - (StrOpt) Principal switch WWN of the fabric + - (String) DEPRECATED: Principal switch WWN of the fabric. This option is not used anymore. * - ``zone_activate`` = ``True`` - - (BoolOpt) overridden zoning activation state - * - ``zone_name_prefix`` = ``None`` - - (StrOpt) overridden zone name prefix + - (Boolean) Overridden zoning activation state. + * - ``zone_name_prefix`` = ``openstack`` + - (String) Overridden zone name prefix. * - ``zoning_policy`` = ``initiator-target`` - - (StrOpt) overridden zoning policy + - (String) Overridden zoning policy. + * - **[CISCO_FABRIC_EXAMPLE]** + - + * - ``cisco_fc_fabric_address`` = + - (String) Management IP of fabric + * - ``cisco_fc_fabric_password`` = + - (String) Password for user + * - ``cisco_fc_fabric_port`` = ``22`` + - (Unknown) Connecting port + * - ``cisco_fc_fabric_user`` = + - (String) Fabric user ID + * - ``cisco_zone_activate`` = ``True`` + - (Boolean) overridden zoning activation state + * - ``cisco_zone_name_prefix`` = ``None`` + - (String) overridden zone name prefix + * - ``cisco_zoning_policy`` = ``initiator-target`` + - (String) overridden zoning policy + * - ``cisco_zoning_vsan`` = ``None`` + - (String) VSAN of the Fabric diff --git a/doc/config-reference/source/tables/glance-amqp.rst b/doc/config-reference/source/tables/glance-amqp.rst index 49d9b6406c..0e816df3a3 100644 --- a/doc/config-reference/source/tables/glance-amqp.rst +++ b/doc/config-reference/source/tables/glance-amqp.rst @@ -19,18 +19,18 @@ * - **[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. * - ``default_publisher_id`` = ``image.localhost`` - - (StrOpt) Default publisher_id for outgoing notifications. + - (String) Default publisher_id for outgoing notifications. * - ``disabled_notifications`` = - - (ListOpt) List of disabled notifications. A notification can be given either as a notification type to disable a single event, or as a notification group prefix to disable all events within a group. Example: if this config option is set to ["image.create", "metadef_namespace"], then "image.create" notification will not be sent after image is created and none of the notifications for metadefinition namespaces will be sent. + - (List) List of disabled notifications. A notification can be given either as a notification type to disable a single event, or as a notification group prefix to disable all events within a group. Example: if this config option is set to ["image.create", "metadef_namespace"], then "image.create" notification will not be sent after image is created and none of the notifications for metadefinition namespaces will be sent. * - ``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. * - **[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. diff --git a/doc/config-reference/source/tables/glance-api.rst b/doc/config-reference/source/tables/glance-api.rst index 969938b060..b00383e177 100644 --- a/doc/config-reference/source/tables/glance-api.rst +++ b/doc/config-reference/source/tables/glance-api.rst @@ -19,68 +19,66 @@ * - **[DEFAULT]** - * - ``admin_role`` = ``admin`` - - (StrOpt) Role used to identify an authenticated user as administrator. + - (String) Role used to identify an authenticated user as administrator. * - ``allow_anonymous_access`` = ``False`` - - (BoolOpt) Allow unauthenticated users to access the API with read-only privileges. This only applies when using ContextMiddleware. + - (Boolean) Allow unauthenticated users to access the API with read-only privileges. This only applies when using ContextMiddleware. * - ``available_plugins`` = - - (ListOpt) A list of artifacts that are allowed in the format name or name-version. Empty list means that any artifact can be loaded. + - (List) A list of artifacts that are allowed in the format name or name-version. Empty list means that any artifact can be loaded. * - ``client_socket_timeout`` = ``900`` - - (IntOpt) Timeout for client connections' socket operations. If an incoming connection is idle for this number of seconds it will be closed. A value of '0' means wait forever. + - (Integer) Timeout for client connections' socket operations. If an incoming connection is idle for this number of seconds it will be closed. A value of '0' means wait forever. * - ``enable_v1_api`` = ``True`` - - (BoolOpt) Deploy the v1 OpenStack Images API. + - (Boolean) Deploy the v1 OpenStack Images API. * - ``enable_v1_registry`` = ``True`` - - (BoolOpt) Deploy the v1 OpenStack Registry API. + - (Boolean) Deploy the v1 OpenStack Registry API. * - ``enable_v2_api`` = ``True`` - - (BoolOpt) Deploy the v2 OpenStack Images API. + - (Boolean) Deploy the v2 OpenStack Images API. * - ``enable_v2_registry`` = ``True`` - - (BoolOpt) Deploy the v2 OpenStack Registry API. - * - ``enable_v3_api`` = ``False`` - - (BoolOpt) Deploy the v3 OpenStack Objects API. + - (Boolean) Deploy the v2 OpenStack Registry API. * - ``http_keepalive`` = ``True`` - - (BoolOpt) If False, server will return the header "Connection: close", If True, server will return "Connection: Keep-Alive" in its responses. In order to close the client socket connection explicitly after the response is sent and read successfully by the client, you simply have to set this option to False when you create a wsgi server. + - (Boolean) If False, server will return the header "Connection: close", If True, server will return "Connection: Keep-Alive" in its responses. In order to close the client socket connection explicitly after the response is sent and read successfully by the client, you simply have to set this option to False when you create a wsgi server. * - ``image_size_cap`` = ``1099511627776`` - - (IntOpt) Maximum size of image a user can upload in bytes. Defaults to 1099511627776 bytes (1 TB).WARNING: this value should only be increased after careful consideration and must be set to a value under 8 EB (9223372036854775808). + - (Integer) Maximum size of image a user can upload in bytes. Defaults to 1099511627776 bytes (1 TB).WARNING: this value should only be increased after careful consideration and must be set to a value under 8 EB (9223372036854775808). * - ``load_enabled`` = ``True`` - - (BoolOpt) When false, no artifacts can be loaded regardless of available_plugins. When true, artifacts can be loaded. + - (Boolean) When false, no artifacts can be loaded regardless of available_plugins. When true, artifacts can be loaded. * - ``location_strategy`` = ``location_order`` - - (StrOpt) This value sets what strategy will be used to determine the image location order. Currently two strategies are packaged with Glance 'location_order' and 'store_type'. + - (String) This value sets what strategy will be used to determine the image location order. Currently two strategies are packaged with Glance 'location_order' and 'store_type'. * - ``max_header_line`` = ``16384`` - - (IntOpt) Maximum line size of message headers to be accepted. max_header_line may need to be increased when using large tokens (typically those generated by the Keystone v3 API with big service catalogs + - (Integer) Maximum line size of message headers to be accepted. max_header_line may need to be increased when using large tokens (typically those generated by the Keystone v3 API with big service catalogs * - ``max_request_id_length`` = ``64`` - - (IntOpt) Limits request ID length. + - (Integer) Limits request ID length. * - ``owner_is_tenant`` = ``True`` - - (BoolOpt) When true, this option sets the owner of an image to be the tenant. Otherwise, the owner of the image will be the authenticated user issuing the request. + - (Boolean) When true, this option sets the owner of an image to be the tenant. Otherwise, the owner of the image will be the authenticated user issuing the request. * - ``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 Glance 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 Glance is operating behind a proxy, you will want to change this to represent the proxy's URL. * - ``send_identity_headers`` = ``False`` - - (BoolOpt) Whether to pass through headers containing user and tenant information when making requests to the registry. This allows the registry to use the context middleware without keystonemiddleware's auth_token middleware, removing calls to the keystone auth service. It is recommended that when using this option, secure communication between glance api and glance registry is ensured by means other than auth_token middleware. + - (Boolean) Whether to pass through headers containing user and tenant information when making requests to the registry. This allows the registry to use the context middleware without keystonemiddleware's auth_token middleware, removing calls to the keystone auth service. It is recommended that when using this option, secure communication between glance api and glance registry is ensured by means other than auth_token middleware. * - ``show_multiple_locations`` = ``False`` - - (BoolOpt) Whether to include the backend image locations in image properties. For example, if using the file system store a URL of "file:///path/to/image" will be returned to the user in the 'direct_url' meta-data field. Revealing storage location can be a security risk, so use this setting with caution! Setting this to true overrides the show_image_direct_url option. + - (Boolean) Whether to include the backend image locations in image properties. For example, if using the file system store a URL of "file:///path/to/image" will be returned to the user in the 'direct_url' meta-data field. Revealing storage location can be a security risk, so use this setting with caution! Setting this to true overrides the show_image_direct_url option. * - ``tcp_keepidle`` = ``600`` - - (IntOpt) The value for the socket option TCP_KEEPIDLE. This is the time in seconds that the connection must be idle before TCP starts sending keepalive probes. + - (Integer) The value for the socket option TCP_KEEPIDLE. This is the time in seconds that the connection must be idle before TCP starts sending keepalive probes. * - ``use_user_token`` = ``True`` - - (BoolOpt) Whether to pass through the user token when making requests to the registry. To prevent failures with token expiration during big files upload, it is recommended to set this parameter to False.If "use_user_token" is not in effect, then admin credentials can be specified. + - (Boolean) DEPRECATED: Whether to pass through the user token when making requests to the registry. To prevent failures with token expiration during big files upload, it is recommended to set this parameter to False.If "use_user_token" is not in effect, then admin credentials can be specified. This option was considered harmful and has been deprecated in M release. It will be removed in O release. For more information read OSSN-0060. Related functionality with uploading big images has been implemented with Keystone trusts support. * - **[glance_store]** - * - ``default_store`` = ``file`` - - (StrOpt) Default scheme to use to store image data. The scheme must be registered by one of the stores defined by the 'stores' config option. + - (String) Default scheme to use to store image data. The scheme must be registered by one of the stores defined by the 'stores' config option. * - ``store_capabilities_update_min_interval`` = ``0`` - - (IntOpt) Minimum interval seconds to execute updating dynamic storage capabilities based on backend status then. It's not a periodic routine, the update logic will be executed only when interval seconds elapsed and an operation of store has triggered. The feature will be enabled only when the option value greater then zero. + - (Integer) Minimum interval seconds to execute updating dynamic storage capabilities based on backend status then. It's not a periodic routine, the update logic will be executed only when interval seconds elapsed and an operation of store has triggered. The feature will be enabled only when the option value greater then zero. * - ``stores`` = ``file, http`` - - (ListOpt) List of stores enabled. Valid stores are: cinder, file, http, rbd, sheepdog, swift, s3, vsphere + - (List) List of stores enabled. Valid stores are: cinder, file, http, rbd, sheepdog, swift, s3, vsphere * - **[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. * - **[paste_deploy]** - * - ``config_file`` = ``None`` - - (StrOpt) Name of the paste configuration file. + - (String) Name of the paste configuration file. * - ``flavor`` = ``None`` - - (StrOpt) Partial name of a pipeline in your paste configuration file with the service name removed. For example, if your paste section name is [pipeline:glance-api-keystone] use the value "keystone" + - (String) Partial name of a pipeline in your paste configuration file with the service name removed. For example, if your paste section name is [pipeline:glance-api-keystone] use the value "keystone" * - **[store_type_location_strategy]** - * - ``store_type_preference`` = - - (ListOpt) The store names to use to get store preference order. The name must be registered by one of the stores defined by the 'stores' config option. This option will be applied when you using 'store_type' option as image location strategy defined by the 'location_strategy' config option. + - (List) The store names to use to get store preference order. The name must be registered by one of the stores defined by the 'stores' config option. This option will be applied when you using 'store_type' option as image location strategy defined by the 'location_strategy' config option. diff --git a/doc/config-reference/source/tables/glance-auth_token.rst b/doc/config-reference/source/tables/glance-auth_token.rst index 16fb36e134..c4ebff3ab5 100644 --- a/doc/config-reference/source/tables/glance-auth_token.rst +++ b/doc/config-reference/source/tables/glance-auth_token.rst @@ -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. diff --git a/doc/config-reference/source/tables/glance-ca.rst b/doc/config-reference/source/tables/glance-ca.rst index a5e85b1ef4..693d3908fd 100644 --- a/doc/config-reference/source/tables/glance-ca.rst +++ b/doc/config-reference/source/tables/glance-ca.rst @@ -19,8 +19,8 @@ * - **[DEFAULT]** - * - ``ca_file`` = ``None`` - - (StrOpt) CA certificate file to use to verify connecting clients. + - (String) CA certificate file to use to verify connecting clients. * - ``cert_file`` = ``None`` - - (StrOpt) Certificate file to use when starting API server securely. + - (String) Certificate file to use when starting API server securely. * - ``key_file`` = ``None`` - - (StrOpt) Private key file to use when starting API server securely. + - (String) Private key file to use when starting API server securely. diff --git a/doc/config-reference/source/tables/glance-cinder.rst b/doc/config-reference/source/tables/glance-cinder.rst index 4a0e940dc2..b3c894cbe2 100644 --- a/doc/config-reference/source/tables/glance-cinder.rst +++ b/doc/config-reference/source/tables/glance-cinder.rst @@ -19,12 +19,24 @@ * - **[glance_store]** - * - ``cinder_api_insecure`` = ``False`` - - (BoolOpt) Allow to perform insecure SSL requests to cinder + - (Boolean) Allow to perform insecure SSL requests to cinder * - ``cinder_ca_certificates_file`` = ``None`` - - (StrOpt) Location of ca certicates file to use for cinder client requests. - * - ``cinder_catalog_info`` = ``volume:cinder:publicURL`` - - (StrOpt) Info to match when looking for cinder in the service catalog. Format is : separated values of the form: :: + - (String) Location of ca certicates file to use for cinder client requests. + * - ``cinder_catalog_info`` = ``volumev2::publicURL`` + - (String) Info to match when looking for cinder in the service catalog. Format is : separated values of the form: :: * - ``cinder_endpoint_template`` = ``None`` - - (StrOpt) Override service catalog lookup with template for cinder endpoint e.g. http://localhost:8776/v1/%(project_id)s + - (String) Override service catalog lookup with template for cinder endpoint e.g. http://localhost:8776/v2/%(tenant)s * - ``cinder_http_retries`` = ``3`` - - (IntOpt) Number of cinderclient retries on failed http calls + - (Integer) Number of cinderclient retries on failed http calls + * - ``cinder_os_region_name`` = ``None`` + - (String) Region name of this node. If specified, it will be used to locate OpenStack services for stores. + * - ``cinder_state_transition_timeout`` = ``300`` + - (Integer) Time period of time in seconds to wait for a cinder volume transition to complete. + * - ``cinder_store_auth_address`` = ``None`` + - (String) The address where the Cinder authentication service is listening. If , the cinder endpoint in the service catalog is used. + * - ``cinder_store_password`` = ``None`` + - (String) Password for the user authenticating against Cinder. If , the current context auth token is used. + * - ``cinder_store_project_name`` = ``None`` + - (String) Project name where the image is stored in Cinder. If , the project in current context is used. + * - ``cinder_store_user_name`` = ``None`` + - (String) User name to authenticate against Cinder. If , the user of current context is used. diff --git a/doc/config-reference/source/tables/glance-common.rst b/doc/config-reference/source/tables/glance-common.rst index af0977bfd7..89b19575e1 100644 --- a/doc/config-reference/source/tables/glance-common.rst +++ b/doc/config-reference/source/tables/glance-common.rst @@ -19,66 +19,66 @@ * - **[DEFAULT]** - * - ``allow_additional_image_properties`` = ``True`` - - (BoolOpt) Whether to allow users to specify image properties beyond what the image schema provides + - (Boolean) Whether to allow users to specify image properties beyond what the image schema provides * - ``api_limit_max`` = ``1000`` - - (IntOpt) Maximum permissible number of items that could be returned by a request + - (Integer) Maximum permissible number of items that could be returned by a request * - ``backlog`` = ``4096`` - - (IntOpt) The backlog value that will be used when creating the TCP listener socket. + - (Integer) The backlog value that will be used when creating the TCP listener socket. * - ``bind_host`` = ``0.0.0.0`` - - (StrOpt) Address to bind the server. Useful when selecting a particular network interface. + - (String) Address to bind the server. Useful when selecting a particular network interface. * - ``bind_port`` = ``None`` - - (PortOpt) The port on which the server will listen. + - (Unknown) The port on which the server will listen. * - ``data_api`` = ``glance.db.sqlalchemy.api`` - - (StrOpt) Python module path of data access API + - (String) Python module path of data access API * - ``digest_algorithm`` = ``sha256`` - - (StrOpt) Digest algorithm which will be used for digital signature. Use the command "openssl list-message-digest-algorithms" to get the available algorithms supported by the version of OpenSSL on the platform. Examples are "sha1", "sha256", "sha512", etc. + - (String) Digest algorithm which will be used for digital signature. Use the command "openssl list-message-digest-algorithms" to get the available algorithms supported by the version of OpenSSL on the platform. Examples are "sha1", "sha256", "sha512", etc. * - ``executor_thread_pool_size`` = ``64`` - - (IntOpt) Size of executor thread pool. + - (Integer) Size of executor thread pool. * - ``image_location_quota`` = ``10`` - - (IntOpt) Maximum number of locations allowed on an image. Negative values evaluate to unlimited. + - (Integer) Maximum number of locations allowed on an image. Negative values evaluate to unlimited. * - ``image_member_quota`` = ``128`` - - (IntOpt) Maximum number of image members per image. Negative values evaluate to unlimited. + - (Integer) Maximum number of image members per image. Negative values evaluate to unlimited. * - ``image_property_quota`` = ``128`` - - (IntOpt) Maximum number of properties allowed on an image. Negative values evaluate to unlimited. + - (Integer) Maximum number of properties allowed on an image. Negative values evaluate to unlimited. * - ``image_tag_quota`` = ``128`` - - (IntOpt) Maximum number of tags allowed on an image. Negative values evaluate to unlimited. + - (Integer) Maximum number of tags allowed on an image. Negative values evaluate to unlimited. * - ``limit_param_default`` = ``25`` - - (IntOpt) Default value for the number of items returned by a request if not specified explicitly in the request + - (Integer) Default value for the number of items returned by a request if not specified explicitly in the request * - ``memcached_servers`` = ``None`` - - (ListOpt) Memcached servers or None for in process cache. + - (List) Memcached servers or None for in process cache. * - ``metadata_encryption_key`` = ``None`` - - (StrOpt) AES key for encrypting store 'location' metadata. This includes, if used, Swift or S3 credentials. Should be set to a random string of length 16, 24 or 32 bytes + - (String) AES key for encrypting store 'location' metadata. This includes, if used, Swift or S3 credentials. Should be set to a random string of length 16, 24 or 32 bytes * - ``metadata_source_path`` = ``/etc/glance/metadefs/`` - - (StrOpt) Path to the directory where json metadata files are stored + - (String) Path to the directory where json metadata files are stored * - ``property_protection_file`` = ``None`` - - (StrOpt) The location of the property protection file.This file contains the rules for property protections and the roles/policies associated with it. If this config value is not specified, by default, property protections won't be enforced. If a value is specified and the file is not found, then the glance-api service will not start. + - (String) The location of the property protection file.This file contains the rules for property protections and the roles/policies associated with it. If this config value is not specified, by default, property protections won't be enforced. If a value is specified and the file is not found, then the glance-api service will not start. * - ``property_protection_rule_format`` = ``roles`` - - (StrOpt) This config value indicates whether "roles" or "policies" are used in the property protection file. + - (String) This config value indicates whether "roles" or "policies" are used in the property protection file. * - ``show_image_direct_url`` = ``False`` - - (BoolOpt) Whether to include the backend image storage location in image properties. Revealing storage location can be a security risk, so use this setting with caution! + - (Boolean) Whether to include the backend image storage location in image properties. Revealing storage location can be a security risk, so use this setting with caution! * - ``user_storage_quota`` = ``0`` - - (StrOpt) Set a system wide quota for every user. This value is the total capacity that a user can use across all storage systems. A value of 0 means unlimited.Optional unit can be specified for the value. Accepted units are B, KB, MB, GB and TB representing Bytes, KiloBytes, MegaBytes, GigaBytes and TeraBytes respectively. If no unit is specified then Bytes is assumed. Note that there should not be any space between value and unit and units are case sensitive. - * - ``workers`` = ``4`` - - (IntOpt) The number of child process workers that will be created to service requests. The default will be equal to the number of CPUs available. + - (String) Set a system wide quota for every user. This value is the total capacity that a user can use across all storage systems. A value of 0 means unlimited.Optional unit can be specified for the value. Accepted units are B, KB, MB, GB and TB representing Bytes, KiloBytes, MegaBytes, GigaBytes and TeraBytes respectively. If no unit is specified then Bytes is assumed. Note that there should not be any space between value and unit and units are case sensitive. + * - ``workers`` = ``None`` + - (Integer) The number of child process workers that will be created to service requests. The default will be equal to the number of CPUs available. * - **[glance_store]** - - * - ``os_region_name`` = ``None`` - - (StrOpt) Region name of this node + * - ``rootwrap_config`` = ``/etc/glance/rootwrap.conf`` + - (String) Path to the rootwrap configuration file to use for running commands as root. * - **[image_format]** - * - ``container_formats`` = ``ami, ari, aki, bare, ovf, ova, docker`` - - (ListOpt) Supported values for the 'container_format' image attribute + - (List) Supported values for the 'container_format' image attribute * - ``disk_formats`` = ``ami, ari, aki, vhd, vmdk, raw, qcow2, vdi, iso`` - - (ListOpt) Supported values for the 'disk_format' image attribute + - (List) Supported values for the 'disk_format' image attribute * - **[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. * - **[task]** - * - ``task_executor`` = ``taskflow`` - - (StrOpt) Specifies which task executor to be used to run the task scripts. + - (String) Specifies which task executor to be used to run the task scripts. * - ``task_time_to_live`` = ``48`` - - (IntOpt) Time in hours for which a task lives after, either succeeding or failing + - (Integer) Time in hours for which a task lives after, either succeeding or failing * - ``work_dir`` = ``None`` - - (StrOpt) Work dir for asynchronous task operations. The directory set here will be used to operate over images - normally before they are imported in the destination store. When providing work dir, make sure enough space is provided for concurrent tasks to run efficiently without running out of space. A rough estimation can be done by multiplying the number of `max_workers` - or the N of workers running - by an average image size (e.g 500MB). The image size estimation should be done based on the average size in your deployment. Note that depending on the tasks running you may need to multiply this number by some factor depending on what the task does. For example, you may want to double the available size if image conversion is enabled. All this being said, remember these are just estimations and you should do them based on the worst case scenario and be prepared to act in case they were wrong. + - (String) Work dir for asynchronous task operations. The directory set here will be used to operate over images - normally before they are imported in the destination store. When providing work dir, make sure enough space is provided for concurrent tasks to run efficiently without running out of space. A rough estimation can be done by multiplying the number of `max_workers` - or the N of workers running - by an average image size (e.g 500MB). The image size estimation should be done based on the average size in your deployment. Note that depending on the tasks running you may need to multiply this number by some factor depending on what the task does. For example, you may want to double the available size if image conversion is enabled. All this being said, remember these are just estimations and you should do them based on the worst case scenario and be prepared to act in case they were wrong. diff --git a/doc/config-reference/source/tables/glance-cors.rst b/doc/config-reference/source/tables/glance-cors.rst index 5292e44824..52c526ed38 100644 --- a/doc/config-reference/source/tables/glance-cors.rst +++ b/doc/config-reference/source/tables/glance-cors.rst @@ -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. diff --git a/doc/config-reference/source/tables/glance-database.rst b/doc/config-reference/source/tables/glance-database.rst index 1fb3a37b2d..661b2911c5 100644 --- a/doc/config-reference/source/tables/glance-database.rst +++ b/doc/config-reference/source/tables/glance-database.rst @@ -19,42 +19,42 @@ * - **[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. diff --git a/doc/config-reference/source/tables/glance-filesystem.rst b/doc/config-reference/source/tables/glance-filesystem.rst index b9345fda9b..9514d29101 100644 --- a/doc/config-reference/source/tables/glance-filesystem.rst +++ b/doc/config-reference/source/tables/glance-filesystem.rst @@ -19,10 +19,10 @@ * - **[glance_store]** - * - ``filesystem_store_datadir`` = ``/var/lib/glance/images`` - - (StrOpt) Directory to which the Filesystem backend store writes images. + - (String) Directory to which the Filesystem backend store writes images. * - ``filesystem_store_datadirs`` = ``None`` - - (MultiStrOpt) List of directories and its priorities to which the Filesystem backend store writes images. + - (Multi-valued) List of directories and its priorities to which the Filesystem backend store writes images. * - ``filesystem_store_file_perm`` = ``0`` - - (IntOpt) The required permission for created image file. In this way the user other service used, e.g. Nova, who consumes the image could be the exclusive member of the group that owns the files created. Assigning it less then or equal to zero means don't change the default permission of the file. This value will be decoded as an octal digit. + - (Integer) The required permission for created image file. In this way the user other service used, e.g. Nova, who consumes the image could be the exclusive member of the group that owns the files created. Assigning it less then or equal to zero means don't change the default permission of the file. This value will be decoded as an octal digit. * - ``filesystem_store_metadata_file`` = ``None`` - - (StrOpt) The path to a file which contains the metadata to be returned with any location associated with this store. The file must contain a valid JSON object. The object should contain the keys 'id' and 'mountpoint'. The value for both keys should be 'string'. + - (String) The path to a file which contains the metadata to be returned with any location associated with this store. The file must contain a valid JSON object. The object should contain the keys 'id' and 'mountpoint'. The value for both keys should be 'string'. diff --git a/doc/config-reference/source/tables/glance-http.rst b/doc/config-reference/source/tables/glance-http.rst new file mode 100644 index 0000000000..a7b7029c22 --- /dev/null +++ b/doc/config-reference/source/tables/glance-http.rst @@ -0,0 +1,26 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. _glance-http: + +.. list-table:: Description of http configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[glance_store]** + - + * - ``http_proxy_information`` = ``{}`` + - (Dict) Specify the http/https proxy information that should be used to connect to the remote server. The proxy information should be a key value pair of the scheme and proxy. e.g. http:10.0.0.1:3128. You can specify proxies for multiple schemes by seperating the key value pairs with a comma.e.g. http:10.0.0.1:3128, https:10.0.0.1:1080. + * - ``https_ca_certificates_file`` = ``None`` + - (String) Specify the path to the CA bundle file to use in verifying the remote server certificate. + * - ``https_insecure`` = ``True`` + - (Boolean) If true, the remote server certificate is not verified. If false, then the default CA truststore is used for verification. This option is ignored if "https_ca_certificates_file" is set. diff --git a/doc/config-reference/source/tables/glance-imagecache.rst b/doc/config-reference/source/tables/glance-imagecache.rst index cac4ff6ad6..70f8d50777 100644 --- a/doc/config-reference/source/tables/glance-imagecache.rst +++ b/doc/config-reference/source/tables/glance-imagecache.rst @@ -19,18 +19,18 @@ * - **[DEFAULT]** - * - ``delayed_delete`` = ``False`` - - (BoolOpt) Turn on/off delayed delete. + - (Boolean) Turn on/off delayed delete. * - ``image_cache_dir`` = ``None`` - - (StrOpt) Base directory that the image cache uses. + - (String) Base directory that the image cache uses. * - ``image_cache_driver`` = ``sqlite`` - - (StrOpt) The driver to use for image cache management. + - (String) The driver to use for image cache management. * - ``image_cache_max_size`` = ``10737418240`` - - (IntOpt) The upper limit (the maximum size of accumulated cache in bytes) beyond which the cache pruner, if running, starts cleaning the image cache. + - (Integer) The upper limit (the maximum size of accumulated cache in bytes) beyond which the cache pruner, if running, starts cleaning the image cache. * - ``image_cache_sqlite_db`` = ``cache.db`` - - (StrOpt) The path to the sqlite file database that will be used for image cache management. + - (String) The path to the sqlite file database that will be used for image cache management. * - ``image_cache_stall_time`` = ``86400`` - - (IntOpt) The amount of time to let an incomplete image remain in the cache, before the cache cleaner, if running, will remove the incomplete image. + - (Integer) The amount of time to let an incomplete image remain in the cache, before the cache cleaner, if running, will remove the incomplete image. * - ``scrub_pool_size`` = ``1`` - - (IntOpt) The size of thread pool to be used for scrubbing images. The default is one, which signifies serial scrubbing. Any value above one indicates the max number of images that may be scrubbed in parallel. + - (Integer) The size of thread pool to be used for scrubbing images. The default is one, which signifies serial scrubbing. Any value above one indicates the max number of images that may be scrubbed in parallel. * - ``scrub_time`` = ``0`` - - (IntOpt) The amount of time in seconds to delay before performing a delete. + - (Integer) The amount of time in seconds to delay before performing a delete. diff --git a/doc/config-reference/source/tables/glance-logging.rst b/doc/config-reference/source/tables/glance-logging.rst index a50496b2f2..48172c5eeb 100644 --- a/doc/config-reference/source/tables/glance-logging.rst +++ b/doc/config-reference/source/tables/glance-logging.rst @@ -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. diff --git a/doc/config-reference/source/tables/glance-policy.rst b/doc/config-reference/source/tables/glance-policy.rst index e2685c9afb..7728ae258d 100644 --- a/doc/config-reference/source/tables/glance-policy.rst +++ b/doc/config-reference/source/tables/glance-policy.rst @@ -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. diff --git a/doc/config-reference/source/tables/glance-profiler.rst b/doc/config-reference/source/tables/glance-profiler.rst index 4f77ecb251..deb8ddcf24 100644 --- a/doc/config-reference/source/tables/glance-profiler.rst +++ b/doc/config-reference/source/tables/glance-profiler.rst @@ -19,8 +19,8 @@ * - **[profiler]** - * - ``enabled`` = ``False`` - - (BoolOpt) If False fully disable profiling feature. + - (Boolean) If False fully disable profiling feature. * - ``hmac_keys`` = ``SECRET_KEY`` - - (StrOpt) Secret key to use to sign Glance API and Glance Registry services tracing messages. + - (String) Secret key to use to sign Glance API and Glance Registry services tracing messages. * - ``trace_sqlalchemy`` = ``False`` - - (BoolOpt) If False doesn't trace SQL requests. + - (Boolean) If False doesn't trace SQL requests. diff --git a/doc/config-reference/source/tables/glance-qpid.rst b/doc/config-reference/source/tables/glance-qpid.rst deleted file mode 100644 index 4b0110c209..0000000000 --- a/doc/config-reference/source/tables/glance-qpid.rst +++ /dev/null @@ -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. - -.. _glance-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. diff --git a/doc/config-reference/source/tables/glance-rabbitmq.rst b/doc/config-reference/source/tables/glance-rabbitmq.rst index 991be12286..7a3f699a20 100644 --- a/doc/config-reference/source/tables/glance-rabbitmq.rst +++ b/doc/config-reference/source/tables/glance-rabbitmq.rst @@ -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. diff --git a/doc/config-reference/source/tables/glance-rbd.rst b/doc/config-reference/source/tables/glance-rbd.rst index 080c052884..956f5ea46d 100644 --- a/doc/config-reference/source/tables/glance-rbd.rst +++ b/doc/config-reference/source/tables/glance-rbd.rst @@ -19,12 +19,12 @@ * - **[glance_store]** - * - ``rados_connect_timeout`` = ``0`` - - (IntOpt) Timeout value (in seconds) used when connecting to ceph cluster. If value <= 0, no timeout is set and default librados value is used. + - (Integer) Timeout value (in seconds) used when connecting to ceph cluster. If value <= 0, no timeout is set and default librados value is used. * - ``rbd_store_ceph_conf`` = ``/etc/ceph/ceph.conf`` - - (StrOpt) Ceph configuration file path. If , librados will locate the default config. If using cephx authentication, this file should include a reference to the right keyring in a client. section + - (String) Ceph configuration file path. If , librados will locate the default config. If using cephx authentication, this file should include a reference to the right keyring in a client. section * - ``rbd_store_chunk_size`` = ``8`` - - (IntOpt) RADOS images will be chunked into objects of this size (in megabytes). For best performance, this should be a power of two. + - (Integer) RADOS images will be chunked into objects of this size (in megabytes). For best performance, this should be a power of two. * - ``rbd_store_pool`` = ``images`` - - (StrOpt) RADOS pool in which images are stored. + - (String) RADOS pool in which images are stored. * - ``rbd_store_user`` = ``None`` - - (StrOpt) RADOS user to authenticate as (only applicable if using Cephx. If , a default will be chosen based on the client. section in rbd_store_ceph_conf) + - (String) RADOS user to authenticate as (only applicable if using Cephx. If , a default will be chosen based on the client. section in rbd_store_ceph_conf) diff --git a/doc/config-reference/source/tables/glance-redis.rst b/doc/config-reference/source/tables/glance-redis.rst index 37fdd77b1d..7c3e1c3e5f 100644 --- a/doc/config-reference/source/tables/glance-redis.rst +++ b/doc/config-reference/source/tables/glance-redis.rst @@ -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. diff --git a/doc/config-reference/source/tables/glance-registry.rst b/doc/config-reference/source/tables/glance-registry.rst index 16448a864a..53569f1a76 100644 --- a/doc/config-reference/source/tables/glance-registry.rst +++ b/doc/config-reference/source/tables/glance-registry.rst @@ -19,30 +19,30 @@ * - **[DEFAULT]** - * - ``admin_password`` = ``None`` - - (StrOpt) The administrators password. If "use_user_token" is not in effect, then admin credentials can be specified. + - (String) DEPRECATED: The administrators password. If "use_user_token" is not in effect, then admin credentials can be specified. This option was considered harmful and has been deprecated in M release. It will be removed in O release. For more information read OSSN-0060. Related functionality with uploading big images has been implemented with Keystone trusts support. * - ``admin_tenant_name`` = ``None`` - - (StrOpt) The tenant name of the administrative user. If "use_user_token" is not in effect, then admin tenant name can be specified. + - (String) DEPRECATED: The tenant name of the administrative user. If "use_user_token" is not in effect, then admin tenant name can be specified. This option was considered harmful and has been deprecated in M release. It will be removed in O release. For more information read OSSN-0060. Related functionality with uploading big images has been implemented with Keystone trusts support. * - ``admin_user`` = ``None`` - - (StrOpt) The administrators user name. If "use_user_token" is not in effect, then admin credentials can be specified. + - (String) DEPRECATED: The administrators user name. If "use_user_token" is not in effect, then admin credentials can be specified. This option was considered harmful and has been deprecated in M release. It will be removed in O release. For more information read OSSN-0060. Related functionality with uploading big images has been implemented with Keystone trusts support. * - ``auth_region`` = ``None`` - - (StrOpt) The region for the authentication service. If "use_user_token" is not in effect and using keystone auth, then region name can be specified. + - (String) DEPRECATED: The region for the authentication service. If "use_user_token" is not in effect and using keystone auth, then region name can be specified. This option was considered harmful and has been deprecated in M release. It will be removed in O release. For more information read OSSN-0060. Related functionality with uploading big images has been implemented with Keystone trusts support. * - ``auth_strategy`` = ``noauth`` - - (StrOpt) The strategy to use for authentication. If "use_user_token" is not in effect, then auth strategy can be specified. + - (String) DEPRECATED: The strategy to use for authentication. If "use_user_token" is not in effect, then auth strategy can be specified. This option was considered harmful and has been deprecated in M release. It will be removed in O release. For more information read OSSN-0060. Related functionality with uploading big images has been implemented with Keystone trusts support. * - ``auth_url`` = ``None`` - - (StrOpt) The URL to the keystone service. If "use_user_token" is not in effect and using keystone auth, then URL of keystone can be specified. + - (String) DEPRECATED: The URL to the keystone service. If "use_user_token" is not in effect and using keystone auth, then URL of keystone can be specified. This option was considered harmful and has been deprecated in M release. It will be removed in O release. For more information read OSSN-0060. Related functionality with uploading big images has been implemented with Keystone trusts support. * - ``registry_client_ca_file`` = ``None`` - - (StrOpt) The path to the certifying authority cert file to use in SSL connections to the registry server, if any. Alternately, you may set the GLANCE_CLIENT_CA_FILE environment variable to a filepath of the CA cert file. + - (String) The path to the certifying authority cert file to use in SSL connections to the registry server, if any. Alternately, you may set the GLANCE_CLIENT_CA_FILE environment variable to a filepath of the CA cert file. * - ``registry_client_cert_file`` = ``None`` - - (StrOpt) The path to the cert file to use in SSL connections to the registry server, if any. Alternately, you may set the GLANCE_CLIENT_CERT_FILE environment variable to a filepath of the CA cert file + - (String) The path to the cert file to use in SSL connections to the registry server, if any. Alternately, you may set the GLANCE_CLIENT_CERT_FILE environment variable to a filepath of the CA cert file * - ``registry_client_insecure`` = ``False`` - - (BoolOpt) When using SSL in connections to the registry server, do not require validation via a certifying authority. This is the registry's equivalent of specifying --insecure on the command line using glanceclient for the API. + - (Boolean) When using SSL in connections to the registry server, do not require validation via a certifying authority. This is the registry's equivalent of specifying --insecure on the command line using glanceclient for the API. * - ``registry_client_key_file`` = ``None`` - - (StrOpt) The path to the key file to use in SSL connections to the registry server, if any. Alternately, you may set the GLANCE_CLIENT_KEY_FILE environment variable to a filepath of the key file + - (String) The path to the key file to use in SSL connections to the registry server, if any. Alternately, you may set the GLANCE_CLIENT_KEY_FILE environment variable to a filepath of the key file * - ``registry_client_protocol`` = ``http`` - - (StrOpt) The protocol to use for communication with the registry server. Either http or https. + - (String) The protocol to use for communication with the registry server. Either http or https. * - ``registry_client_timeout`` = ``600`` - - (IntOpt) The period of time, in seconds, that the API server will wait for a registry request to complete. A value of 0 implies no timeout. + - (Integer) The period of time, in seconds, that the API server will wait for a registry request to complete. A value of 0 implies no timeout. * - ``registry_host`` = ``0.0.0.0`` - - (StrOpt) Address to find the registry server. + - (String) Address to find the registry server. * - ``registry_port`` = ``9191`` - - (PortOpt) Port the registry server is listening on. + - (Unknown) Port the registry server is listening on. diff --git a/doc/config-reference/source/tables/glance-replicator.rst b/doc/config-reference/source/tables/glance-replicator.rst index a859374515..03b9fbee0c 100644 --- a/doc/config-reference/source/tables/glance-replicator.rst +++ b/doc/config-reference/source/tables/glance-replicator.rst @@ -19,18 +19,18 @@ * - **[DEFAULT]** - * - ``args`` = ``None`` - - (ListOpt) Arguments for the command + - (List) Arguments for the command * - ``chunksize`` = ``65536`` - - (IntOpt) Amount of data to transfer per HTTP write. + - (Integer) Amount of data to transfer per HTTP write. * - ``command`` = ``None`` - - (StrOpt) Command to be given to replicator + - (String) Command to be given to replicator * - ``dontreplicate`` = ``created_at date deleted_at location updated_at`` - - (StrOpt) List of fields to not replicate. + - (String) List of fields to not replicate. * - ``mastertoken`` = - - (StrOpt) Pass in your authentication token if you have one. This is the token used for the master. + - (String) Pass in your authentication token if you have one. This is the token used for the master. * - ``metaonly`` = ``False`` - - (BoolOpt) Only replicate metadata, not images. + - (Boolean) Only replicate metadata, not images. * - ``slavetoken`` = - - (StrOpt) Pass in your authentication token if you have one. This is the token used for the slave. + - (String) Pass in your authentication token if you have one. This is the token used for the slave. * - ``token`` = - - (StrOpt) Pass in your authentication token if you have one. If you use this option the same token is used for both the master and the slave. + - (String) Pass in your authentication token if you have one. If you use this option the same token is used for both the master and the slave. diff --git a/doc/config-reference/source/tables/glance-rpc.rst b/doc/config-reference/source/tables/glance-rpc.rst index 2856d82c65..9e86283938 100644 --- a/doc/config-reference/source/tables/glance-rpc.rst +++ b/doc/config-reference/source/tables/glance-rpc.rst @@ -19,54 +19,78 @@ * - **[DEFAULT]** - * - ``allowed_rpc_exception_modules`` = ``glance.common.exception, builtins, exceptions`` - - (ListOpt) Modules of exceptions that are permitted to be recreated upon receiving exception data from an rpc call. + - (List) Modules of exceptions that are permitted to be recreated upon receiving exception data from an rpc call. * - ``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_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_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 diff --git a/doc/config-reference/source/tables/glance-s3.rst b/doc/config-reference/source/tables/glance-s3.rst index 0ec182ee5f..50fde0d986 100644 --- a/doc/config-reference/source/tables/glance-s3.rst +++ b/doc/config-reference/source/tables/glance-s3.rst @@ -19,32 +19,32 @@ * - **[glance_store]** - * - ``s3_store_access_key`` = ``None`` - - (StrOpt) The S3 query token access key. + - (String) The S3 query token access key. * - ``s3_store_bucket`` = ``None`` - - (StrOpt) The S3 bucket to be used to store the Glance data. + - (String) The S3 bucket to be used to store the Glance data. * - ``s3_store_bucket_url_format`` = ``subdomain`` - - (StrOpt) The S3 calling format used to determine the bucket. Either subdomain or path can be used. + - (String) The S3 calling format used to determine the bucket. Either subdomain or path can be used. * - ``s3_store_create_bucket_on_put`` = ``False`` - - (BoolOpt) A boolean to determine if the S3 bucket should be created on upload if it does not exist or if an error should be returned to the user. + - (Boolean) A boolean to determine if the S3 bucket should be created on upload if it does not exist or if an error should be returned to the user. * - ``s3_store_enable_proxy`` = ``False`` - - (BoolOpt) Enable the use of a proxy. + - (Boolean) Enable the use of a proxy. * - ``s3_store_host`` = ``None`` - - (StrOpt) The host where the S3 server is listening. + - (String) The host where the S3 server is listening. * - ``s3_store_large_object_chunk_size`` = ``10`` - - (IntOpt) What multipart upload part size, in MB, should S3 use when uploading parts. The size must be greater than or equal to 5M. + - (Integer) What multipart upload part size, in MB, should S3 use when uploading parts. The size must be greater than or equal to 5M. * - ``s3_store_large_object_size`` = ``100`` - - (IntOpt) What size, in MB, should S3 start chunking image files and do a multipart upload in S3. + - (Integer) What size, in MB, should S3 start chunking image files and do a multipart upload in S3. * - ``s3_store_object_buffer_dir`` = ``None`` - - (StrOpt) The local directory where uploads will be staged before they are transferred into S3. + - (String) The local directory where uploads will be staged before they are transferred into S3. * - ``s3_store_proxy_host`` = ``None`` - - (StrOpt) Address or hostname for the proxy server. + - (String) Address or hostname for the proxy server. * - ``s3_store_proxy_password`` = ``None`` - - (StrOpt) The password to use when connecting over a proxy. + - (String) The password to use when connecting over a proxy. * - ``s3_store_proxy_port`` = ``8080`` - - (IntOpt) The port to use when connecting over a proxy. + - (Integer) The port to use when connecting over a proxy. * - ``s3_store_proxy_user`` = ``None`` - - (StrOpt) The username to connect to the proxy. + - (String) The username to connect to the proxy. * - ``s3_store_secret_key`` = ``None`` - - (StrOpt) The S3 query token secret key. + - (String) The S3 query token secret key. * - ``s3_store_thread_pools`` = ``10`` - - (IntOpt) The number of thread pools to perform a multipart upload in S3. + - (Integer) The number of thread pools to perform a multipart upload in S3. diff --git a/doc/config-reference/source/tables/glance-scrubber.rst b/doc/config-reference/source/tables/glance-scrubber.rst index 016db3f9bc..a700501806 100644 --- a/doc/config-reference/source/tables/glance-scrubber.rst +++ b/doc/config-reference/source/tables/glance-scrubber.rst @@ -19,4 +19,4 @@ * - **[DEFAULT]** - * - ``wakeup_time`` = ``300`` - - (IntOpt) Loop time between checking for new items to schedule for delete. + - (Integer) Loop time between checking for new items to schedule for delete. diff --git a/doc/config-reference/source/tables/glance-sheepdog.rst b/doc/config-reference/source/tables/glance-sheepdog.rst index 28fb0542c2..178f29bd41 100644 --- a/doc/config-reference/source/tables/glance-sheepdog.rst +++ b/doc/config-reference/source/tables/glance-sheepdog.rst @@ -19,8 +19,8 @@ * - **[glance_store]** - * - ``sheepdog_store_address`` = ``localhost`` - - (StrOpt) IP address of sheep daemon. + - (String) IP address of sheep daemon. * - ``sheepdog_store_chunk_size`` = ``64`` - - (IntOpt) Images will be chunked into objects of this size (in megabytes). For best performance, this should be a power of two. + - (Integer) Images will be chunked into objects of this size (in megabytes). For best performance, this should be a power of two. * - ``sheepdog_store_port`` = ``7000`` - - (IntOpt) Port of sheep daemon. + - (Integer) Port of sheep daemon. diff --git a/doc/config-reference/source/tables/glance-swift.rst b/doc/config-reference/source/tables/glance-swift.rst index 27f555f3ac..8756ac3c46 100644 --- a/doc/config-reference/source/tables/glance-swift.rst +++ b/doc/config-reference/source/tables/glance-swift.rst @@ -19,56 +19,60 @@ * - **[DEFAULT]** - * - ``default_swift_reference`` = ``ref1`` - - (StrOpt) The reference to the default swift account/backing store parameters to use for adding new images. + - (String) The reference to the default swift account/backing store parameters to use for adding new images. * - ``swift_store_auth_address`` = ``None`` - - (StrOpt) The address where the Swift authentication service is listening.(deprecated) + - (String) The address where the Swift authentication service is listening.(deprecated) * - ``swift_store_config_file`` = ``None`` - - (StrOpt) The config file that has the swift account(s)configs. + - (String) The config file that has the swift account(s)configs. * - ``swift_store_key`` = ``None`` - - (StrOpt) Auth key for the user authenticating against the Swift authentication service. (deprecated) + - (String) Auth key for the user authenticating against the Swift authentication service. (deprecated) * - ``swift_store_user`` = ``None`` - - (StrOpt) The user to authenticate against the Swift authentication service (deprecated) + - (String) The user to authenticate against the Swift authentication service (deprecated) * - **[glance_store]** - * - ``default_swift_reference`` = ``ref1`` - - (StrOpt) The reference to the default swift account/backing store parameters to use for adding new images. + - (String) The reference to the default swift account/backing store parameters to use for adding new images. * - ``swift_store_admin_tenants`` = - - (ListOpt) A list of tenants that will be granted read/write access on all Swift containers created by Glance in multi-tenant mode. + - (List) A list of tenants that will be granted read/write access on all Swift containers created by Glance in multi-tenant mode. * - ``swift_store_auth_address`` = ``None`` - - (StrOpt) The address where the Swift authentication service is listening. (deprecated - use "auth_address" in swift_store_config_file) + - (String) The address where the Swift authentication service is listening. (deprecated - use "auth_address" in swift_store_config_file) * - ``swift_store_auth_insecure`` = ``False`` - - (BoolOpt) If True, swiftclient won't check for a valid SSL certificate when authenticating. + - (Boolean) If True, swiftclient won't check for a valid SSL certificate when authenticating. * - ``swift_store_auth_version`` = ``2`` - - (StrOpt) Version of the authentication service to use. Valid versions are 2 and 3 for keystone and 1 (deprecated) for swauth and rackspace. (deprecated - use "auth_version" in swift_store_config_file) + - (String) Version of the authentication service to use. Valid versions are 2 and 3 for keystone and 1 (deprecated) for swauth and rackspace. (deprecated - use "auth_version" in swift_store_config_file) * - ``swift_store_cacert`` = ``None`` - - (StrOpt) A string giving the CA certificate file to use in SSL connections for verifying certs. + - (String) A string giving the CA certificate file to use in SSL connections for verifying certs. * - ``swift_store_config_file`` = ``None`` - - (StrOpt) The config file that has the swift account(s)configs. + - (String) The config file that has the swift account(s)configs. * - ``swift_store_container`` = ``glance`` - - (StrOpt) Container within the account that the account should use for storing images in Swift when using single container mode. In multiple container mode, this will be the prefix for all containers. + - (String) Container within the account that the account should use for storing images in Swift when using single container mode. In multiple container mode, this will be the prefix for all containers. * - ``swift_store_create_container_on_put`` = ``False`` - - (BoolOpt) A boolean value that determines if we create the container if it does not exist. + - (Boolean) A boolean value that determines if we create the container if it does not exist. * - ``swift_store_endpoint`` = ``None`` - - (StrOpt) If set, the configured endpoint will be used. If None, the storage url from the auth response will be used. + - (String) If set, the configured endpoint will be used. If None, the storage url from the auth response will be used. * - ``swift_store_endpoint_type`` = ``publicURL`` - - (StrOpt) A string giving the endpoint type of the swift service to use (publicURL, adminURL or internalURL). This setting is only used if swift_store_auth_version is 2. + - (String) A string giving the endpoint type of the swift service to use (publicURL, adminURL or internalURL). This setting is only used if swift_store_auth_version is 2. + * - ``swift_store_expire_soon_interval`` = ``60`` + - (Integer) The period of time (in seconds) before token expirationwhen glance_store will try to reques new user token. Default value 60 sec means that if token is going to expire in 1 min then glance_store request new user token. * - ``swift_store_key`` = ``None`` - - (StrOpt) Auth key for the user authenticating against the Swift authentication service. (deprecated - use "key" in swift_store_config_file) + - (String) Auth key for the user authenticating against the Swift authentication service. (deprecated - use "key" in swift_store_config_file) * - ``swift_store_large_object_chunk_size`` = ``200`` - - (IntOpt) The amount of data written to a temporary disk buffer during the process of chunking the image file. + - (Integer) The amount of data written to a temporary disk buffer during the process of chunking the image file. * - ``swift_store_large_object_size`` = ``5120`` - - (IntOpt) The size, in MB, that Glance will start chunking image files and do a large object manifest in Swift. + - (Integer) The size, in MB, that Glance will start chunking image files and do a large object manifest in Swift. * - ``swift_store_multi_tenant`` = ``False`` - - (BoolOpt) If set to True, enables multi-tenant storage mode which causes Glance images to be stored in tenant specific Swift accounts. + - (Boolean) If set to True, enables multi-tenant storage mode which causes Glance images to be stored in tenant specific Swift accounts. * - ``swift_store_multiple_containers_seed`` = ``0`` - - (IntOpt) When set to 0, a single-tenant store will only use one container to store all images. When set to an integer value between 1 and 32, a single-tenant store will use multiple containers to store images, and this value will determine how many containers are created.Used only when swift_store_multi_tenant is disabled. The total number of containers that will be used is equal to 16^N, so if this config option is set to 2, then 16^2=256 containers will be used to store images. + - (Integer) When set to 0, a single-tenant store will only use one container to store all images. When set to an integer value between 1 and 32, a single-tenant store will use multiple containers to store images, and this value will determine how many containers are created.Used only when swift_store_multi_tenant is disabled. The total number of containers that will be used is equal to 16^N, so if this config option is set to 2, then 16^2=256 containers will be used to store images. * - ``swift_store_region`` = ``None`` - - (StrOpt) The region of the swift endpoint to be used for single tenant. This setting is only necessary if the tenant has multiple swift endpoints. + - (String) The region of the swift endpoint to be used for single tenant. This setting is only necessary if the tenant has multiple swift endpoints. * - ``swift_store_retry_get_count`` = ``0`` - - (IntOpt) The number of times a Swift download will be retried before the request fails. + - (Integer) The number of times a Swift download will be retried before the request fails. * - ``swift_store_service_type`` = ``object-store`` - - (StrOpt) A string giving the service type of the swift service to use. This setting is only used if swift_store_auth_version is 2. + - (String) A string giving the service type of the swift service to use. This setting is only used if swift_store_auth_version is 2. * - ``swift_store_ssl_compression`` = ``True`` - - (BoolOpt) If set to False, disables SSL layer compression of https swift requests. Setting to False may improve performance for images which are already in a compressed format, eg qcow2. + - (Boolean) If set to False, disables SSL layer compression of https swift requests. Setting to False may improve performance for images which are already in a compressed format, eg qcow2. + * - ``swift_store_use_trusts`` = ``True`` + - (Boolean) If set to True create a trust for each add/get request to Multi-tenant store in order to prevent authentication token to be expired during uploading/downloading data. If set to False then user token is used for Swift connection (so no overhead on trust creation). Please note that this option is considered only and only if swift_store_multi_tenant=True * - ``swift_store_user`` = ``None`` - - (StrOpt) The user to authenticate against the Swift authentication service (deprecated - use "user" in swift_store_config_file) + - (String) The user to authenticate against the Swift authentication service (deprecated - use "user" in swift_store_config_file) diff --git a/doc/config-reference/source/tables/glance-taskflow.rst b/doc/config-reference/source/tables/glance-taskflow.rst index 5c25f9c7e5..5d6eba607a 100644 --- a/doc/config-reference/source/tables/glance-taskflow.rst +++ b/doc/config-reference/source/tables/glance-taskflow.rst @@ -19,8 +19,8 @@ * - **[taskflow_executor]** - * - ``conversion_format`` = ``None`` - - (StrOpt) The format to which images will be automatically converted. When using the RBD backend, this should be set to 'raw' + - (String) The format to which images will be automatically converted. When using the RBD backend, this should be set to 'raw' * - ``engine_mode`` = ``parallel`` - - (StrOpt) The mode in which the engine will run. Can be 'serial' or 'parallel'. + - (String) The mode in which the engine will run. Can be 'serial' or 'parallel'. * - ``max_workers`` = ``10`` - - (IntOpt) The number of parallel activities executed at the same time by the engine. The value can be greater than one when the engine mode is 'parallel'. + - (Integer) The number of parallel activities executed at the same time by the engine. The value can be greater than one when the engine mode is 'parallel'. diff --git a/doc/config-reference/source/tables/glance-testing.rst b/doc/config-reference/source/tables/glance-testing.rst index 90aab68091..ba2c7b61d6 100644 --- a/doc/config-reference/source/tables/glance-testing.rst +++ b/doc/config-reference/source/tables/glance-testing.rst @@ -19,6 +19,6 @@ * - **[DEFAULT]** - * - ``pydev_worker_debug_host`` = ``None`` - - (StrOpt) The hostname/IP of the pydev process listening for debug connections + - (String) The hostname/IP of the pydev process listening for debug connections * - ``pydev_worker_debug_port`` = ``5678`` - - (PortOpt) The port on which a pydev process is listening for connections. + - (Unknown) The port on which a pydev process is listening for connections. diff --git a/doc/config-reference/source/tables/glance-vmware.rst b/doc/config-reference/source/tables/glance-vmware.rst index be72b2ed62..c0ee808b26 100644 --- a/doc/config-reference/source/tables/glance-vmware.rst +++ b/doc/config-reference/source/tables/glance-vmware.rst @@ -18,19 +18,21 @@ - Description * - **[glance_store]** - - * - ``vmware_api_insecure`` = ``False`` - - (BoolOpt) Allow to perform insecure SSL requests to ESX/VC. * - ``vmware_api_retry_count`` = ``10`` - - (IntOpt) Number of times VMware ESX/VC server API must be retried upon connection related issues. + - (Integer) Number of times VMware ESX/VC server API must be retried upon connection related issues. + * - ``vmware_ca_file`` = ``None`` + - (String) Specify a CA bundle file to use in verifying the ESX/vCenter server certificate. * - ``vmware_datastores`` = ``None`` - - (MultiStrOpt) A list of datastores where the image can be stored. This option may be specified multiple times for specifying multiple datastores. The datastore name should be specified after its datacenter path, seperated by ":". An optional weight may be given after the datastore name, seperated again by ":". Thus, the required format becomes ::. When adding an image, the datastore with highest weight will be selected, unless there is not enough free space available in cases where the image size is already known. If no weight is given, it is assumed to be zero and the directory will be considered for selection last. If multiple datastores have the same weight, then the one with the most free space available is selected. + - (Multi-valued) A list of datastores where the image can be stored. This option may be specified multiple times for specifying multiple datastores. The datastore name should be specified after its datacenter path, seperated by ":". An optional weight may be given after the datastore name, seperated again by ":". Thus, the required format becomes ::. When adding an image, the datastore with highest weight will be selected, unless there is not enough free space available in cases where the image size is already known. If no weight is given, it is assumed to be zero and the directory will be considered for selection last. If multiple datastores have the same weight, then the one with the most free space available is selected. + * - ``vmware_insecure`` = ``False`` + - (Boolean) If true, the ESX/vCenter server certificate is not verified. If false, then the default CA truststore is used for verification. This option is ignored if "vmware_ca_file" is set. * - ``vmware_server_host`` = ``None`` - - (StrOpt) ESX/ESXi or vCenter Server target system. The server value can be an IP address or a DNS name. + - (String) ESX/ESXi or vCenter Server target system. The server value can be an IP address or a DNS name. * - ``vmware_server_password`` = ``None`` - - (StrOpt) Password for authenticating with VMware ESX/VC server. + - (String) Password for authenticating with VMware ESX/VC server. * - ``vmware_server_username`` = ``None`` - - (StrOpt) Username for authenticating with VMware ESX/VC server. + - (String) Username for authenticating with VMware ESX/VC server. * - ``vmware_store_image_dir`` = ``/openstack_glance`` - - (StrOpt) The name of the directory where the glance images will be stored in the VMware datastore. + - (String) The name of the directory where the glance images will be stored in the VMware datastore. * - ``vmware_task_poll_interval`` = ``5`` - - (IntOpt) The interval used for polling remote tasks invoked on VMware ESX/VC server. + - (Integer) The interval used for polling remote tasks invoked on VMware ESX/VC server. diff --git a/doc/config-reference/source/tables/glance-zeromq.rst b/doc/config-reference/source/tables/glance-zeromq.rst index 85370f3ab9..aa3f1c58ab 100644 --- a/doc/config-reference/source/tables/glance-zeromq.rst +++ b/doc/config-reference/source/tables/glance-zeromq.rst @@ -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). diff --git a/doc/config-reference/source/tables/heat-amqp.rst b/doc/config-reference/source/tables/heat-amqp.rst index 0a47f2c185..f5b6f4aee1 100644 --- a/doc/config-reference/source/tables/heat-amqp.rst +++ b/doc/config-reference/source/tables/heat-amqp.rst @@ -19,16 +19,10 @@ * - **[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. * - ``default_notification_level`` = ``INFO`` - - (StrOpt) Default notification level for outgoing notifications. + - (String) Default notification level for outgoing notifications. * - ``default_publisher_id`` = ``None`` - - (StrOpt) Default publisher_id for outgoing notifications. - * - ``notification_driver`` = ``[]`` - - (MultiStrOpt) The Drivers(s) to handle sending notifications. Possible values are messaging, messagingv2, routing, log, test, noop - * - ``notification_topics`` = ``notifications`` - - (ListOpt) AMQP topic used for OpenStack notifications. - * - ``notification_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) Default publisher_id for outgoing notifications. * - ``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. diff --git a/doc/config-reference/source/tables/heat-api.rst b/doc/config-reference/source/tables/heat-api.rst index 302ae08842..a12cf61549 100644 --- a/doc/config-reference/source/tables/heat-api.rst +++ b/doc/config-reference/source/tables/heat-api.rst @@ -19,108 +19,112 @@ * - **[DEFAULT]** - * - ``action_retry_limit`` = ``5`` - - (IntOpt) Number of times to retry to bring a resource to a non-error state. Set to 0 to disable retries. + - (Integer) Number of times to retry to bring a resource to a non-error state. Set to 0 to disable retries. * - ``enable_stack_abandon`` = ``False`` - - (BoolOpt) Enable the preview Stack Abandon feature. + - (Boolean) Enable the preview Stack Abandon feature. * - ``enable_stack_adopt`` = ``False`` - - (BoolOpt) Enable the preview Stack Adopt feature. + - (Boolean) Enable the preview Stack Adopt feature. * - ``encrypt_parameters_and_properties`` = ``False`` - - (BoolOpt) Encrypt template parameters that were marked as hidden and also all the resource properties before storing them in database. - * - ``heat_metadata_server_url`` = - - (StrOpt) URL of the Heat metadata server. + - (Boolean) Encrypt template parameters that were marked as hidden and also all the resource properties before storing them in database. + * - ``heat_metadata_server_url`` = ``None`` + - (String) URL of the Heat metadata server. NOTE: Setting this is only needed if you require instances to use a different endpoint than in the keystone catalog * - ``heat_stack_user_role`` = ``heat_stack_user`` - - (StrOpt) Keystone role for heat template-defined users. + - (String) Keystone role for heat template-defined users. * - ``heat_waitcondition_server_url`` = ``None`` - - (StrOpt) URL of the Heat waitcondition server. + - (String) URL of the Heat waitcondition server. * - ``heat_watch_server_url`` = - - (StrOpt) URL of the Heat CloudWatch server. + - (String) URL of the Heat CloudWatch server. * - ``hidden_stack_tags`` = ``data-processing-cluster`` - - (ListOpt) Stacks containing these tag names will be hidden. Multiple tags should be given in a comma-delimited list (eg. hidden_stack_tags=hide_me,me_too). + - (List) Stacks containing these tag names will be hidden. Multiple tags should be given in a comma-delimited list (eg. hidden_stack_tags=hide_me,me_too). * - ``max_json_body_size`` = ``1048576`` - - (IntOpt) Maximum raw byte size of JSON request body. Should be larger than max_template_size. - * - ``num_engine_workers`` = ``1`` - - (IntOpt) Number of heat-engine processes to fork and run. + - (Integer) Maximum raw byte size of JSON request body. Should be larger than max_template_size. + * - ``num_engine_workers`` = ``None`` + - (Integer) Number of heat-engine processes to fork and run. + * - ``observe_on_update`` = ``False`` + - (Boolean) On update, enables heat to collect existing resource properties from reality and converge to updated template. * - ``stack_action_timeout`` = ``3600`` - - (IntOpt) Timeout in seconds for stack action (ie. create or update). + - (Integer) Timeout in seconds for stack action (ie. create or update). * - ``stack_domain_admin`` = ``None`` - - (StrOpt) Keystone username, a user with roles sufficient to manage users and projects in the stack_user_domain. + - (String) Keystone username, a user with roles sufficient to manage users and projects in the stack_user_domain. * - ``stack_domain_admin_password`` = ``None`` - - (StrOpt) Keystone password for stack_domain_admin user. + - (String) Keystone password for stack_domain_admin user. * - ``stack_scheduler_hints`` = ``False`` - - (BoolOpt) When this feature is enabled, scheduler hints identifying the heat stack context of a server or volume resource are passed to the configured schedulers in nova and cinder, for creates done using heat resource types OS::Cinder::Volume, OS::Nova::Server, and AWS::EC2::Instance. heat_root_stack_id will be set to the id of the root stack of the resource, heat_stack_id will be set to the id of the resource's parent stack, heat_stack_name will be set to the name of the resource's parent stack, heat_path_in_stack will be set to a list of tuples, (stackresourcename, stackname) with list[0] being (None, rootstackname), heat_resource_name will be set to the resource's name, and heat_resource_uuid will be set to the resource's orchestration id. + - (Boolean) When this feature is enabled, scheduler hints identifying the heat stack context of a server or volume resource are passed to the configured schedulers in nova and cinder, for creates done using heat resource types OS::Cinder::Volume, OS::Nova::Server, and AWS::EC2::Instance. heat_root_stack_id will be set to the id of the root stack of the resource, heat_stack_id will be set to the id of the resource's parent stack, heat_stack_name will be set to the name of the resource's parent stack, heat_path_in_stack will be set to a list of tuples, (stackresourcename, stackname) with list[0] being (None, rootstackname), heat_resource_name will be set to the resource's name, and heat_resource_uuid will be set to the resource's orchestration id. * - ``stack_user_domain_id`` = ``None`` - - (StrOpt) Keystone domain ID which contains heat template-defined users. If this option is set, stack_user_domain_name option will be ignored. + - (String) Keystone domain ID which contains heat template-defined users. If this option is set, stack_user_domain_name option will be ignored. * - ``stack_user_domain_name`` = ``None`` - - (StrOpt) Keystone domain name which contains heat template-defined users. If `stack_user_domain_id` option is set, this option is ignored. + - (String) Keystone domain name which contains heat template-defined users. If `stack_user_domain_id` option is set, this option is ignored. + * - ``stale_token_duration`` = ``30`` + - (Integer) Gap, in seconds, to determine whether the given token is about to expire. * - ``trusts_delegated_roles`` = - - (ListOpt) Subset of trustor roles to be delegated to heat. If left unset, all roles of a user will be delegated to heat when creating a stack. + - (List) Subset of trustor roles to be delegated to heat. If left unset, all roles of a user will be delegated to heat when creating a stack. * - **[auth_password]** - * - ``allowed_auth_uris`` = - - (ListOpt) Allowed keystone endpoints for auth_uri when multi_cloud is enabled. At least one endpoint needs to be specified. + - (List) Allowed keystone endpoints for auth_uri when multi_cloud is enabled. At least one endpoint needs to be specified. * - ``multi_cloud`` = ``False`` - - (BoolOpt) Allow orchestration of multiple clouds. + - (Boolean) Allow orchestration of multiple clouds. * - **[ec2authtoken]** - * - ``allowed_auth_uris`` = - - (ListOpt) Allowed keystone endpoints for auth_uri when multi_cloud is enabled. At least one endpoint needs to be specified. + - (List) Allowed keystone endpoints for auth_uri when multi_cloud is enabled. At least one endpoint needs to be specified. * - ``auth_uri`` = ``None`` - - (StrOpt) Authentication Endpoint URI. + - (String) Authentication Endpoint URI. * - ``ca_file`` = ``None`` - - (StrOpt) Optional CA cert file to use in SSL connections. + - (String) Optional CA cert file to use in SSL connections. * - ``cert_file`` = ``None`` - - (StrOpt) Optional PEM-formatted certificate chain file. + - (String) Optional PEM-formatted certificate chain file. * - ``insecure`` = ``False`` - - (BoolOpt) If set, then the server's certificate will not be verified. + - (Boolean) If set, then the server's certificate will not be verified. * - ``key_file`` = ``None`` - - (StrOpt) Optional PEM-formatted file that contains the private key. + - (String) Optional PEM-formatted file that contains the private key. * - ``multi_cloud`` = ``False`` - - (BoolOpt) Allow orchestration of multiple clouds. + - (Boolean) Allow orchestration of multiple clouds. * - **[eventlet_opts]** - * - ``client_socket_timeout`` = ``900`` - - (IntOpt) Timeout for client connections' socket operations. If an incoming connection is idle for this number of seconds it will be closed. A value of '0' means wait forever. + - (Integer) Timeout for client connections' socket operations. If an incoming connection is idle for this number of seconds it will be closed. A value of '0' means wait forever. * - ``wsgi_keep_alive`` = ``True`` - - (BoolOpt) If False, closes the client socket connection explicitly. + - (Boolean) If False, closes the client socket connection explicitly. * - **[heat_api]** - * - ``backlog`` = ``4096`` - - (IntOpt) Number of backlog requests to configure the socket with. + - (Integer) Number of backlog requests to configure the socket with. * - ``bind_host`` = ``0.0.0.0`` - - (IPOpt) Address to bind the server. Useful when selecting a particular network interface. + - (Unknown) Address to bind the server. Useful when selecting a particular network interface. * - ``bind_port`` = ``8004`` - - (PortOpt) The port on which the server will listen. + - (Unknown) The port on which the server will listen. * - ``cert_file`` = ``None`` - - (StrOpt) Location of the SSL certificate file to use for SSL mode. + - (String) Location of the SSL certificate file to use for SSL mode. * - ``key_file`` = ``None`` - - (StrOpt) Location of the SSL key file to use for enabling SSL mode. + - (String) Location of the SSL key file to use for enabling SSL mode. * - ``max_header_line`` = ``16384`` - - (IntOpt) Maximum line size of message headers to be accepted. max_header_line may need to be increased when using large tokens (typically those generated by the Keystone v3 API with big service catalogs). + - (Integer) Maximum line size of message headers to be accepted. max_header_line may need to be increased when using large tokens (typically those generated by the Keystone v3 API with big service catalogs). * - ``tcp_keepidle`` = ``600`` - - (IntOpt) The value for the socket option TCP_KEEPIDLE. This is the time in seconds that the connection must be idle before TCP starts sending keepalive probes. - * - ``workers`` = ``1`` - - (IntOpt) Number of workers for Heat service. + - (Integer) The value for the socket option TCP_KEEPIDLE. This is the time in seconds that the connection must be idle before TCP starts sending keepalive probes. + * - ``workers`` = ``0`` + - (Integer) Number of workers for Heat service. Default value 0 means, that service will start number of workers equal number of cores on 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. * - **[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 * - **[paste_deploy]** - * - ``api_paste_config`` = ``api-paste.ini`` - - (StrOpt) The API paste config file to use. + - (String) The API paste config file to use. * - ``flavor`` = ``None`` - - (StrOpt) The flavor to use. + - (String) The flavor to use. diff --git a/doc/config-reference/source/tables/heat-auth_token.rst b/doc/config-reference/source/tables/heat-auth_token.rst index 662700052e..87e5ce3b4c 100644 --- a/doc/config-reference/source/tables/heat-auth_token.rst +++ b/doc/config-reference/source/tables/heat-auth_token.rst @@ -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. - * - ``auth_plugin`` = ``None`` - - (StrOpt) Name of the plugin to load + - (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 (http or https). Deprecated, use identity_uri. + - (String) Protocol of the admin Identity API endpoint. Deprecated, use identity_uri. * - ``auth_section`` = ``None`` - - (StrOpt) Config Section from which to load plugin specific options + - (Unknown) Config Section from which to load plugin specific options + * - ``auth_type`` = ``None`` + - (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. Acceptable values are MAC or ENCRYPT. 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. diff --git a/doc/config-reference/source/tables/heat-cfn_api.rst b/doc/config-reference/source/tables/heat-cfn_api.rst index 1559810063..cc93879215 100644 --- a/doc/config-reference/source/tables/heat-cfn_api.rst +++ b/doc/config-reference/source/tables/heat-cfn_api.rst @@ -19,24 +19,24 @@ * - **[DEFAULT]** - * - ``instance_connection_https_validate_certificates`` = ``1`` - - (StrOpt) Instance connection to CFN/CW API validate certs if SSL is used. + - (String) Instance connection to CFN/CW API validate certs if SSL is used. * - ``instance_connection_is_secure`` = ``0`` - - (StrOpt) Instance connection to CFN/CW API via https. + - (String) Instance connection to CFN/CW API via https. * - **[heat_api_cfn]** - * - ``backlog`` = ``4096`` - - (IntOpt) Number of backlog requests to configure the socket with. + - (Integer) Number of backlog requests to configure the socket with. * - ``bind_host`` = ``0.0.0.0`` - - (IPOpt) Address to bind the server. Useful when selecting a particular network interface. + - (Unknown) Address to bind the server. Useful when selecting a particular network interface. * - ``bind_port`` = ``8000`` - - (PortOpt) The port on which the server will listen. + - (Unknown) The port on which the server will listen. * - ``cert_file`` = ``None`` - - (StrOpt) Location of the SSL certificate file to use for SSL mode. + - (String) Location of the SSL certificate file to use for SSL mode. * - ``key_file`` = ``None`` - - (StrOpt) Location of the SSL key file to use for enabling SSL mode. + - (String) Location of the SSL key file to use for enabling SSL mode. * - ``max_header_line`` = ``16384`` - - (IntOpt) Maximum line size of message headers to be accepted. max_header_line may need to be increased when using large tokens (typically those generated by the Keystone v3 API with big service catalogs). + - (Integer) Maximum line size of message headers to be accepted. max_header_line may need to be increased when using large tokens (typically those generated by the Keystone v3 API with big service catalogs). * - ``tcp_keepidle`` = ``600`` - - (IntOpt) The value for the socket option TCP_KEEPIDLE. This is the time in seconds that the connection must be idle before TCP starts sending keepalive probes. - * - ``workers`` = ``0`` - - (IntOpt) Number of workers for Heat service. + - (Integer) The value for the socket option TCP_KEEPIDLE. This is the time in seconds that the connection must be idle before TCP starts sending keepalive probes. + * - ``workers`` = ``1`` + - (Integer) Number of workers for Heat service. diff --git a/doc/config-reference/source/tables/heat-clients.rst b/doc/config-reference/source/tables/heat-clients.rst index a7590bbd04..08c5a4d3ae 100644 --- a/doc/config-reference/source/tables/heat-clients.rst +++ b/doc/config-reference/source/tables/heat-clients.rst @@ -19,16 +19,16 @@ * - **[DEFAULT]** - * - ``region_name_for_services`` = ``None`` - - (StrOpt) Default region name used to get services endpoints. + - (String) Default region name used to get services endpoints. * - **[clients]** - * - ``ca_file`` = ``None`` - - (StrOpt) Optional CA cert file to use in SSL connections. + - (String) Optional CA cert file to use in SSL connections. * - ``cert_file`` = ``None`` - - (StrOpt) Optional PEM-formatted certificate chain file. + - (String) Optional PEM-formatted certificate chain file. * - ``endpoint_type`` = ``publicURL`` - - (StrOpt) Type of endpoint in Identity service catalog to use for communication with the OpenStack service. + - (String) Type of endpoint in Identity service catalog to use for communication with the OpenStack service. * - ``insecure`` = ``False`` - - (BoolOpt) If set, then the server's certificate will not be verified. + - (Boolean) If set, then the server's certificate will not be verified. * - ``key_file`` = ``None`` - - (StrOpt) Optional PEM-formatted file that contains the private key. + - (String) Optional PEM-formatted file that contains the private key. diff --git a/doc/config-reference/source/tables/heat-clients_backends.rst b/doc/config-reference/source/tables/heat-clients_backends.rst index 56c43ce6c7..b732a5f6ce 100644 --- a/doc/config-reference/source/tables/heat-clients_backends.rst +++ b/doc/config-reference/source/tables/heat-clients_backends.rst @@ -19,4 +19,4 @@ * - **[DEFAULT]** - * - ``cloud_backend`` = ``heat.engine.clients.OpenStackClients`` - - (StrOpt) Fully qualified class name to use as a client backend. + - (String) Fully qualified class name to use as a client backend. diff --git a/doc/config-reference/source/tables/heat-clients_ceilometer.rst b/doc/config-reference/source/tables/heat-clients_ceilometer.rst index e395723f02..b392c0a896 100644 --- a/doc/config-reference/source/tables/heat-clients_ceilometer.rst +++ b/doc/config-reference/source/tables/heat-clients_ceilometer.rst @@ -19,12 +19,12 @@ * - **[clients_ceilometer]** - * - ``ca_file`` = ``None`` - - (StrOpt) Optional CA cert file to use in SSL connections. + - (String) Optional CA cert file to use in SSL connections. * - ``cert_file`` = ``None`` - - (StrOpt) Optional PEM-formatted certificate chain file. + - (String) Optional PEM-formatted certificate chain file. * - ``endpoint_type`` = ``None`` - - (StrOpt) Type of endpoint in Identity service catalog to use for communication with the OpenStack service. + - (String) Type of endpoint in Identity service catalog to use for communication with the OpenStack service. * - ``insecure`` = ``None`` - - (BoolOpt) If set, then the server's certificate will not be verified. + - (Boolean) If set, then the server's certificate will not be verified. * - ``key_file`` = ``None`` - - (StrOpt) Optional PEM-formatted file that contains the private key. + - (String) Optional PEM-formatted file that contains the private key. diff --git a/doc/config-reference/source/tables/heat-clients_cinder.rst b/doc/config-reference/source/tables/heat-clients_cinder.rst index eb8cc1d287..c841537cfc 100644 --- a/doc/config-reference/source/tables/heat-clients_cinder.rst +++ b/doc/config-reference/source/tables/heat-clients_cinder.rst @@ -19,14 +19,14 @@ * - **[clients_cinder]** - * - ``ca_file`` = ``None`` - - (StrOpt) Optional CA cert file to use in SSL connections. + - (String) Optional CA cert file to use in SSL connections. * - ``cert_file`` = ``None`` - - (StrOpt) Optional PEM-formatted certificate chain file. + - (String) Optional PEM-formatted certificate chain file. * - ``endpoint_type`` = ``None`` - - (StrOpt) Type of endpoint in Identity service catalog to use for communication with the OpenStack service. + - (String) Type of endpoint in Identity service catalog to use for communication with the OpenStack service. * - ``http_log_debug`` = ``False`` - - (BoolOpt) Allow client's debug log output. + - (Boolean) Allow client's debug log output. * - ``insecure`` = ``None`` - - (BoolOpt) If set, then the server's certificate will not be verified. + - (Boolean) If set, then the server's certificate will not be verified. * - ``key_file`` = ``None`` - - (StrOpt) Optional PEM-formatted file that contains the private key. + - (String) Optional PEM-formatted file that contains the private key. diff --git a/doc/config-reference/source/tables/heat-clients_glance.rst b/doc/config-reference/source/tables/heat-clients_glance.rst index ad7911b0d0..0ff6d291de 100644 --- a/doc/config-reference/source/tables/heat-clients_glance.rst +++ b/doc/config-reference/source/tables/heat-clients_glance.rst @@ -19,12 +19,12 @@ * - **[clients_glance]** - * - ``ca_file`` = ``None`` - - (StrOpt) Optional CA cert file to use in SSL connections. + - (String) Optional CA cert file to use in SSL connections. * - ``cert_file`` = ``None`` - - (StrOpt) Optional PEM-formatted certificate chain file. + - (String) Optional PEM-formatted certificate chain file. * - ``endpoint_type`` = ``None`` - - (StrOpt) Type of endpoint in Identity service catalog to use for communication with the OpenStack service. + - (String) Type of endpoint in Identity service catalog to use for communication with the OpenStack service. * - ``insecure`` = ``None`` - - (BoolOpt) If set, then the server's certificate will not be verified. + - (Boolean) If set, then the server's certificate will not be verified. * - ``key_file`` = ``None`` - - (StrOpt) Optional PEM-formatted file that contains the private key. + - (String) Optional PEM-formatted file that contains the private key. diff --git a/doc/config-reference/source/tables/heat-clients_heat.rst b/doc/config-reference/source/tables/heat-clients_heat.rst index e9d594cda9..2904f78660 100644 --- a/doc/config-reference/source/tables/heat-clients_heat.rst +++ b/doc/config-reference/source/tables/heat-clients_heat.rst @@ -19,14 +19,14 @@ * - **[clients_heat]** - * - ``ca_file`` = ``None`` - - (StrOpt) Optional CA cert file to use in SSL connections. + - (String) Optional CA cert file to use in SSL connections. * - ``cert_file`` = ``None`` - - (StrOpt) Optional PEM-formatted certificate chain file. + - (String) Optional PEM-formatted certificate chain file. * - ``endpoint_type`` = ``None`` - - (StrOpt) Type of endpoint in Identity service catalog to use for communication with the OpenStack service. + - (String) Type of endpoint in Identity service catalog to use for communication with the OpenStack service. * - ``insecure`` = ``None`` - - (BoolOpt) If set, then the server's certificate will not be verified. + - (Boolean) If set, then the server's certificate will not be verified. * - ``key_file`` = ``None`` - - (StrOpt) Optional PEM-formatted file that contains the private key. + - (String) Optional PEM-formatted file that contains the private key. * - ``url`` = - - (StrOpt) Optional heat url in format like http://0.0.0.0:8004/v1/%(tenant_id)s. + - (String) Optional heat url in format like http://0.0.0.0:8004/v1/%(tenant_id)s. diff --git a/doc/config-reference/source/tables/heat-clients_keystone.rst b/doc/config-reference/source/tables/heat-clients_keystone.rst index 762280cbcb..bd9a8da7e5 100644 --- a/doc/config-reference/source/tables/heat-clients_keystone.rst +++ b/doc/config-reference/source/tables/heat-clients_keystone.rst @@ -19,14 +19,14 @@ * - **[clients_keystone]** - * - ``auth_uri`` = - - (StrOpt) Unversioned keystone url in format like http://0.0.0.0:5000. + - (String) Unversioned keystone url in format like http://0.0.0.0:5000. * - ``ca_file`` = ``None`` - - (StrOpt) Optional CA cert file to use in SSL connections. + - (String) Optional CA cert file to use in SSL connections. * - ``cert_file`` = ``None`` - - (StrOpt) Optional PEM-formatted certificate chain file. + - (String) Optional PEM-formatted certificate chain file. * - ``endpoint_type`` = ``None`` - - (StrOpt) Type of endpoint in Identity service catalog to use for communication with the OpenStack service. + - (String) Type of endpoint in Identity service catalog to use for communication with the OpenStack service. * - ``insecure`` = ``None`` - - (BoolOpt) If set, then the server's certificate will not be verified. + - (Boolean) If set, then the server's certificate will not be verified. * - ``key_file`` = ``None`` - - (StrOpt) Optional PEM-formatted file that contains the private key. + - (String) Optional PEM-formatted file that contains the private key. diff --git a/doc/config-reference/source/tables/heat-clients_neutron.rst b/doc/config-reference/source/tables/heat-clients_neutron.rst index 085886bcd7..6e0bc82bf1 100644 --- a/doc/config-reference/source/tables/heat-clients_neutron.rst +++ b/doc/config-reference/source/tables/heat-clients_neutron.rst @@ -19,12 +19,12 @@ * - **[clients_neutron]** - * - ``ca_file`` = ``None`` - - (StrOpt) Optional CA cert file to use in SSL connections. + - (String) Optional CA cert file to use in SSL connections. * - ``cert_file`` = ``None`` - - (StrOpt) Optional PEM-formatted certificate chain file. + - (String) Optional PEM-formatted certificate chain file. * - ``endpoint_type`` = ``None`` - - (StrOpt) Type of endpoint in Identity service catalog to use for communication with the OpenStack service. + - (String) Type of endpoint in Identity service catalog to use for communication with the OpenStack service. * - ``insecure`` = ``None`` - - (BoolOpt) If set, then the server's certificate will not be verified. + - (Boolean) If set, then the server's certificate will not be verified. * - ``key_file`` = ``None`` - - (StrOpt) Optional PEM-formatted file that contains the private key. + - (String) Optional PEM-formatted file that contains the private key. diff --git a/doc/config-reference/source/tables/heat-clients_nova.rst b/doc/config-reference/source/tables/heat-clients_nova.rst index 46b9bddb44..57a3c804b9 100644 --- a/doc/config-reference/source/tables/heat-clients_nova.rst +++ b/doc/config-reference/source/tables/heat-clients_nova.rst @@ -19,14 +19,14 @@ * - **[clients_nova]** - * - ``ca_file`` = ``None`` - - (StrOpt) Optional CA cert file to use in SSL connections. + - (String) Optional CA cert file to use in SSL connections. * - ``cert_file`` = ``None`` - - (StrOpt) Optional PEM-formatted certificate chain file. + - (String) Optional PEM-formatted certificate chain file. * - ``endpoint_type`` = ``None`` - - (StrOpt) Type of endpoint in Identity service catalog to use for communication with the OpenStack service. + - (String) Type of endpoint in Identity service catalog to use for communication with the OpenStack service. * - ``http_log_debug`` = ``False`` - - (BoolOpt) Allow client's debug log output. + - (Boolean) Allow client's debug log output. * - ``insecure`` = ``None`` - - (BoolOpt) If set, then the server's certificate will not be verified. + - (Boolean) If set, then the server's certificate will not be verified. * - ``key_file`` = ``None`` - - (StrOpt) Optional PEM-formatted file that contains the private key. + - (String) Optional PEM-formatted file that contains the private key. diff --git a/doc/config-reference/source/tables/heat-clients_sahara.rst b/doc/config-reference/source/tables/heat-clients_sahara.rst index e709f19657..160b97292a 100644 --- a/doc/config-reference/source/tables/heat-clients_sahara.rst +++ b/doc/config-reference/source/tables/heat-clients_sahara.rst @@ -19,12 +19,12 @@ * - **[clients_sahara]** - * - ``ca_file`` = ``None`` - - (StrOpt) Optional CA cert file to use in SSL connections. + - (String) Optional CA cert file to use in SSL connections. * - ``cert_file`` = ``None`` - - (StrOpt) Optional PEM-formatted certificate chain file. + - (String) Optional PEM-formatted certificate chain file. * - ``endpoint_type`` = ``None`` - - (StrOpt) Type of endpoint in Identity service catalog to use for communication with the OpenStack service. + - (String) Type of endpoint in Identity service catalog to use for communication with the OpenStack service. * - ``insecure`` = ``None`` - - (BoolOpt) If set, then the server's certificate will not be verified. + - (Boolean) If set, then the server's certificate will not be verified. * - ``key_file`` = ``None`` - - (StrOpt) Optional PEM-formatted file that contains the private key. + - (String) Optional PEM-formatted file that contains the private key. diff --git a/doc/config-reference/source/tables/heat-clients_swift.rst b/doc/config-reference/source/tables/heat-clients_swift.rst index 8c0639589a..ee66b29bee 100644 --- a/doc/config-reference/source/tables/heat-clients_swift.rst +++ b/doc/config-reference/source/tables/heat-clients_swift.rst @@ -19,12 +19,12 @@ * - **[clients_swift]** - * - ``ca_file`` = ``None`` - - (StrOpt) Optional CA cert file to use in SSL connections. + - (String) Optional CA cert file to use in SSL connections. * - ``cert_file`` = ``None`` - - (StrOpt) Optional PEM-formatted certificate chain file. + - (String) Optional PEM-formatted certificate chain file. * - ``endpoint_type`` = ``None`` - - (StrOpt) Type of endpoint in Identity service catalog to use for communication with the OpenStack service. + - (String) Type of endpoint in Identity service catalog to use for communication with the OpenStack service. * - ``insecure`` = ``None`` - - (BoolOpt) If set, then the server's certificate will not be verified. + - (Boolean) If set, then the server's certificate will not be verified. * - ``key_file`` = ``None`` - - (StrOpt) Optional PEM-formatted file that contains the private key. + - (String) Optional PEM-formatted file that contains the private key. diff --git a/doc/config-reference/source/tables/heat-clients_trove.rst b/doc/config-reference/source/tables/heat-clients_trove.rst index 650af565f3..f7ef76cb70 100644 --- a/doc/config-reference/source/tables/heat-clients_trove.rst +++ b/doc/config-reference/source/tables/heat-clients_trove.rst @@ -19,12 +19,12 @@ * - **[clients_trove]** - * - ``ca_file`` = ``None`` - - (StrOpt) Optional CA cert file to use in SSL connections. + - (String) Optional CA cert file to use in SSL connections. * - ``cert_file`` = ``None`` - - (StrOpt) Optional PEM-formatted certificate chain file. + - (String) Optional PEM-formatted certificate chain file. * - ``endpoint_type`` = ``None`` - - (StrOpt) Type of endpoint in Identity service catalog to use for communication with the OpenStack service. + - (String) Type of endpoint in Identity service catalog to use for communication with the OpenStack service. * - ``insecure`` = ``None`` - - (BoolOpt) If set, then the server's certificate will not be verified. + - (Boolean) If set, then the server's certificate will not be verified. * - ``key_file`` = ``None`` - - (StrOpt) Optional PEM-formatted file that contains the private key. + - (String) Optional PEM-formatted file that contains the private key. diff --git a/doc/config-reference/source/tables/heat-cloudwatch_api.rst b/doc/config-reference/source/tables/heat-cloudwatch_api.rst index c98db06669..648c06d74e 100644 --- a/doc/config-reference/source/tables/heat-cloudwatch_api.rst +++ b/doc/config-reference/source/tables/heat-cloudwatch_api.rst @@ -19,24 +19,24 @@ * - **[DEFAULT]** - * - ``enable_cloud_watch_lite`` = ``False`` - - (BoolOpt) Enable the legacy OS::Heat::CWLiteAlarm resource. + - (Boolean) Enable the legacy OS::Heat::CWLiteAlarm resource. * - ``heat_watch_server_url`` = - - (StrOpt) URL of the Heat CloudWatch server. + - (String) URL of the Heat CloudWatch server. * - **[heat_api_cloudwatch]** - * - ``backlog`` = ``4096`` - - (IntOpt) Number of backlog requests to configure the socket with. + - (Integer) Number of backlog requests to configure the socket with. * - ``bind_host`` = ``0.0.0.0`` - - (IPOpt) Address to bind the server. Useful when selecting a particular network interface. + - (Unknown) Address to bind the server. Useful when selecting a particular network interface. * - ``bind_port`` = ``8003`` - - (PortOpt) The port on which the server will listen. + - (Unknown) The port on which the server will listen. * - ``cert_file`` = ``None`` - - (StrOpt) Location of the SSL certificate file to use for SSL mode. + - (String) Location of the SSL certificate file to use for SSL mode. * - ``key_file`` = ``None`` - - (StrOpt) Location of the SSL key file to use for enabling SSL mode. + - (String) Location of the SSL key file to use for enabling SSL mode. * - ``max_header_line`` = ``16384`` - - (IntOpt) Maximum line size of message headers to be accepted. max_header_line may need to be increased when using large tokens (typically those generated by the Keystone v3 API with big service catalogs.) + - (Integer) Maximum line size of message headers to be accepted. max_header_line may need to be increased when using large tokens (typically those generated by the Keystone v3 API with big service catalogs.) * - ``tcp_keepidle`` = ``600`` - - (IntOpt) The value for the socket option TCP_KEEPIDLE. This is the time in seconds that the connection must be idle before TCP starts sending keepalive probes. - * - ``workers`` = ``0`` - - (IntOpt) Number of workers for Heat service. + - (Integer) The value for the socket option TCP_KEEPIDLE. This is the time in seconds that the connection must be idle before TCP starts sending keepalive probes. + * - ``workers`` = ``1`` + - (Integer) Number of workers for Heat service. diff --git a/doc/config-reference/source/tables/heat-common.rst b/doc/config-reference/source/tables/heat-common.rst index 70568b0667..fdff44d659 100644 --- a/doc/config-reference/source/tables/heat-common.rst +++ b/doc/config-reference/source/tables/heat-common.rst @@ -18,79 +18,87 @@ - Description * - **[DEFAULT]** - + * - ``client_retry_limit`` = ``2`` + - (Integer) Number of times to retry when a client encounters an expected intermittent error. Set to 0 to disable retries. * - ``convergence_engine`` = ``False`` - - (BoolOpt) Enables engine with convergence architecture. All stacks with this option will be created using convergence engine . + - (Boolean) Enables engine with convergence architecture. All stacks with this option will be created using convergence engine. * - ``default_deployment_signal_transport`` = ``CFN_SIGNAL`` - - (StrOpt) Template default for how the server should signal to heat with the deployment output values. CFN_SIGNAL will allow an HTTP POST to a CFN keypair signed URL (requires enabled heat-api-cfn). TEMP_URL_SIGNAL will create a Swift TempURL to be signaled via HTTP PUT (requires object-store endpoint which supports TempURL). HEAT_SIGNAL will allow calls to the Heat API resource-signal using the provided keystone credentials. ZAQAR_SIGNAL will create a dedicated zaqar queue to be signaled using the provided keystone credentials. + - (String) Template default for how the server should signal to heat with the deployment output values. CFN_SIGNAL will allow an HTTP POST to a CFN keypair signed URL (requires enabled heat-api-cfn). TEMP_URL_SIGNAL will create a Swift TempURL to be signaled via HTTP PUT (requires object-store endpoint which supports TempURL). HEAT_SIGNAL will allow calls to the Heat API resource-signal using the provided keystone credentials. ZAQAR_SIGNAL will create a dedicated zaqar queue to be signaled using the provided keystone credentials. * - ``default_software_config_transport`` = ``POLL_SERVER_CFN`` - - (StrOpt) Template default for how the server should receive the metadata required for software configuration. POLL_SERVER_CFN will allow calls to the cfn API action DescribeStackResource authenticated with the provided keypair (requires enabled heat-api-cfn). POLL_SERVER_HEAT will allow calls to the Heat API resource-show using the provided keystone credentials (requires keystone v3 API, and configured stack_user_* config options). POLL_TEMP_URL will create and populate a Swift TempURL with metadata for polling (requires object-store endpoint which supports TempURL).ZAQAR_MESSAGE will create a dedicated zaqar queue and post the metadata for polling. + - (String) Template default for how the server should receive the metadata required for software configuration. POLL_SERVER_CFN will allow calls to the cfn API action DescribeStackResource authenticated with the provided keypair (requires enabled heat-api-cfn). POLL_SERVER_HEAT will allow calls to the Heat API resource-show using the provided keystone credentials (requires keystone v3 API, and configured stack_user_* config options). POLL_TEMP_URL will create and populate a Swift TempURL with metadata for polling (requires object-store endpoint which supports TempURL).ZAQAR_MESSAGE will create a dedicated zaqar queue and post the metadata for polling. * - ``deferred_auth_method`` = ``trusts`` - - (StrOpt) Select deferred auth method, stored password or trusts. + - (String) Select deferred auth method, stored password or trusts. * - ``environment_dir`` = ``/etc/heat/environment.d`` - - (StrOpt) The directory to search for environment files. + - (String) The directory to search for environment files. * - ``error_wait_time`` = ``240`` - - (IntOpt) Error wait time in seconds for stack action (ie. create or update). + - (Integer) Error wait time in seconds for stack action (ie. create or update). * - ``event_purge_batch_size`` = ``10`` - - (IntOpt) Controls how many events will be pruned whenever a stack's events exceed max_events_per_stack. Set this lower to keep more events at the expense of more frequent purges. + - (Integer) Controls how many events will be pruned whenever a stack's events exceed max_events_per_stack. Set this lower to keep more events at the expense of more frequent purges. * - ``executor_thread_pool_size`` = ``64`` - - (IntOpt) Size of executor thread pool. + - (Integer) Size of executor thread pool. * - ``host`` = ``localhost`` - - (StrOpt) Name of the engine node. This can be an opaque identifier. It is not necessarily a hostname, FQDN, or IP address. + - (String) Name of the engine node. This can be an opaque identifier. It is not necessarily a hostname, FQDN, or IP address. * - ``keystone_backend`` = ``heat.common.heat_keystoneclient.KeystoneClientV3`` - - (StrOpt) Fully qualified class name to use as a keystone backend. + - (String) Fully qualified class name to use as a keystone backend. + * - ``max_interface_check_attempts`` = ``10`` + - (Integer) Number of times to check whether an interface has been attached or detached. * - ``memcached_servers`` = ``None`` - - (ListOpt) Memcached servers or None for in process cache. - * - ``password`` = - - (StrOpt) Password for Redis server (optional). + - (List) Memcached servers or None for in process cache. * - ``periodic_interval`` = ``60`` - - (IntOpt) Seconds between running periodic tasks. + - (Integer) Seconds between running periodic tasks. * - ``plugin_dirs`` = ``/usr/lib64/heat, /usr/lib/heat, /usr/local/lib/heat, /usr/local/lib64/heat`` - - (ListOpt) List of directories to search for plug-ins. - * - ``port`` = ``6379`` - - (IntOpt) Use this port to connect to redis host. + - (List) List of directories to search for plug-ins. + * - ``reauthentication_auth_method`` = + - (String) Allow reauthentication on token expiry, such that long-running tasks may complete. Note this defeats the expiry of any provided user tokens. * - ``watch_log_file`` = ``False`` - - (BoolOpt) (Optional) 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. * - **[cache]** - * - ``backend`` = ``dogpile.cache.null`` - - (StrOpt) Dogpile.cache backend module. It is recommended that Memcache with pooling (oslo_cache.memcache_pool) or Redis (dogpile.cache.redis) be used in production deployments. Small workloads (single process) like devstack can use the dogpile.cache.memory backend. + - (String) Dogpile.cache backend module. It is recommended that Memcache with pooling (oslo_cache.memcache_pool) or Redis (dogpile.cache.redis) be used in production deployments. Small workloads (single process) like devstack can use the dogpile.cache.memory backend. * - ``backend_argument`` = ``[]`` - - (MultiStrOpt) Arguments supplied to the backend module. Specify this option once per argument to be passed to the dogpile.cache backend. Example format: ":". + - (Multi-valued) Arguments supplied to the backend module. Specify this option once per argument to be passed to the dogpile.cache backend. Example format: ":". * - ``config_prefix`` = ``cache.oslo`` - - (StrOpt) Prefix for building the configuration dictionary for the cache region. This should not need to be changed unless there is another dogpile.cache region with the same configuration name. + - (String) Prefix for building the configuration dictionary for the cache region. This should not need to be changed unless there is another dogpile.cache region with the same configuration name. * - ``debug_cache_backend`` = ``False`` - - (BoolOpt) Extra debugging from the cache backend (cache keys, get/set/delete/etc calls). This is only really useful if you need to see the specific cache-backend get/set/delete calls with the keys/values. Typically this should be left set to false. + - (Boolean) Extra debugging from the cache backend (cache keys, get/set/delete/etc calls). This is only really useful if you need to see the specific cache-backend get/set/delete calls with the keys/values. Typically this should be left set to false. * - ``enabled`` = ``False`` - - (BoolOpt) Global toggle for caching. + - (Boolean) Global toggle for caching. * - ``expiration_time`` = ``600`` - - (IntOpt) Default TTL, in seconds, for any cached item in the dogpile.cache region. This applies to any cached method that doesn't have an explicit cache expiration time defined for it. + - (Integer) Default TTL, in seconds, for any cached item in the dogpile.cache region. This applies to any cached method that doesn't have an explicit cache expiration time defined for it. * - ``memcache_dead_retry`` = ``300`` - - (IntOpt) Number of seconds memcached server is considered dead before it is tried again. (dogpile.cache.memcache and oslo_cache.memcache_pool backends only). + - (Integer) Number of seconds memcached server is considered dead before it is tried again. (dogpile.cache.memcache and oslo_cache.memcache_pool backends only). * - ``memcache_pool_connection_get_timeout`` = ``10`` - - (IntOpt) Number of seconds that an operation will wait to get a memcache client connection. + - (Integer) Number of seconds that an operation will wait to get a memcache client connection. * - ``memcache_pool_maxsize`` = ``10`` - - (IntOpt) Max total number of open connections to every memcached server. (oslo_cache.memcache_pool backend only). + - (Integer) Max total number of open connections to every memcached server. (oslo_cache.memcache_pool backend only). * - ``memcache_pool_unused_timeout`` = ``60`` - - (IntOpt) Number of seconds a connection to memcached is held unused in the pool before it is closed. (oslo_cache.memcache_pool backend only). + - (Integer) Number of seconds a connection to memcached is held unused in the pool before it is closed. (oslo_cache.memcache_pool backend only). * - ``memcache_servers`` = ``localhost:11211`` - - (ListOpt) Memcache servers in the format of "host:port". (dogpile.cache.memcache and oslo_cache.memcache_pool backends only). + - (List) Memcache servers in the format of "host:port". (dogpile.cache.memcache and oslo_cache.memcache_pool backends only). * - ``memcache_socket_timeout`` = ``3`` - - (IntOpt) Timeout in seconds for every call to a server. (dogpile.cache.memcache and oslo_cache.memcache_pool backends only). + - (Integer) Timeout in seconds for every call to a server. (dogpile.cache.memcache and oslo_cache.memcache_pool backends only). * - ``proxies`` = - - (ListOpt) Proxy classes to import that will affect the way the dogpile.cache backend functions. See the dogpile.cache documentation on changing-backend-behavior. + - (List) Proxy classes to import that will affect the way the dogpile.cache backend functions. See the dogpile.cache documentation on changing-backend-behavior. * - **[constraint_validation_cache]** - * - ``caching`` = ``True`` - - (BoolOpt) Toggle to enable/disable caching when Orchestration Engine validates property constraints of stack.During property validation with constraints Orchestration Engine caches requests to other OpenStack services. Please note that the global toggle for oslo.cache(enabled=True in [cache] group) must be enabled to use this feature. + - (Boolean) Toggle to enable/disable caching when Orchestration Engine validates property constraints of stack.During property validation with constraints Orchestration Engine caches requests to other OpenStack services. Please note that the global toggle for oslo.cache(enabled=True in [cache] group) must be enabled to use this feature. * - ``expiration_time`` = ``60`` - - (IntOpt) TTL, in seconds, for any cached item in the dogpile.cache region used for caching of validation constraints. + - (Integer) TTL, in seconds, for any cached item in the dogpile.cache region used for caching of validation constraints. + * - **[resource_finder_cache]** + - + * - ``caching`` = ``True`` + - (Boolean) Toggle to enable/disable caching when Orchestration Engine looks for other OpenStack service resources using name or id. Please note that the global toggle for oslo.cache(enabled=True in [cache] group) must be enabled to use this feature. + * - ``expiration_time`` = ``3600`` + - (Integer) TTL, in seconds, for any cached item in the dogpile.cache region used for caching of OpenStack service finder functions. * - **[revision]** - * - ``heat_revision`` = ``unknown`` - - (StrOpt) Heat build revision. If you would prefer to manage your build revision separately, you can move this section to a different file and add it as another config option. + - (String) Heat build revision. If you would prefer to manage your build revision separately, you can move this section to a different file and add it as another config option. * - **[service_extension_cache]** - * - ``caching`` = ``True`` - - (BoolOpt) Toggle to enable/disable caching when Orchestration Engine retrieves extensions from other OpenStack services. Please note that the global toggle for oslo.cache(enabled=True in [cache] group) must be enabled to use this feature. + - (Boolean) Toggle to enable/disable caching when Orchestration Engine retrieves extensions from other OpenStack services. Please note that the global toggle for oslo.cache(enabled=True in [cache] group) must be enabled to use this feature. * - ``expiration_time`` = ``3600`` - - (IntOpt) TTL, in seconds, for any cached item in the dogpile.cache region used for caching of service extensions. + - (Integer) TTL, in seconds, for any cached item in the dogpile.cache region used for caching of service extensions. diff --git a/doc/config-reference/source/tables/heat-cors.rst b/doc/config-reference/source/tables/heat-cors.rst index d1df7fd451..029fe558de 100644 --- a/doc/config-reference/source/tables/heat-cors.rst +++ b/doc/config-reference/source/tables/heat-cors.rst @@ -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. diff --git a/doc/config-reference/source/tables/heat-crypt.rst b/doc/config-reference/source/tables/heat-crypt.rst index eb927da62d..c9b0e2d7a8 100644 --- a/doc/config-reference/source/tables/heat-crypt.rst +++ b/doc/config-reference/source/tables/heat-crypt.rst @@ -19,4 +19,4 @@ * - **[DEFAULT]** - * - ``auth_encryption_key`` = ``notgood but just long enough i t`` - - (StrOpt) Key used to encrypt authentication info in the database. Length of this key must be 32 characters. + - (String) Key used to encrypt authentication info in the database. Length of this key must be 32 characters. diff --git a/doc/config-reference/source/tables/heat-database.rst b/doc/config-reference/source/tables/heat-database.rst index 9136c589ce..ae2ba27349 100644 --- a/doc/config-reference/source/tables/heat-database.rst +++ b/doc/config-reference/source/tables/heat-database.rst @@ -19,42 +19,42 @@ * - **[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. diff --git a/doc/config-reference/source/tables/heat-loadbalancer.rst b/doc/config-reference/source/tables/heat-loadbalancer.rst index 7532eea475..ad872dd815 100644 --- a/doc/config-reference/source/tables/heat-loadbalancer.rst +++ b/doc/config-reference/source/tables/heat-loadbalancer.rst @@ -19,4 +19,4 @@ * - **[DEFAULT]** - * - ``loadbalancer_template`` = ``None`` - - (StrOpt) Custom template for the built-in loadbalancer nested stack. + - (String) Custom template for the built-in loadbalancer nested stack. diff --git a/doc/config-reference/source/tables/heat-logging.rst b/doc/config-reference/source/tables/heat-logging.rst index 331ab3a917..aaa41e763e 100644 --- a/doc/config-reference/source/tables/heat-logging.rst +++ b/doc/config-reference/source/tables/heat-logging.rst @@ -19,42 +19,40 @@ * - **[DEFAULT]** - * - ``debug`` = ``False`` - - (BoolOpt) Print debugging output (set logging level to DEBUG instead of 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`` - - (ListOpt) List of logger=LEVEL pairs. This option is ignored if log_config_append is set. + - (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`` + - (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. + - (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) 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 output to. If no default is set, logging will go to stdout. 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) Data to append to log format when level 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 without context. + - (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) Format string for user_identity field of the 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) (Optional) Enables or disables syslog rfc5424 format for logging. If enabled, prefixes the MSG part of the syslog message with APP-NAME (RFC5424). The format without the APP-NAME is deprecated in Kilo, and will be removed in Mitaka, along with this option. 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, will disable INFO logging level, making WARNING the default. + - (Boolean) DEPRECATED: If set to false, the logging level will be set to WARNING instead of the default INFO level. diff --git a/doc/config-reference/source/tables/heat-metadata_api.rst b/doc/config-reference/source/tables/heat-metadata_api.rst index cc3d341647..7fea68beeb 100644 --- a/doc/config-reference/source/tables/heat-metadata_api.rst +++ b/doc/config-reference/source/tables/heat-metadata_api.rst @@ -18,5 +18,5 @@ - Description * - **[DEFAULT]** - - * - ``heat_metadata_server_url`` = - - (StrOpt) URL of the Heat metadata server. + * - ``heat_metadata_server_url`` = ``None`` + - (String) URL of the Heat metadata server. NOTE: Setting this is only needed if you require instances to use a different endpoint than in the keystone catalog diff --git a/doc/config-reference/source/tables/heat-notification.rst b/doc/config-reference/source/tables/heat-notification.rst index 3f174bc9b0..aeb67e4636 100644 --- a/doc/config-reference/source/tables/heat-notification.rst +++ b/doc/config-reference/source/tables/heat-notification.rst @@ -19,4 +19,4 @@ * - **[DEFAULT]** - * - ``onready`` = ``None`` - - (StrOpt) Deprecated. + - (String) Deprecated. diff --git a/doc/config-reference/source/tables/heat-qpid.rst b/doc/config-reference/source/tables/heat-qpid.rst deleted file mode 100644 index 4df34acd39..0000000000 --- a/doc/config-reference/source/tables/heat-qpid.rst +++ /dev/null @@ -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. - -.. _heat-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. diff --git a/doc/config-reference/source/tables/heat-quota.rst b/doc/config-reference/source/tables/heat-quota.rst index 74c377e549..57e9b23e1e 100644 --- a/doc/config-reference/source/tables/heat-quota.rst +++ b/doc/config-reference/source/tables/heat-quota.rst @@ -19,12 +19,12 @@ * - **[DEFAULT]** - * - ``max_events_per_stack`` = ``1000`` - - (IntOpt) Maximum events that will be available per stack. Older events will be deleted when this is reached. Set to 0 for unlimited events per stack. + - (Integer) Maximum events that will be available per stack. Older events will be deleted when this is reached. Set to 0 for unlimited events per stack. * - ``max_nested_stack_depth`` = ``5`` - - (IntOpt) Maximum depth allowed when using nested stacks. + - (Integer) Maximum depth allowed when using nested stacks. * - ``max_resources_per_stack`` = ``1000`` - - (IntOpt) Maximum resources allowed per top-level stack. -1 stands for unlimited. + - (Integer) Maximum resources allowed per top-level stack. -1 stands for unlimited. * - ``max_stacks_per_tenant`` = ``100`` - - (IntOpt) Maximum number of stacks any one tenant may have active at one time. + - (Integer) Maximum number of stacks any one tenant may have active at one time. * - ``max_template_size`` = ``524288`` - - (IntOpt) Maximum raw byte size of any template. + - (Integer) Maximum raw byte size of any template. diff --git a/doc/config-reference/source/tables/heat-rabbitmq.rst b/doc/config-reference/source/tables/heat-rabbitmq.rst index 2c0efa1e9b..d85390142e 100644 --- a/doc/config-reference/source/tables/heat-rabbitmq.rst +++ b/doc/config-reference/source/tables/heat-rabbitmq.rst @@ -19,50 +19,112 @@ * - **[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`` + - (String) EXPERIMENTAL: Possible values are: gzip, bz2. If not set compression will not be used. This option may notbe available in future versions. + * - ``kombu_failover_strategy`` = ``round-robin`` + - (String) Determines how the next RabbitMQ node is chosen in case the one we are currently connected to becomes unavailable. Takes effect only if more than one RabbitMQ node is provided in config. + * - ``kombu_missing_consumer_retry_timeout`` = ``60`` + - (Integer) How long to wait a missing client 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. - * - ``kombu_reconnect_timeout`` = ``60`` - - (IntOpt) How long to wait before considering a reconnect attempt to have failed. This value should not be longer than rpc_response_timeout. + - (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`` + - (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`` - - (IntOpt) 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`` + - (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. + - (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. - * - ``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. + - (String) The RabbitMQ virtual host. + * - ``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 diff --git a/doc/config-reference/source/tables/heat-redis.rst b/doc/config-reference/source/tables/heat-redis.rst index b55f553101..522ebe0c05 100644 --- a/doc/config-reference/source/tables/heat-redis.rst +++ b/doc/config-reference/source/tables/heat-redis.rst @@ -18,9 +18,19 @@ - Description * - **[matchmaker_redis]** - + * - ``check_timeout`` = ``20000`` + - (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`` - - (IntOpt) Use this port to connect to redis host. + - (Unknown) Use this port to connect to redis host. + * - ``sentinel_group_name`` = ``oslo-messaging-zeromq`` + - (String) Redis replica set name. + * - ``sentinel_hosts`` = + - (List) List of Redis Sentinel hosts (fault tolerance mode) e.g. [host:port, host1:port ... ] + * - ``socket_timeout`` = ``1000`` + - (Integer) Timeout in ms on blocking socket operations + * - ``wait_timeout`` = ``500`` + - (Integer) Time in ms to wait between connection attempts. diff --git a/doc/config-reference/source/tables/heat-rpc.rst b/doc/config-reference/source/tables/heat-rpc.rst index 5df3e21e33..78db7ac8db 100644 --- a/doc/config-reference/source/tables/heat-rpc.rst +++ b/doc/config-reference/source/tables/heat-rpc.rst @@ -19,54 +19,62 @@ * - **[DEFAULT]** - * - ``engine_life_check_timeout`` = ``2`` - - (IntOpt) RPC timeout for the engine liveness check that is used for stack locking. + - (Integer) RPC timeout for the engine liveness check that is used for stack locking. * - ``rpc_backend`` = ``rabbit`` - - (StrOpt) The messaging driver to use, defaults to rabbit. Other drivers include qpid and zmq. - * - ``rpc_cast_timeout`` = ``30`` - - (IntOpt) Seconds to wait before a cast expires (TTL). Only supported by impl_zmq. + - (String) The messaging driver to use, defaults to rabbit. Other drivers include amqp and zmq. + * - ``rpc_cast_timeout`` = ``-1`` + - (Integer) Seconds to wait before a cast expires (TTL). The default value of -1 specifies an infinite linger period. The value of 0 specifies no linger period. Pending messages shall be discarded immediately when the socket is closed. Only supported by impl_zmq. * - ``rpc_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_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`` = ``[]`` + - (Multi-valued) The Drivers(s) to handle sending notifications. Possible values are messaging, messagingv2, routing, log, test, noop + * - ``topics`` = ``notifications`` + - (List) AMQP topic used for OpenStack notifications. + * - ``transport_url`` = ``None`` + - (String) A URL representing the messaging driver to use for notifications. If not set, we fall back to the same configuration used for RPC. diff --git a/doc/config-reference/source/tables/heat-testing.rst b/doc/config-reference/source/tables/heat-testing.rst index ab458dc141..c3c36457a0 100644 --- a/doc/config-reference/source/tables/heat-testing.rst +++ b/doc/config-reference/source/tables/heat-testing.rst @@ -19,8 +19,6 @@ * - **[profiler]** - * - ``hmac_keys`` = ``SECRET_KEY`` - - (StrOpt) Secret key to use to sign tracing messages. - * - ``profiler_enabled`` = ``False`` - - (BoolOpt) If False fully disable profiling feature. + - (String) Secret key(s) to use for encrypting context data for performance profiling. This string value should have the following format: [,,...], where each key is some random string. A user who triggers the profiling via the REST API has to set one of these keys in the headers of the REST API call to include profiling results of this node for this particular project. Both "enabled" flag and "hmac_keys" config options should be set to enable profiling. Also, to generate correct profiling information across all services at least one key needs to be consistent between OpenStack projects. This ensures it can be used from client side to generate the trace, containing information from all possible resources. * - ``trace_sqlalchemy`` = ``False`` - - (BoolOpt) If False do not trace SQL requests. + - (Boolean) Enables SQL requests profiling in services. Default value is False (SQL requests won't be traced). Possible values: * True: Enables SQL requests profiling. Each SQL query will be part of the trace and can the be analyzed by how much time was spent for that. * False: Disables SQL requests profiling. The spent time is only shown on a higher level of operations. Single SQL queries cannot be analyzed this way. diff --git a/doc/config-reference/source/tables/heat-trustee.rst b/doc/config-reference/source/tables/heat-trustee.rst index 081149c4d1..0397b14cce 100644 --- a/doc/config-reference/source/tables/heat-trustee.rst +++ b/doc/config-reference/source/tables/heat-trustee.rst @@ -19,6 +19,6 @@ * - **[trustee]** - * - ``auth_plugin`` = ``None`` - - (StrOpt) Name of the plugin to load + - (String) Name of the plugin to load * - ``auth_section`` = ``None`` - - (StrOpt) Config Section from which to load plugin specific options + - (String) Config Section from which to load plugin specific options diff --git a/doc/config-reference/source/tables/heat-waitcondition_api.rst b/doc/config-reference/source/tables/heat-waitcondition_api.rst index c2bf834ef4..5ee22036af 100644 --- a/doc/config-reference/source/tables/heat-waitcondition_api.rst +++ b/doc/config-reference/source/tables/heat-waitcondition_api.rst @@ -19,4 +19,4 @@ * - **[DEFAULT]** - * - ``heat_waitcondition_server_url`` = ``None`` - - (StrOpt) URL of the Heat waitcondition server. + - (String) URL of the Heat waitcondition server. diff --git a/doc/config-reference/source/tables/heat-zeromq.rst b/doc/config-reference/source/tables/heat-zeromq.rst index 7494b5d58f..b925c5fa87 100644 --- a/doc/config-reference/source/tables/heat-zeromq.rst +++ b/doc/config-reference/source/tables/heat-zeromq.rst @@ -18,27 +18,27 @@ - Description * - **[DEFAULT]** - - * - ``rpc_zmq_all_req_rep`` = ``True`` - - (BoolOpt) Use REQ/REP pattern for all methods CALL/CAST/FANOUT. * - ``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`` - - (IntOpt) 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. - * - ``zmq_use_broker`` = ``True`` - - (BoolOpt) Shows whether zmq-messaging uses broker or not. + - (Integer) Maximum number of ingress messages to locally buffer per topic. Default is unlimited. + * - ``use_pub_sub`` = ``True`` + - (Boolean) Use PUB/SUB pattern for fanout methods. PUB/SUB always uses proxy. + * - ``zmq_target_expire`` = ``120`` + - (Integer) Expiration timeout in seconds of a name service record about existing target ( < 0 means no timeout). diff --git a/doc/config-reference/source/tables/ironic-agent.rst b/doc/config-reference/source/tables/ironic-agent.rst index 83f5e3e656..3a8217e389 100644 --- a/doc/config-reference/source/tables/ironic-agent.rst +++ b/doc/config-reference/source/tables/ironic-agent.rst @@ -19,18 +19,20 @@ * - **[agent]** - * - ``agent_api_version`` = ``v1`` - - (StrOpt) API version to use for communicating with the ramdisk agent. + - (String) API version to use for communicating with the ramdisk agent. * - ``agent_pxe_append_params`` = ``nofb nomodeset vga=normal`` - - (StrOpt) DEPRECATED. Additional append parameters for baremetal PXE boot. This option is deprecated and will be removed in Mitaka release. Please use [pxe]pxe_append_params instead. + - (String) DEPRECATED. Additional append parameters for baremetal PXE boot. This option is deprecated and will be removed in Mitaka release. Please use [pxe]pxe_append_params instead. * - ``agent_pxe_config_template`` = ``$pybasedir/drivers/modules/agent_config.template`` - - (StrOpt) DEPRECATED. Template file for PXE configuration. This option is deprecated and will be removed in Mitaka release. Please use [pxe]pxe_config_template instead. + - (String) DEPRECATED. Template file for PXE configuration. This option is deprecated and will be removed in Mitaka release. Please use [pxe]pxe_config_template instead. * - ``heartbeat_timeout`` = ``300`` - - (IntOpt) Maximum interval (in seconds) for agent heartbeats. + - (Integer) Maximum interval (in seconds) for agent heartbeats. * - ``manage_agent_boot`` = ``True`` - - (BoolOpt) Whether Ironic will manage booting of the agent ramdisk. If set to False, you will need to configure your mechanism to allow booting the agent ramdisk. + - (Boolean) Whether Ironic will manage booting of the agent ramdisk. If set to False, you will need to configure your mechanism to allow booting the agent ramdisk. * - ``memory_consumed_by_agent`` = ``0`` - - (IntOpt) The memory size in MiB consumed by agent when it is booted on a bare metal node. This is used for checking if the image can be downloaded and deployed on the bare metal node after booting agent ramdisk. This may be set according to the memory consumed by the agent ramdisk image. + - (Integer) The memory size in MiB consumed by agent when it is booted on a bare metal node. This is used for checking if the image can be downloaded and deployed on the bare metal node after booting agent ramdisk. This may be set according to the memory consumed by the agent ramdisk image. * - ``post_deploy_get_power_state_retries`` = ``6`` - - (IntOpt) Number of times to retry getting power state to check if bare metal node has been powered off after a soft power off. + - (Integer) Number of times to retry getting power state to check if bare metal node has been powered off after a soft power off. * - ``post_deploy_get_power_state_retry_interval`` = ``5`` - - (IntOpt) Amount of time (in seconds) to wait between polling power state after trigger soft poweroff. + - (Integer) Amount of time (in seconds) to wait between polling power state after trigger soft poweroff. + * - ``stream_raw_images`` = ``True`` + - (Boolean) Whether the agent ramdisk should stream raw images directly onto the disk or not. By streaming raw images directly onto the disk the agent ramdisk will not spend time copying the image to a tmpfs partition (therefore consuming less memory) prior to writing it to the disk. Unless the disk where the image will be copied to is really slow, this option should be set to True. Defaults to True. diff --git a/doc/config-reference/source/tables/ironic-amqp.rst b/doc/config-reference/source/tables/ironic-amqp.rst index d7f18aeac6..2171f972d1 100644 --- a/doc/config-reference/source/tables/ironic-amqp.rst +++ b/doc/config-reference/source/tables/ironic-amqp.rst @@ -19,12 +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. - * - ``notification_driver`` = ``[]`` - - (MultiStrOpt) The Drivers(s) to handle sending notifications. Possible values are messaging, messagingv2, routing, log, test, noop - * - ``notification_topics`` = ``notifications`` - - (ListOpt) AMQP topic used for OpenStack notifications. - * - ``notification_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) 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. diff --git a/doc/config-reference/source/tables/ironic-amt.rst b/doc/config-reference/source/tables/ironic-amt.rst index 27dfe45673..acab03ba72 100644 --- a/doc/config-reference/source/tables/ironic-amt.rst +++ b/doc/config-reference/source/tables/ironic-amt.rst @@ -19,8 +19,10 @@ * - **[amt]** - * - ``action_wait`` = ``10`` - - (IntOpt) Amount of time (in seconds) to wait, before retrying an AMT operation + - (Integer) Amount of time (in seconds) to wait, before retrying an AMT operation + * - ``awake_interval`` = ``60`` + - (Integer) Time interval (in seconds) for successive awake call to AMT interface, this depends on the IdleTimeout setting on AMT interface. AMT Interface will go to sleep after 60 seconds of inactivity by default. IdleTimeout=0 means AMT will not go to sleep at all. Setting awake_interval=0 will disable awake call. * - ``max_attempts`` = ``3`` - - (IntOpt) Maximum number of times to attempt an AMT operation, before failing + - (Integer) Maximum number of times to attempt an AMT operation, before failing * - ``protocol`` = ``http`` - - (StrOpt) Protocol used for AMT endpoint, support http/https + - (String) Protocol used for AMT endpoint diff --git a/doc/config-reference/source/tables/ironic-api.rst b/doc/config-reference/source/tables/ironic-api.rst index d1c3b6790e..686e20e79d 100644 --- a/doc/config-reference/source/tables/ironic-api.rst +++ b/doc/config-reference/source/tables/ironic-api.rst @@ -19,50 +19,52 @@ * - **[api]** - * - ``api_workers`` = ``None`` - - (IntOpt) Number of workers for OpenStack Ironic API service. The default is equal to the number of CPUs available if that can be determined, else a default worker count of 1 is returned. + - (Integer) Number of workers for OpenStack Ironic API service. The default is equal to the number of CPUs available if that can be determined, else a default worker count of 1 is returned. + * - ``enable_ssl_api`` = ``False`` + - (Boolean) Enable the integrated stand-alone API to service requests via HTTPS instead of HTTP. If there is a front-end service performing HTTPS offloading from the service, this option should be False; note, you will want to change public API endpoint to represent SSL termination URL with 'public_endpoint' option. * - ``host_ip`` = ``0.0.0.0`` - - (StrOpt) The IP address on which ironic-api listens. + - (String) The IP address on which ironic-api listens. * - ``max_limit`` = ``1000`` - - (IntOpt) The maximum number of items returned in a single response from a collection resource. + - (Integer) The maximum number of items returned in a single response from a collection resource. * - ``port`` = ``6385`` - - (PortOpt) The TCP port on which ironic-api listens. + - (Unknown) The TCP port on which ironic-api listens. * - ``public_endpoint`` = ``None`` - - (StrOpt) Public URL to use when building the links to the API resources (for example, "https://ironic.rocks:6384"). If None the links will be built using the request's host URL. If the API is operating behind a proxy, you will want to change this to represent the proxy's URL. Defaults to None. + - (String) Public URL to use when building the links to the API resources (for example, "https://ironic.rocks:6384"). If None the links will be built using the request's host URL. If the API is operating behind a proxy, you will want to change this to represent the proxy's URL. Defaults to None. * - **[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. * - **[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_versionedobjects]** - * - ``fatal_exception_format_errors`` = ``False`` - - (BoolOpt) Make exception message format errors fatal + - (Boolean) Make exception message format errors fatal diff --git a/doc/config-reference/source/tables/ironic-auth.rst b/doc/config-reference/source/tables/ironic-auth.rst index 80c2059b0c..909ce89477 100644 --- a/doc/config-reference/source/tables/ironic-auth.rst +++ b/doc/config-reference/source/tables/ironic-auth.rst @@ -19,4 +19,4 @@ * - **[DEFAULT]** - * - ``auth_strategy`` = ``keystone`` - - (StrOpt) Authentication strategy used by ironic-api: one of "keystone" or "noauth". "noauth" should not be used in a production environment because all authentication will be disabled. + - (String) Authentication strategy used by ironic-api. "noauth" should not be used in a production environment because all authentication will be disabled. diff --git a/doc/config-reference/source/tables/ironic-auth_token.rst b/doc/config-reference/source/tables/ironic-auth_token.rst index 7070804581..bc5e83a4c8 100644 --- a/doc/config-reference/source/tables/ironic-auth_token.rst +++ b/doc/config-reference/source/tables/ironic-auth_token.rst @@ -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. - * - ``auth_plugin`` = ``None`` - - (StrOpt) Name of the plugin to load + - (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 (http or https). Deprecated, use identity_uri. + - (String) Protocol of the admin Identity API endpoint. Deprecated, use identity_uri. * - ``auth_section`` = ``None`` - - (StrOpt) Config Section from which to load plugin specific options + - (Unknown) Config Section from which to load plugin specific options + * - ``auth_type`` = ``None`` + - (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. Acceptable values are MAC or ENCRYPT. 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. diff --git a/doc/config-reference/source/tables/ironic-cisco_ucs.rst b/doc/config-reference/source/tables/ironic-cisco_ucs.rst index 92b83f7413..0bf54c5f96 100644 --- a/doc/config-reference/source/tables/ironic-cisco_ucs.rst +++ b/doc/config-reference/source/tables/ironic-cisco_ucs.rst @@ -19,12 +19,12 @@ * - **[cimc]** - * - ``action_interval`` = ``10`` - - (IntOpt) Amount of time in seconds to wait in between power operations + - (Integer) Amount of time in seconds to wait in between power operations * - ``max_retry`` = ``6`` - - (IntOpt) Number of times a power operation needs to be retried + - (Integer) Number of times a power operation needs to be retried * - **[cisco_ucs]** - * - ``action_interval`` = ``5`` - - (IntOpt) Amount of time in seconds to wait in between power operations + - (Integer) Amount of time in seconds to wait in between power operations * - ``max_retry`` = ``6`` - - (IntOpt) Number of times a power operation needs to be retried + - (Integer) Number of times a power operation needs to be retried diff --git a/doc/config-reference/source/tables/ironic-common.rst b/doc/config-reference/source/tables/ironic-common.rst index b88b9b8915..5048b109fb 100644 --- a/doc/config-reference/source/tables/ironic-common.rst +++ b/doc/config-reference/source/tables/ironic-common.rst @@ -19,42 +19,48 @@ * - **[DEFAULT]** - * - ``bindir`` = ``/usr/local/bin`` - - (StrOpt) Directory where ironic binaries are installed. + - (String) Directory where ironic binaries are installed. * - ``enabled_drivers`` = ``pxe_ipmitool`` - - (ListOpt) Specify the list of drivers to load during service initialization. Missing drivers, or drivers which fail to initialize, will prevent the conductor service from starting. The option default is a recommended set of production-oriented drivers. A complete list of drivers present on your system may be found by enumerating the "ironic.drivers" entrypoint. An example may be found in the developer documentation online. + - (List) Specify the list of drivers to load during service initialization. Missing drivers, or drivers which fail to initialize, will prevent the conductor service from starting. The option default is a recommended set of production-oriented drivers. A complete list of drivers present on your system may be found by enumerating the "ironic.drivers" entrypoint. An example may be found in the developer documentation online. * - ``executor_thread_pool_size`` = ``64`` - - (IntOpt) Size of executor thread pool. + - (Integer) Size of executor thread pool. * - ``fatal_deprecations`` = ``False`` - - (BoolOpt) Enables or disables fatal status of deprecations. + - (Boolean) Enables or disables fatal status of deprecations. * - ``force_raw_images`` = ``True`` - - (BoolOpt) If True, convert backing images to "raw" disk image format. + - (Boolean) If True, convert backing images to "raw" disk image format. * - ``grub_config_template`` = ``$pybasedir/common/grub_conf.template`` - - (StrOpt) Template file for grub configuration file. + - (String) Template file for grub configuration file. * - ``hash_distribution_replicas`` = ``1`` - - (IntOpt) [Experimental Feature] Number of hosts to map onto each hash partition. Setting this to more than one will cause additional conductor services to prepare deployment environments and potentially allow the Ironic cluster to recover more quickly if a conductor instance is terminated. + - (Integer) [Experimental Feature] Number of hosts to map onto each hash partition. Setting this to more than one will cause additional conductor services to prepare deployment environments and potentially allow the Ironic cluster to recover more quickly if a conductor instance is terminated. * - ``hash_partition_exponent`` = ``5`` - - (IntOpt) Exponent to determine number of hash partitions to use when distributing load across conductors. Larger values will result in more even distribution of load and less load when rebalancing the ring, but more memory usage. Number of partitions per conductor is (2^hash_partition_exponent). This determines the granularity of rebalancing: given 10 hosts, and an exponent of the 2, there are 40 partitions in the ring.A few thousand partitions should make rebalancing smooth in most cases. The default is suitable for up to a few hundred conductors. Too many partitions has a CPU impact. + - (Integer) Exponent to determine number of hash partitions to use when distributing load across conductors. Larger values will result in more even distribution of load and less load when rebalancing the ring, but more memory usage. Number of partitions per conductor is (2^hash_partition_exponent). This determines the granularity of rebalancing: given 10 hosts, and an exponent of the 2, there are 40 partitions in the ring.A few thousand partitions should make rebalancing smooth in most cases. The default is suitable for up to a few hundred conductors. Too many partitions has a CPU impact. * - ``hash_ring_reset_interval`` = ``180`` - - (IntOpt) Interval (in seconds) between hash ring resets. + - (Integer) Interval (in seconds) between hash ring resets. * - ``host`` = ``localhost`` - - (StrOpt) Name of this node. This can be an opaque identifier. It is not necessarily a hostname, FQDN, or IP address. However, the node name must be valid within an AMQP key, and if using ZeroMQ, a valid hostname, FQDN, or IP address. + - (String) Name of this node. This can be an opaque identifier. It is not necessarily a hostname, FQDN, or IP address. However, the node name must be valid within an AMQP key, and if using ZeroMQ, a valid hostname, FQDN, or IP address. * - ``isolinux_bin`` = ``/usr/lib/syslinux/isolinux.bin`` - - (StrOpt) Path to isolinux binary file. + - (String) Path to isolinux binary file. * - ``isolinux_config_template`` = ``$pybasedir/common/isolinux_config.template`` - - (StrOpt) Template file for isolinux configuration file. + - (String) Template file for isolinux configuration file. * - ``memcached_servers`` = ``None`` - - (ListOpt) Memcached servers or None for in process cache. + - (List) Memcached servers or None for in process cache. * - ``my_ip`` = ``10.0.0.1`` - - (StrOpt) IP address of this host. If unset, will determine the IP programmatically. If unable to do so, will use "127.0.0.1". + - (String) IP address of this host. If unset, will determine the IP programmatically. If unable to do so, will use "127.0.0.1". * - ``parallel_image_downloads`` = ``False`` - - (BoolOpt) Run image downloads and raw format conversions in parallel. + - (Boolean) Run image downloads and raw format conversions in parallel. * - ``periodic_interval`` = ``60`` - - (IntOpt) Seconds between running periodic tasks. + - (Integer) DEPRECATED: Default interval (in seconds) for running driver periodic tasks. * - ``pybasedir`` = ``/usr/lib/python/site-packages/ironic/ironic`` - - (StrOpt) Directory where the ironic python module is installed. + - (String) Directory where the ironic python module is installed. * - ``rootwrap_config`` = ``/etc/ironic/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. * - ``state_path`` = ``$pybasedir`` - - (StrOpt) Top-level directory for maintaining ironic's state. + - (String) Top-level directory for maintaining ironic's state. * - ``tempdir`` = ``/tmp`` - - (StrOpt) Temporary working directory, default is Python temp dir. + - (String) Temporary working directory, default is Python temp dir. + * - **[ironic_lib]** + - + * - ``fatal_exception_format_errors`` = ``False`` + - (Boolean) Make exception message format errors fatal. + * - ``root_helper`` = ``sudo ironic-rootwrap /etc/ironic/rootwrap.conf`` + - (String) Command that is prefixed to commands that are run as root. If not specified, no commands are run as root. diff --git a/doc/config-reference/source/tables/ironic-conductor.rst b/doc/config-reference/source/tables/ironic-conductor.rst index ebb58950d3..bf6ce1a7c8 100644 --- a/doc/config-reference/source/tables/ironic-conductor.rst +++ b/doc/config-reference/source/tables/ironic-conductor.rst @@ -19,44 +19,44 @@ * - **[conductor]** - * - ``api_url`` = ``None`` - - (StrOpt) URL of Ironic API service. If not set ironic can get the current value from the keystone service catalog. + - (String) URL of Ironic API service. If not set ironic can get the current value from the keystone service catalog. + * - ``automated_clean`` = ``True`` + - (Boolean) Enables or disables automated cleaning. Automated cleaning is a configurable set of steps, such as erasing disk drives, that are performed on the node to ensure it is in a baseline state and ready to be deployed to. This is done after instance deletion as well as during the transition from a "manageable" to "available" state. When enabled, the particular steps performed to clean a node depend on which driver that node is managed by; see the individual driver's documentation for details. NOTE: The introduction of the cleaning operation causes instance deletion to take significantly longer. In an environment where all tenants are trusted (eg, because there is only one tenant), this option could be safely disabled. * - ``check_provision_state_interval`` = ``60`` - - (IntOpt) Interval between checks of provision timeouts, in seconds. + - (Integer) Interval between checks of provision timeouts, in seconds. * - ``clean_callback_timeout`` = ``1800`` - - (IntOpt) Timeout (seconds) to wait for a callback from the ramdisk doing the cleaning. If the timeout is reached the node will be put in the "clean failed" provision state. Set to 0 to disable timeout. - * - ``clean_nodes`` = ``True`` - - (BoolOpt) Cleaning is a configurable set of steps, such as erasing disk drives, that are performed on the node to ensure it is in a baseline state and ready to be deployed to. This is done after instance deletion, and during the transition from a "managed" to "available" state. When enabled, the particular steps performed to clean a node depend on which driver that node is managed by; see the individual driver's documentation for details. NOTE: The introduction of the cleaning operation causes instance deletion to take significantly longer. In an environment where all tenants are trusted (eg, because there is only one tenant), this option could be safely disabled. + - (Integer) Timeout (seconds) to wait for a callback from the ramdisk doing the cleaning. If the timeout is reached the node will be put in the "clean failed" provision state. Set to 0 to disable timeout. * - ``configdrive_swift_container`` = ``ironic_configdrive_container`` - - (StrOpt) Name of the Swift container to store config drive data. Used when configdrive_use_swift is True. + - (String) Name of the Swift container to store config drive data. Used when configdrive_use_swift is True. * - ``configdrive_use_swift`` = ``False`` - - (BoolOpt) Whether to upload the config drive to Swift. + - (Boolean) Whether to upload the config drive to Swift. * - ``deploy_callback_timeout`` = ``1800`` - - (IntOpt) Timeout (seconds) to wait for a callback from a deploy ramdisk. Set to 0 to disable timeout. + - (Integer) Timeout (seconds) to wait for a callback from a deploy ramdisk. Set to 0 to disable timeout. * - ``force_power_state_during_sync`` = ``True`` - - (BoolOpt) During sync_power_state, should the hardware power state be set to the state recorded in the database (True) or should the database be updated based on the hardware state (False). + - (Boolean) During sync_power_state, should the hardware power state be set to the state recorded in the database (True) or should the database be updated based on the hardware state (False). * - ``heartbeat_interval`` = ``10`` - - (IntOpt) Seconds between conductor heart beats. + - (Integer) Seconds between conductor heart beats. * - ``heartbeat_timeout`` = ``60`` - - (IntOpt) Maximum time (in seconds) since the last check-in of a conductor. A conductor is considered inactive when this time has been exceeded. + - (Integer) Maximum time (in seconds) since the last check-in of a conductor. A conductor is considered inactive when this time has been exceeded. * - ``inspect_timeout`` = ``1800`` - - (IntOpt) Timeout (seconds) for waiting for node inspection. 0 - unlimited. + - (Integer) Timeout (seconds) for waiting for node inspection. 0 - unlimited. * - ``node_locked_retry_attempts`` = ``3`` - - (IntOpt) Number of attempts to grab a node lock. + - (Integer) Number of attempts to grab a node lock. * - ``node_locked_retry_interval`` = ``1`` - - (IntOpt) Seconds to sleep between node lock attempts. + - (Integer) Seconds to sleep between node lock attempts. * - ``periodic_max_workers`` = ``8`` - - (IntOpt) Maximum number of worker threads that can be started simultaneously by a periodic task. Should be less than RPC thread pool size. + - (Integer) Maximum number of worker threads that can be started simultaneously by a periodic task. Should be less than RPC thread pool size. * - ``power_state_sync_max_retries`` = ``3`` - - (IntOpt) During sync_power_state failures, limit the number of times Ironic should try syncing the hardware node power state with the node power state in DB + - (Integer) During sync_power_state failures, limit the number of times Ironic should try syncing the hardware node power state with the node power state in DB * - ``send_sensor_data`` = ``False`` - - (BoolOpt) Enable sending sensor data message via the notification bus + - (Boolean) Enable sending sensor data message via the notification bus * - ``send_sensor_data_interval`` = ``600`` - - (IntOpt) Seconds between conductor sending sensor data message to ceilometer via the notification bus. + - (Integer) Seconds between conductor sending sensor data message to ceilometer via the notification bus. * - ``send_sensor_data_types`` = ``ALL`` - - (ListOpt) List of comma separated meter types which need to be sent to Ceilometer. The default value, "ALL", is a special value meaning send all the sensor data. + - (List) List of comma separated meter types which need to be sent to Ceilometer. The default value, "ALL", is a special value meaning send all the sensor data. * - ``sync_local_state_interval`` = ``180`` - - (IntOpt) When conductors join or leave the cluster, existing conductors may need to update any persistent local state as nodes are moved around the cluster. This option controls how often, in seconds, each conductor will check for nodes that it should "take over". Set it to a negative value to disable the check entirely. + - (Integer) When conductors join or leave the cluster, existing conductors may need to update any persistent local state as nodes are moved around the cluster. This option controls how often, in seconds, each conductor will check for nodes that it should "take over". Set it to a negative value to disable the check entirely. * - ``sync_power_state_interval`` = ``60`` - - (IntOpt) Interval between syncing the node power state to the database, in seconds. + - (Integer) Interval between syncing the node power state to the database, in seconds. * - ``workers_pool_size`` = ``100`` - - (IntOpt) The size of the workers greenthread pool. + - (Integer) The size of the workers greenthread pool. Note that 2 threads will be reserved by the conductor itself for handling heart beats and periodic tasks. diff --git a/doc/config-reference/source/tables/ironic-console.rst b/doc/config-reference/source/tables/ironic-console.rst index 3c9b27bec9..41d5db249f 100644 --- a/doc/config-reference/source/tables/ironic-console.rst +++ b/doc/config-reference/source/tables/ironic-console.rst @@ -19,12 +19,12 @@ * - **[console]** - * - ``subprocess_checking_interval`` = ``1`` - - (IntOpt) Time interval (in seconds) for checking the status of console subprocess. + - (Integer) Time interval (in seconds) for checking the status of console subprocess. * - ``subprocess_timeout`` = ``10`` - - (IntOpt) Time (in seconds) to wait for the console subprocess to start. + - (Integer) Time (in seconds) to wait for the console subprocess to start. * - ``terminal`` = ``shellinaboxd`` - - (StrOpt) Path to serial console terminal program + - (String) Path to serial console terminal program * - ``terminal_cert_dir`` = ``None`` - - (StrOpt) Directory containing the terminal SSL cert(PEM) for serial console access + - (String) Directory containing the terminal SSL cert(PEM) for serial console access * - ``terminal_pid_dir`` = ``None`` - - (StrOpt) Directory for holding terminal pid files. If not specified, the temporary directory will be used. + - (String) Directory for holding terminal pid files. If not specified, the temporary directory will be used. diff --git a/doc/config-reference/source/tables/ironic-database.rst b/doc/config-reference/source/tables/ironic-database.rst index 1930ce1cd1..599a30cef7 100644 --- a/doc/config-reference/source/tables/ironic-database.rst +++ b/doc/config-reference/source/tables/ironic-database.rst @@ -19,44 +19,44 @@ * - **[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_engine`` = ``InnoDB`` - - (StrOpt) MySQL engine to use. + - (String) MySQL engine to use. * - ``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. diff --git a/doc/config-reference/source/tables/ironic-debug.rst b/doc/config-reference/source/tables/ironic-debug.rst index 19e049b7b6..34f2da603a 100644 --- a/doc/config-reference/source/tables/ironic-debug.rst +++ b/doc/config-reference/source/tables/ironic-debug.rst @@ -19,4 +19,4 @@ * - **[DEFAULT]** - * - ``pecan_debug`` = ``False`` - - (BoolOpt) Enable pecan debug mode. WARNING: this is insecure and should not be used in a production environment. + - (Boolean) Enable pecan debug mode. WARNING: this is insecure and should not be used in a production environment. diff --git a/doc/config-reference/source/tables/ironic-deploy.rst b/doc/config-reference/source/tables/ironic-deploy.rst index 884642fbd2..a457101b7b 100644 --- a/doc/config-reference/source/tables/ironic-deploy.rst +++ b/doc/config-reference/source/tables/ironic-deploy.rst @@ -18,17 +18,11 @@ - Description * - **[deploy]** - - * - ``dd_block_size`` = ``1M`` - - (StrOpt) Block size to use when writing to the nodes disk. - * - ``efi_system_partition_size`` = ``200`` - - (IntOpt) Size of EFI system partition in MiB when configuring UEFI systems for local boot. * - ``erase_devices_iterations`` = ``1`` - - (IntOpt) Number of iterations to be run for erasing devices. + - (Integer) Number of iterations to be run for erasing devices. * - ``erase_devices_priority`` = ``None`` - - (IntOpt) Priority to run in-band erase devices via the Ironic Python Agent ramdisk. If unset, will use the priority set in the ramdisk (defaults to 10 for the GenericHardwareManager). If set to 0, will not run during cleaning. + - (Integer) Priority to run in-band erase devices via the Ironic Python Agent ramdisk. If unset, will use the priority set in the ramdisk (defaults to 10 for the GenericHardwareManager). If set to 0, will not run during cleaning. * - ``http_root`` = ``/httpboot`` - - (StrOpt) ironic-conductor node's HTTP root path. + - (String) ironic-conductor node's HTTP root path. * - ``http_url`` = ``None`` - - (StrOpt) ironic-conductor node's HTTP server URL. Example: http://192.1.2.3:8080 - * - ``iscsi_verify_attempts`` = ``3`` - - (IntOpt) Maximum attempts to verify an iSCSI connection is active, sleeping 1 second between attempts. + - (String) ironic-conductor node's HTTP server URL. Example: http://192.1.2.3:8080 diff --git a/doc/config-reference/source/tables/ironic-dhcp.rst b/doc/config-reference/source/tables/ironic-dhcp.rst index 291e2d094b..8205cd1629 100644 --- a/doc/config-reference/source/tables/ironic-dhcp.rst +++ b/doc/config-reference/source/tables/ironic-dhcp.rst @@ -19,4 +19,4 @@ * - **[dhcp]** - * - ``dhcp_provider`` = ``neutron`` - - (StrOpt) DHCP provider to use. "neutron" uses Neutron, and "none" uses a no-op provider. + - (String) DHCP provider to use. "neutron" uses Neutron, and "none" uses a no-op provider. diff --git a/doc/config-reference/source/tables/ironic-disk_partitioner.rst b/doc/config-reference/source/tables/ironic-disk_partitioner.rst index 50c8d0a6c0..ecf61b6992 100644 --- a/doc/config-reference/source/tables/ironic-disk_partitioner.rst +++ b/doc/config-reference/source/tables/ironic-disk_partitioner.rst @@ -19,6 +19,14 @@ * - **[disk_partitioner]** - * - ``check_device_interval`` = ``1`` - - (IntOpt) After Ironic has completed creating the partition table, it continues to check for activity on the attached iSCSI device status at this interval prior to copying the image to the node, in seconds + - (Integer) After Ironic has completed creating the partition table, it continues to check for activity on the attached iSCSI device status at this interval prior to copying the image to the node, in seconds * - ``check_device_max_retries`` = ``20`` - - (IntOpt) The maximum number of times to check that the device is not accessed by another process. If the device is still busy after that, the disk partitioning will be treated as having failed. + - (Integer) The maximum number of times to check that the device is not accessed by another process. If the device is still busy after that, the disk partitioning will be treated as having failed. + * - **[disk_utils]** + - + * - ``dd_block_size`` = ``1M`` + - (String) Block size to use when writing to the nodes disk. + * - ``efi_system_partition_size`` = ``200`` + - (Integer) Size of EFI system partition in MiB when configuring UEFI systems for local boot. + * - ``iscsi_verify_attempts`` = ``3`` + - (Integer) Maximum attempts to verify an iSCSI connection is active, sleeping 1 second between attempts. diff --git a/doc/config-reference/source/tables/ironic-glance.rst b/doc/config-reference/source/tables/ironic-glance.rst index 5f4433ee4f..c8123ee90d 100644 --- a/doc/config-reference/source/tables/ironic-glance.rst +++ b/doc/config-reference/source/tables/ironic-glance.rst @@ -19,34 +19,40 @@ * - **[glance]** - * - ``allowed_direct_url_schemes`` = - - (ListOpt) A list of URL schemes that can be downloaded directly via the direct_url. Currently supported schemes: [file]. + - (List) A list of URL schemes that can be downloaded directly via the direct_url. Currently supported schemes: [file]. * - ``auth_strategy`` = ``keystone`` - - (StrOpt) Authentication strategy to use when connecting to glance. Only "keystone" and "noauth" are currently supported by ironic. + - (String) Authentication strategy to use when connecting to glance. * - ``glance_api_insecure`` = ``False`` - - (BoolOpt) Allow to perform insecure SSL (https) requests to glance. + - (Boolean) Allow to perform insecure SSL (https) requests to glance. * - ``glance_api_servers`` = ``None`` - - (ListOpt) A list of the glance api servers available to ironic. Prefix with https:// for SSL-based glance API servers. Format is [hostname|IP]:port. + - (List) A list of the glance api servers available to ironic. Prefix with https:// for SSL-based glance API servers. Format is [hostname|IP]:port. + * - ``glance_cafile`` = ``None`` + - (String) Optional path to a CA certificate bundle to be used to validate the SSL certificate served by glance. It is used when glance_api_insecure is set to False. * - ``glance_host`` = ``$my_ip`` - - (StrOpt) Default glance hostname or IP address. + - (String) Default glance hostname or IP address. * - ``glance_num_retries`` = ``0`` - - (IntOpt) Number of retries when downloading an image from glance. + - (Integer) Number of retries when downloading an image from glance. * - ``glance_port`` = ``9292`` - - (PortOpt) Default glance port. + - (Unknown) Default glance port. * - ``glance_protocol`` = ``http`` - - (StrOpt) Default protocol to use when connecting to glance. Set to https for SSL. + - (String) Default protocol to use when connecting to glance. Set to https for SSL. * - ``swift_account`` = ``None`` - - (StrOpt) The account that Glance uses to communicate with Swift. The format is "AUTH_uuid". "uuid" is the UUID for the account configured in the glance-api.conf. Required for temporary URLs when Glance backend is Swift. For example: "AUTH_a422b2-91f3-2f46-74b7-d7c9e8958f5d30". Swift temporary URL format: "endpoint_url/api_version/[account/]container/object_id" + - (String) The account that Glance uses to communicate with Swift. The format is "AUTH_uuid". "uuid" is the UUID for the account configured in the glance-api.conf. Required for temporary URLs when Glance backend is Swift. For example: "AUTH_a422b2-91f3-2f46-74b7-d7c9e8958f5d30". Swift temporary URL format: "endpoint_url/api_version/[account/]container/object_id" * - ``swift_api_version`` = ``v1`` - - (StrOpt) The Swift API version to create a temporary URL for. Defaults to "v1". Swift temporary URL format: "endpoint_url/api_version/[account/]container/object_id" + - (String) The Swift API version to create a temporary URL for. Defaults to "v1". Swift temporary URL format: "endpoint_url/api_version/[account/]container/object_id" * - ``swift_container`` = ``glance`` - - (StrOpt) The Swift container Glance is configured to store its images in. Defaults to "glance", which is the default in glance-api.conf. Swift temporary URL format: "endpoint_url/api_version/[account/]container/object_id" + - (String) The Swift container Glance is configured to store its images in. Defaults to "glance", which is the default in glance-api.conf. Swift temporary URL format: "endpoint_url/api_version/[account/]container/object_id" * - ``swift_endpoint_url`` = ``None`` - - (StrOpt) The "endpoint" (scheme, hostname, optional port) for the Swift URL of the form "endpoint_url/api_version/[account/]container/object_id". Do not include trailing "/". For example, use "https://swift.example.com". If using RADOS Gateway, endpoint may also contain /swift path; if it does not, it will be appended. Required for temporary URLs. + - (String) The "endpoint" (scheme, hostname, optional port) for the Swift URL of the form "endpoint_url/api_version/[account/]container/object_id". Do not include trailing "/". For example, use "https://swift.example.com". If using RADOS Gateway, endpoint may also contain /swift path; if it does not, it will be appended. Required for temporary URLs. * - ``swift_store_multiple_containers_seed`` = ``0`` - - (IntOpt) This should match a config by the same name in the Glance configuration file. When set to 0, a single-tenant store will only use one container to store all images. When set to an integer value between 1 and 32, a single-tenant store will use multiple containers to store images, and this value will determine how many containers are created. + - (Integer) This should match a config by the same name in the Glance configuration file. When set to 0, a single-tenant store will only use one container to store all images. When set to an integer value between 1 and 32, a single-tenant store will use multiple containers to store images, and this value will determine how many containers are created. + * - ``swift_temp_url_cache_enabled`` = ``False`` + - (Boolean) Whether to cache generated Swift temporary URLs. Setting it to true is only useful when an image caching proxy is used. Defaults to False. * - ``swift_temp_url_duration`` = ``1200`` - - (IntOpt) The length of time in seconds that the temporary URL will be valid for. Defaults to 20 minutes. If some deploys get a 401 response code when trying to download from the temporary URL, try raising this duration. + - (Integer) The length of time in seconds that the temporary URL will be valid for. Defaults to 20 minutes. If some deploys get a 401 response code when trying to download from the temporary URL, try raising this duration. This value must be greater than or equal to the value for swift_temp_url_expected_download_start_delay + * - ``swift_temp_url_expected_download_start_delay`` = ``0`` + - (Integer) This is the delay (in seconds) from the time of the deploy request (when the Swift temporary URL is generated) to when the IPA ramdisk starts up and URL is used for the image download. This value is used to check if the Swift temporary URL duration is large enough to let the image download begin. Also if temporary URL caching is enabled this will determine if a cached entry will still be valid when the download starts. swift_temp_url_duration value must be greater than or equal to this option's value. Defaults to 0. * - ``swift_temp_url_key`` = ``None`` - - (StrOpt) The secret token given to Swift to allow temporary URL downloads. Required for temporary URLs. + - (String) The secret token given to Swift to allow temporary URL downloads. Required for temporary URLs. * - ``temp_url_endpoint_type`` = ``swift`` - - (StrOpt) Type of endpoint to use for temporary URLs. If the Glance backend is Swift, use "swift"; if it is CEPH with RADOS gateway, use "radosgw". + - (String) Type of endpoint to use for temporary URLs. If the Glance backend is Swift, use "swift"; if it is CEPH with RADOS gateway, use "radosgw". diff --git a/doc/config-reference/source/tables/ironic-iboot.rst b/doc/config-reference/source/tables/ironic-iboot.rst index 3d7040b24c..4abf284169 100644 --- a/doc/config-reference/source/tables/ironic-iboot.rst +++ b/doc/config-reference/source/tables/ironic-iboot.rst @@ -19,8 +19,8 @@ * - **[iboot]** - * - ``max_retry`` = ``3`` - - (IntOpt) Maximum retries for iBoot operations + - (Integer) Maximum retries for iBoot operations * - ``reboot_delay`` = ``5`` - - (IntOpt) Time (in seconds) to sleep between when rebooting (powering off and on again). + - (Integer) Time (in seconds) to sleep between when rebooting (powering off and on again). * - ``retry_interval`` = ``1`` - - (IntOpt) Time (in seconds) between retry attempts for iBoot operations + - (Integer) Time (in seconds) between retry attempts for iBoot operations diff --git a/doc/config-reference/source/tables/ironic-ilo.rst b/doc/config-reference/source/tables/ironic-ilo.rst index 79528dff6d..be87454e04 100644 --- a/doc/config-reference/source/tables/ironic-ilo.rst +++ b/doc/config-reference/source/tables/ironic-ilo.rst @@ -19,28 +19,28 @@ * - **[ilo]** - * - ``clean_priority_clear_secure_boot_keys`` = ``0`` - - (IntOpt) Priority for clear_secure_boot_keys clean step. This step is not enabled by default. It can be enabled to to clear all secure boot keys enrolled with iLO. + - (Integer) Priority for clear_secure_boot_keys clean step. This step is not enabled by default. It can be enabled to to clear all secure boot keys enrolled with iLO. * - ``clean_priority_erase_devices`` = ``None`` - - (IntOpt) Priority for erase devices clean step. If unset, it defaults to 10. If set to 0, the step will be disabled and will not run during cleaning. + - (Integer) Priority for erase devices clean step. If unset, it defaults to 10. If set to 0, the step will be disabled and will not run during cleaning. * - ``clean_priority_reset_bios_to_default`` = ``10`` - - (IntOpt) Priority for reset_bios_to_default clean step. - * - ``clean_priority_reset_ilo`` = ``1`` - - (IntOpt) Priority for reset_ilo clean step. + - (Integer) Priority for reset_bios_to_default clean step. + * - ``clean_priority_reset_ilo`` = ``0`` + - (Integer) Priority for reset_ilo clean step. * - ``clean_priority_reset_ilo_credential`` = ``30`` - - (IntOpt) Priority for reset_ilo_credential clean step. This step requires "ilo_change_password" parameter to be updated in nodes's driver_info with the new password. + - (Integer) Priority for reset_ilo_credential clean step. This step requires "ilo_change_password" parameter to be updated in nodes's driver_info with the new password. * - ``clean_priority_reset_secure_boot_keys_to_default`` = ``20`` - - (IntOpt) Priority for reset_secure_boot_keys clean step. This step will reset the secure boot keys to manufacturing defaults. + - (Integer) Priority for reset_secure_boot_keys clean step. This step will reset the secure boot keys to manufacturing defaults. * - ``client_port`` = ``443`` - - (PortOpt) Port to be used for iLO operations + - (Unknown) Port to be used for iLO operations * - ``client_timeout`` = ``60`` - - (IntOpt) Timeout (in seconds) for iLO operations + - (Integer) Timeout (in seconds) for iLO operations * - ``power_retry`` = ``6`` - - (IntOpt) Number of times a power operation needs to be retried + - (Integer) Number of times a power operation needs to be retried * - ``power_wait`` = ``2`` - - (IntOpt) Amount of time in seconds to wait in between power operations + - (Integer) Amount of time in seconds to wait in between power operations * - ``swift_ilo_container`` = ``ironic_ilo_container`` - - (StrOpt) The Swift iLO container to store data. + - (String) The Swift iLO container to store data. * - ``swift_object_expiry_timeout`` = ``900`` - - (IntOpt) Amount of time in seconds for Swift objects to auto-expire. + - (Integer) Amount of time in seconds for Swift objects to auto-expire. * - ``use_web_server_for_images`` = ``False`` - - (BoolOpt) Set this to True to use http web server to host floppy images and generated boot ISO. This requires http_root and http_url to be configured in the [deploy] section of the config file. If this is set to False, then Ironic will use Swift to host the floppy images and generated boot_iso. + - (Boolean) Set this to True to use http web server to host floppy images and generated boot ISO. This requires http_root and http_url to be configured in the [deploy] section of the config file. If this is set to False, then Ironic will use Swift to host the floppy images and generated boot_iso. diff --git a/doc/config-reference/source/tables/ironic-inspector.rst b/doc/config-reference/source/tables/ironic-inspector.rst index 8b37a6b52d..d5f81fe560 100644 --- a/doc/config-reference/source/tables/ironic-inspector.rst +++ b/doc/config-reference/source/tables/ironic-inspector.rst @@ -19,8 +19,8 @@ * - **[inspector]** - * - ``enabled`` = ``False`` - - (BoolOpt) whether to enable inspection using ironic-inspector + - (Boolean) whether to enable inspection using ironic-inspector * - ``service_url`` = ``None`` - - (StrOpt) ironic-inspector HTTP endpoint. If this is not set, the ironic-inspector client default (http://127.0.0.1:5050) will be used. + - (String) ironic-inspector HTTP endpoint. If this is not set, the ironic-inspector client default (http://127.0.0.1:5050) will be used. * - ``status_check_period`` = ``60`` - - (IntOpt) period (in seconds) to check status of nodes on inspection + - (Integer) period (in seconds) to check status of nodes on inspection diff --git a/doc/config-reference/source/tables/ironic-ipmi.rst b/doc/config-reference/source/tables/ironic-ipmi.rst index 49ca84bb1f..d843276648 100644 --- a/doc/config-reference/source/tables/ironic-ipmi.rst +++ b/doc/config-reference/source/tables/ironic-ipmi.rst @@ -19,6 +19,6 @@ * - **[ipmi]** - * - ``min_command_interval`` = ``5`` - - (IntOpt) Minimum time, in seconds, between IPMI operations sent to a server. There is a risk with some hardware that setting this too low may cause the BMC to crash. Recommended setting is 5 seconds. + - (Integer) Minimum time, in seconds, between IPMI operations sent to a server. There is a risk with some hardware that setting this too low may cause the BMC to crash. Recommended setting is 5 seconds. * - ``retry_timeout`` = ``60`` - - (IntOpt) Maximum time in seconds to retry IPMI operations. There is a tradeoff when setting this value. Setting this too low may cause older BMCs to crash and require a hard reset. However, setting too high can cause the sync power state periodic task to hang when there are slow or unresponsive BMCs. + - (Integer) Maximum time in seconds to retry IPMI operations. There is a tradeoff when setting this value. Setting this too low may cause older BMCs to crash and require a hard reset. However, setting too high can cause the sync power state periodic task to hang when there are slow or unresponsive BMCs. diff --git a/doc/config-reference/source/tables/ironic-irmc.rst b/doc/config-reference/source/tables/ironic-irmc.rst index 68d2f3d6d4..a0a4c27723 100644 --- a/doc/config-reference/source/tables/ironic-irmc.rst +++ b/doc/config-reference/source/tables/ironic-irmc.rst @@ -19,24 +19,32 @@ * - **[irmc]** - * - ``auth_method`` = ``basic`` - - (StrOpt) Authentication method to be used for iRMC operations, either "basic" or "digest" + - (String) Authentication method to be used for iRMC operations * - ``client_timeout`` = ``60`` - - (IntOpt) Timeout (in seconds) for iRMC operations + - (Integer) Timeout (in seconds) for iRMC operations * - ``port`` = ``443`` - - (PortOpt) Port to be used for iRMC operations, either 80 or 443 + - (Unknown) Port to be used for iRMC operations * - ``remote_image_server`` = ``None`` - - (StrOpt) IP of remote image server + - (String) IP of remote image server * - ``remote_image_share_name`` = ``share`` - - (StrOpt) share name of remote_image_server + - (String) share name of remote_image_server * - ``remote_image_share_root`` = ``/remote_image_share_root`` - - (StrOpt) Ironic conductor node's "NFS" or "CIFS" root path + - (String) Ironic conductor node's "NFS" or "CIFS" root path * - ``remote_image_share_type`` = ``CIFS`` - - (StrOpt) Share type of virtual media, either "NFS" or "CIFS" + - (String) Share type of virtual media * - ``remote_image_user_domain`` = - - (StrOpt) Domain name of remote_image_user_name + - (String) Domain name of remote_image_user_name * - ``remote_image_user_name`` = ``None`` - - (StrOpt) User name of remote_image_server + - (String) User name of remote_image_server * - ``remote_image_user_password`` = ``None`` - - (StrOpt) Password of remote_image_user_name + - (String) Password of remote_image_user_name * - ``sensor_method`` = ``ipmitool`` - - (StrOpt) Sensor data retrieval method, either "ipmitool" or "scci" + - (String) Sensor data retrieval method. + * - ``snmp_community`` = ``public`` + - (String) SNMP community. Required for versions "v1" and "v2c" + * - ``snmp_port`` = ``161`` + - (Unknown) SNMP port + * - ``snmp_security`` = ``None`` + - (String) SNMP security name. Required for version "v3" + * - ``snmp_version`` = ``v2c`` + - (String) SNMP protocol version diff --git a/doc/config-reference/source/tables/ironic-keystone.rst b/doc/config-reference/source/tables/ironic-keystone.rst index 0858e9011a..1fc216467b 100644 --- a/doc/config-reference/source/tables/ironic-keystone.rst +++ b/doc/config-reference/source/tables/ironic-keystone.rst @@ -19,4 +19,4 @@ * - **[keystone]** - * - ``region_name`` = ``None`` - - (StrOpt) The region used for getting endpoints of OpenStack services. + - (String) The region used for getting endpoints of OpenStack services. diff --git a/doc/config-reference/source/tables/ironic-logging.rst b/doc/config-reference/source/tables/ironic-logging.rst index b386e3ff6f..58c7cb0a26 100644 --- a/doc/config-reference/source/tables/ironic-logging.rst +++ b/doc/config-reference/source/tables/ironic-logging.rst @@ -19,44 +19,44 @@ * - **[DEFAULT]** - * - ``debug`` = ``False`` - - (BoolOpt) Print debugging output (set logging level to DEBUG instead of 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`` - - (ListOpt) List of logger=LEVEL pairs. This option is ignored if log_config_append is set. + - (Boolean) If set to true, the logging level will be set to DEBUG instead of the default INFO level. + * - ``debug_tracebacks_in_api`` = ``False`` + - (Boolean) Return server tracebacks in the API response for any error responses. WARNING: this is insecure and should not be used in a production environment. + * - ``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`` + - (List) List of package logging levels in logger=LEVEL pairs. This option is ignored if log_config_append is set. * - ``fatal_exception_format_errors`` = ``False`` - - (BoolOpt) Used if there is a formatting error when generating an exception message (a programming error). If True, raise an exception; if False, use the unformatted message. + - (Boolean) Used if there is a formatting error when generating an exception message (a programming error). If True, raise an exception; if False, use the unformatted message. * - ``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. + - (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) 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 output to. If no default is set, logging will go to stdout. 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) Data to append to log format when level 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 without context. + - (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) Format string for user_identity field of the 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) (Optional) Enables or disables syslog rfc5424 format for logging. If enabled, prefixes the MSG part of the syslog message with APP-NAME (RFC5424). The format without the APP-NAME is deprecated in Kilo, and will be removed in Mitaka, along with this option. 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, will disable INFO logging level, making WARNING the default. + - (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) (Optional) 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. diff --git a/doc/config-reference/source/tables/ironic-neutron.rst b/doc/config-reference/source/tables/ironic-neutron.rst index e41b3bba1b..7d1a6a7fab 100644 --- a/doc/config-reference/source/tables/ironic-neutron.rst +++ b/doc/config-reference/source/tables/ironic-neutron.rst @@ -19,12 +19,12 @@ * - **[neutron]** - * - ``auth_strategy`` = ``keystone`` - - (StrOpt) Default authentication strategy to use when connecting to neutron. Can be either "keystone" or "noauth". Running neutron in noauth mode (related to but not affected by this setting) is insecure and should only be used for testing. + - (String) Default authentication strategy to use when connecting to neutron. Running neutron in noauth mode (related to but not affected by this setting) is insecure and should only be used for testing. * - ``cleaning_network_uuid`` = ``None`` - - (StrOpt) UUID of the network to create Neutron ports on when booting to a ramdisk for cleaning/zapping using Neutron DHCP + - (String) UUID of the network to create Neutron ports on, when booting to a ramdisk for cleaning using Neutron DHCP. * - ``retries`` = ``3`` - - (IntOpt) Client retries in the case of a failed request. + - (Integer) Client retries in the case of a failed request. * - ``url`` = ``http://$my_ip:9696`` - - (StrOpt) URL for connecting to neutron. + - (String) URL for connecting to neutron. * - ``url_timeout`` = ``30`` - - (IntOpt) Timeout value for connecting to neutron in seconds. + - (Integer) Timeout value for connecting to neutron in seconds. diff --git a/doc/config-reference/source/tables/ironic-oneview.rst b/doc/config-reference/source/tables/ironic-oneview.rst index 3ffc381fd6..fdcbf1d306 100644 --- a/doc/config-reference/source/tables/ironic-oneview.rst +++ b/doc/config-reference/source/tables/ironic-oneview.rst @@ -19,14 +19,14 @@ * - **[oneview]** - * - ``allow_insecure_connections`` = ``False`` - - (BoolOpt) Option to allow insecure connection with OneView + - (Boolean) Option to allow insecure connection with OneView * - ``manager_url`` = ``None`` - - (StrOpt) URL where OneView is available + - (String) URL where OneView is available * - ``max_polling_attempts`` = ``12`` - - (IntOpt) Max connection retries to check changes on OneView + - (Integer) Max connection retries to check changes on OneView * - ``password`` = ``None`` - - (StrOpt) OneView password to be used + - (String) OneView password to be used * - ``tls_cacert_file`` = ``None`` - - (StrOpt) Path to CA certificate + - (String) Path to CA certificate * - ``username`` = ``None`` - - (StrOpt) OneView username to be used + - (String) OneView username to be used diff --git a/doc/config-reference/source/tables/ironic-policy.rst b/doc/config-reference/source/tables/ironic-policy.rst index eeaf50b855..85b691503c 100644 --- a/doc/config-reference/source/tables/ironic-policy.rst +++ b/doc/config-reference/source/tables/ironic-policy.rst @@ -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. diff --git a/doc/config-reference/source/tables/ironic-pxe.rst b/doc/config-reference/source/tables/ironic-pxe.rst index 090a969312..cdfdac5e88 100644 --- a/doc/config-reference/source/tables/ironic-pxe.rst +++ b/doc/config-reference/source/tables/ironic-pxe.rst @@ -19,36 +19,38 @@ * - **[pxe]** - * - ``default_ephemeral_format`` = ``ext4`` - - (StrOpt) Default file system format for ephemeral partition, if one is created. + - (String) Default file system format for ephemeral partition, if one is created. * - ``disk_devices`` = ``cciss/c0d0,sda,hda,vda`` - - (StrOpt) The disk devices to scan while doing the deploy. + - (String) The disk devices to scan while doing the deploy. * - ``image_cache_size`` = ``20480`` - - (IntOpt) Maximum size (in MiB) of cache for master images, including those in use. + - (Integer) Maximum size (in MiB) of cache for master images, including those in use. * - ``image_cache_ttl`` = ``10080`` - - (IntOpt) Maximum TTL (in minutes) for old master images in cache. + - (Integer) Maximum TTL (in minutes) for old master images in cache. * - ``images_path`` = ``/var/lib/ironic/images/`` - - (StrOpt) On the ironic-conductor node, directory where images are stored on disk. + - (String) On the ironic-conductor node, directory where images are stored on disk. * - ``instance_master_path`` = ``/var/lib/ironic/master_images`` - - (StrOpt) On the ironic-conductor node, directory where master instance images are stored on disk. + - (String) On the ironic-conductor node, directory where master instance images are stored on disk. Setting to disables image caching. * - ``ip_version`` = ``4`` - - (StrOpt) The IP version that will be used for PXE booting. Can be either 4 or 6. Defaults to 4. EXPERIMENTAL + - (String) The IP version that will be used for PXE booting. Defaults to 4. EXPERIMENTAL * - ``ipxe_boot_script`` = ``$pybasedir/drivers/modules/boot.ipxe`` - - (StrOpt) On ironic-conductor node, the path to the main iPXE script file. + - (String) On ironic-conductor node, the path to the main iPXE script file. * - ``ipxe_enabled`` = ``False`` - - (BoolOpt) Enable iPXE boot. + - (Boolean) Enable iPXE boot. + * - ``ipxe_timeout`` = ``0`` + - (Integer) Timeout value (in seconds) for downloading an image via iPXE. Defaults to 0 (no timeout) * - ``pxe_append_params`` = ``nofb nomodeset vga=normal`` - - (StrOpt) Additional append parameters for baremetal PXE boot. + - (String) Additional append parameters for baremetal PXE boot. * - ``pxe_bootfile_name`` = ``pxelinux.0`` - - (StrOpt) Bootfile DHCP parameter. + - (String) Bootfile DHCP parameter. * - ``pxe_config_template`` = ``$pybasedir/drivers/modules/pxe_config.template`` - - (StrOpt) On ironic-conductor node, template file for PXE configuration. + - (String) On ironic-conductor node, template file for PXE configuration. * - ``tftp_master_path`` = ``/tftpboot/master_images`` - - (StrOpt) On ironic-conductor node, directory where master TFTP images are stored on disk. + - (String) On ironic-conductor node, directory where master TFTP images are stored on disk. Setting to disables image caching. * - ``tftp_root`` = ``/tftpboot`` - - (StrOpt) ironic-conductor node's TFTP root path. The ironic-conductor must have read/write access to this path. + - (String) ironic-conductor node's TFTP root path. The ironic-conductor must have read/write access to this path. * - ``tftp_server`` = ``$my_ip`` - - (StrOpt) IP address of ironic-conductor node's TFTP server. + - (String) IP address of ironic-conductor node's TFTP server. * - ``uefi_pxe_bootfile_name`` = ``elilo.efi`` - - (StrOpt) Bootfile DHCP parameter for UEFI boot mode. + - (String) Bootfile DHCP parameter for UEFI boot mode. * - ``uefi_pxe_config_template`` = ``$pybasedir/drivers/modules/elilo_efi_pxe_config.template`` - - (StrOpt) On ironic-conductor node, template file for PXE configuration for UEFI boot loader. + - (String) On ironic-conductor node, template file for PXE configuration for UEFI boot loader. diff --git a/doc/config-reference/source/tables/ironic-qpid.rst b/doc/config-reference/source/tables/ironic-qpid.rst deleted file mode 100644 index 00e55eff9d..0000000000 --- a/doc/config-reference/source/tables/ironic-qpid.rst +++ /dev/null @@ -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. - -.. _ironic-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. diff --git a/doc/config-reference/source/tables/ironic-rabbitmq.rst b/doc/config-reference/source/tables/ironic-rabbitmq.rst index 73b31ca9dc..9af1ff1752 100644 --- a/doc/config-reference/source/tables/ironic-rabbitmq.rst +++ b/doc/config-reference/source/tables/ironic-rabbitmq.rst @@ -19,50 +19,112 @@ * - **[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`` + - (String) EXPERIMENTAL: Possible values are: gzip, bz2. If not set compression will not be used. This option may notbe available in future versions. + * - ``kombu_failover_strategy`` = ``round-robin`` + - (String) Determines how the next RabbitMQ node is chosen in case the one we are currently connected to becomes unavailable. Takes effect only if more than one RabbitMQ node is provided in config. + * - ``kombu_missing_consumer_retry_timeout`` = ``60`` + - (Integer) How long to wait a missing client 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. - * - ``kombu_reconnect_timeout`` = ``60`` - - (IntOpt) How long to wait before considering a reconnect attempt to have failed. This value should not be longer than rpc_response_timeout. + - (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`` + - (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`` - - (IntOpt) 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`` + - (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. + - (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. - * - ``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. + - (String) The RabbitMQ virtual host. + * - ``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 diff --git a/doc/config-reference/source/tables/ironic-redis.rst b/doc/config-reference/source/tables/ironic-redis.rst index d7a9379b40..8d4b19933b 100644 --- a/doc/config-reference/source/tables/ironic-redis.rst +++ b/doc/config-reference/source/tables/ironic-redis.rst @@ -16,17 +16,21 @@ * - Configuration option = Default value - Description - * - **[DEFAULT]** - - - * - ``password`` = - - (StrOpt) Password for Redis server (optional). - * - ``port`` = ``6379`` - - (IntOpt) Use this port to connect to redis host. * - **[matchmaker_redis]** - + * - ``check_timeout`` = ``20000`` + - (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`` - - (IntOpt) Use this port to connect to redis host. + - (Unknown) Use this port to connect to redis host. + * - ``sentinel_group_name`` = ``oslo-messaging-zeromq`` + - (String) Redis replica set name. + * - ``sentinel_hosts`` = + - (List) List of Redis Sentinel hosts (fault tolerance mode) e.g. [host:port, host1:port ... ] + * - ``socket_timeout`` = ``1000`` + - (Integer) Timeout in ms on blocking socket operations + * - ``wait_timeout`` = ``500`` + - (Integer) Time in ms to wait between connection attempts. diff --git a/doc/config-reference/source/tables/ironic-rpc.rst b/doc/config-reference/source/tables/ironic-rpc.rst index bcfcf2cb20..b14fa84906 100644 --- a/doc/config-reference/source/tables/ironic-rpc.rst +++ b/doc/config-reference/source/tables/ironic-rpc.rst @@ -19,52 +19,60 @@ * - **[DEFAULT]** - * - ``rpc_backend`` = ``rabbit`` - - (StrOpt) The messaging driver to use, defaults to rabbit. Other drivers include qpid and zmq. - * - ``rpc_cast_timeout`` = ``30`` - - (IntOpt) Seconds to wait before a cast expires (TTL). Only supported by impl_zmq. + - (String) The messaging driver to use, defaults to rabbit. Other drivers include amqp and zmq. + * - ``rpc_cast_timeout`` = ``-1`` + - (Integer) Seconds to wait before a cast expires (TTL). The default value of -1 specifies an infinite linger period. The value of 0 specifies no linger period. Pending messages shall be discarded immediately when the socket is closed. Only supported by impl_zmq. * - ``rpc_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_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`` = ``[]`` + - (Multi-valued) The Drivers(s) to handle sending notifications. Possible values are messaging, messagingv2, routing, log, test, noop + * - ``topics`` = ``notifications`` + - (List) AMQP topic used for OpenStack notifications. + * - ``transport_url`` = ``None`` + - (String) A URL representing the messaging driver to use for notifications. If not set, we fall back to the same configuration used for RPC. diff --git a/doc/config-reference/source/tables/ironic-seamicro.rst b/doc/config-reference/source/tables/ironic-seamicro.rst index fca1d28785..467fc498b3 100644 --- a/doc/config-reference/source/tables/ironic-seamicro.rst +++ b/doc/config-reference/source/tables/ironic-seamicro.rst @@ -19,6 +19,6 @@ * - **[seamicro]** - * - ``action_timeout`` = ``10`` - - (IntOpt) Seconds to wait for power action to be completed + - (Integer) Seconds to wait for power action to be completed * - ``max_retry`` = ``3`` - - (IntOpt) Maximum retries for SeaMicro operations + - (Integer) Maximum retries for SeaMicro operations diff --git a/doc/config-reference/source/tables/ironic-snmp.rst b/doc/config-reference/source/tables/ironic-snmp.rst index 3c8fc21878..ad68fbc267 100644 --- a/doc/config-reference/source/tables/ironic-snmp.rst +++ b/doc/config-reference/source/tables/ironic-snmp.rst @@ -19,6 +19,6 @@ * - **[snmp]** - * - ``power_timeout`` = ``10`` - - (IntOpt) Seconds to wait for power action to be completed + - (Integer) Seconds to wait for power action to be completed * - ``reboot_delay`` = ``0`` - - (IntOpt) Time (in seconds) to sleep between when rebooting (powering off and on again) + - (Integer) Time (in seconds) to sleep between when rebooting (powering off and on again) diff --git a/doc/config-reference/source/tables/ironic-ssh.rst b/doc/config-reference/source/tables/ironic-ssh.rst index 9a9c5a1430..2ac0d9afa6 100644 --- a/doc/config-reference/source/tables/ironic-ssh.rst +++ b/doc/config-reference/source/tables/ironic-ssh.rst @@ -19,8 +19,8 @@ * - **[ssh]** - * - ``get_vm_name_attempts`` = ``3`` - - (IntOpt) Number of attempts to try to get VM name used by the host that corresponds to a node's MAC address. + - (Integer) Number of attempts to try to get VM name used by the host that corresponds to a node's MAC address. * - ``get_vm_name_retry_interval`` = ``3`` - - (IntOpt) Number of seconds to wait between attempts to get VM name used by the host that corresponds to a node's MAC address. + - (Integer) Number of seconds to wait between attempts to get VM name used by the host that corresponds to a node's MAC address. * - ``libvirt_uri`` = ``qemu:///system`` - - (StrOpt) libvirt URI. + - (String) libvirt URI. diff --git a/doc/config-reference/source/tables/ironic-swift.rst b/doc/config-reference/source/tables/ironic-swift.rst index 4d0a7b4a80..091f0a5651 100644 --- a/doc/config-reference/source/tables/ironic-swift.rst +++ b/doc/config-reference/source/tables/ironic-swift.rst @@ -19,4 +19,4 @@ * - **[swift]** - * - ``swift_max_retries`` = ``2`` - - (IntOpt) Maximum number of times to retry a Swift request, before failing. + - (Integer) Maximum number of times to retry a Swift request, before failing. diff --git a/doc/config-reference/source/tables/ironic-virtualbox.rst b/doc/config-reference/source/tables/ironic-virtualbox.rst index 748a75d183..468b579bfa 100644 --- a/doc/config-reference/source/tables/ironic-virtualbox.rst +++ b/doc/config-reference/source/tables/ironic-virtualbox.rst @@ -19,4 +19,4 @@ * - **[virtualbox]** - * - ``port`` = ``18083`` - - (PortOpt) Port on which VirtualBox web service is listening. + - (Unknown) Port on which VirtualBox web service is listening. diff --git a/doc/config-reference/source/tables/ironic-zeromq.rst b/doc/config-reference/source/tables/ironic-zeromq.rst index ea3e740c59..6b741ba294 100644 --- a/doc/config-reference/source/tables/ironic-zeromq.rst +++ b/doc/config-reference/source/tables/ironic-zeromq.rst @@ -18,27 +18,27 @@ - Description * - **[DEFAULT]** - - * - ``rpc_zmq_all_req_rep`` = ``True`` - - (BoolOpt) Use REQ/REP pattern for all methods CALL/CAST/FANOUT. * - ``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`` - - (IntOpt) 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. - * - ``zmq_use_broker`` = ``True`` - - (BoolOpt) Shows whether zmq-messaging uses broker or not. + - (Integer) Maximum number of ingress messages to locally buffer per topic. Default is unlimited. + * - ``use_pub_sub`` = ``True`` + - (Boolean) Use PUB/SUB pattern for fanout methods. PUB/SUB always uses proxy. + * - ``zmq_target_expire`` = ``120`` + - (Integer) Expiration timeout in seconds of a name service record about existing target ( < 0 means no timeout). diff --git a/doc/config-reference/source/tables/keystone-amqp.rst b/doc/config-reference/source/tables/keystone-amqp.rst index daee165b45..4918313221 100644 --- a/doc/config-reference/source/tables/keystone-amqp.rst +++ b/doc/config-reference/source/tables/keystone-amqp.rst @@ -19,16 +19,12 @@ * - **[DEFAULT]** - * - ``control_exchange`` = ``keystone`` - - (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. * - ``default_publisher_id`` = ``None`` - - (StrOpt) Default publisher_id for outgoing notifications - * - ``notification_driver`` = ``[]`` - - (MultiStrOpt) The Drivers(s) to handle sending notifications. Possible values are messaging, messagingv2, routing, log, test, noop + - (String) Default publisher_id for outgoing notifications * - ``notification_format`` = ``basic`` - - (StrOpt) Define the notification format for Identity Service events. A "basic" notification has information about the resource being operated on. A "cadf" notification has the same information, as well as information about the initiator of the event. - * - ``notification_topics`` = ``notifications`` - - (ListOpt) AMQP topic used for OpenStack notifications. - * - ``notification_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) Define the notification format for Identity Service events. A "basic" notification has information about the resource being operated on. A "cadf" notification has the same information, as well as information about the initiator of the event. + * - ``notification_opt_out`` = ``[]`` + - (Multi-valued) Define the notification options to opt-out from. The value expected is: identity... This field can be set multiple times in order to add more notifications to opt-out from. For example: notification_opt_out=identity.user.created notification_opt_out=identity.authenticate.success * - ``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. diff --git a/doc/config-reference/source/tables/keystone-api.rst b/doc/config-reference/source/tables/keystone-api.rst index 469f4bf175..1ca50a02dc 100644 --- a/doc/config-reference/source/tables/keystone-api.rst +++ b/doc/config-reference/source/tables/keystone-api.rst @@ -19,80 +19,92 @@ * - **[DEFAULT]** - * - ``admin_endpoint`` = ``None`` - - (StrOpt) The base admin endpoint URL for Keystone that is advertised to clients (NOTE: this does NOT affect how Keystone listens for connections). Defaults to the base host URL of the request. E.g. a request to http://server:35357/v3/users will default to http://server:35357. You should only need to set this value if the base URL contains a path (e.g. /prefix/v3) or the endpoint should be found on a different server. - * - ``admin_token`` = ``ADMIN`` - - (StrOpt) A "shared secret" that can be used to bootstrap Keystone. This "token" does not represent a user, and carries no explicit authorization. To disable in production (highly recommended), remove AdminTokenAuthMiddleware from your paste application pipelines (for example, in keystone-paste.ini). + - (String) The base admin endpoint URL for Keystone that is advertised to clients (NOTE: this does NOT affect how Keystone listens for connections). Defaults to the base host URL of the request. E.g. a request to http://server:35357/v3/users will default to http://server:35357. You should only need to set this value if the base URL contains a path (e.g. /prefix/v3) or the endpoint should be found on a different server. + * - ``admin_token`` = ``None`` + - (String) A "shared secret" that can be used to bootstrap Keystone. This "token" does not represent a user, and carries no explicit authorization. If set to `None`, the value is ignored and the `admin_token` log in mechanism is effectively disabled. To completely disable `admin_token` in production (highly recommended), remove AdminTokenAuthMiddleware from your paste application pipelines (for example, in keystone-paste.ini). * - ``domain_id_immutable`` = ``True`` - - (BoolOpt) Set this to false if you want to enable the ability for user, group and project entities to be moved between domains by updating their domain_id. Allowing such movement is not recommended if the scope of a domain admin is being restricted by use of an appropriate policy file (see policy.v3cloudsample as an example). + - (Boolean) DEPRECATED: Set this to false if you want to enable the ability for user, group and project entities to be moved between domains by updating their domain_id. Allowing such movement is not recommended if the scope of a domain admin is being restricted by use of an appropriate policy file (see policy.v3cloudsample as an example). This ability is deprecated and will be removed in a future release. * - ``list_limit`` = ``None`` - - (IntOpt) The maximum number of entities that will be returned in a collection, with no limit set by default. This global limit may be then overridden for a specific driver, by specifying a list_limit in the appropriate section (e.g. [assignment]). + - (Integer) The maximum number of entities that will be returned in a collection, with no limit set by default. This global limit may be then overridden for a specific driver, by specifying a list_limit in the appropriate section (e.g. [assignment]). * - ``max_param_size`` = ``64`` - - (IntOpt) Limit the sizes of user & project ID/names. + - (Integer) Limit the sizes of user & project ID/names. * - ``max_project_tree_depth`` = ``5`` - - (IntOpt) Maximum depth of the project hierarchy. WARNING: setting it to a large value may adversely impact performance. + - (Integer) Maximum depth of the project hierarchy, excluding the project acting as a domain at the top of the hierarchy. WARNING: setting it to a large value may adversely impact performance. * - ``max_token_size`` = ``8192`` - - (IntOpt) Similar to max_param_size, but provides an exception for token values. + - (Integer) Similar to max_param_size, but provides an exception for token values. * - ``member_role_id`` = ``9fe2ff9ee4384b1894a90878d3e92bab`` - - (StrOpt) Similar to the member_role_name option, this represents the default role ID used to associate users with their default projects in the v2 API. This will be used as the explicit role where one is not specified by the v2 API. + - (String) Similar to the member_role_name option, this represents the default role ID used to associate users with their default projects in the v2 API. This will be used as the explicit role where one is not specified by the v2 API. * - ``member_role_name`` = ``_member_`` - - (StrOpt) This is the role name used in combination with the member_role_id option; see that option for more detail. + - (String) This is the role name used in combination with the member_role_id option; see that option for more detail. * - ``public_endpoint`` = ``None`` - - (StrOpt) The base public endpoint URL for Keystone that is advertised to clients (NOTE: this does NOT affect how Keystone listens for connections). Defaults to the base host URL of the request. E.g. a request to http://server:5000/v3/users will default to http://server:5000. You should only need to set this value if the base URL contains a path (e.g. /prefix/v3) or the endpoint should be found on a different server. - * - ``secure_proxy_ssl_header`` = ``None`` - - (StrOpt) The HTTP header used to determine the scheme for the original request, even if it was removed by an SSL terminating proxy. Typical value is "HTTP_X_FORWARDED_PROTO". + - (String) The base public endpoint URL for Keystone that is advertised to clients (NOTE: this does NOT affect how Keystone listens for connections). Defaults to the base host URL of the request. E.g. a request to http://server:5000/v3/users will default to http://server:5000. You should only need to set this value if the base URL contains a path (e.g. /prefix/v3) or the endpoint should be found on a different server. + * - ``secure_proxy_ssl_header`` = ``HTTP_X_FORWARDED_PROTO`` + - (String) The HTTP header used to determine the scheme for the original request, even if it was removed by an SSL terminating proxy. * - ``strict_password_check`` = ``False`` - - (BoolOpt) If set to true, strict password length checking is performed for password manipulation. If a password exceeds the maximum length, the operation will fail with an HTTP 403 Forbidden error. If set to false, passwords are automatically truncated to the maximum length. + - (Boolean) If set to true, strict password length checking is performed for password manipulation. If a password exceeds the maximum length, the operation will fail with an HTTP 403 Forbidden error. If set to false, passwords are automatically truncated to the maximum length. * - **[endpoint_filter]** - * - ``driver`` = ``sql`` - - (StrOpt) Entrypoint for the endpoint filter backend driver in the keystone.endpoint_filter namespace. + - (String) Entrypoint for the endpoint filter backend driver in the keystone.endpoint_filter namespace. * - ``return_all_endpoints_if_no_filter`` = ``True`` - - (BoolOpt) Toggle to return all active endpoints if no filter exists. + - (Boolean) Toggle to return all active endpoints if no filter exists. * - **[endpoint_policy]** - * - ``driver`` = ``sql`` - - (StrOpt) Entrypoint for the endpoint policy backend driver in the keystone.endpoint_policy namespace. + - (String) Entrypoint for the endpoint policy backend driver in the keystone.endpoint_policy namespace. * - ``enabled`` = ``True`` - - (BoolOpt) Enable endpoint_policy functionality. + - (Boolean) DEPRECATED: Enable endpoint_policy functionality. The option to enable the OS-ENDPOINT-POLICY extension has been deprecated in the M release and will be removed in the O release. The OS-ENDPOINT-POLICY extension will be enabled by default. * - **[eventlet_server]** - * - ``admin_bind_host`` = ``0.0.0.0`` - - (StrOpt) The IP address of the network interface for the admin service to listen on. + - (String) DEPRECATED: The IP address of the network interface for the admin service to listen on. * - ``admin_port`` = ``35357`` - - (IntOpt) The port number which the admin service listens on. + - (Unknown) DEPRECATED: The port number which the admin service listens on. * - ``admin_workers`` = ``None`` - - (IntOpt) The number of worker processes to serve the admin eventlet application. Defaults to number of CPUs (minimum of 2). + - (Integer) DEPRECATED: The number of worker processes to serve the admin eventlet application. Defaults to number of CPUs (minimum of 2). * - ``client_socket_timeout`` = ``900`` - - (IntOpt) Timeout for socket operations on a client connection. If an incoming connection is idle for this number of seconds it will be closed. A value of "0" means wait forever. + - (Integer) Timeout for socket operations on a client connection. If an incoming connection is idle for this number of seconds it will be closed. A value of "0" means wait forever. * - ``public_bind_host`` = ``0.0.0.0`` - - (StrOpt) The IP address of the network interface for the public service to listen on. + - (String) DEPRECATED: The IP address of the network interface for the public service to listen on. * - ``public_port`` = ``5000`` - - (IntOpt) The port number which the public service listens on. + - (Unknown) DEPRECATED: The port number which the public service listens on. * - ``public_workers`` = ``None`` - - (IntOpt) The number of worker processes to serve the public eventlet application. Defaults to number of CPUs (minimum of 2). + - (Integer) DEPRECATED: The number of worker processes to serve the public eventlet application. Defaults to number of CPUs (minimum of 2). * - ``tcp_keepalive`` = ``False`` - - (BoolOpt) Set this to true if you want to enable TCP_KEEPALIVE on server sockets, i.e. sockets used by the Keystone wsgi server for client connections. + - (Boolean) DEPRECATED: Set this to true if you want to enable TCP_KEEPALIVE on server sockets, i.e. sockets used by the Keystone wsgi server for client connections. * - ``tcp_keepidle`` = ``600`` - - (IntOpt) Sets the value of TCP_KEEPIDLE in seconds for each server socket. Only applies if tcp_keepalive is true. + - (Integer) DEPRECATED: Sets the value of TCP_KEEPIDLE in seconds for each server socket. Only applies if tcp_keepalive is true. Ignored if system does not support it. * - ``wsgi_keep_alive`` = ``True`` - - (BoolOpt) If set to false, disables keepalives on the server; all connections will be closed after serving one request. + - (Boolean) If set to false, disables keepalives on the server; all connections will be closed after serving one request. * - **[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. * - **[paste_deploy]** - * - ``config_file`` = ``keystone-paste.ini`` - - (StrOpt) Name of the paste configuration file that defines the available pipelines. + - (String) Name of the paste configuration file that defines the available pipelines. * - **[resource]** - + * - ``admin_project_domain_name`` = ``None`` + - (String) Name of the domain that owns the `admin_project_name`. Defaults to None. + * - ``admin_project_name`` = ``None`` + - (String) Special project for performing administrative operations on remote services. Tokens scoped to this project will contain the key/value `is_admin_project=true`. Defaults to None. * - ``cache_time`` = ``None`` - - (IntOpt) TTL (in seconds) to cache resource data. This has no effect unless global caching is enabled. + - (Integer) TTL (in seconds) to cache resource data. This has no effect unless global caching is enabled. * - ``caching`` = ``True`` - - (BoolOpt) Toggle for resource caching. This has no effect unless global caching is enabled. + - (Boolean) Toggle for resource caching. This has no effect unless global caching is enabled. + * - ``domain_name_url_safe`` = ``off`` + - (String) Whether the names of domains are restricted from containing url reserved characters. If set to new, attempts to create or update a domain with a url unsafe name will return an error. In addition, if set to strict, attempts to scope a token using a domain name which is unsafe will return an error. * - ``driver`` = ``None`` - - (StrOpt) Entrypoint for the resource backend driver in the keystone.resource namespace. Supplied drivers are ldap and sql. If a resource driver is not specified, the assignment driver will choose the resource driver. + - (String) Entrypoint for the resource backend driver in the keystone.resource namespace. Only an SQL driver is supplied. If a resource driver is not specified, the assignment driver will choose the resource driver. * - ``list_limit`` = ``None`` - - (IntOpt) Maximum number of entities that will be returned in a resource collection. + - (Integer) Maximum number of entities that will be returned in a resource collection. + * - ``project_name_url_safe`` = ``off`` + - (String) Whether the names of projects are restricted from containing url reserved characters. If set to new, attempts to create or update a project with a url unsafe name will return an error. In addition, if set to strict, attempts to scope a token using an unsafe project name will return an error. + * - **[shadow_users]** + - + * - ``driver`` = ``sql`` + - (String) Entrypoint for the shadow users backend driver in the keystone.identity.shadow_users namespace. diff --git a/doc/config-reference/source/tables/keystone-assignment.rst b/doc/config-reference/source/tables/keystone-assignment.rst index 87d79c6a6f..abfb4f2669 100644 --- a/doc/config-reference/source/tables/keystone-assignment.rst +++ b/doc/config-reference/source/tables/keystone-assignment.rst @@ -19,4 +19,6 @@ * - **[assignment]** - * - ``driver`` = ``None`` - - (StrOpt) Entrypoint for the assignment backend driver in the keystone.assignment namespace. Supplied drivers are ldap and sql. If an assignment driver is not specified, the identity driver will choose the assignment driver. + - (String) Entrypoint for the assignment backend driver in the keystone.assignment namespace. Only an SQL driver is supplied. If an assignment driver is not specified, the identity driver will choose the assignment driver (driver selection based on `[identity]/driver` option is deprecated and will be removed in the "O" release). + * - ``prohibited_implied_role`` = ``admin`` + - (List) A list of role names which are prohibited from being an implied role. diff --git a/doc/config-reference/source/tables/keystone-auth.rst b/doc/config-reference/source/tables/keystone-auth.rst index d9c4bcb195..570065bc1e 100644 --- a/doc/config-reference/source/tables/keystone-auth.rst +++ b/doc/config-reference/source/tables/keystone-auth.rst @@ -19,12 +19,12 @@ * - **[auth]** - * - ``external`` = ``None`` - - (StrOpt) Entrypoint for the external (REMOTE_USER) auth plugin module in the keystone.auth.external namespace. Supplied drivers are DefaultDomain and Domain. The default driver is DefaultDomain. + - (String) Entrypoint for the external (REMOTE_USER) auth plugin module in the keystone.auth.external namespace. Supplied drivers are DefaultDomain and Domain. The default driver is DefaultDomain. * - ``methods`` = ``external, password, token, oauth1`` - - (ListOpt) Allowed authentication methods. + - (List) Allowed authentication methods. * - ``oauth1`` = ``None`` - - (StrOpt) Entrypoint for the oAuth1.0 auth plugin module in the keystone.auth.oauth1 namespace. + - (String) Entrypoint for the oAuth1.0 auth plugin module in the keystone.auth.oauth1 namespace. * - ``password`` = ``None`` - - (StrOpt) Entrypoint for the password auth plugin module in the keystone.auth.password namespace. + - (String) Entrypoint for the password auth plugin module in the keystone.auth.password namespace. * - ``token`` = ``None`` - - (StrOpt) Entrypoint for the token auth plugin module in the keystone.auth.token namespace. + - (String) Entrypoint for the token auth plugin module in the keystone.auth.token namespace. diff --git a/doc/config-reference/source/tables/keystone-auth_token.rst b/doc/config-reference/source/tables/keystone-auth_token.rst index a07935a525..f34f158fa7 100644 --- a/doc/config-reference/source/tables/keystone-auth_token.rst +++ b/doc/config-reference/source/tables/keystone-auth_token.rst @@ -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. - * - ``auth_plugin`` = ``None`` - - (StrOpt) Name of the plugin to load + - (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 (http or https). Deprecated, use identity_uri. + - (String) Protocol of the admin Identity API endpoint. Deprecated, use identity_uri. * - ``auth_section`` = ``None`` - - (StrOpt) Config Section from which to load plugin specific options + - (Unknown) Config Section from which to load plugin specific options + * - ``auth_type`` = ``None`` + - (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. Acceptable values are MAC or ENCRYPT. 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. diff --git a/doc/config-reference/source/tables/keystone-ca.rst b/doc/config-reference/source/tables/keystone-ca.rst index a50492d276..8ec6482c4d 100644 --- a/doc/config-reference/source/tables/keystone-ca.rst +++ b/doc/config-reference/source/tables/keystone-ca.rst @@ -19,38 +19,38 @@ * - **[eventlet_server_ssl]** - * - ``ca_certs`` = ``/etc/keystone/ssl/certs/ca.pem`` - - (StrOpt) Path of the CA cert file for SSL. + - (String) DEPRECATED: Path of the CA cert file for SSL. * - ``cert_required`` = ``False`` - - (BoolOpt) Require client certificate. + - (Boolean) DEPRECATED: Require client certificate. * - ``certfile`` = ``/etc/keystone/ssl/certs/keystone.pem`` - - (StrOpt) Path of the certfile for SSL. For non-production environments, you may be interested in using `keystone-manage ssl_setup` to generate self-signed certificates. + - (String) DEPRECATED: Path of the certfile for SSL. For non-production environments, you may be interested in using `keystone-manage ssl_setup` to generate self-signed certificates. * - ``enable`` = ``False`` - - (BoolOpt) Toggle for SSL support on the Keystone eventlet servers. + - (Boolean) DEPRECATED: Toggle for SSL support on the Keystone eventlet servers. * - ``keyfile`` = ``/etc/keystone/ssl/private/keystonekey.pem`` - - (StrOpt) Path of the keyfile for SSL. + - (String) DEPRECATED: Path of the keyfile for SSL. * - **[signing]** - * - ``ca_certs`` = ``/etc/keystone/ssl/certs/ca.pem`` - - (StrOpt) Path of the CA for token signing. + - (String) DEPRECATED: Path of the CA for token signing. PKI token support has been deprecated in the M release and will be removed in the O release. Fernet or UUID tokens are recommended. * - ``ca_key`` = ``/etc/keystone/ssl/private/cakey.pem`` - - (StrOpt) Path of the CA key for token signing. + - (String) DEPRECATED: Path of the CA key for token signing. PKI token support has been deprecated in the M release and will be removed in the O release. Fernet or UUID tokens are recommended. * - ``cert_subject`` = ``/C=US/ST=Unset/L=Unset/O=Unset/CN=www.example.com`` - - (StrOpt) Certificate subject (auto generated certificate) for token signing. + - (String) DEPRECATED: Certificate subject (auto generated certificate) for token signing. PKI token support has been deprecated in the M release and will be removed in the O release. Fernet or UUID tokens are recommended. * - ``certfile`` = ``/etc/keystone/ssl/certs/signing_cert.pem`` - - (StrOpt) Path of the certfile for token signing. For non-production environments, you may be interested in using `keystone-manage pki_setup` to generate self-signed certificates. + - (String) DEPRECATED: Path of the certfile for token signing. For non-production environments, you may be interested in using `keystone-manage pki_setup` to generate self-signed certificates. PKI token support has been deprecated in the M release and will be removed in the O release. Fernet or UUID tokens are recommended. * - ``key_size`` = ``2048`` - - (IntOpt) Key size (in bits) for token signing cert (auto generated certificate). + - (Integer) DEPRECATED: Key size (in bits) for token signing cert (auto generated certificate). PKI token support has been deprecated in the M release and will be removed in the O release. Fernet or UUID tokens are recommended. * - ``keyfile`` = ``/etc/keystone/ssl/private/signing_key.pem`` - - (StrOpt) Path of the keyfile for token signing. + - (String) DEPRECATED: Path of the keyfile for token signing. PKI token support has been deprecated in the M release and will be removed in the O release. Fernet or UUID tokens are recommended. * - ``valid_days`` = ``3650`` - - (IntOpt) Days the token signing cert is valid for (auto generated certificate). + - (Integer) DEPRECATED: Days the token signing cert is valid for (auto generated certificate). PKI token support has been deprecated in the M release and will be removed in the O release. Fernet or UUID tokens are recommended. * - **[ssl]** - * - ``ca_key`` = ``/etc/keystone/ssl/private/cakey.pem`` - - (StrOpt) Path of the CA key file for SSL. + - (String) Path of the CA key file for SSL. * - ``cert_subject`` = ``/C=US/ST=Unset/L=Unset/O=Unset/CN=localhost`` - - (StrOpt) SSL certificate subject (auto generated certificate). + - (String) SSL certificate subject (auto generated certificate). * - ``key_size`` = ``1024`` - - (IntOpt) SSL key length (in bits) (auto generated certificate). + - (Integer) SSL key length (in bits) (auto generated certificate). * - ``valid_days`` = ``3650`` - - (IntOpt) Days the certificate is valid for once signed (auto generated certificate). + - (Integer) Days the certificate is valid for once signed (auto generated certificate). diff --git a/doc/config-reference/source/tables/keystone-cache.rst b/doc/config-reference/source/tables/keystone-cache.rst index 9ba60cfa5d..d1cba0c3a8 100644 --- a/doc/config-reference/source/tables/keystone-cache.rst +++ b/doc/config-reference/source/tables/keystone-cache.rst @@ -19,38 +19,38 @@ * - **[cache]** - * - ``backend`` = ``dogpile.cache.null`` - - (StrOpt) Dogpile.cache backend module. It is recommended that Memcache with pooling (oslo_cache.memcache_pool) or Redis (dogpile.cache.redis) be used in production deployments. Small workloads (single process) like devstack can use the dogpile.cache.memory backend. + - (String) Dogpile.cache backend module. It is recommended that Memcache with pooling (oslo_cache.memcache_pool) or Redis (dogpile.cache.redis) be used in production deployments. Small workloads (single process) like devstack can use the dogpile.cache.memory backend. * - ``backend_argument`` = ``[]`` - - (MultiStrOpt) Arguments supplied to the backend module. Specify this option once per argument to be passed to the dogpile.cache backend. Example format: ":". + - (Multi-valued) Arguments supplied to the backend module. Specify this option once per argument to be passed to the dogpile.cache backend. Example format: ":". * - ``config_prefix`` = ``cache.oslo`` - - (StrOpt) Prefix for building the configuration dictionary for the cache region. This should not need to be changed unless there is another dogpile.cache region with the same configuration name. + - (String) Prefix for building the configuration dictionary for the cache region. This should not need to be changed unless there is another dogpile.cache region with the same configuration name. * - ``debug_cache_backend`` = ``False`` - - (BoolOpt) Extra debugging from the cache backend (cache keys, get/set/delete/etc calls). This is only really useful if you need to see the specific cache-backend get/set/delete calls with the keys/values. Typically this should be left set to false. + - (Boolean) Extra debugging from the cache backend (cache keys, get/set/delete/etc calls). This is only really useful if you need to see the specific cache-backend get/set/delete calls with the keys/values. Typically this should be left set to false. * - ``enabled`` = ``False`` - - (BoolOpt) Global toggle for caching. + - (Boolean) Global toggle for caching. * - ``expiration_time`` = ``600`` - - (IntOpt) Default TTL, in seconds, for any cached item in the dogpile.cache region. This applies to any cached method that doesn't have an explicit cache expiration time defined for it. + - (Integer) Default TTL, in seconds, for any cached item in the dogpile.cache region. This applies to any cached method that doesn't have an explicit cache expiration time defined for it. * - ``memcache_dead_retry`` = ``300`` - - (IntOpt) Number of seconds memcached server is considered dead before it is tried again. (dogpile.cache.memcache and oslo_cache.memcache_pool backends only). + - (Integer) Number of seconds memcached server is considered dead before it is tried again. (dogpile.cache.memcache and oslo_cache.memcache_pool backends only). * - ``memcache_pool_connection_get_timeout`` = ``10`` - - (IntOpt) Number of seconds that an operation will wait to get a memcache client connection. + - (Integer) Number of seconds that an operation will wait to get a memcache client connection. * - ``memcache_pool_maxsize`` = ``10`` - - (IntOpt) Max total number of open connections to every memcached server. (oslo_cache.memcache_pool backend only). + - (Integer) Max total number of open connections to every memcached server. (oslo_cache.memcache_pool backend only). * - ``memcache_pool_unused_timeout`` = ``60`` - - (IntOpt) Number of seconds a connection to memcached is held unused in the pool before it is closed. (oslo_cache.memcache_pool backend only). + - (Integer) Number of seconds a connection to memcached is held unused in the pool before it is closed. (oslo_cache.memcache_pool backend only). * - ``memcache_servers`` = ``localhost:11211`` - - (ListOpt) Memcache servers in the format of "host:port". (dogpile.cache.memcache and oslo_cache.memcache_pool backends only). + - (List) Memcache servers in the format of "host:port". (dogpile.cache.memcache and oslo_cache.memcache_pool backends only). * - ``memcache_socket_timeout`` = ``3`` - - (IntOpt) Timeout in seconds for every call to a server. (dogpile.cache.memcache and oslo_cache.memcache_pool backends only). + - (Integer) Timeout in seconds for every call to a server. (dogpile.cache.memcache and oslo_cache.memcache_pool backends only). * - ``proxies`` = - - (ListOpt) Proxy classes to import that will affect the way the dogpile.cache backend functions. See the dogpile.cache documentation on changing-backend-behavior. + - (List) Proxy classes to import that will affect the way the dogpile.cache backend functions. See the dogpile.cache documentation on changing-backend-behavior. * - **[memcache]** - * - ``dead_retry`` = ``300`` - - (IntOpt) Number of seconds memcached server is considered dead before it is tried again. This is used by the key value store system (e.g. token pooled memcached persistence backend). + - (Integer) Number of seconds memcached server is considered dead before it is tried again. This is used by the key value store system (e.g. token pooled memcached persistence backend). * - ``pool_connection_get_timeout`` = ``10`` - - (IntOpt) Number of seconds that an operation will wait to get a memcache client connection. This is used by the key value store system (e.g. token pooled memcached persistence backend). + - (Integer) Number of seconds that an operation will wait to get a memcache client connection. This is used by the key value store system (e.g. token pooled memcached persistence backend). * - ``pool_maxsize`` = ``10`` - - (IntOpt) Max total number of open connections to every memcached server. This is used by the key value store system (e.g. token pooled memcached persistence backend). + - (Integer) Max total number of open connections to every memcached server. This is used by the key value store system (e.g. token pooled memcached persistence backend). * - ``pool_unused_timeout`` = ``60`` - - (IntOpt) Number of seconds a connection to memcached is held unused in the pool before it is closed. This is used by the key value store system (e.g. token pooled memcached persistence backend). + - (Integer) Number of seconds a connection to memcached is held unused in the pool before it is closed. This is used by the key value store system (e.g. token pooled memcached persistence backend). diff --git a/doc/config-reference/source/tables/keystone-catalog.rst b/doc/config-reference/source/tables/keystone-catalog.rst index e67d6c0b4b..820509d637 100644 --- a/doc/config-reference/source/tables/keystone-catalog.rst +++ b/doc/config-reference/source/tables/keystone-catalog.rst @@ -19,12 +19,12 @@ * - **[catalog]** - * - ``cache_time`` = ``None`` - - (IntOpt) Time to cache catalog data (in seconds). This has no effect unless global and catalog caching are enabled. + - (Integer) Time to cache catalog data (in seconds). This has no effect unless global and catalog caching are enabled. * - ``caching`` = ``True`` - - (BoolOpt) Toggle for catalog caching. This has no effect unless global caching is enabled. + - (Boolean) Toggle for catalog caching. This has no effect unless global caching is enabled. * - ``driver`` = ``sql`` - - (StrOpt) Entrypoint for the catalog backend driver in the keystone.catalog namespace. Supplied drivers are kvs, sql, templated, and endpoint_filter.sql + - (String) Entrypoint for the catalog backend driver in the keystone.catalog namespace. Supplied drivers are kvs, sql, templated, and endpoint_filter.sql * - ``list_limit`` = ``None`` - - (IntOpt) Maximum number of entities that will be returned in a catalog collection. + - (Integer) Maximum number of entities that will be returned in a catalog collection. * - ``template_file`` = ``default_catalog.templates`` - - (StrOpt) Catalog template file name for use with the template catalog backend. + - (String) Catalog template file name for use with the template catalog backend. diff --git a/doc/config-reference/source/tables/keystone-common.rst b/doc/config-reference/source/tables/keystone-common.rst index a5ce119263..ebf5d54ecf 100644 --- a/doc/config-reference/source/tables/keystone-common.rst +++ b/doc/config-reference/source/tables/keystone-common.rst @@ -19,16 +19,16 @@ * - **[DEFAULT]** - * - ``executor_thread_pool_size`` = ``64`` - - (IntOpt) Size of executor thread pool. + - (Integer) Size of executor thread pool. * - ``memcached_servers`` = ``None`` - - (ListOpt) Memcached servers or None for in process cache. + - (List) Memcached servers or None for in process cache. * - **[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. * - **[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. diff --git a/doc/config-reference/source/tables/keystone-cors.rst b/doc/config-reference/source/tables/keystone-cors.rst index ef35c2f1de..04939d3607 100644 --- a/doc/config-reference/source/tables/keystone-cors.rst +++ b/doc/config-reference/source/tables/keystone-cors.rst @@ -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. diff --git a/doc/config-reference/source/tables/keystone-credential.rst b/doc/config-reference/source/tables/keystone-credential.rst index c22efd7227..3da1090f09 100644 --- a/doc/config-reference/source/tables/keystone-credential.rst +++ b/doc/config-reference/source/tables/keystone-credential.rst @@ -19,4 +19,4 @@ * - **[credential]** - * - ``driver`` = ``sql`` - - (StrOpt) Entrypoint for the credential backend driver in the keystone.credential namespace. + - (String) Entrypoint for the credential backend driver in the keystone.credential namespace. diff --git a/doc/config-reference/source/tables/keystone-database.rst b/doc/config-reference/source/tables/keystone-database.rst index 99d9dda377..edf350cc7f 100644 --- a/doc/config-reference/source/tables/keystone-database.rst +++ b/doc/config-reference/source/tables/keystone-database.rst @@ -19,42 +19,42 @@ * - **[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. diff --git a/doc/config-reference/source/tables/keystone-debug.rst b/doc/config-reference/source/tables/keystone-debug.rst index c9be540304..b1fa3de054 100644 --- a/doc/config-reference/source/tables/keystone-debug.rst +++ b/doc/config-reference/source/tables/keystone-debug.rst @@ -19,12 +19,12 @@ * - **[DEFAULT]** - * - ``pydev_debug_host`` = ``None`` - - (StrOpt) Host to connect to for remote debugger. + - (String) Host to connect to for remote debugger. * - ``pydev_debug_port`` = ``None`` - - (IntOpt) Port to connect to for remote debugger. + - (Unknown) Port to connect to for remote debugger. * - ``standard_threads`` = ``False`` - - (BoolOpt) Do not monkey-patch threading system modules. + - (Boolean) Do not monkey-patch threading system modules. * - **[audit]** - * - ``namespace`` = ``openstack`` - - (StrOpt) namespace prefix for generated id + - (String) namespace prefix for generated id diff --git a/doc/config-reference/source/tables/keystone-domain.rst b/doc/config-reference/source/tables/keystone-domain.rst index 26d77dc89e..10f7426ec7 100644 --- a/doc/config-reference/source/tables/keystone-domain.rst +++ b/doc/config-reference/source/tables/keystone-domain.rst @@ -19,8 +19,8 @@ * - **[domain_config]** - * - ``cache_time`` = ``300`` - - (IntOpt) TTL (in seconds) to cache domain config data. This has no effect unless domain config caching is enabled. + - (Integer) TTL (in seconds) to cache domain config data. This has no effect unless domain config caching is enabled. * - ``caching`` = ``True`` - - (BoolOpt) Toggle for domain config caching. This has no effect unless global caching is enabled. + - (Boolean) Toggle for domain config caching. This has no effect unless global caching is enabled. * - ``driver`` = ``sql`` - - (StrOpt) Entrypoint for the domain config backend driver in the keystone.resource.domain_config namespace. + - (String) Entrypoint for the domain config backend driver in the keystone.resource.domain_config namespace. diff --git a/doc/config-reference/source/tables/keystone-federation.rst b/doc/config-reference/source/tables/keystone-federation.rst index 115cf81d3f..3bc19245aa 100644 --- a/doc/config-reference/source/tables/keystone-federation.rst +++ b/doc/config-reference/source/tables/keystone-federation.rst @@ -19,14 +19,14 @@ * - **[federation]** - * - ``assertion_prefix`` = - - (StrOpt) Value to be used when filtering assertion parameters from the environment. + - (String) Value to be used when filtering assertion parameters from the environment. * - ``driver`` = ``sql`` - - (StrOpt) Entrypoint for the federation backend driver in the keystone.federation namespace. + - (String) Entrypoint for the federation backend driver in the keystone.federation namespace. * - ``federated_domain_name`` = ``Federated`` - - (StrOpt) A domain name that is reserved to allow federated ephemeral users to have a domain concept. Note that an admin will not be able to create a domain with this name or update an existing domain to this name. You are not advised to change this value unless you really have to. + - (String) A domain name that is reserved to allow federated ephemeral users to have a domain concept. Note that an admin will not be able to create a domain with this name or update an existing domain to this name. You are not advised to change this value unless you really have to. * - ``remote_id_attribute`` = ``None`` - - (StrOpt) Value to be used to obtain the entity ID of the Identity Provider from the environment (e.g. if using the mod_shib plugin this value is `Shib-Identity-Provider`). + - (String) Value to be used to obtain the entity ID of the Identity Provider from the environment (e.g. if using the mod_shib plugin this value is `Shib-Identity-Provider`). * - ``sso_callback_template`` = ``/etc/keystone/sso_callback_template.html`` - - (StrOpt) Location of Single Sign-On callback handler, will return a token to a trusted dashboard host. + - (String) Location of Single Sign-On callback handler, will return a token to a trusted dashboard host. * - ``trusted_dashboard`` = ``[]`` - - (MultiStrOpt) A list of trusted dashboard hosts. Before accepting a Single Sign-On request to return a token, the origin host must be a member of the trusted_dashboard list. This configuration option may be repeated for multiple values. For example: trusted_dashboard=http://acme.com/auth/websso trusted_dashboard=http://beta.com/auth/websso + - (Multi-valued) A list of trusted dashboard hosts. Before accepting a Single Sign-On request to return a token, the origin host must be a member of the trusted_dashboard list. This configuration option may be repeated for multiple values. For example: trusted_dashboard=http://acme.com/auth/websso trusted_dashboard=http://beta.com/auth/websso diff --git a/doc/config-reference/source/tables/keystone-fernet_tokens.rst b/doc/config-reference/source/tables/keystone-fernet_tokens.rst index 6c0f46eced..e919205648 100644 --- a/doc/config-reference/source/tables/keystone-fernet_tokens.rst +++ b/doc/config-reference/source/tables/keystone-fernet_tokens.rst @@ -19,6 +19,6 @@ * - **[fernet_tokens]** - * - ``key_repository`` = ``/etc/keystone/fernet-keys/`` - - (StrOpt) Directory containing Fernet token keys. + - (String) Directory containing Fernet token keys. * - ``max_active_keys`` = ``3`` - - (IntOpt) This controls how many keys are held in rotation by keystone-manage fernet_rotate before they are discarded. The default value of 3 means that keystone will maintain one staged key, one primary key, and one secondary key. Increasing this value means that additional secondary keys will be kept in the rotation. + - (Integer) This controls how many keys are held in rotation by keystone-manage fernet_rotate before they are discarded. The default value of 3 means that keystone will maintain one staged key, one primary key, and one secondary key. Increasing this value means that additional secondary keys will be kept in the rotation. diff --git a/doc/config-reference/source/tables/keystone-identity.rst b/doc/config-reference/source/tables/keystone-identity.rst index c0cf94d882..7d4b57c495 100644 --- a/doc/config-reference/source/tables/keystone-identity.rst +++ b/doc/config-reference/source/tables/keystone-identity.rst @@ -19,20 +19,20 @@ * - **[identity]** - * - ``cache_time`` = ``600`` - - (IntOpt) Time to cache identity data (in seconds). This has no effect unless global and identity caching are enabled. + - (Integer) Time to cache identity data (in seconds). This has no effect unless global and identity caching are enabled. * - ``caching`` = ``True`` - - (BoolOpt) Toggle for identity caching. This has no effect unless global caching is enabled. + - (Boolean) Toggle for identity caching. This has no effect unless global caching is enabled. * - ``default_domain_id`` = ``default`` - - (StrOpt) This references the domain to use for all Identity API v2 requests (which are not aware of domains). A domain with this ID will be created for you by keystone-manage db_sync in migration 008. The domain referenced by this ID cannot be deleted on the v3 API, to prevent accidentally breaking the v2 API. There is nothing special about this domain, other than the fact that it must exist to order to maintain support for your v2 clients. + - (String) This references the domain to use for all Identity API v2 requests (which are not aware of domains). A domain with this ID will be created for you by keystone-manage db_sync in migration 008. The domain referenced by this ID cannot be deleted on the v3 API, to prevent accidentally breaking the v2 API. There is nothing special about this domain, other than the fact that it must exist to order to maintain support for your v2 clients. * - ``domain_config_dir`` = ``/etc/keystone/domains`` - - (StrOpt) Path for Keystone to locate the domain specific identity configuration files if domain_specific_drivers_enabled is set to true. + - (String) Path for Keystone to locate the domain specific identity configuration files if domain_specific_drivers_enabled is set to true. * - ``domain_configurations_from_database`` = ``False`` - - (BoolOpt) Extract the domain specific configuration options from the resource backend where they have been stored with the domain data. This feature is disabled by default (in which case the domain specific options will be loaded from files in the domain configuration directory); set to true to enable. + - (Boolean) Extract the domain specific configuration options from the resource backend where they have been stored with the domain data. This feature is disabled by default (in which case the domain specific options will be loaded from files in the domain configuration directory); set to true to enable. * - ``domain_specific_drivers_enabled`` = ``False`` - - (BoolOpt) A subset (or all) of domains can have their own identity driver, each with their own partial configuration options, stored in either the resource backend or in a file in a domain configuration directory (depending on the setting of domain_configurations_from_database). Only values specific to the domain need to be specified in this manner. This feature is disabled by default; set to true to enable. + - (Boolean) A subset (or all) of domains can have their own identity driver, each with their own partial configuration options, stored in either the resource backend or in a file in a domain configuration directory (depending on the setting of domain_configurations_from_database). Only values specific to the domain need to be specified in this manner. This feature is disabled by default; set to true to enable. * - ``driver`` = ``sql`` - - (StrOpt) Entrypoint for the identity backend driver in the keystone.identity namespace. Supplied drivers are ldap and sql. + - (String) Entrypoint for the identity backend driver in the keystone.identity namespace. Supplied drivers are ldap and sql. * - ``list_limit`` = ``None`` - - (IntOpt) Maximum number of entities that will be returned in an identity collection. + - (Integer) Maximum number of entities that will be returned in an identity collection. * - ``max_password_length`` = ``4096`` - - (IntOpt) Maximum supported length for user passwords; decrease to improve performance. + - (Integer) Maximum supported length for user passwords; decrease to improve performance. diff --git a/doc/config-reference/source/tables/keystone-kvs.rst b/doc/config-reference/source/tables/keystone-kvs.rst index 59beaeda7b..bd69b8aa0c 100644 --- a/doc/config-reference/source/tables/keystone-kvs.rst +++ b/doc/config-reference/source/tables/keystone-kvs.rst @@ -19,10 +19,10 @@ * - **[kvs]** - * - ``backends`` = - - (ListOpt) Extra dogpile.cache backend modules to register with the dogpile.cache library. + - (List) Extra dogpile.cache backend modules to register with the dogpile.cache library. * - ``config_prefix`` = ``keystone.kvs`` - - (StrOpt) Prefix for building the configuration dictionary for the KVS region. This should not need to be changed unless there is another dogpile.cache region with the same configuration name. + - (String) Prefix for building the configuration dictionary for the KVS region. This should not need to be changed unless there is another dogpile.cache region with the same configuration name. * - ``default_lock_timeout`` = ``5`` - - (IntOpt) Default lock timeout (in seconds) for distributed locking. + - (Integer) Default lock timeout (in seconds) for distributed locking. * - ``enable_key_mangler`` = ``True`` - - (BoolOpt) Toggle to disable using a key-mangling function to ensure fixed length keys. This is toggle-able for debugging purposes, it is highly recommended to always leave this set to true. + - (Boolean) Toggle to disable using a key-mangling function to ensure fixed length keys. This is toggle-able for debugging purposes, it is highly recommended to always leave this set to true. diff --git a/doc/config-reference/source/tables/keystone-ldap.rst b/doc/config-reference/source/tables/keystone-ldap.rst index c2d794732d..b5e36719c2 100644 --- a/doc/config-reference/source/tables/keystone-ldap.rst +++ b/doc/config-reference/source/tables/keystone-ldap.rst @@ -19,172 +19,120 @@ * - **[ldap]** - * - ``alias_dereferencing`` = ``default`` - - (StrOpt) The LDAP dereferencing option for queries. The "default" option falls back to using default dereferencing configured by your ldap.conf. + - (String) The LDAP dereferencing option for queries. The "default" option falls back to using default dereferencing configured by your ldap.conf. * - ``allow_subtree_delete`` = ``False`` - - (BoolOpt) Delete subtrees using the subtree delete control. Only enable this option if your LDAP server supports subtree deletion. + - (Boolean) Delete subtrees using the subtree delete control. Only enable this option if your LDAP server supports subtree deletion. * - ``auth_pool_connection_lifetime`` = ``60`` - - (IntOpt) End user auth connection lifetime in seconds. + - (Integer) End user auth connection lifetime in seconds. * - ``auth_pool_size`` = ``100`` - - (IntOpt) End user auth connection pool size. + - (Integer) End user auth connection pool size. * - ``chase_referrals`` = ``None`` - - (BoolOpt) Override the system's default referral chasing behavior for queries. + - (Boolean) Override the system's default referral chasing behavior for queries. * - ``debug_level`` = ``None`` - - (IntOpt) Sets the LDAP debugging level for LDAP calls. A value of 0 means that debugging is not enabled. This value is a bitmask, consult your LDAP documentation for possible values. + - (Integer) Sets the LDAP debugging level for LDAP calls. A value of 0 means that debugging is not enabled. This value is a bitmask, consult your LDAP documentation for possible values. * - ``dumb_member`` = ``cn=dumb,dc=nonexistent`` - - (StrOpt) DN of the "dummy member" to use when "use_dumb_member" is enabled. + - (String) DN of the "dummy member" to use when "use_dumb_member" is enabled. * - ``group_additional_attribute_mapping`` = - - (ListOpt) Additional attribute mappings for groups. Attribute mapping format is :, where ldap_attr is the attribute in the LDAP entry and user_attr is the Identity API attribute. + - (List) Additional attribute mappings for groups. Attribute mapping format is :, where ldap_attr is the attribute in the LDAP entry and user_attr is the Identity API attribute. * - ``group_allow_create`` = ``True`` - - (BoolOpt) Allow group creation in LDAP backend. + - (Boolean) DEPRECATED: Allow group creation in LDAP backend. Write support for Identity LDAP backends has been deprecated in the M release and will be removed in the O release. * - ``group_allow_delete`` = ``True`` - - (BoolOpt) Allow group deletion in LDAP backend. + - (Boolean) DEPRECATED: Allow group deletion in LDAP backend. Write support for Identity LDAP backends has been deprecated in the M release and will be removed in the O release. * - ``group_allow_update`` = ``True`` - - (BoolOpt) Allow group update in LDAP backend. + - (Boolean) DEPRECATED: Allow group update in LDAP backend. Write support for Identity LDAP backends has been deprecated in the M release and will be removed in the O release. * - ``group_attribute_ignore`` = - - (ListOpt) List of attributes stripped off the group on update. + - (List) List of attributes stripped off the group on update. * - ``group_desc_attribute`` = ``description`` - - (StrOpt) LDAP attribute mapped to group description. + - (String) LDAP attribute mapped to group description. * - ``group_filter`` = ``None`` - - (StrOpt) LDAP search filter for groups. + - (String) LDAP search filter for groups. * - ``group_id_attribute`` = ``cn`` - - (StrOpt) LDAP attribute mapped to group id. + - (String) LDAP attribute mapped to group id. * - ``group_member_attribute`` = ``member`` - - (StrOpt) LDAP attribute mapped to show group membership. + - (String) LDAP attribute mapped to show group membership. + * - ``group_members_are_ids`` = ``False`` + - (Boolean) If the members of the group objectclass are user IDs rather than DNs, set this to true. This is the case when using posixGroup as the group objectclass and OpenDirectory. * - ``group_name_attribute`` = ``ou`` - - (StrOpt) LDAP attribute mapped to group name. + - (String) LDAP attribute mapped to group name. * - ``group_objectclass`` = ``groupOfNames`` - - (StrOpt) LDAP objectclass for groups. + - (String) LDAP objectclass for groups. * - ``group_tree_dn`` = ``None`` - - (StrOpt) Search base for groups. Defaults to the suffix value. + - (String) Search base for groups. Defaults to the suffix value. * - ``page_size`` = ``0`` - - (IntOpt) Maximum results per page; a value of zero ("0") disables paging. + - (Integer) Maximum results per page; a value of zero ("0") disables paging. * - ``password`` = ``None`` - - (StrOpt) Password for the BindDN to query the LDAP server. + - (String) Password for the BindDN to query the LDAP server. * - ``pool_connection_lifetime`` = ``600`` - - (IntOpt) Connection lifetime in seconds. + - (Integer) Connection lifetime in seconds. * - ``pool_connection_timeout`` = ``-1`` - - (IntOpt) Connector timeout in seconds. Value -1 indicates indefinite wait for response. + - (Integer) Connector timeout in seconds. Value -1 indicates indefinite wait for response. * - ``pool_retry_delay`` = ``0.1`` - - (FloatOpt) Time span in seconds to wait between two reconnect trials. + - (Floating point) Time span in seconds to wait between two reconnect trials. * - ``pool_retry_max`` = ``3`` - - (IntOpt) Maximum count of reconnect trials. + - (Integer) Maximum count of reconnect trials. * - ``pool_size`` = ``10`` - - (IntOpt) Connection pool size. - * - ``project_additional_attribute_mapping`` = - - (ListOpt) Additional attribute mappings for projects. Attribute mapping format is :, where ldap_attr is the attribute in the LDAP entry and user_attr is the Identity API attribute. - * - ``project_allow_create`` = ``True`` - - (BoolOpt) Allow project creation in LDAP backend. - * - ``project_allow_delete`` = ``True`` - - (BoolOpt) Allow project deletion in LDAP backend. - * - ``project_allow_update`` = ``True`` - - (BoolOpt) Allow project update in LDAP backend. - * - ``project_attribute_ignore`` = - - (ListOpt) List of attributes stripped off the project on update. - * - ``project_desc_attribute`` = ``description`` - - (StrOpt) LDAP attribute mapped to project description. - * - ``project_domain_id_attribute`` = ``businessCategory`` - - (StrOpt) LDAP attribute mapped to project domain_id. - * - ``project_enabled_attribute`` = ``enabled`` - - (StrOpt) LDAP attribute mapped to project enabled. - * - ``project_enabled_emulation`` = ``False`` - - (BoolOpt) If true, Keystone uses an alternative method to determine if a project is enabled or not by checking if they are a member of the "project_enabled_emulation_dn" group. - * - ``project_enabled_emulation_dn`` = ``None`` - - (StrOpt) DN of the group entry to hold enabled projects when using enabled emulation. - * - ``project_enabled_emulation_use_group_config`` = ``False`` - - (BoolOpt) Use the "group_member_attribute" and "group_objectclass" settings to determine membership in the emulated enabled group. - * - ``project_filter`` = ``None`` - - (StrOpt) LDAP search filter for projects. - * - ``project_id_attribute`` = ``cn`` - - (StrOpt) LDAP attribute mapped to project id. - * - ``project_member_attribute`` = ``member`` - - (StrOpt) LDAP attribute mapped to project membership for user. - * - ``project_name_attribute`` = ``ou`` - - (StrOpt) LDAP attribute mapped to project name. - * - ``project_objectclass`` = ``groupOfNames`` - - (StrOpt) LDAP objectclass for projects. - * - ``project_tree_dn`` = ``None`` - - (StrOpt) Search base for projects. Defaults to the suffix value. + - (Integer) Connection pool size. * - ``query_scope`` = ``one`` - - (StrOpt) The LDAP scope for queries, "one" represents oneLevel/singleLevel and "sub" represents subtree/wholeSubtree options. - * - ``role_additional_attribute_mapping`` = - - (ListOpt) Additional attribute mappings for roles. Attribute mapping format is :, where ldap_attr is the attribute in the LDAP entry and user_attr is the Identity API attribute. - * - ``role_allow_create`` = ``True`` - - (BoolOpt) Allow role creation in LDAP backend. - * - ``role_allow_delete`` = ``True`` - - (BoolOpt) Allow role deletion in LDAP backend. - * - ``role_allow_update`` = ``True`` - - (BoolOpt) Allow role update in LDAP backend. - * - ``role_attribute_ignore`` = - - (ListOpt) List of attributes stripped off the role on update. - * - ``role_filter`` = ``None`` - - (StrOpt) LDAP search filter for roles. - * - ``role_id_attribute`` = ``cn`` - - (StrOpt) LDAP attribute mapped to role id. - * - ``role_member_attribute`` = ``roleOccupant`` - - (StrOpt) LDAP attribute mapped to role membership. - * - ``role_name_attribute`` = ``ou`` - - (StrOpt) LDAP attribute mapped to role name. - * - ``role_objectclass`` = ``organizationalRole`` - - (StrOpt) LDAP objectclass for roles. - * - ``role_tree_dn`` = ``None`` - - (StrOpt) Search base for roles. Defaults to the suffix value. + - (String) The LDAP scope for queries, "one" represents oneLevel/singleLevel and "sub" represents subtree/wholeSubtree options. * - ``suffix`` = ``cn=example,cn=com`` - - (StrOpt) LDAP server suffix + - (String) LDAP server suffix * - ``tls_cacertdir`` = ``None`` - - (StrOpt) CA certificate directory path for communicating with LDAP servers. + - (String) CA certificate directory path for communicating with LDAP servers. * - ``tls_cacertfile`` = ``None`` - - (StrOpt) CA certificate file path for communicating with LDAP servers. + - (String) CA certificate file path for communicating with LDAP servers. * - ``tls_req_cert`` = ``demand`` - - (StrOpt) Specifies what checks to perform on client certificates in an incoming TLS session. + - (String) Specifies what checks to perform on client certificates in an incoming TLS session. * - ``url`` = ``ldap://localhost`` - - (StrOpt) URL for connecting to the LDAP server. - * - ``use_auth_pool`` = ``False`` - - (BoolOpt) Enable LDAP connection pooling for end user authentication. If use_pool is disabled, then this setting is meaningless and is not used at all. + - (String) URL(s) for connecting to the LDAP server. Multiple LDAP URLs may be specified as a comma separated string. The first URL to successfully bind is used for the connection. + * - ``use_auth_pool`` = ``True`` + - (Boolean) Enable LDAP connection pooling for end user authentication. If use_pool is disabled, then this setting is meaningless and is not used at all. * - ``use_dumb_member`` = ``False`` - - (BoolOpt) If true, will add a dummy member to groups. This is required if the objectclass for groups requires the "member" attribute. - * - ``use_pool`` = ``False`` - - (BoolOpt) Enable LDAP connection pooling. + - (Boolean) If true, will add a dummy member to groups. This is required if the objectclass for groups requires the "member" attribute. + * - ``use_pool`` = ``True`` + - (Boolean) Enable LDAP connection pooling. * - ``use_tls`` = ``False`` - - (BoolOpt) Enable TLS for communicating with LDAP servers. + - (Boolean) Enable TLS for communicating with LDAP servers. * - ``user`` = ``None`` - - (StrOpt) User BindDN to query the LDAP server. + - (String) User BindDN to query the LDAP server. * - ``user_additional_attribute_mapping`` = - - (ListOpt) List of additional LDAP attributes used for mapping additional attribute mappings for users. Attribute mapping format is :, where ldap_attr is the attribute in the LDAP entry and user_attr is the Identity API attribute. + - (List) List of additional LDAP attributes used for mapping additional attribute mappings for users. Attribute mapping format is :, where ldap_attr is the attribute in the LDAP entry and user_attr is the Identity API attribute. * - ``user_allow_create`` = ``True`` - - (BoolOpt) Allow user creation in LDAP backend. + - (Boolean) DEPRECATED: Allow user creation in LDAP backend. Write support for Identity LDAP backends has been deprecated in the M release and will be removed in the O release. * - ``user_allow_delete`` = ``True`` - - (BoolOpt) Allow user deletion in LDAP backend. + - (Boolean) DEPRECATED: Allow user deletion in LDAP backend. Write support for Identity LDAP backends has been deprecated in the M release and will be removed in the O release. * - ``user_allow_update`` = ``True`` - - (BoolOpt) Allow user updates in LDAP backend. + - (Boolean) DEPRECATED: Allow user updates in LDAP backend. Write support for Identity LDAP backends has been deprecated in the M release and will be removed in the O release. * - ``user_attribute_ignore`` = ``default_project_id`` - - (ListOpt) List of attributes stripped off the user on update. + - (List) List of attributes stripped off the user on update. * - ``user_default_project_id_attribute`` = ``None`` - - (StrOpt) LDAP attribute mapped to default_project_id for users. + - (String) LDAP attribute mapped to default_project_id for users. + * - ``user_description_attribute`` = ``description`` + - (String) LDAP attribute mapped to user description. * - ``user_enabled_attribute`` = ``enabled`` - - (StrOpt) LDAP attribute mapped to user enabled flag. + - (String) LDAP attribute mapped to user enabled flag. * - ``user_enabled_default`` = ``True`` - - (StrOpt) Default value to enable users. This should match an appropriate int value if the LDAP server uses non-boolean (bitmask) values to indicate if a user is enabled or disabled. If this is not set to "True" the typical value is "512". This is typically used when "user_enabled_attribute = userAccountControl". + - (String) Default value to enable users. This should match an appropriate int value if the LDAP server uses non-boolean (bitmask) values to indicate if a user is enabled or disabled. If this is not set to "True" the typical value is "512". This is typically used when "user_enabled_attribute = userAccountControl". * - ``user_enabled_emulation`` = ``False`` - - (BoolOpt) If true, Keystone uses an alternative method to determine if a user is enabled or not by checking if they are a member of the "user_enabled_emulation_dn" group. + - (Boolean) If true, Keystone uses an alternative method to determine if a user is enabled or not by checking if they are a member of the "user_enabled_emulation_dn" group. * - ``user_enabled_emulation_dn`` = ``None`` - - (StrOpt) DN of the group entry to hold enabled users when using enabled emulation. + - (String) DN of the group entry to hold enabled users when using enabled emulation. * - ``user_enabled_emulation_use_group_config`` = ``False`` - - (BoolOpt) Use the "group_member_attribute" and "group_objectclass" settings to determine membership in the emulated enabled group. + - (Boolean) Use the "group_member_attribute" and "group_objectclass" settings to determine membership in the emulated enabled group. * - ``user_enabled_invert`` = ``False`` - - (BoolOpt) Invert the meaning of the boolean enabled values. Some LDAP servers use a boolean lock attribute where "true" means an account is disabled. Setting "user_enabled_invert = true" will allow these lock attributes to be used. This setting will have no effect if "user_enabled_mask" or "user_enabled_emulation" settings are in use. + - (Boolean) Invert the meaning of the boolean enabled values. Some LDAP servers use a boolean lock attribute where "true" means an account is disabled. Setting "user_enabled_invert = true" will allow these lock attributes to be used. This setting will have no effect if "user_enabled_mask" or "user_enabled_emulation" settings are in use. * - ``user_enabled_mask`` = ``0`` - - (IntOpt) Bitmask integer to indicate the bit that the enabled value is stored in if the LDAP server represents "enabled" as a bit on an integer rather than a boolean. A value of "0" indicates the mask is not used. If this is not set to "0" the typical value is "2". This is typically used when "user_enabled_attribute = userAccountControl". + - (Integer) Bitmask integer to indicate the bit that the enabled value is stored in if the LDAP server represents "enabled" as a bit on an integer rather than a boolean. A value of "0" indicates the mask is not used. If this is not set to "0" the typical value is "2". This is typically used when "user_enabled_attribute = userAccountControl". * - ``user_filter`` = ``None`` - - (StrOpt) LDAP search filter for users. + - (String) LDAP search filter for users. * - ``user_id_attribute`` = ``cn`` - - (StrOpt) LDAP attribute mapped to user id. WARNING: must not be a multivalued attribute. + - (String) LDAP attribute mapped to user id. WARNING: must not be a multivalued attribute. * - ``user_mail_attribute`` = ``mail`` - - (StrOpt) LDAP attribute mapped to user email. + - (String) LDAP attribute mapped to user email. * - ``user_name_attribute`` = ``sn`` - - (StrOpt) LDAP attribute mapped to user name. + - (String) LDAP attribute mapped to user name. * - ``user_objectclass`` = ``inetOrgPerson`` - - (StrOpt) LDAP objectclass for users. + - (String) LDAP objectclass for users. * - ``user_pass_attribute`` = ``userPassword`` - - (StrOpt) LDAP attribute mapped to password. + - (String) LDAP attribute mapped to password. * - ``user_tree_dn`` = ``None`` - - (StrOpt) Search base for users. Defaults to the suffix value. + - (String) Search base for users. Defaults to the suffix value. diff --git a/doc/config-reference/source/tables/keystone-logging.rst b/doc/config-reference/source/tables/keystone-logging.rst index 21dc1fb8a6..fa4978f4b6 100644 --- a/doc/config-reference/source/tables/keystone-logging.rst +++ b/doc/config-reference/source/tables/keystone-logging.rst @@ -19,44 +19,44 @@ * - **[DEFAULT]** - * - ``debug`` = ``False`` - - (BoolOpt) Print debugging output (set logging level to DEBUG instead of 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`` - - (ListOpt) List of logger=LEVEL pairs. This option is ignored if log_config_append is set. + - (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`` + - (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. + * - ``insecure_debug`` = ``False`` + - (Boolean) If set to true the server will return information in the response that may allow an unauthenticated or authenticated user to get more information than normal, such as why authentication failed. This may be useful for debugging but is insecure. * - ``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. + - (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) 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 output to. If no default is set, logging will go to stdout. 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) Data to append to log format when level 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 without context. + - (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) Format string for user_identity field of the 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) (Optional) Enables or disables syslog rfc5424 format for logging. If enabled, prefixes the MSG part of the syslog message with APP-NAME (RFC5424). The format without the APP-NAME is deprecated in Kilo, and will be removed in Mitaka, along with this option. 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, will disable INFO logging level, making WARNING the default. + - (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) (Optional) 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. diff --git a/doc/config-reference/source/tables/keystone-mapping.rst b/doc/config-reference/source/tables/keystone-mapping.rst index c764a93ca0..b6ac990d66 100644 --- a/doc/config-reference/source/tables/keystone-mapping.rst +++ b/doc/config-reference/source/tables/keystone-mapping.rst @@ -19,8 +19,8 @@ * - **[identity_mapping]** - * - ``backward_compatible_ids`` = ``True`` - - (BoolOpt) The format of user and group IDs changed in Juno for backends that do not generate UUIDs (e.g. LDAP), with keystone providing a hash mapping to the underlying attribute in LDAP. By default this mapping is disabled, which ensures that existing IDs will not change. Even when the mapping is enabled by using domain specific drivers, any users and groups from the default domain being handled by LDAP will still not be mapped to ensure their IDs remain backward compatible. Setting this value to False will enable the mapping for even the default LDAP driver. It is only safe to do this if you do not already have assignments for users and groups from the default LDAP domain, and it is acceptable for Keystone to provide the different IDs to clients than it did previously. Typically this means that the only time you can set this value to False is when configuring a fresh installation. + - (Boolean) The format of user and group IDs changed in Juno for backends that do not generate UUIDs (e.g. LDAP), with keystone providing a hash mapping to the underlying attribute in LDAP. By default this mapping is disabled, which ensures that existing IDs will not change. Even when the mapping is enabled by using domain specific drivers, any users and groups from the default domain being handled by LDAP will still not be mapped to ensure their IDs remain backward compatible. Setting this value to False will enable the mapping for even the default LDAP driver. It is only safe to do this if you do not already have assignments for users and groups from the default LDAP domain, and it is acceptable for Keystone to provide the different IDs to clients than it did previously. Typically this means that the only time you can set this value to False is when configuring a fresh installation. * - ``driver`` = ``sql`` - - (StrOpt) Entrypoint for the identity mapping backend driver in the keystone.identity.id_mapping namespace. + - (String) Entrypoint for the identity mapping backend driver in the keystone.identity.id_mapping namespace. * - ``generator`` = ``sha256`` - - (StrOpt) Entrypoint for the public ID generator for user and group entities in the keystone.identity.id_generator namespace. The Keystone identity mapper only supports generators that produce no more than 64 characters. + - (String) Entrypoint for the public ID generator for user and group entities in the keystone.identity.id_generator namespace. The Keystone identity mapper only supports generators that produce no more than 64 characters. diff --git a/doc/config-reference/source/tables/keystone-memcache.rst b/doc/config-reference/source/tables/keystone-memcache.rst index 8f9a947686..1e997aad92 100644 --- a/doc/config-reference/source/tables/keystone-memcache.rst +++ b/doc/config-reference/source/tables/keystone-memcache.rst @@ -19,6 +19,6 @@ * - **[memcache]** - * - ``servers`` = ``localhost:11211`` - - (ListOpt) Memcache servers in the format of "host:port". + - (List) Memcache servers in the format of "host:port". * - ``socket_timeout`` = ``3`` - - (IntOpt) Timeout in seconds for every call to a server. This is used by the key value store system (e.g. token pooled memcached persistence backend). + - (Integer) Timeout in seconds for every call to a server. This is used by the key value store system (e.g. token pooled memcached persistence backend). diff --git a/doc/config-reference/source/tables/keystone-oauth.rst b/doc/config-reference/source/tables/keystone-oauth.rst index 103bd194e2..1ee3400352 100644 --- a/doc/config-reference/source/tables/keystone-oauth.rst +++ b/doc/config-reference/source/tables/keystone-oauth.rst @@ -19,8 +19,8 @@ * - **[oauth1]** - * - ``access_token_duration`` = ``86400`` - - (IntOpt) Duration (in seconds) for the OAuth Access Token. + - (Integer) Duration (in seconds) for the OAuth Access Token. * - ``driver`` = ``sql`` - - (StrOpt) Entrypoint for the OAuth backend driver in the keystone.oauth1 namespace. + - (String) Entrypoint for the OAuth backend driver in the keystone.oauth1 namespace. * - ``request_token_duration`` = ``28800`` - - (IntOpt) Duration (in seconds) for the OAuth Request Token. + - (Integer) Duration (in seconds) for the OAuth Request Token. diff --git a/doc/config-reference/source/tables/keystone-os_inherit.rst b/doc/config-reference/source/tables/keystone-os_inherit.rst index e36e767430..ca25839f0c 100644 --- a/doc/config-reference/source/tables/keystone-os_inherit.rst +++ b/doc/config-reference/source/tables/keystone-os_inherit.rst @@ -18,5 +18,5 @@ - Description * - **[os_inherit]** - - * - ``enabled`` = ``False`` - - (BoolOpt) role-assignment inheritance to projects from owning domain or from projects higher in the hierarchy can be optionally enabled. + * - ``enabled`` = ``True`` + - (Boolean) DEPRECATED: role-assignment inheritance to projects from owning domain or from projects higher in the hierarchy can be optionally disabled. In the future, this option will be removed and the hierarchy will be always enabled. The option to enable the OS-INHERIT extension has been deprecated in the M release and will be removed in the O release. The OS-INHERIT extension will be enabled by default. diff --git a/doc/config-reference/source/tables/keystone-policy.rst b/doc/config-reference/source/tables/keystone-policy.rst index d025197945..245df50c9d 100644 --- a/doc/config-reference/source/tables/keystone-policy.rst +++ b/doc/config-reference/source/tables/keystone-policy.rst @@ -19,14 +19,14 @@ * - **[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. * - **[policy]** - * - ``driver`` = ``sql`` - - (StrOpt) Entrypoint for the policy backend driver in the keystone.policy namespace. Supplied drivers are rules and sql. + - (String) Entrypoint for the policy backend driver in the keystone.policy namespace. Supplied drivers are rules and sql. * - ``list_limit`` = ``None`` - - (IntOpt) Maximum number of entities that will be returned in a policy collection. + - (Integer) Maximum number of entities that will be returned in a policy collection. diff --git a/doc/config-reference/source/tables/keystone-qpid.rst b/doc/config-reference/source/tables/keystone-qpid.rst deleted file mode 100644 index 0fd19a0c9e..0000000000 --- a/doc/config-reference/source/tables/keystone-qpid.rst +++ /dev/null @@ -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. - -.. _keystone-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. diff --git a/doc/config-reference/source/tables/keystone-rabbitmq.rst b/doc/config-reference/source/tables/keystone-rabbitmq.rst index 3357974f51..02bc079a06 100644 --- a/doc/config-reference/source/tables/keystone-rabbitmq.rst +++ b/doc/config-reference/source/tables/keystone-rabbitmq.rst @@ -19,50 +19,112 @@ * - **[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`` + - (String) EXPERIMENTAL: Possible values are: gzip, bz2. If not set compression will not be used. This option may notbe available in future versions. + * - ``kombu_failover_strategy`` = ``round-robin`` + - (String) Determines how the next RabbitMQ node is chosen in case the one we are currently connected to becomes unavailable. Takes effect only if more than one RabbitMQ node is provided in config. + * - ``kombu_missing_consumer_retry_timeout`` = ``60`` + - (Integer) How long to wait a missing client 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. - * - ``kombu_reconnect_timeout`` = ``60`` - - (IntOpt) How long to wait before considering a reconnect attempt to have failed. This value should not be longer than rpc_response_timeout. + - (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`` + - (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`` - - (IntOpt) 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`` + - (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. + - (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. - * - ``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. + - (String) The RabbitMQ virtual host. + * - ``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 diff --git a/doc/config-reference/source/tables/keystone-redis.rst b/doc/config-reference/source/tables/keystone-redis.rst index 44d2fa3a38..5ee284fed1 100644 --- a/doc/config-reference/source/tables/keystone-redis.rst +++ b/doc/config-reference/source/tables/keystone-redis.rst @@ -16,19 +16,21 @@ * - Configuration option = Default value - Description - * - **[DEFAULT]** - - - * - ``host`` = ``127.0.0.1`` - - (StrOpt) Host to locate redis. - * - ``password`` = - - (StrOpt) Password for Redis server (optional). - * - ``port`` = ``6379`` - - (IntOpt) Use this port to connect to redis host. * - **[matchmaker_redis]** - + * - ``check_timeout`` = ``20000`` + - (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`` - - (IntOpt) Use this port to connect to redis host. + - (Unknown) Use this port to connect to redis host. + * - ``sentinel_group_name`` = ``oslo-messaging-zeromq`` + - (String) Redis replica set name. + * - ``sentinel_hosts`` = + - (List) List of Redis Sentinel hosts (fault tolerance mode) e.g. [host:port, host1:port ... ] + * - ``socket_timeout`` = ``1000`` + - (Integer) Timeout in ms on blocking socket operations + * - ``wait_timeout`` = ``500`` + - (Integer) Time in ms to wait between connection attempts. diff --git a/doc/config-reference/source/tables/keystone-revoke.rst b/doc/config-reference/source/tables/keystone-revoke.rst index 40ff55f118..f840110e41 100644 --- a/doc/config-reference/source/tables/keystone-revoke.rst +++ b/doc/config-reference/source/tables/keystone-revoke.rst @@ -19,10 +19,10 @@ * - **[revoke]** - * - ``cache_time`` = ``3600`` - - (IntOpt) Time to cache the revocation list and the revocation events (in seconds). This has no effect unless global and token caching are enabled. + - (Integer) Time to cache the revocation list and the revocation events (in seconds). This has no effect unless global and token caching are enabled. * - ``caching`` = ``True`` - - (BoolOpt) Toggle for revocation event caching. This has no effect unless global caching is enabled. + - (Boolean) Toggle for revocation event caching. This has no effect unless global caching is enabled. * - ``driver`` = ``sql`` - - (StrOpt) Entrypoint for an implementation of the backend for persisting revocation events in the keystone.revoke namespace. Supplied drivers are kvs and sql. + - (String) Entrypoint for an implementation of the backend for persisting revocation events in the keystone.revoke namespace. Supplied drivers are kvs and sql. * - ``expiration_buffer`` = ``1800`` - - (IntOpt) This value (calculated in seconds) is added to token expiration before a revocation event may be removed from the backend. + - (Integer) This value (calculated in seconds) is added to token expiration before a revocation event may be removed from the backend. diff --git a/doc/config-reference/source/tables/keystone-role.rst b/doc/config-reference/source/tables/keystone-role.rst index 0ce0a51e76..084cd4d385 100644 --- a/doc/config-reference/source/tables/keystone-role.rst +++ b/doc/config-reference/source/tables/keystone-role.rst @@ -19,10 +19,10 @@ * - **[role]** - * - ``cache_time`` = ``None`` - - (IntOpt) TTL (in seconds) to cache role data. This has no effect unless global caching is enabled. + - (Integer) TTL (in seconds) to cache role data. This has no effect unless global caching is enabled. * - ``caching`` = ``True`` - - (BoolOpt) Toggle for role caching. This has no effect unless global caching is enabled. + - (Boolean) Toggle for role caching. This has no effect unless global caching is enabled. * - ``driver`` = ``None`` - - (StrOpt) Entrypoint for the role backend driver in the keystone.role namespace. Supplied drivers are ldap and sql. + - (String) Entrypoint for the role backend driver in the keystone.role namespace. Supplied drivers are ldap and sql. * - ``list_limit`` = ``None`` - - (IntOpt) Maximum number of entities that will be returned in a role collection. + - (Integer) Maximum number of entities that will be returned in a role collection. diff --git a/doc/config-reference/source/tables/keystone-rpc.rst b/doc/config-reference/source/tables/keystone-rpc.rst index 62a385e8c1..088c8374ca 100644 --- a/doc/config-reference/source/tables/keystone-rpc.rst +++ b/doc/config-reference/source/tables/keystone-rpc.rst @@ -19,46 +19,54 @@ * - **[DEFAULT]** - * - ``rpc_backend`` = ``rabbit`` - - (StrOpt) The messaging driver to use, defaults to rabbit. Other drivers include qpid and zmq. - * - ``rpc_cast_timeout`` = ``30`` - - (IntOpt) Seconds to wait before a cast expires (TTL). Only supported by impl_zmq. + - (String) The messaging driver to use, defaults to rabbit. Other drivers include amqp and zmq. + * - ``rpc_cast_timeout`` = ``-1`` + - (Integer) Seconds to wait before a cast expires (TTL). The default value of -1 specifies an infinite linger period. The value of 0 specifies no linger period. Pending messages shall be discarded immediately when the socket is closed. Only supported by impl_zmq. * - ``rpc_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`` = ``[]`` + - (Multi-valued) The Drivers(s) to handle sending notifications. Possible values are messaging, messagingv2, routing, log, test, noop + * - ``topics`` = ``notifications`` + - (List) AMQP topic used for OpenStack notifications. + * - ``transport_url`` = ``None`` + - (String) A URL representing the messaging driver to use for notifications. If not set, we fall back to the same configuration used for RPC. diff --git a/doc/config-reference/source/tables/keystone-saml.rst b/doc/config-reference/source/tables/keystone-saml.rst index 580a9b9a06..019be22f6e 100644 --- a/doc/config-reference/source/tables/keystone-saml.rst +++ b/doc/config-reference/source/tables/keystone-saml.rst @@ -19,38 +19,38 @@ * - **[saml]** - * - ``assertion_expiration_time`` = ``3600`` - - (IntOpt) Default TTL, in seconds, for any generated SAML assertion created by Keystone. + - (Integer) Default TTL, in seconds, for any generated SAML assertion created by Keystone. * - ``certfile`` = ``/etc/keystone/ssl/certs/signing_cert.pem`` - - (StrOpt) Path of the certfile for SAML signing. For non-production environments, you may be interested in using `keystone-manage pki_setup` to generate self-signed certificates. Note, the path cannot contain a comma. + - (String) Path of the certfile for SAML signing. For non-production environments, you may be interested in using `keystone-manage pki_setup` to generate self-signed certificates. Note, the path cannot contain a comma. * - ``idp_contact_company`` = ``None`` - - (StrOpt) Company of contact person. + - (String) Company of contact person. * - ``idp_contact_email`` = ``None`` - - (StrOpt) Email address of contact person. + - (String) Email address of contact person. * - ``idp_contact_name`` = ``None`` - - (StrOpt) Given name of contact person + - (String) Given name of contact person * - ``idp_contact_surname`` = ``None`` - - (StrOpt) Surname of contact person. + - (String) Surname of contact person. * - ``idp_contact_telephone`` = ``None`` - - (StrOpt) Telephone number of contact person. + - (String) Telephone number of contact person. * - ``idp_contact_type`` = ``other`` - - (StrOpt) The contact type describing the main point of contact for the identity provider. + - (String) The contact type describing the main point of contact for the identity provider. * - ``idp_entity_id`` = ``None`` - - (StrOpt) Entity ID value for unique Identity Provider identification. Usually FQDN is set with a suffix. A value is required to generate IDP Metadata. For example: https://keystone.example.com/v3/OS-FEDERATION/saml2/idp + - (String) Entity ID value for unique Identity Provider identification. Usually FQDN is set with a suffix. A value is required to generate IDP Metadata. For example: https://keystone.example.com/v3/OS-FEDERATION/saml2/idp * - ``idp_lang`` = ``en`` - - (StrOpt) Language used by the organization. + - (String) Language used by the organization. * - ``idp_metadata_path`` = ``/etc/keystone/saml2_idp_metadata.xml`` - - (StrOpt) Path to the Identity Provider Metadata file. This file should be generated with the keystone-manage saml_idp_metadata command. + - (String) Path to the Identity Provider Metadata file. This file should be generated with the keystone-manage saml_idp_metadata command. * - ``idp_organization_display_name`` = ``None`` - - (StrOpt) Organization name to be displayed. + - (String) Organization name to be displayed. * - ``idp_organization_name`` = ``None`` - - (StrOpt) Organization name the installation belongs to. + - (String) Organization name the installation belongs to. * - ``idp_organization_url`` = ``None`` - - (StrOpt) URL of the organization. + - (String) URL of the organization. * - ``idp_sso_endpoint`` = ``None`` - - (StrOpt) Identity Provider Single-Sign-On service value, required in the Identity Provider's metadata. A value is required to generate IDP Metadata. For example: https://keystone.example.com/v3/OS-FEDERATION/saml2/sso + - (String) Identity Provider Single-Sign-On service value, required in the Identity Provider's metadata. A value is required to generate IDP Metadata. For example: https://keystone.example.com/v3/OS-FEDERATION/saml2/sso * - ``keyfile`` = ``/etc/keystone/ssl/private/signing_key.pem`` - - (StrOpt) Path of the keyfile for SAML signing. Note, the path cannot contain a comma. + - (String) Path of the keyfile for SAML signing. Note, the path cannot contain a comma. * - ``relay_state_prefix`` = ``ss:mem:`` - - (StrOpt) The prefix to use for the RelayState SAML attribute, used when generating ECP wrapped assertions. + - (String) The prefix to use for the RelayState SAML attribute, used when generating ECP wrapped assertions. * - ``xmlsec1_binary`` = ``xmlsec1`` - - (StrOpt) Binary to be called for XML signing. Install the appropriate package, specify absolute path or adjust your PATH environment variable if the binary cannot be found. + - (String) Binary to be called for XML signing. Install the appropriate package, specify absolute path or adjust your PATH environment variable if the binary cannot be found. diff --git a/doc/config-reference/source/tables/keystone-security.rst b/doc/config-reference/source/tables/keystone-security.rst index 3d97d2013c..814fd50fcf 100644 --- a/doc/config-reference/source/tables/keystone-security.rst +++ b/doc/config-reference/source/tables/keystone-security.rst @@ -19,4 +19,4 @@ * - **[DEFAULT]** - * - ``crypt_strength`` = ``10000`` - - (IntOpt) The value passed as the keyword "rounds" to passlib's encrypt method. + - (Integer) The value passed as the keyword "rounds" to passlib's encrypt method. diff --git a/doc/config-reference/source/tables/keystone-token.rst b/doc/config-reference/source/tables/keystone-token.rst index 51b29a299c..59c1186805 100644 --- a/doc/config-reference/source/tables/keystone-token.rst +++ b/doc/config-reference/source/tables/keystone-token.rst @@ -19,22 +19,24 @@ * - **[token]** - * - ``allow_rescope_scoped_token`` = ``True`` - - (BoolOpt) Allow rescoping of scoped token. Setting allow_rescoped_scoped_token to false prevents a user from exchanging a scoped token for any other token. + - (Boolean) Allow rescoping of scoped token. Setting allow_rescoped_scoped_token to false prevents a user from exchanging a scoped token for any other token. * - ``bind`` = - - (ListOpt) External auth mechanisms that should add bind information to token, e.g., kerberos,x509. + - (List) External auth mechanisms that should add bind information to token, e.g., kerberos,x509. * - ``cache_time`` = ``None`` - - (IntOpt) Time to cache tokens (in seconds). This has no effect unless global and token caching are enabled. + - (Integer) Time to cache tokens (in seconds). This has no effect unless global and token caching are enabled. * - ``caching`` = ``True`` - - (BoolOpt) Toggle for token system caching. This has no effect unless global caching is enabled. + - (Boolean) Toggle for token system caching. This has no effect unless global caching is enabled. * - ``driver`` = ``sql`` - - (StrOpt) Entrypoint for the token persistence backend driver in the keystone.token.persistence namespace. Supplied drivers are kvs, memcache, memcache_pool, and sql. + - (String) Entrypoint for the token persistence backend driver in the keystone.token.persistence namespace. Supplied drivers are kvs, memcache, memcache_pool, and sql. * - ``enforce_token_bind`` = ``permissive`` - - (StrOpt) Enforcement policy on tokens presented to Keystone with bind information. One of disabled, permissive, strict, required or a specifically required bind mode, e.g., kerberos or x509 to require binding to that authentication. + - (String) Enforcement policy on tokens presented to Keystone with bind information. One of disabled, permissive, strict, required or a specifically required bind mode, e.g., kerberos or x509 to require binding to that authentication. * - ``expiration`` = ``3600`` - - (IntOpt) Amount of time a token should remain valid (in seconds). + - (Integer) Amount of time a token should remain valid (in seconds). * - ``hash_algorithm`` = ``md5`` - - (StrOpt) The hash algorithm to use for PKI tokens. This can be set to any algorithm that hashlib supports. WARNING: Before changing this value, the auth_token middleware must be configured with the hash_algorithms, otherwise token revocation will not be processed correctly. + - (String) DEPRECATED: The hash algorithm to use for PKI tokens. This can be set to any algorithm that hashlib supports. WARNING: Before changing this value, the auth_token middleware must be configured with the hash_algorithms, otherwise token revocation will not be processed correctly. PKI token support has been deprecated in the M release and will be removed in the O release. Fernet or UUID tokens are recommended. + * - ``infer_roles`` = ``True`` + - (Boolean) Add roles to token that are not explicitly added, but that are linked implicitly to other roles. * - ``provider`` = ``uuid`` - - (StrOpt) Controls the token construction, validation, and revocation operations. Entrypoint in the keystone.token.provider namespace. Core providers are [fernet|pkiz|pki|uuid]. + - (String) Controls the token construction, validation, and revocation operations. Entrypoint in the keystone.token.provider namespace. Core providers are [fernet|pkiz|pki|uuid]. * - ``revoke_by_id`` = ``True`` - - (BoolOpt) Revoke token by token identifier. Setting revoke_by_id to true enables various forms of enumerating tokens, e.g. `list tokens for user`. These enumerations are processed to determine the list of tokens to revoke. Only disable if you are switching to using the Revoke extension with a backend other than KVS, which stores events in memory. + - (Boolean) Revoke token by token identifier. Setting revoke_by_id to true enables various forms of enumerating tokens, e.g. `list tokens for user`. These enumerations are processed to determine the list of tokens to revoke. Only disable if you are switching to using the Revoke extension with a backend other than KVS, which stores events in memory. diff --git a/doc/config-reference/source/tables/keystone-tokenless.rst b/doc/config-reference/source/tables/keystone-tokenless.rst index 81e733e4cb..d97b56b275 100644 --- a/doc/config-reference/source/tables/keystone-tokenless.rst +++ b/doc/config-reference/source/tables/keystone-tokenless.rst @@ -19,8 +19,8 @@ * - **[tokenless_auth]** - * - ``issuer_attribute`` = ``SSL_CLIENT_I_DN`` - - (StrOpt) The issuer attribute that is served as an IdP ID for the X.509 tokenless authorization along with the protocol to look up its corresponding mapping. It is the environment variable in the WSGI environment that references to the issuer of the client certificate. + - (String) The issuer attribute that is served as an IdP ID for the X.509 tokenless authorization along with the protocol to look up its corresponding mapping. It is the environment variable in the WSGI environment that references to the issuer of the client certificate. * - ``protocol`` = ``x509`` - - (StrOpt) The protocol name for the X.509 tokenless authorization along with the option issuer_attribute below can look up its corresponding mapping. + - (String) The protocol name for the X.509 tokenless authorization along with the option issuer_attribute below can look up its corresponding mapping. * - ``trusted_issuer`` = ``[]`` - - (MultiStrOpt) The list of trusted issuers to further filter the certificates that are allowed to participate in the X.509 tokenless authorization. If the option is absent then no certificates will be allowed. The naming format for the attributes of a Distinguished Name(DN) must be separated by a comma and contain no spaces. This configuration option may be repeated for multiple values. For example: trusted_issuer=CN=john,OU=keystone,O=openstack trusted_issuer=CN=mary,OU=eng,O=abc + - (Multi-valued) The list of trusted issuers to further filter the certificates that are allowed to participate in the X.509 tokenless authorization. If the option is absent then no certificates will be allowed. The naming format for the attributes of a Distinguished Name(DN) must be separated by a comma and contain no spaces. This configuration option may be repeated for multiple values. For example: trusted_issuer=CN=john,OU=keystone,O=openstack trusted_issuer=CN=mary,OU=eng,O=abc diff --git a/doc/config-reference/source/tables/keystone-trust.rst b/doc/config-reference/source/tables/keystone-trust.rst index 9b34d64460..86c8b199d0 100644 --- a/doc/config-reference/source/tables/keystone-trust.rst +++ b/doc/config-reference/source/tables/keystone-trust.rst @@ -19,10 +19,10 @@ * - **[trust]** - * - ``allow_redelegation`` = ``False`` - - (BoolOpt) Enable redelegation feature. + - (Boolean) Enable redelegation feature. * - ``driver`` = ``sql`` - - (StrOpt) Entrypoint for the trust backend driver in the keystone.trust namespace. + - (String) Entrypoint for the trust backend driver in the keystone.trust namespace. * - ``enabled`` = ``True`` - - (BoolOpt) Delegation and impersonation features can be optionally disabled. + - (Boolean) Delegation and impersonation features can be optionally disabled. * - ``max_redelegation_count`` = ``3`` - - (IntOpt) Maximum depth of trust redelegation. + - (Integer) Maximum depth of trust redelegation. diff --git a/doc/config-reference/source/tables/keystone-zeromq.rst b/doc/config-reference/source/tables/keystone-zeromq.rst index 7fa3481407..06d588bc42 100644 --- a/doc/config-reference/source/tables/keystone-zeromq.rst +++ b/doc/config-reference/source/tables/keystone-zeromq.rst @@ -18,27 +18,27 @@ - Description * - **[DEFAULT]** - - * - ``rpc_zmq_all_req_rep`` = ``True`` - - (BoolOpt) Use REQ/REP pattern for all methods CALL/CAST/FANOUT. * - ``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`` - - (IntOpt) 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. - * - ``zmq_use_broker`` = ``True`` - - (BoolOpt) Shows whether zmq-messaging uses broker or not. + - (Integer) Maximum number of ingress messages to locally buffer per topic. Default is unlimited. + * - ``use_pub_sub`` = ``True`` + - (Boolean) Use PUB/SUB pattern for fanout methods. PUB/SUB always uses proxy. + * - ``zmq_target_expire`` = ``120`` + - (Integer) Expiration timeout in seconds of a name service record about existing target ( < 0 means no timeout). diff --git a/doc/config-reference/source/tables/manila-amqp.rst b/doc/config-reference/source/tables/manila-amqp.rst index 40fdab7165..07153238e1 100644 --- a/doc/config-reference/source/tables/manila-amqp.rst +++ b/doc/config-reference/source/tables/manila-amqp.rst @@ -19,12 +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. - * - ``notification_driver`` = ``[]`` - - (MultiStrOpt) The Drivers(s) to handle sending notifications. Possible values are messaging, messagingv2, routing, log, test, noop - * - ``notification_topics`` = ``notifications`` - - (ListOpt) AMQP topic used for OpenStack notifications. - * - ``notification_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) 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. diff --git a/doc/config-reference/source/tables/manila-api.rst b/doc/config-reference/source/tables/manila-api.rst index fbf7ef2f36..f48759ef04 100644 --- a/doc/config-reference/source/tables/manila-api.rst +++ b/doc/config-reference/source/tables/manila-api.rst @@ -18,49 +18,55 @@ - Description * - **[DEFAULT]** - + * - ``admin_network_config_group`` = ``None`` + - (String) If share driver requires to setup admin network for share, then define network plugin config options in some separate config group and set its name here. Used only with another option 'driver_handles_share_servers' set to 'True'. + * - ``admin_network_id`` = ``None`` + - (String) ID of neutron network used to communicate with admin network, to create additional admin export locations on. + * - ``admin_subnet_id`` = ``None`` + - (String) ID of neutron subnet used to communicate with admin network, to create additional admin export locations on. Related to 'admin_network_id'. * - ``api_paste_config`` = ``api-paste.ini`` - - (StrOpt) File name for the paste.deploy config for manila-api. + - (String) File name for the paste.deploy config for manila-api. * - ``api_rate_limit`` = ``True`` - - (BoolOpt) Whether to rate limit the API. + - (Boolean) Whether to rate limit the API. * - ``enable_v1_api`` = ``False`` - - (BoolOpt) Deploy v1 of the Manila API. This option is deprecated, is not used, and will be removed in a future release. + - (Boolean) Deploy v1 of the Manila API. This option is deprecated, is not used, and will be removed in a future release. * - ``enable_v2_api`` = ``False`` - - (BoolOpt) Deploy v2 of the Manila API. This option is deprecated, is not used, and will be removed in a future release. + - (Boolean) Deploy v2 of the Manila API. This option is deprecated, is not used, and will be removed in a future release. * - ``max_header_line`` = ``16384`` - - (IntOpt) Maximum line size of message headers to be accepted. Option max_header_line may need to be increased when using large tokens (typically those generated by the Keystone v3 API with big service catalogs). + - (Integer) Maximum line size of message headers to be accepted. Option max_header_line may need to be increased when using large tokens (typically those generated by the Keystone v3 API with big service catalogs). * - ``osapi_max_limit`` = ``1000`` - - (IntOpt) The maximum number of items returned in a single response from a collection resource. + - (Integer) The maximum number of items returned in a single response from a collection resource. * - ``osapi_share_base_URL`` = ``None`` - - (StrOpt) Base URL to be presented to users in links to the Share API + - (String) Base URL to be presented to users in links to the Share API * - ``osapi_share_ext_list`` = - - (ListOpt) Specify list of extensions to load when using osapi_share_extension option with manila.api.contrib.select_extensions. - * - ``osapi_share_extension`` = ``['manila.api.contrib.standard_extensions']`` - - (MultiStrOpt) The osapi share extension to load. + - (List) Specify list of extensions to load when using osapi_share_extension option with manila.api.contrib.select_extensions. + * - ``osapi_share_extension`` = ``manila.api.contrib.standard_extensions`` + - (List) The osapi share extensions to load. * - ``osapi_share_listen`` = ``::`` - - (StrOpt) IP address for OpenStack Share API to listen on. + - (String) IP address for OpenStack Share API to listen on. * - ``osapi_share_listen_port`` = ``8786`` - - (PortOpt) Port for OpenStack Share API to listen on. + - (Unknown) Port for OpenStack Share API to listen on. * - ``osapi_share_workers`` = ``1`` - - (IntOpt) Number of workers for OpenStack Share API service. + - (Integer) Number of workers for OpenStack Share API service. * - ``share_api_class`` = ``manila.share.api.API`` - - (StrOpt) The full class name of the share API class to use. + - (String) The full class name of the share API class to use. * - ``volume_api_class`` = ``manila.volume.cinder.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_template`` = ``manila-share-%s`` - - (StrOpt) Volume name template. + - (String) Volume name template. * - ``volume_snapshot_name_template`` = ``manila-snapshot-%s`` - - (StrOpt) Volume snapshot name template. + - (String) Volume snapshot name template. * - **[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. diff --git a/doc/config-reference/source/tables/manila-auth.rst b/doc/config-reference/source/tables/manila-auth.rst index 04fac02d64..a937183543 100644 --- a/doc/config-reference/source/tables/manila-auth.rst +++ b/doc/config-reference/source/tables/manila-auth.rst @@ -19,4 +19,4 @@ * - **[DEFAULT]** - * - ``auth_strategy`` = ``keystone`` - - (StrOpt) The strategy to use for auth. Supports noauth, keystone, and deprecated. + - (String) The strategy to use for auth. Supports noauth, keystone, and deprecated. diff --git a/doc/config-reference/source/tables/manila-auth_token.rst b/doc/config-reference/source/tables/manila-auth_token.rst index cc6f30da27..9adb013580 100644 --- a/doc/config-reference/source/tables/manila-auth_token.rst +++ b/doc/config-reference/source/tables/manila-auth_token.rst @@ -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 (http or https). 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. Acceptable values are MAC or ENCRYPT. 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. diff --git a/doc/config-reference/source/tables/manila-ca.rst b/doc/config-reference/source/tables/manila-ca.rst index 8a05888618..0d034ab2a7 100644 --- a/doc/config-reference/source/tables/manila-ca.rst +++ b/doc/config-reference/source/tables/manila-ca.rst @@ -19,8 +19,8 @@ * - **[DEFAULT]** - * - ``ssl_ca_file`` = ``None`` - - (StrOpt) CA certificate file to use to verify connecting clients. + - (String) CA certificate file to use to verify connecting clients. * - ``ssl_cert_file`` = ``None`` - - (StrOpt) Certificate file to use when starting the server securely. + - (String) Certificate file to use when starting the server securely. * - ``ssl_key_file`` = ``None`` - - (StrOpt) Private key file to use when starting the server securely. + - (String) Private key file to use when starting the server securely. diff --git a/doc/config-reference/source/tables/manila-cephfs.rst b/doc/config-reference/source/tables/manila-cephfs.rst new file mode 100644 index 0000000000..62cd762b6d --- /dev/null +++ b/doc/config-reference/source/tables/manila-cephfs.rst @@ -0,0 +1,28 @@ +.. + 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. + +.. _manila-cephfs: + +.. list-table:: Description of CephFS Driver configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``cephfs_auth_id`` = ``manila`` + - (String) The name of the ceph auth identity to use. + * - ``cephfs_cluster_name`` = ``None`` + - (String) The name of the cluster in use, if it is not the default ('ceph'). + * - ``cephfs_conf_path`` = + - (String) Fully qualified path to the ceph.conf file. + * - ``cephfs_enable_snapshots`` = ``False`` + - (Boolean) Whether to enable snapshots in this driver. diff --git a/doc/config-reference/source/tables/manila-common.rst b/doc/config-reference/source/tables/manila-common.rst index 0046a6bde0..b6b575f9fe 100644 --- a/doc/config-reference/source/tables/manila-common.rst +++ b/doc/config-reference/source/tables/manila-common.rst @@ -19,68 +19,82 @@ * - **[DEFAULT]** - * - ``client_socket_timeout`` = ``900`` - - (IntOpt) Timeout for client connections socket operations. If an incoming connection is idle for this number of seconds it will be closed. A value of '0' means wait forever. + - (Integer) Timeout for client connections socket operations. If an incoming connection is idle for this number of seconds it will be closed. A value of '0' means wait forever. * - ``compute_api_class`` = ``manila.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. + * - ``data_access_wait_access_rules_timeout`` = ``180`` + - (Integer) Time to wait for access rules to be allowed/denied on backends when migrating a share (seconds). + * - ``data_manager`` = ``manila.data.manager.DataManager`` + - (String) Full class name for the data manager. + * - ``data_node_access_cert`` = ``None`` + - (String) The certificate installed in the data node in order to allow access to certificate authentication-based shares. + * - ``data_node_access_ip`` = ``None`` + - (String) The IP of the node interface connected to the admin network. Used for allowing access to the mounting shares. + * - ``data_topic`` = ``manila-data`` + - (String) The topic data nodes listen on. * - ``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. * - ``host`` = ``localhost`` - - (StrOpt) Name of this node. This can be an opaque identifier. It is not necessarily a hostname, FQDN, or IP address. + - (String) Name of this node. This can be an opaque identifier. It is not necessarily a hostname, FQDN, or IP address. * - ``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 the total physical capacity. If the ratio is 10.5, it means provisioned capacity can be 10.5 times the total physical capacity. A ratio of 1.0 means provisioned capacity cannot exceed the total physical capacity. A ratio lower than 1.0 is invalid. + - (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 the total physical capacity. If the ratio is 10.5, it means provisioned capacity can be 10.5 times the total physical capacity. A ratio of 1.0 means provisioned capacity cannot exceed the total physical capacity. A ratio lower than 1.0 is invalid. * - ``memcached_servers`` = ``None`` - - (ListOpt) Memcached servers or None for in process cache. + - (List) Memcached servers or None for in process cache. * - ``monkey_patch`` = ``False`` - - (BoolOpt) Whether to log monkey patching. + - (Boolean) Whether to log monkey patching. * - ``monkey_patch_modules`` = - - (ListOpt) List of modules or decorators to monkey patch. + - (List) List of modules or decorators to monkey patch. * - ``my_ip`` = ``10.0.0.1`` - - (StrOpt) IP address of this host. + - (String) IP address of this host. * - ``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. * - ``periodic_fuzzy_delay`` = ``60`` - - (IntOpt) Range of seconds to randomly delay when starting the periodic task scheduler to reduce stampeding. (Disable by setting to 0) + - (Integer) Range of seconds to randomly delay when starting the periodic task scheduler to reduce stampeding. (Disable by setting to 0) * - ``periodic_hooks_interval`` = ``300.0`` - - (FloatOpt) Interval in seconds between execution of periodic hooks. Used when option 'enable_periodic_hooks' is set to True. Default is 300. + - (Floating point) Interval in seconds between execution of periodic hooks. Used when option 'enable_periodic_hooks' is set to True. Default is 300. * - ``periodic_interval`` = ``60`` - - (IntOpt) Seconds between running periodic tasks. + - (Integer) Seconds between running periodic tasks. + * - ``replica_state_update_interval`` = ``300`` + - (Integer) This value, specified in seconds, determines how often the share manager will poll for the health (replica_state) of each replica instance. + * - ``replication_domain`` = ``None`` + - (String) A string specifying the replication domain that the backend belongs to. This option needs to be specified the same in the configuration sections of all backends that support replication between each other. If this option is not specified in the group, it means that replication is not enabled on the backend. * - ``report_interval`` = ``10`` - - (IntOpt) Seconds between nodes reporting state to datastore. + - (Integer) Seconds between nodes reporting state to datastore. * - ``reserved_share_percentage`` = ``0`` - - (IntOpt) The percentage of backend capacity reserved. + - (Integer) The percentage of backend capacity reserved. * - ``rootwrap_config`` = ``None`` - - (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. * - ``service_down_time`` = ``60`` - - (IntOpt) Maximum time since last check-in for up service. + - (Integer) Maximum time since last check-in for up service. * - ``smb_template_config_path`` = ``$state_path/smb.conf`` - - (StrOpt) Path to smb config. + - (String) Path to smb config. * - ``sql_idle_timeout`` = ``3600`` - - (IntOpt) Timeout before idle SQL connections are reaped. + - (Integer) Timeout before idle SQL connections are reaped. * - ``sql_max_retries`` = ``10`` - - (IntOpt) Maximum database connection retries during startup. (setting -1 implies an infinite retry count). + - (Integer) Maximum database connection retries during startup. (setting -1 implies an infinite retry count). * - ``sql_retry_interval`` = ``10`` - - (IntOpt) Interval between retries of opening a SQL connection. + - (Integer) Interval between retries of opening a SQL connection. * - ``sqlite_clean_db`` = ``clean.sqlite`` - - (StrOpt) File name of clean sqlite database. + - (String) File name of clean sqlite database. * - ``sqlite_db`` = ``manila.sqlite`` - - (StrOpt) The filename to use with sqlite. + - (String) The filename to use with sqlite. * - ``sqlite_synchronous`` = ``True`` - - (BoolOpt) If passed, use synchronous mode for sqlite. + - (Boolean) If passed, use synchronous mode for sqlite. * - ``state_path`` = ``/var/lib/manila`` - - (StrOpt) Top-level directory for maintaining manila's state. + - (String) Top-level directory for maintaining manila's state. * - ``storage_availability_zone`` = ``nova`` - - (StrOpt) Availability zone of this node. + - (String) Availability zone of this node. * - ``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. * - ``tcp_keepidle`` = ``600`` - - (IntOpt) Sets the value of TCP_KEEPIDLE in seconds for each server socket. Not supported on OS X. + - (Integer) Sets the value of TCP_KEEPIDLE 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_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. * - ``wsgi_keep_alive`` = ``True`` - - (BoolOpt) If False, closes the client socket connection explicitly. Setting it to True to maintain backward compatibility. Recommended setting is set it to False. + - (Boolean) If False, closes the client socket connection explicitly. Setting it to True to maintain backward compatibility. Recommended setting is set it to False. diff --git a/doc/config-reference/source/tables/manila-compute.rst b/doc/config-reference/source/tables/manila-compute.rst index bbdf7c5c8e..bc0d6f1b81 100644 --- a/doc/config-reference/source/tables/manila-compute.rst +++ b/doc/config-reference/source/tables/manila-compute.rst @@ -19,22 +19,22 @@ * - **[DEFAULT]** - * - ``nova_admin_auth_url`` = ``http://localhost:5000/v2.0`` - - (StrOpt) Identity service URL. + - (String) Identity service URL. * - ``nova_admin_password`` = ``None`` - - (StrOpt) Nova admin password. + - (String) Nova admin password. * - ``nova_admin_tenant_name`` = ``service`` - - (StrOpt) Nova admin tenant name. + - (String) Nova admin tenant name. * - ``nova_admin_username`` = ``nova`` - - (StrOpt) Nova admin username. + - (String) Nova admin username. * - ``nova_api_insecure`` = ``False`` - - (BoolOpt) Allow to perform insecure SSL requests to nova. + - (Boolean) Allow to perform insecure SSL requests to nova. * - ``nova_api_microversion`` = ``2.10`` - - (StrOpt) Version of Nova API to be used. + - (String) Version of Nova API to be used. * - ``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:nova: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:nova:publicURL`` - - (StrOpt) Info to match when looking for nova in the service catalog. Format is separated values of the form: :: + - (String) Info to match when looking for nova in the service catalog. Format is separated values of the form: :: * - ``os_region_name`` = ``None`` - - (StrOpt) Region name of this node. + - (String) Region name of this node. diff --git a/doc/config-reference/source/tables/manila-cors.rst b/doc/config-reference/source/tables/manila-cors.rst index 874c26aa7a..bf4f1b4117 100644 --- a/doc/config-reference/source/tables/manila-cors.rst +++ b/doc/config-reference/source/tables/manila-cors.rst @@ -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. diff --git a/doc/config-reference/source/tables/manila-database.rst b/doc/config-reference/source/tables/manila-database.rst index a49b29f080..6071981153 100644 --- a/doc/config-reference/source/tables/manila-database.rst +++ b/doc/config-reference/source/tables/manila-database.rst @@ -19,48 +19,48 @@ * - **[DEFAULT]** - * - ``db_backend`` = ``sqlalchemy`` - - (StrOpt) The backend to use for database. + - (String) The backend to use for database. * - ``db_driver`` = ``manila.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. diff --git a/doc/config-reference/source/tables/manila-emc.rst b/doc/config-reference/source/tables/manila-emc.rst index 0f51cb1c6f..ea3e8df92d 100644 --- a/doc/config-reference/source/tables/manila-emc.rst +++ b/doc/config-reference/source/tables/manila-emc.rst @@ -19,20 +19,20 @@ * - **[DEFAULT]** - * - ``emc_nas_login`` = ``None`` - - (StrOpt) User name for the EMC server. + - (String) User name for the EMC server. * - ``emc_nas_password`` = ``None`` - - (StrOpt) Password for the EMC server. - * - ``emc_nas_pool_name`` = ``None`` - - (StrOpt) EMC pool name. + - (String) Password for the EMC server. + * - ``emc_nas_pool_names`` = ``None`` + - (String) EMC pool names. * - ``emc_nas_root_dir`` = ``None`` - - (StrOpt) The root directory where shares will be located. + - (String) The root directory where shares will be located. * - ``emc_nas_server`` = ``None`` - - (StrOpt) EMC server hostname or IP address. + - (String) EMC server hostname or IP address. * - ``emc_nas_server_container`` = ``server_2`` - - (StrOpt) Container of share servers. + - (String) Container of share servers. * - ``emc_nas_server_port`` = ``8080`` - - (PortOpt) Port number for the EMC server. + - (Unknown) Port number for the EMC server. * - ``emc_nas_server_secure`` = ``True`` - - (BoolOpt) Use secure connection to server. + - (Boolean) Use secure connection to server. * - ``emc_share_backend`` = ``None`` - - (StrOpt) Share backend. + - (String) Share backend. diff --git a/doc/config-reference/source/tables/manila-ganesha.rst b/doc/config-reference/source/tables/manila-ganesha.rst index 505886a252..ee74537421 100644 --- a/doc/config-reference/source/tables/manila-ganesha.rst +++ b/doc/config-reference/source/tables/manila-ganesha.rst @@ -19,16 +19,16 @@ * - **[DEFAULT]** - * - ``ganesha_config_dir`` = ``/etc/ganesha`` - - (StrOpt) Directory where Ganesha config files are stored. + - (String) Directory where Ganesha config files are stored. * - ``ganesha_config_path`` = ``$ganesha_config_dir/ganesha.conf`` - - (StrOpt) Path to main Ganesha config file. + - (String) Path to main Ganesha config file. * - ``ganesha_db_path`` = ``$state_path/manila-ganesha.db`` - - (StrOpt) Location of Ganesha database file. (Ganesha module only.) + - (String) Location of Ganesha database file. (Ganesha module only.) * - ``ganesha_export_dir`` = ``$ganesha_config_dir/export.d`` - - (StrOpt) Path to directory containing Ganesha export configuration. (Ganesha module only.) + - (String) Path to directory containing Ganesha export configuration. (Ganesha module only.) * - ``ganesha_export_template_dir`` = ``/etc/manila/ganesha-export-templ.d`` - - (StrOpt) Path to directory containing Ganesha export block templates. (Ganesha module only.) + - (String) Path to directory containing Ganesha export block templates. (Ganesha module only.) * - ``ganesha_nfs_export_options`` = ``maxread = 65536, prefread = 65536`` - - (StrOpt) Options to use when exporting a share using ganesha NFS server. Note that these defaults can be overridden when a share is created by passing metadata with key name export_options. Also note the complete set of default ganesha export options is specified in ganesha_utils. (GPFS only.) + - (String) Options to use when exporting a share using ganesha NFS server. Note that these defaults can be overridden when a share is created by passing metadata with key name export_options. Also note the complete set of default ganesha export options is specified in ganesha_utils. (GPFS only.) * - ``ganesha_service_name`` = ``ganesha.nfsd`` - - (StrOpt) Name of the ganesha nfs service. + - (String) Name of the ganesha nfs service. diff --git a/doc/config-reference/source/tables/manila-generic.rst b/doc/config-reference/source/tables/manila-generic.rst index 6f4e2528f9..69fa9f485b 100644 --- a/doc/config-reference/source/tables/manila-generic.rst +++ b/doc/config-reference/source/tables/manila-generic.rst @@ -19,82 +19,86 @@ * - **[DEFAULT]** - * - ``cinder_admin_auth_url`` = ``http://localhost:5000/v2.0`` - - (StrOpt) Identity service URL. + - (String) Identity service URL. * - ``cinder_admin_password`` = ``None`` - - (StrOpt) Cinder admin password. + - (String) Cinder admin password. * - ``cinder_admin_tenant_name`` = ``service`` - - (StrOpt) Cinder admin tenant name. + - (String) Cinder admin tenant name. * - ``cinder_admin_username`` = ``cinder`` - - (StrOpt) Cinder admin username. + - (String) Cinder admin username. * - ``cinder_api_insecure`` = ``False`` - - (BoolOpt) Allow to perform insecure SSL requests to cinder. + - (Boolean) Allow to perform insecure SSL requests to cinder. * - ``cinder_ca_certificates_file`` = ``None`` - - (StrOpt) Location of CA certificates file to use for cinder client requests. + - (String) Location of CA certificates file to use for cinder client requests. * - ``cinder_catalog_info`` = ``volume:cinder:publicURL`` - - (StrOpt) Info to match when looking for cinder in the service catalog. Format is separated values of the form: :: + - (String) Info to match when looking for cinder in the service catalog. Format is separated values of the form: :: * - ``cinder_cross_az_attach`` = ``True`` - - (BoolOpt) Allow attaching between instances and volumes in different availability zones. + - (Boolean) Allow attaching between instances and volumes in different availability zones. * - ``cinder_http_retries`` = ``3`` - - (IntOpt) Number of cinderclient retries on failed HTTP calls. + - (Integer) Number of cinderclient retries on failed HTTP calls. * - ``cinder_volume_type`` = ``None`` - - (StrOpt) Name or id of cinder volume type which will be used for all volumes created by driver. + - (String) Name or id of cinder volume type which will be used for all volumes created by driver. * - ``connect_share_server_to_tenant_network`` = ``False`` - - (BoolOpt) Attach share server directly to share network. Used only with Neutron. + - (Boolean) Attach share server directly to share network. Used only with Neutron and if driver_handles_share_servers=True. * - ``driver_handles_share_servers`` = ``None`` - - (BoolOpt) There are two possible approaches for share drivers in Manila. First is when share driver is able to handle share-servers and second when not. Drivers can support either both or only one of these approaches. So, set this opt to True if share driver is able to handle share servers and it is desired mode else set False. It is set to None by default to make this choice intentional. + - (Boolean) There are two possible approaches for share drivers in Manila. First is when share driver is able to handle share-servers and second when not. Drivers can support either both or only one of these approaches. So, set this opt to True if share driver is able to handle share servers and it is desired mode else set False. It is set to None by default to make this choice intentional. * - ``interface_driver`` = ``manila.network.linux.interface.OVSInterfaceDriver`` - - (StrOpt) Vif driver. Used only with Neutron. + - (String) Vif driver. Used only with Neutron and if driver_handles_share_servers=True. * - ``manila_service_keypair_name`` = ``manila-service`` - - (StrOpt) Keypair name that will be created and used for service instances. + - (String) Keypair name that will be created and used for service instances. Only used if driver_handles_share_servers=True. * - ``max_time_to_attach`` = ``120`` - - (IntOpt) Maximum time to wait for attaching cinder volume. + - (Integer) Maximum time to wait for attaching cinder volume. * - ``max_time_to_build_instance`` = ``300`` - - (IntOpt) Maximum time in seconds to wait for creating service instance. + - (Integer) Maximum time in seconds to wait for creating service instance. * - ``max_time_to_create_volume`` = ``180`` - - (IntOpt) Maximum time to wait for creating cinder volume. + - (Integer) Maximum time to wait for creating cinder volume. * - ``max_time_to_extend_volume`` = ``180`` - - (IntOpt) Maximum time to wait for extending cinder volume. + - (Integer) Maximum time to wait for extending cinder volume. * - ``ovs_integration_bridge`` = ``br-int`` - - (StrOpt) Name of Open vSwitch bridge to use. - * - ``path_to_private_key`` = ``~/.ssh/id_rsa`` - - (StrOpt) Path to host's private key. + - (String) Name of Open vSwitch bridge to use. + * - ``path_to_private_key`` = ``None`` + - (String) Path to host's private key. * - ``path_to_public_key`` = ``~/.ssh/id_rsa.pub`` - - (StrOpt) Path to hosts public key. + - (String) Path to hosts public key. Only used if driver_handles_share_servers=True. * - ``service_image_name`` = ``manila-service-image`` - - (StrOpt) Name of image in Glance, that will be used for service instance creation. + - (String) Name of image in Glance, that will be used for service instance creation. Only used if driver_handles_share_servers=True. * - ``service_instance_flavor_id`` = ``100`` - - (IntOpt) ID of flavor, that will be used for service instance creation. + - (Integer) ID of flavor, that will be used for service instance creation. Only used if driver_handles_share_servers=True. * - ``service_instance_name_or_id`` = ``None`` - - (StrOpt) Name or ID of service instance in Nova to use for share exports. Used only when share servers handling is disabled. + - (String) Name or ID of service instance in Nova to use for share exports. Used only when share servers handling is disabled. * - ``service_instance_name_template`` = ``manila_service_instance_%s`` - - (StrOpt) Name of service instance. + - (String) Name of service instance. Only used if driver_handles_share_servers=True. * - ``service_instance_network_helper_type`` = ``neutron`` - - (StrOpt) Allowed values are ['nova', 'neutron']. + - (String) Allowed values are ['nova', 'neutron']. Only used if driver_handles_share_servers=True. * - ``service_instance_password`` = ``None`` - - (StrOpt) Password for service instance user. + - (String) Password for service instance user. * - ``service_instance_security_group`` = ``manila-service`` - - (StrOpt) Security group name, that will be used for service instance creation. + - (String) Security group name, that will be used for service instance creation. Only used if driver_handles_share_servers=True. * - ``service_instance_smb_config_path`` = ``$share_mount_path/smb.conf`` - - (StrOpt) Path to SMB config in service instance. + - (String) Path to SMB config in service instance. * - ``service_instance_user`` = ``None`` - - (StrOpt) User in service instance that will be used for authentication. + - (String) User in service instance that will be used for authentication. * - ``service_net_name_or_ip`` = ``None`` - - (StrOpt) Can be either name of network that is used by service instance within Nova to get IP address or IP address itself for managing shares there. Used only when share servers handling is disabled. + - (String) Can be either name of network that is used by service instance within Nova to get IP address or IP address itself for managing shares there. Used only when share servers handling is disabled. * - ``service_network_cidr`` = ``10.254.0.0/16`` - - (StrOpt) CIDR of manila service network. Used only with Neutron. + - (String) CIDR of manila service network. Used only with Neutron and if driver_handles_share_servers=True. * - ``service_network_division_mask`` = ``28`` - - (IntOpt) This mask is used for dividing service network into subnets, IP capacity of subnet with this mask directly defines possible amount of created service VMs per tenant's subnet. Used only with Neutron. + - (Integer) This mask is used for dividing service network into subnets, IP capacity of subnet with this mask directly defines possible amount of created service VMs per tenant's subnet. Used only with Neutron and if driver_handles_share_servers=True. * - ``service_network_name`` = ``manila_service_network`` - - (StrOpt) Name of manila service network. Used only with Neutron. - * - ``share_helpers`` = ``CIFS=manila.share.drivers.generic.CIFSHelper, NFS=manila.share.drivers.generic.NFSHelper`` - - (ListOpt) Specify list of share export helpers. + - (String) Name of manila service network. Used only with Neutron. Only used if driver_handles_share_servers=True. + * - ``share_helpers`` = ``CIFS=manila.share.drivers.helpers.CIFSHelperIPAccess, NFS=manila.share.drivers.helpers.NFSHelper`` + - (List) Specify list of share export helpers. * - ``share_mount_path`` = ``/shares`` - - (StrOpt) Parent path in service instance where shares will be mounted. + - (String) Parent path in service instance where shares will be mounted. + * - ``share_mount_template`` = ``mount -vt %(proto)s %(export)s %(path)s`` + - (String) The template for mounting shares for this backend. Must specify the executable with all necessary parameters for the protocol supported. 'proto' template element may not be required if included in the command. 'export' and 'path' template elements are required. It is advisable to separate different commands per backend. + * - ``share_unmount_template`` = ``umount -v %(path)s`` + - (String) The template for unmounting shares for this backend. Must specify the executable with all necessary parameters for the protocol supported. 'path' template element is required. It is advisable to separate different commands per backend. * - ``share_volume_fstype`` = ``ext4`` - - (StrOpt) Filesystem type of the share volume. + - (String) Filesystem type of the share volume. * - ``tenant_net_name_or_ip`` = ``None`` - - (StrOpt) Can be either name of network that is used by service instance within Nova to get IP address or IP address itself for exporting shares. Used only when share servers handling is disabled. + - (String) Can be either name of network that is used by service instance within Nova to get IP address or IP address itself for exporting shares. Used only when share servers handling is disabled. * - ``volume_name_template`` = ``manila-share-%s`` - - (StrOpt) Volume name template. + - (String) Volume name template. * - ``volume_snapshot_name_template`` = ``manila-snapshot-%s`` - - (StrOpt) Volume snapshot name template. + - (String) Volume snapshot name template. diff --git a/doc/config-reference/source/tables/manila-glusterfs.rst b/doc/config-reference/source/tables/manila-glusterfs.rst index 96600549bf..1b368b83a9 100644 --- a/doc/config-reference/source/tables/manila-glusterfs.rst +++ b/doc/config-reference/source/tables/manila-glusterfs.rst @@ -19,24 +19,24 @@ * - **[DEFAULT]** - * - ``glusterfs_ganesha_server_ip`` = ``None`` - - (StrOpt) Remote Ganesha server node's IP address. + - (String) Remote Ganesha server node's IP address. * - ``glusterfs_ganesha_server_password`` = ``None`` - - (StrOpt) Remote Ganesha server node's login password. This is not required if 'glusterfs_path_to_private_key' is configured. + - (String) Remote Ganesha server node's login password. This is not required if 'glusterfs_path_to_private_key' is configured. * - ``glusterfs_ganesha_server_username`` = ``root`` - - (StrOpt) Remote Ganesha server node's username. + - (String) Remote Ganesha server node's username. * - ``glusterfs_mount_point_base`` = ``$state_path/mnt`` - - (StrOpt) Base directory containing mount points for Gluster volumes. + - (String) Base directory containing mount points for Gluster volumes. * - ``glusterfs_nfs_server_type`` = ``Gluster`` - - (StrOpt) Type of NFS server that mediate access to the Gluster volumes (Gluster or Ganesha). + - (String) Type of NFS server that mediate access to the Gluster volumes (Gluster or Ganesha). * - ``glusterfs_path_to_private_key`` = ``None`` - - (StrOpt) Path of Manila host's private SSH key file. + - (String) Path of Manila host's private SSH key file. * - ``glusterfs_server_password`` = ``None`` - - (StrOpt) Remote GlusterFS server node's login password. This is not required if 'glusterfs_path_to_private_key' is configured. + - (String) Remote GlusterFS server node's login password. This is not required if 'glusterfs_path_to_private_key' is configured. * - ``glusterfs_servers`` = - - (ListOpt) List of GlusterFS servers that can be used to create shares. Each GlusterFS server should be of the form [remoteuser@], and they are assumed to belong to distinct Gluster clusters. + - (List) List of GlusterFS servers that can be used to create shares. Each GlusterFS server should be of the form [remoteuser@], and they are assumed to belong to distinct Gluster clusters. * - ``glusterfs_share_layout`` = ``None`` - - (StrOpt) Specifies GlusterFS share layout, that is, the method of associating backing GlusterFS resources to shares. + - (String) Specifies GlusterFS share layout, that is, the method of associating backing GlusterFS resources to shares. * - ``glusterfs_target`` = ``None`` - - (StrOpt) Specifies the GlusterFS volume to be mounted on the Manila host. It is of the form [remoteuser@]:. + - (String) Specifies the GlusterFS volume to be mounted on the Manila host. It is of the form [remoteuser@]:. * - ``glusterfs_volume_pattern`` = ``None`` - - (StrOpt) Regular expression template used to filter GlusterFS volumes for share creation. The regex template can optionally (ie. with support of the GlusterFS backend) contain the #{size} parameter which matches an integer (sequence of digits) in which case the value shall be interpreted as size of the volume in GB. Examples: "manila-share-volume-\d+$", "manila-share-volume-#{size}G-\d+$"; with matching volume names, respectively: "manila-share-volume-12", "manila-share-volume-3G-13". In latter example, the number that matches "#{size}", that is, 3, is an indication that the size of volume is 3G. + - (String) Regular expression template used to filter GlusterFS volumes for share creation. The regex template can optionally (ie. with support of the GlusterFS backend) contain the #{size} parameter which matches an integer (sequence of digits) in which case the value shall be interpreted as size of the volume in GB. Examples: "manila-share-volume-\d+$", "manila-share-volume-#{size}G-\d+$"; with matching volume names, respectively: "manila-share-volume-12", "manila-share-volume-3G-13". In latter example, the number that matches "#{size}", that is, 3, is an indication that the size of volume is 3G. diff --git a/doc/config-reference/source/tables/manila-gpfs.rst b/doc/config-reference/source/tables/manila-gpfs.rst index 24eabcc1a0..629905f583 100644 --- a/doc/config-reference/source/tables/manila-gpfs.rst +++ b/doc/config-reference/source/tables/manila-gpfs.rst @@ -19,22 +19,22 @@ * - **[DEFAULT]** - * - ``gpfs_mount_point_base`` = ``$state_path/mnt`` - - (StrOpt) Base folder where exported shares are located. + - (String) Base folder where exported shares are located. * - ``gpfs_nfs_server_list`` = ``None`` - - (ListOpt) A list of the fully qualified NFS server names that make up the OpenStack Manila configuration. + - (List) A list of the fully qualified NFS server names that make up the OpenStack Manila configuration. * - ``gpfs_nfs_server_type`` = ``KNFS`` - - (StrOpt) NFS Server type. Valid choices are "KNFS" (kernel NFS) or "GNFS" (Ganesha NFS). + - (String) NFS Server type. Valid choices are "KNFS" (kernel NFS) or "GNFS" (Ganesha NFS). * - ``gpfs_share_export_ip`` = ``None`` - - (StrOpt) IP to be added to GPFS export string. + - (String) IP to be added to GPFS export string. * - ``gpfs_share_helpers`` = ``KNFS=manila.share.drivers.ibm.gpfs.KNFSHelper, GNFS=manila.share.drivers.ibm.gpfs.GNFSHelper`` - - (ListOpt) Specify list of share export helpers. + - (List) Specify list of share export helpers. * - ``gpfs_ssh_login`` = ``None`` - - (StrOpt) GPFS server SSH login name. + - (String) GPFS server SSH login name. * - ``gpfs_ssh_password`` = ``None`` - - (StrOpt) GPFS server SSH login password. The password is not needed, if 'gpfs_ssh_private_key' is configured. + - (String) GPFS server SSH login password. The password is not needed, if 'gpfs_ssh_private_key' is configured. * - ``gpfs_ssh_port`` = ``22`` - - (PortOpt) GPFS server SSH port. + - (Unknown) GPFS server SSH port. * - ``gpfs_ssh_private_key`` = ``None`` - - (StrOpt) Path to GPFS server SSH private key for login. + - (String) Path to GPFS server SSH private key for login. * - ``knfs_export_options`` = ``rw,sync,no_root_squash,insecure,no_wdelay,no_subtree_check`` - - (StrOpt) Options to use when exporting a share using kernel NFS server. Note that these defaults can be overridden when a share is created by passing metadata with key name export_options. + - (String) Options to use when exporting a share using kernel NFS server. Note that these defaults can be overridden when a share is created by passing metadata with key name export_options. diff --git a/doc/config-reference/source/tables/manila-hdfs.rst b/doc/config-reference/source/tables/manila-hdfs.rst index 857d530170..486b4ed54a 100644 --- a/doc/config-reference/source/tables/manila-hdfs.rst +++ b/doc/config-reference/source/tables/manila-hdfs.rst @@ -19,14 +19,14 @@ * - **[DEFAULT]** - * - ``hdfs_namenode_ip`` = ``None`` - - (StrOpt) The IP of the HDFS namenode. + - (String) The IP of the HDFS namenode. * - ``hdfs_namenode_port`` = ``9000`` - - (PortOpt) The port of HDFS namenode service. + - (Unknown) The port of HDFS namenode service. * - ``hdfs_ssh_name`` = ``None`` - - (StrOpt) HDFS namenode ssh login name. + - (String) HDFS namenode ssh login name. * - ``hdfs_ssh_port`` = ``22`` - - (PortOpt) HDFS namenode SSH port. + - (Unknown) HDFS namenode SSH port. * - ``hdfs_ssh_private_key`` = ``None`` - - (StrOpt) Path to HDFS namenode SSH private key for login. + - (String) Path to HDFS namenode SSH private key for login. * - ``hdfs_ssh_pw`` = ``None`` - - (StrOpt) HDFS namenode SSH login password, This parameter is not necessary, if 'hdfs_ssh_private_key' is configured. + - (String) HDFS namenode SSH login password, This parameter is not necessary, if 'hdfs_ssh_private_key' is configured. diff --git a/doc/config-reference/source/tables/manila-hds_hnas.rst b/doc/config-reference/source/tables/manila-hds_hnas.rst index 70996a5824..676abce2cd 100644 --- a/doc/config-reference/source/tables/manila-hds_hnas.rst +++ b/doc/config-reference/source/tables/manila-hds_hnas.rst @@ -19,24 +19,24 @@ * - **[hnas1]** - * - ``hds_hnas_cluster_admin_ip0`` = ``None`` - - (StrOpt) The IP of the clusters admin node. Only set in HNAS multinode clusters. + - (String) The IP of the clusters admin node. Only set in HNAS multinode clusters. * - ``hds_hnas_evs_id`` = ``None`` - - (StrOpt) Specify which EVS this backend is assigned to. + - (Integer) Specify which EVS this backend is assigned to. * - ``hds_hnas_evs_ip`` = ``None`` - - (StrOpt) Specify IP for mounting shares. + - (String) Specify IP for mounting shares. * - ``hds_hnas_file_system_name`` = ``None`` - - (StrOpt) Specify file-system name for creating shares. + - (String) Specify file-system name for creating shares. * - ``hds_hnas_ip`` = ``None`` - - (StrOpt) HNAS management interface IP for communication between Manila controller and HNAS. + - (String) HNAS management interface IP for communication between Manila controller and HNAS. * - ``hds_hnas_password`` = ``None`` - - (StrOpt) HNAS user password. Required only if private key is not provided. + - (String) HNAS user password. Required only if private key is not provided. * - ``hds_hnas_ssh_private_key`` = ``None`` - - (StrOpt) RSA/DSA private key value used to connect into HNAS. Required only if password is not provided. + - (String) RSA/DSA private key value used to connect into HNAS. Required only if password is not provided. * - ``hds_hnas_stalled_job_timeout`` = ``30`` - - (IntOpt) The time (in seconds) to wait for stalled HNAS jobs before aborting. + - (Integer) The time (in seconds) to wait for stalled HNAS jobs before aborting. * - ``hds_hnas_user`` = ``None`` - - (StrOpt) HNAS username Base64 String in order to perform tasks such as create file-systems and network interfaces. + - (String) HNAS username Base64 String in order to perform tasks such as create file-systems and network interfaces. * - ``share_backend_name`` = ``None`` - - (StrOpt) The backend name for a given driver implementation. + - (String) The backend name for a given driver implementation. * - ``share_driver`` = ``manila.share.drivers.generic.GenericShareDriver`` - - (StrOpt) Driver to use for share creation. + - (String) Driver to use for share creation. diff --git a/doc/config-reference/source/tables/ironic-drac.rst b/doc/config-reference/source/tables/manila-hnas.rst similarity index 54% rename from doc/config-reference/source/tables/ironic-drac.rst rename to doc/config-reference/source/tables/manila-hnas.rst index 28bca403e5..39d5a67102 100644 --- a/doc/config-reference/source/tables/ironic-drac.rst +++ b/doc/config-reference/source/tables/manila-hnas.rst @@ -8,17 +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. -.. _ironic-drac: +.. _manila-hnas: -.. list-table:: Description of DRAC configuration options +.. list-table:: Description of hnas configuration options :header-rows: 1 :class: config-ref-table * - Configuration option = Default value - Description - * - **[drac]** + * - **[DEFAULT]** - - * - ``client_retry_count`` = ``5`` - - (IntOpt) In case there is a communication failure, the DRAC client resends the request as many times as defined in this setting. - * - ``client_retry_delay`` = ``5`` - - (IntOpt) In case there is a communication failure, the DRAC client waits for as many seconds as defined in this setting before resending the request. + * - ``hds_hnas_driver_helper`` = ``manila.share.drivers.hitachi.ssh.HNASSSHBackend`` + - (String) Python class to be used for driver helper. diff --git a/doc/config-reference/source/tables/manila-hp3par.rst b/doc/config-reference/source/tables/manila-hp3par.rst deleted file mode 100644 index 069663b0a3..0000000000 --- a/doc/config-reference/source/tables/manila-hp3par.rst +++ /dev/null @@ -1,40 +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. - -.. list-table:: Description of HP 3PAR Share Driver configuration options - :header-rows: 1 - :class: config-ref-table - - * - Configuration option = Default value - - Description - * - **[DEFAULT]** - - - * - ``hp3par_api_url`` = `` `` - - (StrOpt) 3PAR WSAPI Server Url like https://<3par ip>:8080/api/v1 - * - ``hp3par_debug`` = ``False`` - - (BoolOpt) Enable HTTP debugging to 3PAR - * - ``hp3par_fpg`` = ``OpenStack`` - - (StrOpt) The File Provisioning Group (FPG) to use - * - ``hp3par_fstore_per_share`` = ``False`` - - (BoolOpt) Use one filestore per share - * - ``hp3par_password`` = `` `` - - (StrOpt) 3PAR password for the user specified in hp3par_username - * - ``hp3par_san_ip`` = `` `` - - (StrOpt) IP address of SAN controller - * - ``hp3par_san_login`` = `` `` - - (StrOpt) Username for SAN controller - * - ``hp3par_san_password`` = `` `` - - (StrOpt) Password for SAN controller - * - ``hp3par_san_ssh_port`` = ``22`` - - (PortOpt) SSH port to use with SAN - * - ``hp3par_share_ip_address`` = `` `` - - (StrOpt) The IP address for shares not using a share server - * - ``hp3par_username`` = `` `` - - (StrOpt) 3PAR username with the 'edit' role diff --git a/doc/config-reference/source/tables/manila-hpe3par.rst b/doc/config-reference/source/tables/manila-hpe3par.rst index 289c84d633..54cba53256 100644 --- a/doc/config-reference/source/tables/manila-hpe3par.rst +++ b/doc/config-reference/source/tables/manila-hpe3par.rst @@ -19,24 +19,34 @@ * - **[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_cifs_admin_access_domain`` = ``LOCAL_CLUSTER`` + - (String) File system domain for the CIFS admin user. + * - ``hpe3par_cifs_admin_access_password`` = + - (String) File system admin password for CIFS. + * - ``hpe3par_cifs_admin_access_username`` = + - (String) File system admin user name for CIFS. * - ``hpe3par_debug`` = ``False`` - - (BoolOpt) Enable HTTP debugging to 3PAR + - (Boolean) Enable HTTP debugging to 3PAR * - ``hpe3par_fpg`` = ``OpenStack`` - - (StrOpt) The File Provisioning Group (FPG) to use + - (String) The File Provisioning Group (FPG) to use * - ``hpe3par_fstore_per_share`` = ``False`` - - (BoolOpt) Use one filestore per share + - (Boolean) Use one filestore per share * - ``hpe3par_password`` = - - (StrOpt) 3PAR password for the user specified in hpe3par_username + - (String) 3PAR password for the user specified in hpe3par_username + * - ``hpe3par_require_cifs_ip`` = ``False`` + - (Boolean) Require IP access rules for CIFS (in addition to user) * - ``hpe3par_san_ip`` = - - (StrOpt) IP address of SAN controller + - (String) IP address of SAN controller * - ``hpe3par_san_login`` = - - (StrOpt) Username for SAN controller + - (String) Username for SAN controller * - ``hpe3par_san_password`` = - - (StrOpt) Password for SAN controller + - (String) Password for SAN controller * - ``hpe3par_san_ssh_port`` = ``22`` - - (PortOpt) SSH port to use with SAN + - (Unknown) SSH port to use with SAN * - ``hpe3par_share_ip_address`` = - - (StrOpt) The IP address for shares not using a share server + - (String) The IP address for shares not using a share server + * - ``hpe3par_share_mount_path`` = ``/mnt/`` + - (String) The path where shares will be mounted when deleting nested file trees. * - ``hpe3par_username`` = - - (StrOpt) 3PAR username with the 'edit' role + - (String) 3PAR username with the 'edit' role diff --git a/doc/config-reference/source/tables/manila-huawei.rst b/doc/config-reference/source/tables/manila-huawei.rst index 1d67c5b3d3..e32ea79e5c 100644 --- a/doc/config-reference/source/tables/manila-huawei.rst +++ b/doc/config-reference/source/tables/manila-huawei.rst @@ -19,4 +19,4 @@ * - **[DEFAULT]** - * - ``manila_huawei_conf_file`` = ``/etc/manila/manila_huawei_conf.xml`` - - (StrOpt) The configuration file for the Manila Huawei driver. + - (String) The configuration file for the Manila Huawei driver. diff --git a/doc/config-reference/source/tables/manila-logging.rst b/doc/config-reference/source/tables/manila-logging.rst index 443da09432..14bf260af8 100644 --- a/doc/config-reference/source/tables/manila-logging.rst +++ b/doc/config-reference/source/tables/manila-logging.rst @@ -19,46 +19,44 @@ * - **[DEFAULT]** - * - ``debug`` = ``False`` - - (BoolOpt) Print debugging output (set logging level to DEBUG instead of 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`` - - (ListOpt) List of logger=LEVEL pairs. This option is ignored if log_config_append is set. + - (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`` + - (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. * - ``fatal_exception_format_errors`` = ``False`` - - (BoolOpt) Whether to make exception message format errors fatal. + - (Boolean) Whether to make exception message format errors fatal. * - ``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. + - (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) 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 output to. If no default is set, logging will go to stdout. 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) Data to append to log format when level 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 without context. + - (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) Format string for user_identity field of the 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) (Optional) Enables or disables syslog rfc5424 format for logging. If enabled, prefixes the MSG part of the syslog message with APP-NAME (RFC5424). The format without the APP-NAME is deprecated in Kilo, and will be removed in Mitaka, along with this option. 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, will disable INFO logging level, making WARNING the default. + - (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) (Optional) 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. diff --git a/doc/config-reference/source/tables/manila-lvm.rst b/doc/config-reference/source/tables/manila-lvm.rst new file mode 100644 index 0000000000..56ef95b6be --- /dev/null +++ b/doc/config-reference/source/tables/manila-lvm.rst @@ -0,0 +1,30 @@ +.. + 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. + +.. _manila-lvm: + +.. list-table:: Description of LVM Share Driver configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``lvm_share_export_ip`` = ``None`` + - (String) IP to be added to export string. + * - ``lvm_share_export_root`` = ``$state_path/mnt`` + - (String) Base folder where exported shares are located. + * - ``lvm_share_helpers`` = ``CIFS=manila.share.drivers.helpers.CIFSHelperUserAccess, NFS=manila.share.drivers.helpers.NFSHelper`` + - (List) Specify list of share export helpers. + * - ``lvm_share_mirrors`` = ``0`` + - (Integer) If set, create LVMs with multiple mirrors. Note that this requires lvm_mirrors + 2 PVs with available space. + * - ``lvm_share_volume_group`` = ``lvm-shares`` + - (String) Name for the VG that will contain exported shares. diff --git a/doc/config-reference/source/tables/manila-netapp.rst b/doc/config-reference/source/tables/manila-netapp.rst index b791261fc0..bbfe4cb998 100644 --- a/doc/config-reference/source/tables/manila-netapp.rst +++ b/doc/config-reference/source/tables/manila-netapp.rst @@ -19,30 +19,34 @@ * - **[DEFAULT]** - * - ``netapp_aggregate_name_search_pattern`` = ``(.*)`` - - (StrOpt) Pattern for searching available aggregates for provisioning. + - (String) Pattern for searching available aggregates for provisioning. * - ``netapp_lif_name_template`` = ``os_%(net_allocation_id)s`` - - (StrOpt) Logical interface (LIF) name template + - (String) Logical interface (LIF) name template * - ``netapp_login`` = ``None`` - - (StrOpt) Administrative user account name used to access the storage system. + - (String) Administrative user account name used to access the storage system. * - ``netapp_password`` = ``None`` - - (StrOpt) Password for the administrative user account specified in the netapp_login option. + - (String) Password for the administrative user account specified in the netapp_login option. * - ``netapp_port_name_search_pattern`` = ``(.*)`` - - (StrOpt) Pattern for overriding the selection of network ports on which to create Vserver LIFs. + - (String) Pattern for overriding the selection of network ports on which to create Vserver LIFs. * - ``netapp_root_volume`` = ``root`` - - (StrOpt) Root volume name. + - (String) Root volume name. * - ``netapp_root_volume_aggregate`` = ``None`` - - (StrOpt) Name of aggregate to create Vserver root volumes on. This option only applies when the option driver_handles_share_servers is set to True. + - (String) Name of aggregate to create Vserver root volumes on. This option only applies when the option driver_handles_share_servers is set to True. * - ``netapp_server_hostname`` = ``None`` - - (StrOpt) The hostname (or IP address) for the storage system. + - (String) The hostname (or IP address) for the storage system. * - ``netapp_server_port`` = ``None`` - - (PortOpt) The TCP port to use for communication with the storage system or proxy server. If not specified, Data ONTAP drivers will use 80 for HTTP and 443 for HTTPS. + - (Unknown) The TCP port to use for communication with the storage system or proxy server. If not specified, Data ONTAP drivers will use 80 for HTTP and 443 for HTTPS. + * - ``netapp_snapmirror_quiesce_timeout`` = ``3600`` + - (Integer) The maximum time in seconds to wait for existing snapmirror transfers to complete before aborting when promoting a replica. * - ``netapp_storage_family`` = ``ontap_cluster`` - - (StrOpt) The storage family type used on the storage system; valid values include ontap_cluster for using clustered Data ONTAP. + - (String) The storage family type used on the storage system; valid values include ontap_cluster for using clustered Data ONTAP. * - ``netapp_trace_flags`` = ``None`` - - (StrOpt) Comma-separated list of options that control which trace info is written to the debug logs. Values include method and api. + - (String) Comma-separated list of options that control which trace info is written to the debug logs. Values include method and api. * - ``netapp_transport_type`` = ``http`` - - (StrOpt) The transport protocol used when communicating with the storage system or proxy server. Valid values are http or https. + - (String) The transport protocol used when communicating with the storage system or proxy server. Valid values are http or https. * - ``netapp_volume_name_template`` = ``share_%(share_id)s`` - - (StrOpt) NetApp volume name template. + - (String) NetApp volume name template. + * - ``netapp_volume_snapshot_reserve_percent`` = ``5`` + - (Integer) The percentage of share space set aside as reserve for snapshot usage; valid values range from 0 to 90. * - ``netapp_vserver_name_template`` = ``os_%s`` - - (StrOpt) Name template to use for new Vserver. + - (String) Name template to use for new Vserver. diff --git a/doc/config-reference/source/tables/manila-qpid.rst b/doc/config-reference/source/tables/manila-qpid.rst deleted file mode 100644 index 2c0fc1bc22..0000000000 --- a/doc/config-reference/source/tables/manila-qpid.rst +++ /dev/null @@ -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. - -.. _manila-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. diff --git a/doc/config-reference/source/tables/manila-quobyte.rst b/doc/config-reference/source/tables/manila-quobyte.rst index e458f5cc13..2d9f525355 100644 --- a/doc/config-reference/source/tables/manila-quobyte.rst +++ b/doc/config-reference/source/tables/manila-quobyte.rst @@ -19,18 +19,18 @@ * - **[DEFAULT]** - * - ``quobyte_api_ca`` = ``None`` - - (StrOpt) The X.509 CA file to verify the server cert. + - (String) The X.509 CA file to verify the server cert. * - ``quobyte_api_password`` = ``quobyte`` - - (StrOpt) Password for Quobyte API server + - (String) Password for Quobyte API server * - ``quobyte_api_url`` = ``None`` - - (StrOpt) URL of the Quobyte API server (http or https) + - (String) URL of the Quobyte API server (http or https) * - ``quobyte_api_username`` = ``admin`` - - (StrOpt) Username for Quobyte API server. + - (String) Username for Quobyte API server. * - ``quobyte_default_volume_group`` = ``root`` - - (StrOpt) Default owning group for new volumes. + - (String) Default owning group for new volumes. * - ``quobyte_default_volume_user`` = ``root`` - - (StrOpt) Default owning user for new volumes. + - (String) Default owning user for new volumes. * - ``quobyte_delete_shares`` = ``False`` - - (BoolOpt) Actually deletes shares (vs. unexport) + - (Boolean) Actually deletes shares (vs. unexport) * - ``quobyte_volume_configuration`` = ``BASE`` - - (StrOpt) Name of volume configuration used for new shares. + - (String) Name of volume configuration used for new shares. diff --git a/doc/config-reference/source/tables/manila-quota.rst b/doc/config-reference/source/tables/manila-quota.rst index eb34c596cc..b96b4fcefa 100644 --- a/doc/config-reference/source/tables/manila-quota.rst +++ b/doc/config-reference/source/tables/manila-quota.rst @@ -19,20 +19,20 @@ * - **[DEFAULT]** - * - ``max_age`` = ``0`` - - (IntOpt) Number of seconds between subsequent usage refreshes. + - (Integer) Number of seconds between subsequent usage refreshes. * - ``max_gigabytes`` = ``10000`` - - (IntOpt) Maximum number of volume gigabytes to allow per host. + - (Integer) Maximum number of volume gigabytes to allow per host. * - ``quota_driver`` = ``manila.quota.DbQuotaDriver`` - - (StrOpt) Default driver to use for quota checks. + - (String) Default driver to use for quota checks. * - ``quota_gigabytes`` = ``1000`` - - (IntOpt) Number of share gigabytes allowed per project. + - (Integer) Number of share gigabytes allowed per project. * - ``quota_share_networks`` = ``10`` - - (IntOpt) Number of share-networks allowed per project. + - (Integer) Number of share-networks allowed per project. * - ``quota_shares`` = ``50`` - - (IntOpt) Number of shares allowed per project. + - (Integer) Number of shares allowed per project. * - ``quota_snapshot_gigabytes`` = ``1000`` - - (IntOpt) Number of snapshot gigabytes allowed per project. + - (Integer) Number of snapshot gigabytes allowed per project. * - ``quota_snapshots`` = ``50`` - - (IntOpt) Number of share snapshots allowed per project. + - (Integer) Number of share snapshots allowed per project. * - ``reservation_expire`` = ``86400`` - - (IntOpt) Number of seconds until a reservation expires. + - (Integer) Number of seconds until a reservation expires. diff --git a/doc/config-reference/source/tables/manila-rabbitmq.rst b/doc/config-reference/source/tables/manila-rabbitmq.rst index 683f51cc08..7389631c43 100644 --- a/doc/config-reference/source/tables/manila-rabbitmq.rst +++ b/doc/config-reference/source/tables/manila-rabbitmq.rst @@ -19,50 +19,112 @@ * - **[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`` + - (String) EXPERIMENTAL: Possible values are: gzip, bz2. If not set compression will not be used. This option may notbe available in future versions. + * - ``kombu_failover_strategy`` = ``round-robin`` + - (String) Determines how the next RabbitMQ node is chosen in case the one we are currently connected to becomes unavailable. Takes effect only if more than one RabbitMQ node is provided in config. + * - ``kombu_missing_consumer_retry_timeout`` = ``60`` + - (Integer) How long to wait a missing client 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. - * - ``kombu_reconnect_timeout`` = ``60`` - - (IntOpt) How long to wait before considering a reconnect attempt to have failed. This value should not be longer than rpc_response_timeout. + - (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`` + - (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`` - - (IntOpt) 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`` + - (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. + - (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. - * - ``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. + - (String) The RabbitMQ virtual host. + * - ``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 diff --git a/doc/config-reference/source/tables/manila-redis.rst b/doc/config-reference/source/tables/manila-redis.rst index 6de060c5bd..55d0ba6ba3 100644 --- a/doc/config-reference/source/tables/manila-redis.rst +++ b/doc/config-reference/source/tables/manila-redis.rst @@ -16,17 +16,21 @@ * - Configuration option = Default value - Description - * - **[DEFAULT]** - - - * - ``password`` = - - (StrOpt) Password for Redis server (optional). - * - ``port`` = ``6379`` - - (IntOpt) Use this port to connect to redis host. * - **[matchmaker_redis]** - + * - ``check_timeout`` = ``20000`` + - (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`` - - (IntOpt) Use this port to connect to redis host. + - (Unknown) Use this port to connect to redis host. + * - ``sentinel_group_name`` = ``oslo-messaging-zeromq`` + - (String) Redis replica set name. + * - ``sentinel_hosts`` = + - (List) List of Redis Sentinel hosts (fault tolerance mode) e.g. [host:port, host1:port ... ] + * - ``socket_timeout`` = ``1000`` + - (Integer) Timeout in ms on blocking socket operations + * - ``wait_timeout`` = ``500`` + - (Integer) Time in ms to wait between connection attempts. diff --git a/doc/config-reference/source/tables/manila-rpc.rst b/doc/config-reference/source/tables/manila-rpc.rst index 55ec8123dc..b91e447918 100644 --- a/doc/config-reference/source/tables/manila-rpc.rst +++ b/doc/config-reference/source/tables/manila-rpc.rst @@ -19,54 +19,62 @@ * - **[DEFAULT]** - * - ``rpc_backend`` = ``rabbit`` - - (StrOpt) The messaging driver to use, defaults to rabbit. Other drivers include qpid and zmq. - * - ``rpc_cast_timeout`` = ``30`` - - (IntOpt) Seconds to wait before a cast expires (TTL). Only supported by impl_zmq. + - (String) The messaging driver to use, defaults to rabbit. Other drivers include amqp and zmq. + * - ``rpc_cast_timeout`` = ``-1`` + - (Integer) Seconds to wait before a cast expires (TTL). The default value of -1 specifies an infinite linger period. The value of 0 specifies no linger period. Pending messages shall be discarded immediately when the socket is closed. Only supported by impl_zmq. * - ``rpc_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. * - ``share_topic`` = ``manila-share`` - - (StrOpt) The topic share nodes listen on. + - (String) The topic share nodes listen on. * - **[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`` = ``[]`` + - (Multi-valued) The Drivers(s) to handle sending notifications. Possible values are messaging, messagingv2, routing, log, test, noop + * - ``topics`` = ``notifications`` + - (List) AMQP topic used for OpenStack notifications. + * - ``transport_url`` = ``None`` + - (String) A URL representing the messaging driver to use for notifications. If not set, we fall back to the same configuration used for RPC. diff --git a/doc/config-reference/source/tables/manila-san.rst b/doc/config-reference/source/tables/manila-san.rst index 0c0ae3f7e1..812aef2564 100644 --- a/doc/config-reference/source/tables/manila-san.rst +++ b/doc/config-reference/source/tables/manila-san.rst @@ -19,8 +19,8 @@ * - **[DEFAULT]** - * - ``ssh_conn_timeout`` = ``60`` - - (IntOpt) Backend server SSH connection timeout. + - (Integer) Backend server SSH connection timeout. * - ``ssh_max_pool_conn`` = ``10`` - - (IntOpt) Maximum number of connections in the SSH pool. + - (Integer) Maximum number of connections in the SSH pool. * - ``ssh_min_pool_conn`` = ``1`` - - (IntOpt) Minimum number of connections in the SSH pool. + - (Integer) Minimum number of connections in the SSH pool. diff --git a/doc/config-reference/source/tables/manila-scheduler.rst b/doc/config-reference/source/tables/manila-scheduler.rst index b5994f7dfc..2f098adcc6 100644 --- a/doc/config-reference/source/tables/manila-scheduler.rst +++ b/doc/config-reference/source/tables/manila-scheduler.rst @@ -19,22 +19,22 @@ * - **[DEFAULT]** - * - ``capacity_weight_multiplier`` = ``1.0`` - - (FloatOpt) Multiplier used for weighing share capacity. Negative numbers mean to stack vs spread. + - (Floating point) Multiplier used for weighing share capacity. Negative numbers mean to stack vs spread. * - ``pool_weight_multiplier`` = ``1.0`` - - (FloatOpt) Multiplier used for weighing pools which have existing share servers. Negative numbers mean to spread vs stack. - * - ``scheduler_default_filters`` = ``AvailabilityZoneFilter, CapacityFilter, CapabilitiesFilter, ConsistencyGroupFilter`` - - (ListOpt) Which filter class names to use for filtering hosts when not specified in the request. + - (Floating point) Multiplier used for weighing pools which have existing share servers. Negative numbers mean to spread vs stack. + * - ``scheduler_default_filters`` = ``AvailabilityZoneFilter, CapacityFilter, CapabilitiesFilter, ConsistencyGroupFilter, ShareReplicationFilter`` + - (List) Which filter class names to use for filtering hosts when not specified in the request. * - ``scheduler_default_weighers`` = ``CapacityWeigher`` - - (ListOpt) Which weigher class names to use for weighing hosts. + - (List) Which weigher class names to use for weighing hosts. * - ``scheduler_driver`` = ``manila.scheduler.drivers.filter.FilterScheduler`` - - (StrOpt) Default scheduler driver to use. + - (String) Default scheduler driver to use. * - ``scheduler_host_manager`` = ``manila.scheduler.host_manager.HostManager`` - - (StrOpt) The scheduler host manager class to use. + - (String) The scheduler host manager class to use. * - ``scheduler_json_config_location`` = - - (StrOpt) Absolute path to scheduler configuration JSON file. + - (String) Absolute path to scheduler configuration JSON file. * - ``scheduler_manager`` = ``manila.scheduler.manager.SchedulerManager`` - - (StrOpt) Full class name for the scheduler manager. + - (String) Full class name for the scheduler manager. * - ``scheduler_max_attempts`` = ``3`` - - (IntOpt) Maximum number of attempts to schedule a share. + - (Integer) Maximum number of attempts to schedule a share. * - ``scheduler_topic`` = ``manila-scheduler`` - - (StrOpt) The topic scheduler nodes listen on. + - (String) The topic scheduler nodes listen on. diff --git a/doc/config-reference/source/tables/manila-share.rst b/doc/config-reference/source/tables/manila-share.rst index b7484d314e..5d610d0b05 100644 --- a/doc/config-reference/source/tables/manila-share.rst +++ b/doc/config-reference/source/tables/manila-share.rst @@ -19,64 +19,58 @@ * - **[DEFAULT]** - * - ``automatic_share_server_cleanup`` = ``True`` - - (BoolOpt) If set to True, then Manila will delete all share servers which were unused more than specified time .If set to False - automatic deletion of share servers will be disabled. + - (Boolean) If set to True, then Manila will delete all share servers which were unused more than specified time .If set to False - automatic deletion of share servers will be disabled. * - ``backlog`` = ``4096`` - - (IntOpt) Number of backlog requests to configure the socket with. + - (Integer) Number of backlog requests to configure the socket with. * - ``default_share_type`` = ``None`` - - (StrOpt) Default share type to use. + - (String) Default share type to use. * - ``delete_share_server_with_last_share`` = ``False`` - - (BoolOpt) Whether share servers will be deleted on deletion of the last share. + - (Boolean) Whether share servers will be deleted on deletion of the last share. * - ``driver_handles_share_servers`` = ``None`` - - (BoolOpt) There are two possible approaches for share drivers in Manila. First is when share driver is able to handle share-servers and second when not. Drivers can support either both or only one of these approaches. So, set this opt to True if share driver is able to handle share servers and it is desired mode else set False. It is set to None by default to make this choice intentional. + - (Boolean) There are two possible approaches for share drivers in Manila. First is when share driver is able to handle share-servers and second when not. Drivers can support either both or only one of these approaches. So, set this opt to True if share driver is able to handle share servers and it is desired mode else set False. It is set to None by default to make this choice intentional. * - ``enable_periodic_hooks`` = ``False`` - - (BoolOpt) Whether to enable periodic hooks or not. + - (Boolean) Whether to enable periodic hooks or not. * - ``enable_post_hooks`` = ``False`` - - (BoolOpt) Whether to enable post hooks or not. + - (Boolean) Whether to enable post hooks or not. * - ``enable_pre_hooks`` = ``False`` - - (BoolOpt) Whether to enable pre hooks or not. + - (Boolean) Whether to enable pre hooks or not. * - ``enabled_share_backends`` = ``None`` - - (ListOpt) A list of share backend names to use. These backend names should be backed by a unique [CONFIG] group with its options. + - (List) A list of share backend names to use. These backend names should be backed by a unique [CONFIG] group with its options. * - ``enabled_share_protocols`` = ``NFS, CIFS`` - - (ListOpt) Specify list of protocols to be allowed for share creation. Available values are '('NFS', 'CIFS', 'GLUSTERFS', 'HDFS')' + - (List) Specify list of protocols to be allowed for share creation. Available values are '('NFS', 'CIFS', 'GLUSTERFS', 'HDFS', 'CEPHFS')' * - ``executor_thread_pool_size`` = ``64`` - - (IntOpt) Size of executor thread pool. + - (Integer) Size of executor thread pool. * - ``hook_drivers`` = - - (ListOpt) Driver(s) to perform some additional actions before and after share driver actions and on a periodic basis. Default is []. + - (List) Driver(s) to perform some additional actions before and after share driver actions and on a periodic basis. Default is []. * - ``migration_create_delete_share_timeout`` = ``300`` - - (IntOpt) Timeout for creating and deleting share instances when performing share migration (seconds). - * - ``migration_data_copy_node_ip`` = ``None`` - - (StrOpt) The IP of the node responsible for copying data during migration, such as the data copy service node, reachable by the backend. + - (Integer) Timeout for creating and deleting share instances when performing share migration (seconds). * - ``migration_ignore_files`` = ``lost+found`` - - (ListOpt) List of files and folders to be ignored when migrating shares. Items should be names (not including any path). - * - ``migration_mounting_backend_ip`` = ``None`` - - (StrOpt) Backend IP in admin network to use for mounting shares during migration. - * - ``migration_protocol_mount_command`` = ``None`` - - (StrOpt) The command for mounting shares for this backend. Must specifythe executable and all necessary parameters for the protocol supported. It is advisable to separate protocols per backend. - * - ``migration_readonly_support`` = ``True`` - - (BoolOpt) Specify whether read only access mode is supported in thisbackend. + - (List) List of files and folders to be ignored when migrating shares. Items should be names (not including any path). + * - ``migration_readonly_rules_support`` = ``True`` + - (Boolean) Specify whether read only access rule mode is supported in this backend. * - ``migration_tmp_location`` = ``/tmp/`` - - (StrOpt) Temporary path to create and mount shares during migration. - * - ``migration_wait_access_rules_timeout`` = ``90`` - - (IntOpt) Time to wait for access rules to be allowed/denied on backends when migrating shares using generic approach (seconds). + - (String) Temporary path to create and mount shares during migration. + * - ``migration_wait_access_rules_timeout`` = ``180`` + - (Integer) Time to wait for access rules to be allowed/denied on backends when migrating shares using generic approach (seconds). * - ``network_config_group`` = ``None`` - - (StrOpt) Name of the configuration group in the Manila conf file to look for network config options.If not set, the share backend's config group will be used.If an option is not found within provided group, then'DEFAULT' group will be used for search of option. + - (String) Name of the configuration group in the Manila conf file to look for network config options.If not set, the share backend's config group will be used.If an option is not found within provided group, then'DEFAULT' group will be used for search of option. * - ``root_helper`` = ``sudo`` - - (StrOpt) Deprecated: command to use for running commands as root. + - (String) Deprecated: command to use for running commands as root. * - ``share_manager`` = ``manila.share.manager.ShareManager`` - - (StrOpt) Full class name for the share manager. + - (String) Full class name for the share manager. * - ``share_name_template`` = ``share-%s`` - - (StrOpt) Template string to be used to generate share names. + - (String) Template string to be used to generate share names. * - ``share_snapshot_name_template`` = ``share-snapshot-%s`` - - (StrOpt) Template string to be used to generate share snapshot names. + - (String) Template string to be used to generate share snapshot names. * - ``share_usage_audit_period`` = ``month`` - - (StrOpt) Time period to generate share usages for. Time period must be hour, day, month or year. + - (String) Time period to generate share usages for. Time period must be hour, day, month or year. * - ``suppress_post_hooks_errors`` = ``False`` - - (BoolOpt) Whether to suppress post hook errors (allow driver's results to pass through) or not. + - (Boolean) Whether to suppress post hook errors (allow driver's results to pass through) or not. * - ``suppress_pre_hooks_errors`` = ``False`` - - (BoolOpt) Whether to suppress pre hook errors (allow driver perform actions) or not. + - (Boolean) Whether to suppress pre hook errors (allow driver perform actions) or not. * - ``unmanage_remove_access_rules`` = ``False`` - - (BoolOpt) If set to True, then manila will deny access and remove all access rules on share unmanage.If set to False - nothing will be changed. + - (Boolean) If set to True, then manila will deny access and remove all access rules on share unmanage.If set to False - nothing will be changed. * - ``unused_share_server_cleanup_interval`` = ``10`` - - (IntOpt) Unallocated share servers reclamation time interval (minutes). Minimum value is 10 minutes, maximum is 60 minutes. The reclamation function is run every 10 minutes and delete share servers which were unused more than unused_share_server_cleanup_interval option defines. This value reflects the shortest time Manila will wait for a share server to go unutilized before deleting it. + - (Integer) Unallocated share servers reclamation time interval (minutes). Minimum value is 10 minutes, maximum is 60 minutes. The reclamation function is run every 10 minutes and delete share servers which were unused more than unused_share_server_cleanup_interval option defines. This value reflects the shortest time Manila will wait for a share server to go unutilized before deleting it. * - ``use_scheduler_creating_share_from_snapshot`` = ``False`` - - (BoolOpt) If set to False, then share creation from snapshot will be performed on the same host. If set to True, then scheduling step will be used. + - (Boolean) If set to False, then share creation from snapshot will be performed on the same host. If set to True, then scheduling step will be used. diff --git a/doc/config-reference/source/tables/neutron-brocade.rst b/doc/config-reference/source/tables/manila-tegile.rst similarity index 52% rename from doc/config-reference/source/tables/neutron-brocade.rst rename to doc/config-reference/source/tables/manila-tegile.rst index 8c3e8c3679..775ed8213a 100644 --- a/doc/config-reference/source/tables/neutron-brocade.rst +++ b/doc/config-reference/source/tables/manila-tegile.rst @@ -8,25 +8,21 @@ autogenerate-config-doc tool from the openstack-doc-tools repository, or ask for help on the documentation mailing list, IRC channel or meeting. -.. _neutron-brocade: +.. _manila-tegile: -.. list-table:: Description of Brocade configuration options +.. list-table:: Description of Tegile Share Driver configuration options :header-rows: 1 :class: config-ref-table * - Configuration option = Default value - Description - * - **[PHYSICAL_INTERFACE]** + * - **[DEFAULT]** - - * - ``physical_interface`` = ``eth0`` - - (StrOpt) The network interface to use when creating a port - * - **[SWITCH]** - - - * - ``address`` = - - (StrOpt) The address of the host to SSH to - * - ``ostype`` = ``NOS`` - - (StrOpt) Currently unused - * - ``password`` = - - (StrOpt) The SSH password to use - * - ``username`` = - - (StrOpt) The SSH username to use + * - ``tegile_default_project`` = ``None`` + - (String) Create shares in this project + * - ``tegile_nas_login`` = ``None`` + - (String) User name for the Tegile NAS server. + * - ``tegile_nas_password`` = ``None`` + - (String) Password for the Tegile NAS server. + * - ``tegile_nas_server`` = ``None`` + - (String) Tegile NAS server hostname or IP address. diff --git a/doc/config-reference/source/tables/manila-winrm.rst b/doc/config-reference/source/tables/manila-winrm.rst index 7b27c892f5..66622177e8 100644 --- a/doc/config-reference/source/tables/manila-winrm.rst +++ b/doc/config-reference/source/tables/manila-winrm.rst @@ -19,16 +19,16 @@ * - **[DEFAULT]** - * - ``winrm_cert_key_pem_path`` = ``~/.ssl/key.pem`` - - (StrOpt) Path to the x509 certificate key. + - (String) Path to the x509 certificate key. * - ``winrm_cert_pem_path`` = ``~/.ssl/cert.pem`` - - (StrOpt) Path to the x509 certificate used for accessing the serviceinstance. + - (String) Path to the x509 certificate used for accessing the serviceinstance. * - ``winrm_conn_timeout`` = ``60`` - - (IntOpt) WinRM connection timeout. + - (Integer) WinRM connection timeout. * - ``winrm_operation_timeout`` = ``60`` - - (IntOpt) WinRM operation timeout. + - (Integer) WinRM operation timeout. * - ``winrm_retry_count`` = ``3`` - - (IntOpt) WinRM retry count. + - (Integer) WinRM retry count. * - ``winrm_retry_interval`` = ``5`` - - (IntOpt) WinRM retry interval in seconds + - (Integer) WinRM retry interval in seconds * - ``winrm_use_cert_based_auth`` = ``False`` - - (BoolOpt) Use x509 certificates in order to authenticate to theservice instance. + - (Boolean) Use x509 certificates in order to authenticate to theservice instance. diff --git a/doc/config-reference/source/tables/manila-zeromq.rst b/doc/config-reference/source/tables/manila-zeromq.rst index 07f4fe2fef..28fa9e325c 100644 --- a/doc/config-reference/source/tables/manila-zeromq.rst +++ b/doc/config-reference/source/tables/manila-zeromq.rst @@ -18,27 +18,27 @@ - Description * - **[DEFAULT]** - - * - ``rpc_zmq_all_req_rep`` = ``True`` - - (BoolOpt) Use REQ/REP pattern for all methods CALL/CAST/FANOUT. * - ``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`` - - (IntOpt) 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. - * - ``zmq_use_broker`` = ``True`` - - (BoolOpt) Shows whether zmq-messaging uses broker or not. + - (Integer) Maximum number of ingress messages to locally buffer per topic. Default is unlimited. + * - ``use_pub_sub`` = ``True`` + - (Boolean) Use PUB/SUB pattern for fanout methods. PUB/SUB always uses proxy. + * - ``zmq_target_expire`` = ``120`` + - (Integer) Expiration timeout in seconds of a name service record about existing target ( < 0 means no timeout). diff --git a/doc/config-reference/source/tables/manila-zfs.rst b/doc/config-reference/source/tables/manila-zfs.rst new file mode 100644 index 0000000000..c6b9797abd --- /dev/null +++ b/doc/config-reference/source/tables/manila-zfs.rst @@ -0,0 +1,44 @@ +.. + 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. + +.. _manila-zfs: + +.. list-table:: Description of ZFS Share Driver configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``zfs_dataset_creation_options`` = ``None`` + - (List) Define here list of options that should be applied for each dataset creation if needed. Example: compression=gzip,dedup=off. Note that, for secondary replicas option 'readonly' will be set to 'on' and for active replicas to 'off' in any way. Also, 'quota' will be equal to share size. Optional. + * - ``zfs_dataset_name_prefix`` = ``manila_share_`` + - (String) Prefix to be used in each dataset name. Optional. + * - ``zfs_dataset_snapshot_name_prefix`` = ``manila_share_snapshot_`` + - (String) Prefix to be used in each dataset snapshot name. Optional. + * - ``zfs_replica_snapshot_prefix`` = ``tmp_snapshot_for_replication_`` + - (String) Set snapshot prefix for usage in ZFS replication. Required. + * - ``zfs_service_ip`` = ``None`` + - (String) IP to be added to admin-facing export location. Required. + * - ``zfs_share_export_ip`` = ``None`` + - (String) IP to be added to user-facing export location. Required. + * - ``zfs_share_helpers`` = ``NFS=manila.share.drivers.zfsonlinux.utils.NFSviaZFSHelper`` + - (List) Specify list of share export helpers for ZFS storage. It should look like following: 'FOO_protocol=foo.FooClass,BAR_protocol=bar.BarClass'. Required. + * - ``zfs_ssh_private_key_path`` = ``None`` + - (String) Path to SSH private key that should be used for SSH'ing ZFS storage host. Not used for replication operations. Optional. + * - ``zfs_ssh_user_password`` = ``None`` + - (String) Password for user that is used for SSH'ing ZFS storage host. Not used for replication operations. They require passwordless SSH access. Optional. + * - ``zfs_ssh_username`` = ``None`` + - (String) SSH user that will be used in 2 cases: 1) By manila-share service in case it is located on different host than its ZFS storage. 2) By manila-share services with other ZFS backends that perform replication. It is expected that SSH'ing will be key-based, passwordless. This user should be passwordless sudoer. Optional. + * - ``zfs_use_ssh`` = ``False`` + - (Boolean) Remote ZFS storage hostname that should be used for SSH'ing. Optional. + * - ``zfs_zpool_list`` = ``None`` + - (List) Specify list of zpools that are allowed to be used by backend. Can contain nested datasets. Examples: Without nested dataset: 'zpool_name'. With nested dataset: 'zpool_name/nested_dataset_name'. Required. diff --git a/doc/config-reference/source/tables/manila-zfssa.rst b/doc/config-reference/source/tables/manila-zfssa.rst index 7428e6c621..7e58ad9f3a 100644 --- a/doc/config-reference/source/tables/manila-zfssa.rst +++ b/doc/config-reference/source/tables/manila-zfssa.rst @@ -19,30 +19,30 @@ * - **[DEFAULT]** - * - ``zfssa_auth_password`` = ``None`` - - (StrOpt) ZFSSA management authorized userpassword. + - (String) ZFSSA management authorized userpassword. * - ``zfssa_auth_user`` = ``None`` - - (StrOpt) ZFSSA management authorized username. + - (String) ZFSSA management authorized username. * - ``zfssa_data_ip`` = ``None`` - - (StrOpt) IP address for data. + - (String) IP address for data. * - ``zfssa_host`` = ``None`` - - (StrOpt) ZFSSA management IP address. + - (String) ZFSSA management IP address. * - ``zfssa_nas_checksum`` = ``fletcher4`` - - (StrOpt) Controls checksum used for data blocks. + - (String) Controls checksum used for data blocks. * - ``zfssa_nas_compression`` = ``off`` - - (StrOpt) Data compression-off, lzjb, gzip-2, gzip, gzip-9. + - (String) Data compression-off, lzjb, gzip-2, gzip, gzip-9. * - ``zfssa_nas_logbias`` = ``latency`` - - (StrOpt) Controls behavior when servicing synchronous writes. + - (String) Controls behavior when servicing synchronous writes. * - ``zfssa_nas_mountpoint`` = - - (StrOpt) Location of project in ZFS/SA. + - (String) Location of project in ZFS/SA. * - ``zfssa_nas_quota_snap`` = ``true`` - - (StrOpt) Controls whether a share quota includes snapshot. + - (String) Controls whether a share quota includes snapshot. * - ``zfssa_nas_rstchown`` = ``true`` - - (StrOpt) Controls whether file ownership can be changed. + - (String) Controls whether file ownership can be changed. * - ``zfssa_nas_vscan`` = ``false`` - - (StrOpt) Controls whether the share is scanned for viruses. + - (String) Controls whether the share is scanned for viruses. * - ``zfssa_pool`` = ``None`` - - (StrOpt) ZFSSA storage pool name. + - (String) ZFSSA storage pool name. * - ``zfssa_project`` = ``None`` - - (StrOpt) ZFSSA project name. + - (String) ZFSSA project name. * - ``zfssa_rest_timeout`` = ``None`` - - (StrOpt) REST connection timeout (in seconds). + - (String) REST connection timeout (in seconds). diff --git a/doc/config-reference/source/tables/neutron-agent.rst b/doc/config-reference/source/tables/neutron-agent.rst index 341b192917..e878bd1fa2 100644 --- a/doc/config-reference/source/tables/neutron-agent.rst +++ b/doc/config-reference/source/tables/neutron-agent.rst @@ -19,14 +19,14 @@ * - **[DEFAULT]** - * - ``external_pids`` = ``$state_path/external/pids`` - - (StrOpt) Location to store child pid files + - (String) Location to store child pid files * - ``network_device_mtu`` = ``None`` - - (IntOpt) MTU setting for device. + - (Integer) DEPRECATED: MTU setting for device. This option will be removed in Newton. Please use the system-wide segment_mtu setting which the agents will take into account when wiring VIFs. * - ``prefix_delegation_driver`` = ``dibbler`` - - (StrOpt) Driver used for ipv6 prefix delegation. This needs to be an entry point defined in the neutron.agent.linux.pd_drivers namespace. See setup.cfg for entry points included with the neutron source. + - (String) Driver used for ipv6 prefix delegation. This needs to be an entry point defined in the neutron.agent.linux.pd_drivers namespace. See setup.cfg for entry points included with the neutron source. * - **[AGENT]** - * - ``agent_type`` = ``Open vSwitch agent`` - - (StrOpt) Selects the Agent Type reported + - (String) DEPRECATED: Selects the Agent Type reported * - ``availability_zone`` = ``nova`` - - (StrOpt) Availability zone of this node + - (String) Availability zone of this node diff --git a/doc/config-reference/source/tables/neutron-amqp.rst b/doc/config-reference/source/tables/neutron-amqp.rst index cf456a317a..7efde5d2d0 100644 --- a/doc/config-reference/source/tables/neutron-amqp.rst +++ b/doc/config-reference/source/tables/neutron-amqp.rst @@ -19,14 +19,6 @@ * - **[DEFAULT]** - * - ``control_exchange`` = ``neutron`` - - (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. - * - **[oslo_messaging_notifications]** - - - * - ``driver`` = ``[]`` - - (MultiStrOpt) 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. - * - ``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 and its full configuration. If not set, we fall back to the rpc_backend option and driver specific configuration. diff --git a/doc/config-reference/source/tables/neutron-api.rst b/doc/config-reference/source/tables/neutron-api.rst index e2b2bbfe34..b6e9c9d044 100644 --- a/doc/config-reference/source/tables/neutron-api.rst +++ b/doc/config-reference/source/tables/neutron-api.rst @@ -19,44 +19,44 @@ * - **[DEFAULT]** - * - ``allow_bulk`` = ``True`` - - (BoolOpt) Allow the usage of the bulk API + - (Boolean) Allow the usage of the bulk API * - ``allow_pagination`` = ``False`` - - (BoolOpt) Allow the usage of the pagination + - (Boolean) Allow the usage of the pagination * - ``allow_sorting`` = ``False`` - - (BoolOpt) Allow the usage of the sorting + - (Boolean) Allow the usage of the sorting * - ``api_extensions_path`` = - - (StrOpt) The path for API extensions. Note that this can be a colon-separated list of paths. For example: api_extensions_path = extensions:/path/to/more/exts:/even/more/exts. The __path__ of neutron.extensions is appended to this, so if your extensions are in there you don't need to specify them here. + - (String) The path for API extensions. Note that this can be a colon-separated list of paths. For example: api_extensions_path = extensions:/path/to/more/exts:/even/more/exts. The __path__ of neutron.extensions is appended to this, so if your extensions are in there you don't need to specify them here. * - ``api_paste_config`` = ``api-paste.ini`` - - (StrOpt) File name for the paste.deploy config for api service + - (String) File name for the paste.deploy config for api service * - ``backlog`` = ``4096`` - - (IntOpt) Number of backlog requests to configure the socket with + - (Integer) Number of backlog requests to configure the socket with * - ``client_socket_timeout`` = ``900`` - - (IntOpt) Timeout for client connections' socket operations. If an incoming connection is idle for this number of seconds it will be closed. A value of '0' means wait forever. + - (Integer) Timeout for client connections' socket operations. If an incoming connection is idle for this number of seconds it will be closed. A value of '0' means wait forever. * - ``max_header_line`` = ``16384`` - - (IntOpt) Maximum line size of message headers to be accepted. max_header_line may need to be increased when using large tokens (typically those generated when keystone is configured to use PKI tokens with big service catalogs). + - (Integer) Maximum line size of message headers to be accepted. max_header_line may need to be increased when using large tokens (typically those generated when keystone is configured to use PKI tokens with big service catalogs). * - ``pagination_max_limit`` = ``-1`` - - (StrOpt) The maximum number of items returned in a single response, value was 'infinite' or negative integer means no limit + - (String) The maximum number of items returned in a single response, value was 'infinite' or negative integer means no limit * - ``retry_until_window`` = ``30`` - - (IntOpt) Number of seconds to keep retrying to listen + - (Integer) Number of seconds to keep retrying to listen * - ``service_plugins`` = - - (ListOpt) The service plugins Neutron will use + - (List) The service plugins Neutron will use * - ``tcp_keepidle`` = ``600`` - - (IntOpt) Sets the value of TCP_KEEPIDLE in seconds for each server socket. Not supported on OS X. + - (Integer) Sets the value of TCP_KEEPIDLE in seconds for each server socket. Not supported on OS X. * - ``wsgi_default_pool_size`` = ``100`` - - (IntOpt) Size of the pool of greenthreads used by wsgi + - (Integer) Size of the pool of greenthreads used by wsgi * - ``wsgi_keep_alive`` = ``True`` - - (BoolOpt) If False, closes the client socket connection explicitly. + - (Boolean) If False, closes the client socket connection explicitly. * - **[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. diff --git a/doc/config-reference/source/tables/neutron-auth_token.rst b/doc/config-reference/source/tables/neutron-auth_token.rst index 19fe18f37e..d6aa3c864f 100644 --- a/doc/config-reference/source/tables/neutron-auth_token.rst +++ b/doc/config-reference/source/tables/neutron-auth_token.rst @@ -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. diff --git a/doc/config-reference/source/tables/neutron-bgp.rst b/doc/config-reference/source/tables/neutron-bgp.rst new file mode 100644 index 0000000000..2bcae1fcd1 --- /dev/null +++ b/doc/config-reference/source/tables/neutron-bgp.rst @@ -0,0 +1,24 @@ +.. + 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. + +.. _neutron-bgp: + +.. list-table:: Description of BGP configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[BGP]** + - + * - ``bgp_router_id`` = ``None`` + - (String) 32-bit BGP identifier, typically an IPv4 address owned by the system running the BGP DrAgent. + * - ``bgp_speaker_driver`` = ``None`` + - (String) BGP speaker driver class to be instantiated. diff --git a/doc/config-reference/source/tables/neutron-cisco.rst b/doc/config-reference/source/tables/neutron-cisco.rst index 94929217bf..2e79c1dd3c 100644 --- a/doc/config-reference/source/tables/neutron-cisco.rst +++ b/doc/config-reference/source/tables/neutron-cisco.rst @@ -19,4 +19,4 @@ * - **[cisco_csr_ipsec]** - * - ``status_check_interval`` = ``60`` - - (IntOpt) Status check interval for Cisco CSR IPSec connections + - (Integer) Status check interval for Cisco CSR IPSec connections diff --git a/doc/config-reference/source/tables/neutron-common.rst b/doc/config-reference/source/tables/neutron-common.rst index f4acc661d9..bf04d6092d 100644 --- a/doc/config-reference/source/tables/neutron-common.rst +++ b/doc/config-reference/source/tables/neutron-common.rst @@ -19,108 +19,110 @@ * - **[DEFAULT]** - * - ``agent_down_time`` = ``75`` - - (IntOpt) Seconds to regard the agent is down; should be at least twice report_interval, to be sure the agent is down for good. + - (Integer) Seconds to regard the agent is down; should be at least twice report_interval, to be sure the agent is down for good. * - ``api_workers`` = ``None`` - - (IntOpt) Number of separate API worker processes for service. If not specified, the default is equal to the number of CPUs available for best performance. + - (Integer) Number of separate API worker processes for service. If not specified, the default is equal to the number of CPUs available for best performance. * - ``auth_ca_cert`` = ``None`` - - (StrOpt) Certificate Authority public key (CA cert) file for ssl + - (String) Certificate Authority public key (CA cert) file for ssl * - ``auth_strategy`` = ``keystone`` - - (StrOpt) The type of authentication to use + - (String) The type of authentication to use * - ``base_mac`` = ``fa:16:3e:00:00:00`` - - (StrOpt) The base MAC address Neutron will use for VIFs. The first 3 octets will remain unchanged. If the 4th octet is not 00, it will also be used. The others will be randomly generated. + - (String) The base MAC address Neutron will use for VIFs. The first 3 octets will remain unchanged. If the 4th octet is not 00, it will also be used. The others will be randomly generated. * - ``bgp_drscheduler_driver`` = ``neutron.services.bgp.scheduler.bgp_dragent_scheduler.ChanceScheduler`` - - (StrOpt) Driver used for scheduling BGP speakers to BGP DrAgent + - (String) Driver used for scheduling BGP speakers to BGP DrAgent * - ``bind_host`` = ``0.0.0.0`` - - (StrOpt) The host IP to bind to + - (String) The host IP to bind to * - ``bind_port`` = ``9696`` - - (PortOpt) The port to bind to + - (Unknown) The port to bind to * - ``core_plugin`` = ``None`` - - (StrOpt) The core plugin Neutron will use + - (String) The core plugin Neutron will use * - ``default_availability_zones`` = - - (ListOpt) Default value of availability zone hints. The availability zone aware schedulers use this when the resources availability_zone_hints is empty. Multiple availability zones can be specified by a comma separated string. This value can be empty. In this case, even if availability_zone_hints for a resource is empty, availability zone is considered for high availability while scheduling the resource. + - (List) Default value of availability zone hints. The availability zone aware schedulers use this when the resources availability_zone_hints is empty. Multiple availability zones can be specified by a comma separated string. This value can be empty. In this case, even if availability_zone_hints for a resource is empty, availability zone is considered for high availability while scheduling the resource. * - ``default_ipv4_subnet_pool`` = ``None`` - - (StrOpt) Default IPv4 subnet pool to be used for automatic subnet CIDR allocation. Specifies by UUID the pool to be used in case where creation of a subnet is being called without a subnet pool ID. If not set then no pool will be used unless passed explicitly to the subnet create. If no pool is used, then a CIDR must be passed to create a subnet and that subnet will not be allocated from any pool; it will be considered part of the tenant's private address space. This option is deprecated for removal in the N release. + - (String) DEPRECATED: Default IPv4 subnet pool to be used for automatic subnet CIDR allocation. Specifies by UUID the pool to be used in case where creation of a subnet is being called without a subnet pool ID. If not set then no pool will be used unless passed explicitly to the subnet create. If no pool is used, then a CIDR must be passed to create a subnet and that subnet will not be allocated from any pool; it will be considered part of the tenant's private address space. This option is deprecated for removal in the N release. * - ``default_ipv6_subnet_pool`` = ``None`` - - (StrOpt) Default IPv6 subnet pool to be used for automatic subnet CIDR allocation. Specifies by UUID the pool to be used in case where creation of a subnet is being called without a subnet pool ID. See the description for default_ipv4_subnet_pool for more information. This option is deprecated for removal in the N release. + - (String) DEPRECATED: Default IPv6 subnet pool to be used for automatic subnet CIDR allocation. Specifies by UUID the pool to be used in case where creation of a subnet is being called without a subnet pool ID. See the description for default_ipv4_subnet_pool for more information. This option is deprecated for removal in the N release. * - ``dhcp_agent_notification`` = ``True`` - - (BoolOpt) Allow sending resource operation notification to DHCP agent + - (Boolean) Allow sending resource operation notification to DHCP agent * - ``dhcp_agents_per_network`` = ``1`` - - (IntOpt) Number of DHCP agents scheduled to host a tenant network. If this number is greater than 1, the scheduler automatically assigns multiple DHCP agents for a given tenant network, providing high availability for DHCP service. + - (Integer) Number of DHCP agents scheduled to host a tenant network. If this number is greater than 1, the scheduler automatically assigns multiple DHCP agents for a given tenant network, providing high availability for DHCP service. * - ``dhcp_broadcast_reply`` = ``False`` - - (BoolOpt) Use broadcast in DHCP replies. + - (Boolean) Use broadcast in DHCP replies. * - ``dhcp_confs`` = ``$state_path/dhcp`` - - (StrOpt) Location to store DHCP server config files. + - (String) Location to store DHCP server config files. * - ``dhcp_domain`` = ``openstacklocal`` - - (StrOpt) Domain to use for building the hostnames. This option is deprecated. It has been moved to neutron.conf as dns_domain. It will be removed in a future release. + - (String) DEPRECATED: Domain to use for building the hostnames. This option is deprecated. It has been moved to neutron.conf as dns_domain. It will be removed in a future release. * - ``dhcp_lease_duration`` = ``86400`` - - (IntOpt) DHCP lease duration (in seconds). Use -1 to tell dnsmasq to use infinite lease times. + - (Integer) DHCP lease duration (in seconds). Use -1 to tell dnsmasq to use infinite lease times. * - ``dhcp_load_type`` = ``networks`` - - (StrOpt) Representing the resource type whose load is being reported by the agent. This can be "networks", "subnets" or "ports". When specified (Default is networks), the server will extract particular load sent as part of its agent configuration object from the agent report state, which is the number of resources being consumed, at every report_interval.dhcp_load_type can be used in combination with network_scheduler_driver = neutron.scheduler.dhcp_agent_scheduler.WeightScheduler When the network_scheduler_driver is WeightScheduler, dhcp_load_type can be configured to represent the choice for the resource being balanced. Example: dhcp_load_type=networks + - (String) Representing the resource type whose load is being reported by the agent. This can be "networks", "subnets" or "ports". When specified (Default is networks), the server will extract particular load sent as part of its agent configuration object from the agent report state, which is the number of resources being consumed, at every report_interval.dhcp_load_type can be used in combination with network_scheduler_driver = neutron.scheduler.dhcp_agent_scheduler.WeightScheduler When the network_scheduler_driver is WeightScheduler, dhcp_load_type can be configured to represent the choice for the resource being balanced. Example: dhcp_load_type=networks * - ``dns_domain`` = ``openstacklocal`` - - (StrOpt) Domain to use for building the hostnames + - (String) Domain to use for building the hostnames * - ``enable_new_agents`` = ``True`` - - (BoolOpt) Agent starts with admin_state_up=False when enable_new_agents=False. In the case, user's resources will not be scheduled automatically to the agent until admin changes admin_state_up to True. + - (Boolean) Agent starts with admin_state_up=False when enable_new_agents=False. In the case, user's resources will not be scheduled automatically to the agent until admin changes admin_state_up to True. * - ``enable_services_on_agents_with_admin_state_down`` = ``False`` - - (BoolOpt) Enable services on an agent with admin_state_up False. If this option is False, when admin_state_up of an agent is turned False, services on it will be disabled. Agents with admin_state_up False are not selected for automatic scheduling regardless of this option. But manual scheduling to such agents is available if this option is True. + - (Boolean) Enable services on an agent with admin_state_up False. If this option is False, when admin_state_up of an agent is turned False, services on it will be disabled. Agents with admin_state_up False are not selected for automatic scheduling regardless of this option. But manual scheduling to such agents is available if this option is True. * - ``executor_thread_pool_size`` = ``64`` - - (IntOpt) Size of executor thread pool. + - (Integer) Size of executor thread pool. * - ``external_dns_driver`` = ``None`` - - (StrOpt) Driver for external DNS integration. + - (String) Driver for external DNS integration. * - ``force_gateway_on_subnet`` = ``True`` - - (BoolOpt) Ensure that configured gateway is on subnet. For IPv6, validate only if gateway is not a link local address. Deprecated, to be removed during the Newton release, at which point the gateway will not be forced on to subnet. + - (Boolean) DEPRECATED: Ensure that configured gateway is on subnet. For IPv6, validate only if gateway is not a link local address. Deprecated, to be removed during the Newton release, at which point the gateway will not be forced on to subnet. + * - ``global_physnet_mtu`` = ``1500`` + - (Integer) MTU of the underlying physical network. Neutron uses this value to calculate MTU for all virtual network components. For flat and VLAN networks, neutron uses this value without modification. For overlay networks such as VXLAN, neutron automatically subtracts the overlay protocol overhead from this value. Defaults to 1500, the standard value for Ethernet. * - ``ip_lib_force_root`` = ``False`` - - (BoolOpt) Force ip_lib calls to use the root helper + - (Boolean) Force ip_lib calls to use the root helper * - ``ipam_driver`` = ``None`` - - (StrOpt) Neutron IPAM (IP address management) driver to use. If ipam_driver is not set (default behavior), no IPAM driver is used. In order to use the reference implementation of Neutron IPAM driver, use 'internal'. + - (String) Neutron IPAM (IP address management) driver to use. If ipam_driver is not set (default behavior), no IPAM driver is used. In order to use the reference implementation of Neutron IPAM driver, use 'internal'. * - ``mac_generation_retries`` = ``16`` - - (IntOpt) How many times Neutron will retry MAC generation + - (Integer) How many times Neutron will retry MAC generation * - ``max_allowed_address_pair`` = ``10`` - - (IntOpt) Maximum number of allowed address pairs + - (Integer) Maximum number of allowed address pairs * - ``max_dns_nameservers`` = ``5`` - - (IntOpt) Maximum number of DNS nameservers per subnet + - (Integer) Maximum number of DNS nameservers per subnet * - ``max_fixed_ips_per_port`` = ``5`` - - (IntOpt) Maximum number of fixed ips per port. This option is deprecated and will be removed in the N release. + - (Integer) DEPRECATED: Maximum number of fixed ips per port. This option is deprecated and will be removed in the N release. * - ``max_rtr_adv_interval`` = ``100`` - - (IntOpt) MaxRtrAdvInterval setting for radvd.conf + - (Integer) MaxRtrAdvInterval setting for radvd.conf * - ``max_subnet_host_routes`` = ``20`` - - (IntOpt) Maximum number of host routes per subnet + - (Integer) Maximum number of host routes per subnet * - ``memcached_servers`` = ``None`` - - (ListOpt) Memcached servers or None for in process cache. + - (List) Memcached servers or None for in process cache. * - ``min_rtr_adv_interval`` = ``30`` - - (IntOpt) MinRtrAdvInterval setting for radvd.conf + - (Integer) MinRtrAdvInterval setting for radvd.conf * - ``periodic_fuzzy_delay`` = ``5`` - - (IntOpt) Range of seconds to randomly delay when starting the periodic task scheduler to reduce stampeding. (Disable by setting to 0) + - (Integer) Range of seconds to randomly delay when starting the periodic task scheduler to reduce stampeding. (Disable by setting to 0) * - ``periodic_interval`` = ``40`` - - (IntOpt) Seconds between running periodic tasks + - (Integer) Seconds between running periodic tasks * - ``report_interval`` = ``300`` - - (IntOpt) Interval between two metering reports + - (Integer) Interval between two metering reports * - ``state_path`` = ``/var/lib/neutron`` - - (StrOpt) Where to store Neutron state files. This directory must be writable by the agent. + - (String) Where to store Neutron state files. This directory must be writable by the agent. * - ``vlan_transparent`` = ``False`` - - (BoolOpt) If True, then allow plugins that support it to create VLAN transparent networks. + - (Boolean) If True, then allow plugins that support it to create VLAN transparent networks. * - ``web_framework`` = ``legacy`` - - (StrOpt) This will choose the web framework in which to run the Neutron API server. 'pecan' is a new experiemental rewrite of the API server. + - (String) This will choose the web framework in which to run the Neutron API server. 'pecan' is a new experiemental rewrite of the API server. * - **[AGENT]** - * - ``check_child_processes_action`` = ``respawn`` - - (StrOpt) Action to be executed when a child process dies + - (String) Action to be executed when a child process dies * - ``check_child_processes_interval`` = ``60`` - - (IntOpt) Interval between checks of child process liveness (seconds), use 0 to disable + - (Integer) Interval between checks of child process liveness (seconds), use 0 to disable * - ``log_agent_heartbeats`` = ``False`` - - (BoolOpt) Log agent heartbeats + - (Boolean) Log agent heartbeats * - ``root_helper`` = ``sudo`` - - (StrOpt) Root helper application. Use 'sudo neutron-rootwrap /etc/neutron/rootwrap.conf' to use the real root filter facility. Change to 'sudo' to skip the filtering and just run the command directly. + - (String) Root helper application. Use 'sudo neutron-rootwrap /etc/neutron/rootwrap.conf' to use the real root filter facility. Change to 'sudo' to skip the filtering and just run the command directly. * - ``root_helper_daemon`` = ``None`` - - (StrOpt) Root helper daemon application to use when possible. + - (String) Root helper daemon application to use when possible. * - **[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. * - **[qos]** - * - ``notification_drivers`` = ``message_queue`` - - (ListOpt) Drivers list to use to send the update notification + - (List) Drivers list to use to send the update notification * - **[service_providers]** - * - ``service_provider`` = ``[]`` - - (MultiStrOpt) Defines providers for advanced services using the format: ::[:default] + - (Multi-valued) Defines providers for advanced services using the format: ::[:default] diff --git a/doc/config-reference/source/tables/neutron-compute.rst b/doc/config-reference/source/tables/neutron-compute.rst index 4dd0e7c048..d6b2eddc58 100644 --- a/doc/config-reference/source/tables/neutron-compute.rst +++ b/doc/config-reference/source/tables/neutron-compute.rst @@ -19,12 +19,12 @@ * - **[DEFAULT]** - * - ``notify_nova_on_port_data_changes`` = ``True`` - - (BoolOpt) Send notification to nova when port data (fixed_ips/floatingip) changes so nova can update its cache. + - (Boolean) Send notification to nova when port data (fixed_ips/floatingip) changes so nova can update its cache. * - ``notify_nova_on_port_status_changes`` = ``True`` - - (BoolOpt) Send notification to nova when port status changes + - (Boolean) Send notification to nova when port status changes * - ``nova_client_cert`` = - - (StrOpt) Client certificate for nova metadata api server. + - (String) Client certificate for nova metadata api server. * - ``nova_client_priv_key`` = - - (StrOpt) Private key of client certificate. + - (String) Private key of client certificate. * - ``send_events_interval`` = ``2`` - - (IntOpt) Number of seconds between sending events to nova if there are any events to send. + - (Integer) Number of seconds between sending events to nova if there are any events to send. diff --git a/doc/config-reference/source/tables/neutron-cors.rst b/doc/config-reference/source/tables/neutron-cors.rst index 21a4607fe1..8d58a57f36 100644 --- a/doc/config-reference/source/tables/neutron-cors.rst +++ b/doc/config-reference/source/tables/neutron-cors.rst @@ -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. diff --git a/doc/config-reference/source/tables/neutron-database.rst b/doc/config-reference/source/tables/neutron-database.rst index ebf7a0577e..0e141c544e 100644 --- a/doc/config-reference/source/tables/neutron-database.rst +++ b/doc/config-reference/source/tables/neutron-database.rst @@ -19,42 +19,42 @@ * - **[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. + - (Integer) Timeout before idle SQL connections are reaped. * - ``max_overflow`` = ``50`` - - (IntOpt) If set, use this value for max_overflow with SQLAlchemy. + - (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. diff --git a/doc/config-reference/source/tables/neutron-designate.rst b/doc/config-reference/source/tables/neutron-designate.rst index 259ff2b8fa..e2f935275c 100644 --- a/doc/config-reference/source/tables/neutron-designate.rst +++ b/doc/config-reference/source/tables/neutron-designate.rst @@ -19,22 +19,22 @@ * - **[designate]** - * - ``admin_auth_url`` = ``None`` - - (StrOpt) Authorization URL for connecting to designate in admin context + - (String) Authorization URL for connecting to designate in admin context * - ``admin_password`` = ``None`` - - (StrOpt) Password for connecting to designate in admin context + - (String) Password for connecting to designate in admin context * - ``admin_tenant_id`` = ``None`` - - (StrOpt) Tenant id for connecting to designate in admin context + - (String) Tenant id for connecting to designate in admin context * - ``admin_tenant_name`` = ``None`` - - (StrOpt) Tenant name for connecting to designate in admin context + - (String) Tenant name for connecting to designate in admin context * - ``admin_username`` = ``None`` - - (StrOpt) Username for connecting to designate in admin context + - (String) Username for connecting to designate in admin context * - ``allow_reverse_dns_lookup`` = ``True`` - - (BoolOpt) Allow the creation of PTR records + - (Boolean) Allow the creation of PTR records * - ``ipv4_ptr_zone_prefix_size`` = ``24`` - - (IntOpt) Number of bits in an ipv4 PTR zone that will be considered network prefix. It has to align to byte boundary. Minimum value is 8. Maximum value is 24. As a consequence, range of values is 8, 16 and 24 + - (Integer) Number of bits in an ipv4 PTR zone that will be considered network prefix. It has to align to byte boundary. Minimum value is 8. Maximum value is 24. As a consequence, range of values is 8, 16 and 24 * - ``ipv6_ptr_zone_prefix_size`` = ``120`` - - (IntOpt) Number of bits in an ipv6 PTR zone that will be considered network prefix. It has to align to nyble boundary. Minimum value is 4. Maximum value is 124. As a consequence, range of values is 4, 8, 12, 16,..., 124 + - (Integer) Number of bits in an ipv6 PTR zone that will be considered network prefix. It has to align to nyble boundary. Minimum value is 4. Maximum value is 124. As a consequence, range of values is 4, 8, 12, 16,..., 124 * - ``ptr_zone_email`` = - - (StrOpt) The email address to be used when creating PTR zones. If not specified, the email address will be admin@ + - (String) The email address to be used when creating PTR zones. If not specified, the email address will be admin@ * - ``url`` = ``None`` - - (StrOpt) URL for connecting to designate + - (String) URL for connecting to designate diff --git a/doc/config-reference/source/tables/neutron-dhcp_agent.rst b/doc/config-reference/source/tables/neutron-dhcp_agent.rst index 2dd466ab64..3dd0102405 100644 --- a/doc/config-reference/source/tables/neutron-dhcp_agent.rst +++ b/doc/config-reference/source/tables/neutron-dhcp_agent.rst @@ -19,30 +19,30 @@ * - **[DEFAULT]** - * - ``advertise_mtu`` = ``True`` - - (BoolOpt) If True, advertise network MTU values if core plugin calculates them. MTU is advertised to running instances via DHCP and RA MTU options. + - (Boolean) If True, advertise network MTU values if core plugin calculates them. MTU is advertised to running instances via DHCP and RA MTU options. * - ``dhcp_driver`` = ``neutron.agent.linux.dhcp.Dnsmasq`` - - (StrOpt) The driver used to manage the DHCP server. + - (String) The driver used to manage the DHCP server. * - ``dnsmasq_base_log_dir`` = ``None`` - - (StrOpt) Base log dir for dnsmasq logging. The log contains DHCP and DNS log information and is useful for debugging issues with either DHCP or DNS. If this section is null, disable dnsmasq log. + - (String) Base log dir for dnsmasq logging. The log contains DHCP and DNS log information and is useful for debugging issues with either DHCP or DNS. If this section is null, disable dnsmasq log. * - ``dnsmasq_config_file`` = - - (StrOpt) Override the default dnsmasq settings with this file. + - (String) Override the default dnsmasq settings with this file. * - ``dnsmasq_dns_servers`` = ``None`` - - (ListOpt) Comma-separated list of the DNS servers which will be used as forwarders. + - (List) Comma-separated list of the DNS servers which will be used as forwarders. * - ``dnsmasq_lease_max`` = ``16777216`` - - (IntOpt) Limit number of leases to prevent a denial-of-service. + - (Integer) Limit number of leases to prevent a denial-of-service. * - ``dnsmasq_local_resolv`` = ``False`` - - (BoolOpt) Enables the dnsmasq service to provide name resolution for instances via DNS resolvers on the host running the DHCP agent. Effectively removes the '--no-resolv' option from the dnsmasq process arguments. Adding custom DNS resolvers to the 'dnsmasq_dns_servers' option disables this feature. + - (Boolean) Enables the dnsmasq service to provide name resolution for instances via DNS resolvers on the host running the DHCP agent. Effectively removes the '--no-resolv' option from the dnsmasq process arguments. Adding custom DNS resolvers to the 'dnsmasq_dns_servers' option disables this feature. * - ``enable_isolated_metadata`` = ``False`` - - (BoolOpt) The DHCP server can assist with providing metadata support on isolated networks. Setting this value to True will cause the DHCP server to append specific host routes to the DHCP request. The metadata service will only be activated when the subnet does not contain any router port. The guest instance must be configured to request host routes via DHCP (Option 121). This option doesn't have any effect when force_metadata is set to True. + - (Boolean) The DHCP server can assist with providing metadata support on isolated networks. Setting this value to True will cause the DHCP server to append specific host routes to the DHCP request. The metadata service will only be activated when the subnet does not contain any router port. The guest instance must be configured to request host routes via DHCP (Option 121). This option doesn't have any effect when force_metadata is set to True. * - ``enable_metadata_network`` = ``False`` - - (BoolOpt) Allows for serving metadata requests coming from a dedicated metadata access network whose CIDR is 169.254.169.254/16 (or larger prefix), and is connected to a Neutron router from which the VMs send metadata:1 request. In this case DHCP Option 121 will not be injected in VMs, as they will be able to reach 169.254.169.254 through a router. This option requires enable_isolated_metadata = True. + - (Boolean) Allows for serving metadata requests coming from a dedicated metadata access network whose CIDR is 169.254.169.254/16 (or larger prefix), and is connected to a Neutron router from which the VMs send metadata:1 request. In this case DHCP Option 121 will not be injected in VMs, as they will be able to reach 169.254.169.254 through a router. This option requires enable_isolated_metadata = True. * - ``force_metadata`` = ``False`` - - (BoolOpt) In some cases the Neutron router is not present to provide the metadata IP but the DHCP server can be used to provide this info. Setting this value will force the DHCP server to append specific host routes to the DHCP request. If this option is set, then the metadata service will be activated for all the networks. + - (Boolean) In some cases the Neutron router is not present to provide the metadata IP but the DHCP server can be used to provide this info. Setting this value will force the DHCP server to append specific host routes to the DHCP request. If this option is set, then the metadata service will be activated for all the networks. * - ``host`` = ``example.domain`` - - (StrOpt) Hostname to be used by the Neutron server, agents and services running on this machine. All the agents and services running on this machine must use the same host value. + - (String) Hostname to be used by the Neutron server, agents and services running on this machine. All the agents and services running on this machine must use the same host value. * - ``interface_driver`` = ``None`` - - (StrOpt) The driver used to manage the virtual interface. + - (String) The driver used to manage the virtual interface. * - ``num_sync_threads`` = ``4`` - - (IntOpt) Number of threads to use during sync process. Should not exceed connection pool size configured on server. + - (Integer) Number of threads to use during sync process. Should not exceed connection pool size configured on server. * - ``resync_interval`` = ``5`` - - (IntOpt) The DHCP agent will resync its state with Neutron to recover from any transient notification or RPC errors. The interval is number of seconds between attempts. + - (Integer) The DHCP agent will resync its state with Neutron to recover from any transient notification or RPC errors. The interval is number of seconds between attempts. diff --git a/doc/config-reference/source/tables/neutron-dvr.rst b/doc/config-reference/source/tables/neutron-dvr.rst index 86c11ac646..c0bb7ebce8 100644 --- a/doc/config-reference/source/tables/neutron-dvr.rst +++ b/doc/config-reference/source/tables/neutron-dvr.rst @@ -19,6 +19,6 @@ * - **[DEFAULT]** - * - ``dvr_base_mac`` = ``fa:16:3f:00:00:00`` - - (StrOpt) The base mac address used for unique DVR instances by Neutron. The first 3 octets will remain unchanged. If the 4th octet is not 00, it will also be used. The others will be randomly generated. The 'dvr_base_mac' *must* be different from 'base_mac' to avoid mixing them up with MAC's allocated for tenant ports. A 4 octet example would be dvr_base_mac = fa:16:3f:4f:00:00. The default is 3 octet + - (String) The base mac address used for unique DVR instances by Neutron. The first 3 octets will remain unchanged. If the 4th octet is not 00, it will also be used. The others will be randomly generated. The 'dvr_base_mac' *must* be different from 'base_mac' to avoid mixing them up with MAC's allocated for tenant ports. A 4 octet example would be dvr_base_mac = fa:16:3f:4f:00:00. The default is 3 octet * - ``router_distributed`` = ``False`` - - (BoolOpt) System-wide flag to determine the type of router that tenants can create. Only admin can override. + - (Boolean) System-wide flag to determine the type of router that tenants can create. Only admin can override. diff --git a/doc/config-reference/source/tables/neutron-fwaas.rst b/doc/config-reference/source/tables/neutron-fwaas.rst index ae262b971e..1ca6522219 100644 --- a/doc/config-reference/source/tables/neutron-fwaas.rst +++ b/doc/config-reference/source/tables/neutron-fwaas.rst @@ -19,4 +19,4 @@ * - **[fwaas]** - * - ``enabled`` = ``False`` - - (BoolOpt) Enable FWaaS + - (Boolean) Enable FWaaS diff --git a/doc/config-reference/source/tables/neutron-fwaas_ngfw.rst b/doc/config-reference/source/tables/neutron-fwaas_ngfw.rst index 5b9be0fb43..a1d039999b 100644 --- a/doc/config-reference/source/tables/neutron-fwaas_ngfw.rst +++ b/doc/config-reference/source/tables/neutron-fwaas_ngfw.rst @@ -19,8 +19,8 @@ * - **[ngfw]** - * - ``smc_api_auth_key`` = - - (StrOpt) Authentication key to SMC API + - (String) Authentication key to SMC API * - ``smc_api_version`` = - - (StrOpt) verion of SMC API + - (String) verion of SMC API * - ``smc_url`` = - - (StrOpt) URL to contact SMC server + - (String) URL to contact SMC server diff --git a/doc/config-reference/source/tables/neutron-fwaas_varmour.rst b/doc/config-reference/source/tables/neutron-fwaas_varmour.rst index 2305eb8dbf..49a625f7ea 100644 --- a/doc/config-reference/source/tables/neutron-fwaas_varmour.rst +++ b/doc/config-reference/source/tables/neutron-fwaas_varmour.rst @@ -19,10 +19,10 @@ * - **[vArmour]** - * - ``director`` = ``localhost`` - - (StrOpt) vArmour director ip + - (String) vArmour director ip * - ``director_port`` = ``443`` - - (StrOpt) vArmour director port + - (String) vArmour director port * - ``password`` = ``varmour`` - - (StrOpt) vArmour director password + - (String) vArmour director password * - ``username`` = ``varmour`` - - (StrOpt) vArmour director username + - (String) vArmour director username diff --git a/doc/config-reference/source/tables/neutron-hyperv_agent.rst b/doc/config-reference/source/tables/neutron-hyperv_agent.rst index 124e6260f5..f1d73c6387 100644 --- a/doc/config-reference/source/tables/neutron-hyperv_agent.rst +++ b/doc/config-reference/source/tables/neutron-hyperv_agent.rst @@ -19,4 +19,4 @@ * - **[AGENT]** - * - ``polling_interval`` = ``2`` - - (IntOpt) The number of seconds the agent will wait between polling for local device changes. + - (Integer) The number of seconds the agent will wait between polling for local device changes. diff --git a/doc/config-reference/source/tables/neutron-ipv6_ra.rst b/doc/config-reference/source/tables/neutron-ipv6_ra.rst index 8f97ac1a1c..8cb96d22b1 100644 --- a/doc/config-reference/source/tables/neutron-ipv6_ra.rst +++ b/doc/config-reference/source/tables/neutron-ipv6_ra.rst @@ -19,4 +19,4 @@ * - **[DEFAULT]** - * - ``ra_confs`` = ``$state_path/ra`` - - (StrOpt) Location to store IPv6 RA config files + - (String) Location to store IPv6 RA config files diff --git a/doc/config-reference/source/tables/neutron-l2_agent.rst b/doc/config-reference/source/tables/neutron-l2_agent.rst index b5ef42088a..36f1934c4c 100644 --- a/doc/config-reference/source/tables/neutron-l2_agent.rst +++ b/doc/config-reference/source/tables/neutron-l2_agent.rst @@ -19,4 +19,4 @@ * - **[agent]** - * - ``extensions`` = - - (ListOpt) Extensions list to use + - (List) Extensions list to use diff --git a/doc/config-reference/source/tables/neutron-l3_agent.rst b/doc/config-reference/source/tables/neutron-l3_agent.rst index 5030307c2f..38b313f06a 100644 --- a/doc/config-reference/source/tables/neutron-l3_agent.rst +++ b/doc/config-reference/source/tables/neutron-l3_agent.rst @@ -19,58 +19,58 @@ * - **[DEFAULT]** - * - ``agent_mode`` = ``legacy`` - - (StrOpt) The working mode for the agent. Allowed modes are: 'legacy' - this preserves the existing behavior where the L3 agent is deployed on a centralized networking node to provide L3 services like DNAT, and SNAT. Use this mode if you do not want to adopt DVR. 'dvr' - this mode enables DVR functionality and must be used for an L3 agent that runs on a compute host. 'dvr_snat' - this enables centralized SNAT support in conjunction with DVR. This mode must be used for an L3 agent running on a centralized node (or in single-host deployments, e.g. devstack) + - (String) The working mode for the agent. Allowed modes are: 'legacy' - this preserves the existing behavior where the L3 agent is deployed on a centralized networking node to provide L3 services like DNAT, and SNAT. Use this mode if you do not want to adopt DVR. 'dvr' - this mode enables DVR functionality and must be used for an L3 agent that runs on a compute host. 'dvr_snat' - this enables centralized SNAT support in conjunction with DVR. This mode must be used for an L3 agent running on a centralized node (or in single-host deployments, e.g. devstack) * - ``allow_automatic_dhcp_failover`` = ``True`` - - (BoolOpt) Automatically remove networks from offline DHCP agents. + - (Boolean) Automatically remove networks from offline DHCP agents. * - ``allow_automatic_l3agent_failover`` = ``False`` - - (BoolOpt) Automatically reschedule routers from offline L3 agents to online L3 agents. + - (Boolean) Automatically reschedule routers from offline L3 agents to online L3 agents. * - ``enable_metadata_proxy`` = ``True`` - - (BoolOpt) Allow running metadata proxy. + - (Boolean) Allow running metadata proxy. * - ``enable_snat_by_default`` = ``True`` - - (BoolOpt) Define the default value of enable_snat if not provided in external_gateway_info. + - (Boolean) Define the default value of enable_snat if not provided in external_gateway_info. * - ``external_ingress_mark`` = ``0x2`` - - (StrOpt) Iptables mangle mark used to mark ingress from external network. This mark will be masked with 0xffff so that only the lower 16 bits will be used. + - (String) Iptables mangle mark used to mark ingress from external network. This mark will be masked with 0xffff so that only the lower 16 bits will be used. * - ``external_network_bridge`` = ``br-ex`` - - (StrOpt) Name of bridge used for external network traffic. This should be set to an empty value for the Linux Bridge. When this parameter is set, each L3 agent can be associated with no more than one external network. This option is deprecated and will be removed in the M release. + - (String) DEPRECATED: Name of bridge used for external network traffic. This should be set to an empty value for the Linux Bridge. When this parameter is set, each L3 agent can be associated with no more than one external network. This option is deprecated and will be removed in the M release. * - ``gateway_external_network_id`` = - - (StrOpt) When external_network_bridge is set, each L3 agent can be associated with no more than one external network. This value should be set to the UUID of that external network. To allow L3 agent support multiple external networks, both the external_network_bridge and gateway_external_network_id must be left empty. + - (String) When external_network_bridge is set, each L3 agent can be associated with no more than one external network. This value should be set to the UUID of that external network. To allow L3 agent support multiple external networks, both the external_network_bridge and gateway_external_network_id must be left empty. * - ``ha_confs_path`` = ``$state_path/ha_confs`` - - (StrOpt) Location to store keepalived/conntrackd config files + - (String) Location to store keepalived/conntrackd config files * - ``ha_vrrp_advert_int`` = ``2`` - - (IntOpt) The advertisement interval in seconds + - (Integer) The advertisement interval in seconds * - ``ha_vrrp_auth_password`` = ``None`` - - (StrOpt) VRRP authentication password + - (String) VRRP authentication password * - ``ha_vrrp_auth_type`` = ``PASS`` - - (StrOpt) VRRP authentication type + - (String) VRRP authentication type * - ``handle_internal_only_routers`` = ``True`` - - (BoolOpt) Indicates that this L3 agent should also handle routers that do not have an external network gateway configured. This option should be True only for a single agent in a Neutron deployment, and may be False for all agents if all routers must have an external network gateway. + - (Boolean) Indicates that this L3 agent should also handle routers that do not have an external network gateway configured. This option should be True only for a single agent in a Neutron deployment, and may be False for all agents if all routers must have an external network gateway. * - ``host`` = ``example.domain`` - - (StrOpt) Hostname to be used by the Neutron server, agents and services running on this machine. All the agents and services running on this machine must use the same host value. + - (String) Hostname to be used by the Neutron server, agents and services running on this machine. All the agents and services running on this machine must use the same host value. * - ``interface_driver`` = ``None`` - - (StrOpt) The driver used to manage the virtual interface. + - (String) The driver used to manage the virtual interface. * - ``ipv6_gateway`` = - - (StrOpt) With IPv6, the network used for the external gateway does not need to have an associated subnet, since the automatically assigned link-local address (LLA) can be used. However, an IPv6 gateway address is needed for use as the next-hop for the default route. If no IPv6 gateway address is configured here, (and only then) the neutron router will be configured to get its default route from router advertisements (RAs) from the upstream router; in which case the upstream router must also be configured to send these RAs. The ipv6_gateway, when configured, should be the LLA of the interface on the upstream router. If a next-hop using a global unique address (GUA) is desired, it needs to be done via a subnet allocated to the network and not through this parameter. + - (String) With IPv6, the network used for the external gateway does not need to have an associated subnet, since the automatically assigned link-local address (LLA) can be used. However, an IPv6 gateway address is needed for use as the next-hop for the default route. If no IPv6 gateway address is configured here, (and only then) the neutron router will be configured to get its default route from router advertisements (RAs) from the upstream router; in which case the upstream router must also be configured to send these RAs. The ipv6_gateway, when configured, should be the LLA of the interface on the upstream router. If a next-hop using a global unique address (GUA) is desired, it needs to be done via a subnet allocated to the network and not through this parameter. * - ``ipv6_pd_enabled`` = ``False`` - - (BoolOpt) Enables IPv6 Prefix Delegation for automatic subnet CIDR allocation. Set to True to enable IPv6 Prefix Delegation for subnet allocation in a PD-capable environment. Users making subnet creation requests for IPv6 subnets without providing a CIDR or subnetpool ID will be given a CIDR via the Prefix Delegation mechanism. Note that enabling PD will override the behavior of the default IPv6 subnetpool. + - (Boolean) Enables IPv6 Prefix Delegation for automatic subnet CIDR allocation. Set to True to enable IPv6 Prefix Delegation for subnet allocation in a PD-capable environment. Users making subnet creation requests for IPv6 subnets without providing a CIDR or subnetpool ID will be given a CIDR via the Prefix Delegation mechanism. Note that enabling PD will override the behavior of the default IPv6 subnetpool. * - ``l3_ha`` = ``False`` - - (BoolOpt) Enable HA mode for virtual routers. + - (Boolean) Enable HA mode for virtual routers. * - ``l3_ha_net_cidr`` = ``169.254.192.0/18`` - - (StrOpt) Subnet used for the l3 HA admin network. + - (String) Subnet used for the l3 HA admin network. * - ``l3_ha_network_physical_name`` = - - (StrOpt) The physical network name with which the HA network can be created. + - (String) The physical network name with which the HA network can be created. * - ``l3_ha_network_type`` = - - (StrOpt) The network type to use when creating the HA network for an HA router. By default or if empty, the first 'tenant_network_types' is used. This is helpful when the VRRP traffic should use a specific network which is not the default one. + - (String) The network type to use when creating the HA network for an HA router. By default or if empty, the first 'tenant_network_types' is used. This is helpful when the VRRP traffic should use a specific network which is not the default one. * - ``max_l3_agents_per_router`` = ``3`` - - (IntOpt) Maximum number of L3 agents which a HA router will be scheduled on. If it is set to 0 then the router will be scheduled on every agent. + - (Integer) Maximum number of L3 agents which a HA router will be scheduled on. If it is set to 0 then the router will be scheduled on every agent. * - ``min_l3_agents_per_router`` = ``2`` - - (IntOpt) Minimum number of L3 agents which a HA router will be scheduled on. If it is set to 0 then the router will be scheduled on every agent. + - (Integer) Minimum number of L3 agents which a HA router will be scheduled on. If it is set to 0 then the router will be scheduled on every agent. * - ``router_id`` = - - (StrOpt) If non-empty, the l3 agent can only configure a router that has the matching router ID. + - (String) DEPRECATED: If non-empty, the l3 agent can only configure a router that has the matching router ID. * - ``send_arp_for_ha`` = ``3`` - - (IntOpt) Send this many gratuitous ARPs for HA setup, if less than or equal to 0, the feature is disabled + - (Integer) Send this many gratuitous ARPs for HA setup, if less than or equal to 0, the feature is disabled * - **[AGENT]** - * - ``comment_iptables_rules`` = ``True`` - - (BoolOpt) Add comments to iptables rules. Set to false to disallow the addition of comments to generated iptables rules that describe each rule's purpose. System must support the iptables comments module for addition of comments. + - (Boolean) Add comments to iptables rules. Set to false to disallow the addition of comments to generated iptables rules that describe each rule's purpose. System must support the iptables comments module for addition of comments. * - ``use_helper_for_ns_read`` = ``True`` - - (BoolOpt) Use the root helper when listing the namespaces on a system. This may not be required depending on the security configuration. If the root helper is not required, set this to False for a performance improvement. + - (Boolean) Use the root helper when listing the namespaces on a system. This may not be required depending on the security configuration. If the root helper is not required, set this to False for a performance improvement. diff --git a/doc/config-reference/source/tables/neutron-lbaas.rst b/doc/config-reference/source/tables/neutron-lbaas.rst index a283c3fd31..0dd87a225b 100644 --- a/doc/config-reference/source/tables/neutron-lbaas.rst +++ b/doc/config-reference/source/tables/neutron-lbaas.rst @@ -19,8 +19,8 @@ * - **[certificates]** - * - ``barbican_auth`` = ``barbican_acl_auth`` - - (StrOpt) Name of the Barbican authentication method to use + - (String) Name of the Barbican authentication method to use * - ``cert_manager_type`` = ``barbican`` - - (StrOpt) Certificate Manager plugin. Defaults to barbican. + - (String) Certificate Manager plugin. Defaults to barbican. * - ``storage_path`` = ``/var/lib/neutron-lbaas/certificates/`` - - (StrOpt) Absolute path to the certificate storage directory. Defaults to env[OS_LBAAS_TLS_STORAGE]. + - (String) Absolute path to the certificate storage directory. Defaults to env[OS_LBAAS_TLS_STORAGE]. diff --git a/doc/config-reference/source/tables/neutron-lbaas_agent.rst b/doc/config-reference/source/tables/neutron-lbaas_agent.rst index 17fb460c4b..61b83b2b07 100644 --- a/doc/config-reference/source/tables/neutron-lbaas_agent.rst +++ b/doc/config-reference/source/tables/neutron-lbaas_agent.rst @@ -19,18 +19,18 @@ * - **[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. * - ``device_driver`` = ``['neutron_lbaas.drivers.haproxy.namespace_driver.HaproxyNSDriver']`` - - (MultiStrOpt) Drivers used to manage loadbalancing devices + - (Multi-valued) Drivers used to manage loadbalancing devices * - ``interface_driver`` = ``None`` - - (StrOpt) The driver used to manage the virtual interface. + - (String) The driver used to manage the virtual interface. * - ``periodic_interval`` = ``40`` - - (IntOpt) Seconds between running periodic tasks + - (Integer) Seconds between running periodic tasks * - **[haproxy]** - * - ``loadbalancer_state_path`` = ``$state_path/lbaas`` - - (StrOpt) Location to store config and state files + - (String) Location to store config and state files * - ``send_gratuitous_arp`` = ``3`` - - (IntOpt) When delete and re-add the same vip, send this many gratuitous ARPs to flush the ARP cache in the Router. Set it below or equal to 0 to disable this feature. + - (Integer) When delete and re-add the same vip, send this many gratuitous ARPs to flush the ARP cache in the Router. Set it below or equal to 0 to disable this feature. * - ``user_group`` = ``nogroup`` - - (StrOpt) The user group + - (String) The user group diff --git a/doc/config-reference/source/tables/neutron-lbaas_services.rst b/doc/config-reference/source/tables/neutron-lbaas_services.rst index 4a1ac09dd3..eb5d24e8c3 100644 --- a/doc/config-reference/source/tables/neutron-lbaas_services.rst +++ b/doc/config-reference/source/tables/neutron-lbaas_services.rst @@ -19,130 +19,126 @@ * - **[DEFAULT]** - * - ``loadbalancer_pool_scheduler_driver`` = ``neutron_lbaas.services.loadbalancer.agent_scheduler.ChanceScheduler`` - - (StrOpt) Driver to use for scheduling pool to a default loadbalancer agent + - (String) Driver to use for scheduling pool to a default loadbalancer agent * - ``loadbalancer_scheduler_driver`` = ``neutron_lbaas.agent_scheduler.ChanceScheduler`` - - (StrOpt) Driver to use for scheduling to a default loadbalancer agent + - (String) Driver to use for scheduling to a default loadbalancer agent * - **[haproxy]** - - * - ``interface_driver`` = ``None`` - - (StrOpt) The driver used to manage the virtual interface. * - ``jinja_config_template`` = ``/usr/lib/python/site-packages/neutron-lbaas/neutron_lbaas/services/loadbalancer/drivers/haproxy/templates/haproxy.loadbalancer.j2`` - - (StrOpt) Jinja template file for haproxy configuration - * - ``periodic_interval`` = ``10`` - - (IntOpt) Seconds between periodic task runs + - (String) Jinja template file for haproxy configuration * - **[netscaler_driver]** - * - ``is_synchronous`` = ``True`` - - (StrOpt) Setting for option to enable synchronous operationsNetScaler Control Center Server. + - (String) Setting for option to enable synchronous operationsNetScaler Control Center Server. * - ``netscaler_ncc_cleanup_mode`` = ``None`` - - (StrOpt) Setting to enable/disable cleanup mode for NetScaler Control Center Server + - (String) Setting to enable/disable cleanup mode for NetScaler Control Center Server * - ``netscaler_ncc_password`` = ``None`` - - (StrOpt) Password to login to the NetScaler Control Center Server. + - (String) Password to login to the NetScaler Control Center Server. * - ``netscaler_ncc_uri`` = ``None`` - - (StrOpt) The URL to reach the NetScaler Control Center Server. + - (String) The URL to reach the NetScaler Control Center Server. * - ``netscaler_ncc_username`` = ``None`` - - (StrOpt) Username to login to the NetScaler Control Center Server. + - (String) Username to login to the NetScaler Control Center Server. * - ``netscaler_status_collection`` = ``True,300`` - - (StrOpt) Setting for member status collection fromNetScaler Control Center Server. + - (String) Setting for member status collection fromNetScaler Control Center Server. * - ``periodic_task_interval`` = ``2`` - - (StrOpt) Setting for periodic task collection interval fromNetScaler Control Center Server.. + - (String) Setting for periodic task collection interval fromNetScaler Control Center Server.. * - **[octavia]** - * - ``allocates_vip`` = ``False`` - - (BoolOpt) True if Octavia will be responsible for allocating the VIP. False if neutron-lbaas will allocate it and pass to Octavia. + - (Boolean) True if Octavia will be responsible for allocating the VIP. False if neutron-lbaas will allocate it and pass to Octavia. * - ``base_url`` = ``http://127.0.0.1:9876`` - - (StrOpt) URL of Octavia controller root + - (String) URL of Octavia controller root * - ``request_poll_interval`` = ``3`` - - (IntOpt) Interval in seconds to poll octavia when an entity is created, updated, or deleted. + - (Integer) Interval in seconds to poll octavia when an entity is created, updated, or deleted. * - ``request_poll_timeout`` = ``100`` - - (IntOpt) Time to stop polling octavia when a status of an entity does not change. + - (Integer) Time to stop polling octavia when a status of an entity does not change. * - **[radware]** - * - ``actions_to_skip`` = ``setup_l2_l3`` - - (ListOpt) List of actions that are not pushed to the completion queue. + - (List) List of actions that are not pushed to the completion queue. * - ``ha_secondary_address`` = ``None`` - - (StrOpt) IP address of secondary vDirect server. + - (String) IP address of secondary vDirect server. * - ``l2_l3_ctor_params`` = ``{'ha_network_name': 'HA-Network', 'service': '_REPLACE_', 'ha_ip_pool_name': 'default', 'twoleg_enabled': '_REPLACE_', 'allocate_ha_ips': True, 'allocate_ha_vrrp': True}`` - - (DictOpt) Parameter for l2_l3 workflow constructor. + - (Dict) Parameter for l2_l3 workflow constructor. * - ``l2_l3_setup_params`` = ``{'data_ip_address': '192.168.200.99', 'data_port': 1, 'gateway': '192.168.200.1', 'ha_port': 2, 'data_ip_mask': '255.255.255.0'}`` - - (DictOpt) Parameter for l2_l3 workflow setup. + - (Dict) Parameter for l2_l3 workflow setup. * - ``l2_l3_workflow_name`` = ``openstack_l2_l3`` - - (StrOpt) Name of l2_l3 workflow. Default: openstack_l2_l3. + - (String) Name of l2_l3 workflow. Default: openstack_l2_l3. * - ``l4_action_name`` = ``BaseCreate`` - - (StrOpt) Name of the l4 workflow action. Default: BaseCreate. + - (String) Name of the l4 workflow action. Default: BaseCreate. * - ``l4_workflow_name`` = ``openstack_l4`` - - (StrOpt) Name of l4 workflow. Default: openstack_l4. + - (String) Name of l4 workflow. Default: openstack_l4. * - ``service_adc_type`` = ``VA`` - - (StrOpt) Service ADC type. Default: VA. + - (String) Service ADC type. Default: VA. * - ``service_adc_version`` = - - (StrOpt) Service ADC version. + - (String) Service ADC version. * - ``service_cache`` = ``20`` - - (IntOpt) Size of service cache. Default: 20. + - (Integer) Size of service cache. Default: 20. * - ``service_compression_throughput`` = ``100`` - - (IntOpt) Service compression throughput. Default: 100. + - (Integer) Service compression throughput. Default: 100. * - ``service_ha_pair`` = ``False`` - - (BoolOpt) Enables or disables the Service HA pair. Default: False. + - (Boolean) Enables or disables the Service HA pair. Default: False. * - ``service_isl_vlan`` = ``-1`` - - (IntOpt) A required VLAN for the interswitch link to use. + - (Integer) A required VLAN for the interswitch link to use. * - ``service_resource_pool_ids`` = - - (ListOpt) Resource pool IDs. + - (List) Resource pool IDs. * - ``service_session_mirroring_enabled`` = ``False`` - - (BoolOpt) Enable or disable Alteon interswitch link for stateful session failover. Default: False. + - (Boolean) Enable or disable Alteon interswitch link for stateful session failover. Default: False. * - ``service_ssl_throughput`` = ``100`` - - (IntOpt) Service SSL throughput. Default: 100. + - (Integer) Service SSL throughput. Default: 100. * - ``service_throughput`` = ``1000`` - - (IntOpt) Service throughput. Default: 1000. + - (Integer) Service throughput. Default: 1000. * - ``vdirect_address`` = ``None`` - - (StrOpt) IP address of vDirect server. + - (String) IP address of vDirect server. * - ``vdirect_password`` = ``radware`` - - (StrOpt) vDirect user password. + - (String) vDirect user password. * - ``vdirect_user`` = ``vDirect`` - - (StrOpt) vDirect user name. + - (String) vDirect user name. * - **[radwarev2]** - * - ``child_workflow_template_names`` = ``manage_l3`` - - (ListOpt) Name of child workflow templates used.Default: manage_l3 + - (List) Name of child workflow templates used.Default: manage_l3 * - ``ha_secondary_address`` = ``None`` - - (StrOpt) IP address of secondary vDirect server. + - (String) IP address of secondary vDirect server. * - ``service_adc_type`` = ``VA`` - - (StrOpt) Service ADC type. Default: VA. + - (String) Service ADC type. Default: VA. * - ``service_adc_version`` = - - (StrOpt) Service ADC version. + - (String) Service ADC version. * - ``service_cache`` = ``20`` - - (IntOpt) Size of service cache. Default: 20. + - (Integer) Size of service cache. Default: 20. * - ``service_compression_throughput`` = ``100`` - - (IntOpt) Service compression throughput. Default: 100. + - (Integer) Service compression throughput. Default: 100. * - ``service_ha_pair`` = ``False`` - - (BoolOpt) Enables or disables the Service HA pair. Default: False. + - (Boolean) Enables or disables the Service HA pair. Default: False. * - ``service_isl_vlan`` = ``-1`` - - (IntOpt) A required VLAN for the interswitch link to use. + - (Integer) A required VLAN for the interswitch link to use. * - ``service_resource_pool_ids`` = - - (ListOpt) Resource pool IDs. + - (List) Resource pool IDs. * - ``service_session_mirroring_enabled`` = ``False`` - - (BoolOpt) Enable or disable Alteon interswitch link for stateful session failover. Default: False. + - (Boolean) Enable or disable Alteon interswitch link for stateful session failover. Default: False. * - ``service_ssl_throughput`` = ``100`` - - (IntOpt) Service SSL throughput. Default: 100. + - (Integer) Service SSL throughput. Default: 100. * - ``service_throughput`` = ``1000`` - - (IntOpt) Service throughput. Default: 1000. + - (Integer) Service throughput. Default: 1000. * - ``stats_action_name`` = ``stats`` - - (StrOpt) Name of the workflow action for statistics. Default: stats. + - (String) Name of the workflow action for statistics. Default: stats. * - ``vdirect_address`` = ``None`` - - (StrOpt) IP address of vDirect server. + - (String) IP address of vDirect server. * - ``vdirect_password`` = ``radware`` - - (StrOpt) vDirect user password. + - (String) vDirect user password. * - ``vdirect_user`` = ``vDirect`` - - (StrOpt) vDirect user name. + - (String) vDirect user name. * - ``workflow_action_name`` = ``apply`` - - (StrOpt) Name of the workflow action. Default: apply. + - (String) Name of the workflow action. Default: apply. * - ``workflow_params`` = ``{'data_ip_address': '192.168.200.99', 'ha_network_name': 'HA-Network', 'ha_port': 2, 'allocate_ha_ips': True, 'ha_ip_pool_name': 'default', 'allocate_ha_vrrp': True, 'data_port': 1, 'gateway': '192.168.200.1', 'twoleg_enabled': '_REPLACE_', 'data_ip_mask': '255.255.255.0'}`` - - (DictOpt) Parameter for l2_l3 workflow constructor. + - (Dict) Parameter for l2_l3 workflow constructor. * - ``workflow_template_name`` = ``os_lb_v2`` - - (StrOpt) Name of the workflow template. Default: os_lb_v2. + - (String) Name of the workflow template. Default: os_lb_v2. * - **[radwarev2_debug]** - * - ``configure_l3`` = ``True`` - - (BoolOpt) Configule ADC with L3 parameters? + - (Boolean) Configule ADC with L3 parameters? * - ``configure_l4`` = ``True`` - - (BoolOpt) Configule ADC with L4 parameters? + - (Boolean) Configule ADC with L4 parameters? * - ``provision_service`` = ``True`` - - (BoolOpt) Provision ADC service? + - (Boolean) Provision ADC service? diff --git a/doc/config-reference/source/tables/neutron-linuxbridge_agent.rst b/doc/config-reference/source/tables/neutron-linuxbridge_agent.rst index 6b51ee6aab..02b770bc20 100644 --- a/doc/config-reference/source/tables/neutron-linuxbridge_agent.rst +++ b/doc/config-reference/source/tables/neutron-linuxbridge_agent.rst @@ -19,24 +19,30 @@ * - **[AGENT]** - * - ``quitting_rpc_timeout`` = ``10`` - - (IntOpt) Set new timeout in seconds for new rpc calls after agent receives SIGTERM. If value is set to 0, rpc timeout won't be changed + - (Integer) Set new timeout in seconds for new rpc calls after agent receives SIGTERM. If value is set to 0, rpc timeout won't be changed * - **[LINUX_BRIDGE]** - * - ``bridge_mappings`` = - - (ListOpt) List of : + - (List) List of : * - ``physical_interface_mappings`` = - - (ListOpt) Comma-separated list of : tuples mapping physical network names to the agent's node-specific physical network interfaces to be used for flat and VLAN networks. All physical networks listed in network_vlan_ranges on the server should have mappings to appropriate interfaces on each agent. + - (List) Comma-separated list of : tuples mapping physical network names to the agent's node-specific physical network interfaces to be used for flat and VLAN networks. All physical networks listed in network_vlan_ranges on the server should have mappings to appropriate interfaces on each agent. * - **[VXLAN]** - + * - ``arp_responder`` = ``False`` + - (Boolean) Enable local ARP responder which provides local responses instead of performing ARP broadcast into the overlay. Enabling local ARP responder is not fullycompatible with the allowed-address-pairs extension. * - ``enable_vxlan`` = ``True`` - - (BoolOpt) Enable VXLAN on the agent. Can be enabled when agent is managed by ml2 plugin using linuxbridge mechanism driver + - (Boolean) Enable VXLAN on the agent. Can be enabled when agent is managed by ml2 plugin using linuxbridge mechanism driver * - ``l2_population`` = ``False`` - - (BoolOpt) Extension to use alongside ml2 plugin's l2population mechanism driver. It enables the plugin to populate VXLAN forwarding table. + - (Boolean) Extension to use alongside ml2 plugin's l2population mechanism driver. It enables the plugin to populate VXLAN forwarding table. * - ``local_ip`` = ``None`` - - (IPOpt) Local IP address of the VXLAN endpoints. + - (Unknown) Local IP address of the VXLAN endpoints. * - ``tos`` = ``None`` - - (IntOpt) TOS for vxlan interface protocol packets. + - (Integer) TOS for vxlan interface protocol packets. * - ``ttl`` = ``None`` - - (IntOpt) TTL for vxlan interface protocol packets. + - (Integer) TTL for vxlan interface protocol packets. * - ``vxlan_group`` = ``224.0.0.1`` - - (StrOpt) Multicast group(s) for vxlan interface. A range of group addresses may be specified by using CIDR notation. Specifying a range allows different VNIs to use different group addresses, reducing or eliminating spurious broadcast traffic to the tunnel endpoints. To reserve a unique group for each possible (24-bit) VNI, use a /8 such as 239.0.0.0/8. This setting must be the same on all the agents. + - (String) Multicast group(s) for vxlan interface. A range of group addresses may be specified by using CIDR notation. Specifying a range allows different VNIs to use different group addresses, reducing or eliminating spurious broadcast traffic to the tunnel endpoints. To reserve a unique group for each possible (24-bit) VNI, use a /8 such as 239.0.0.0/8. This setting must be the same on all the agents. + * - **[macvtap]** + - + * - ``physical_interface_mappings`` = + - (List) Comma-separated list of : tuples mapping physical network names to the agent's node-specific physical network interfaces to be used for flat and VLAN networks. All physical networks listed in network_vlan_ranges on the server should have mappings to appropriate interfaces on each agent. diff --git a/doc/config-reference/source/tables/neutron-logging.rst b/doc/config-reference/source/tables/neutron-logging.rst index bde5148e7a..448f788560 100644 --- a/doc/config-reference/source/tables/neutron-logging.rst +++ b/doc/config-reference/source/tables/neutron-logging.rst @@ -19,50 +19,50 @@ * - **[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_ssl`` = ``False`` - - (BoolOpt) Enable SSL on the API server + - (Boolean) Enable SSL on the API server * - ``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. + - (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. * - ``wsgi_log_format`` = ``%(client_ip)s "%(request_line)s" status: %(status_code)s len: %(body_length)s time: %(wall_seconds).7f`` - - (StrOpt) A python format string that is used as the template to generate log lines. The following values can beformatted into it: client_ip, date_time, request_line, status_code, body_length, wall_seconds. + - (String) A python format string that is used as the template to generate log lines. The following values can beformatted into it: client_ip, date_time, request_line, status_code, body_length, wall_seconds. * - **[oslo_versionedobjects]** - * - ``fatal_exception_format_errors`` = ``False`` - - (BoolOpt) Make exception message format errors fatal + - (Boolean) Make exception message format errors fatal diff --git a/doc/config-reference/source/tables/neutron-metadata.rst b/doc/config-reference/source/tables/neutron-metadata.rst index 1f448e8676..161cc2f386 100644 --- a/doc/config-reference/source/tables/neutron-metadata.rst +++ b/doc/config-reference/source/tables/neutron-metadata.rst @@ -19,30 +19,30 @@ * - **[DEFAULT]** - * - ``metadata_access_mark`` = ``0x1`` - - (StrOpt) Iptables mangle mark used to mark metadata valid requests. This mark will be masked with 0xffff so that only the lower 16 bits will be used. + - (String) Iptables mangle mark used to mark metadata valid requests. This mark will be masked with 0xffff so that only the lower 16 bits will be used. * - ``metadata_backlog`` = ``4096`` - - (IntOpt) Number of backlog requests to configure the metadata server socket with + - (Integer) Number of backlog requests to configure the metadata server socket with * - ``metadata_port`` = ``9697`` - - (PortOpt) TCP Port used by Neutron metadata namespace proxy. + - (Unknown) TCP Port used by Neutron metadata namespace proxy. * - ``metadata_proxy_group`` = - - (StrOpt) Group (gid or name) running metadata proxy after its initialization (if empty: agent effective group). + - (String) Group (gid or name) running metadata proxy after its initialization (if empty: agent effective group). * - ``metadata_proxy_shared_secret`` = - - (StrOpt) When proxying metadata requests, Neutron signs the Instance-ID header with a shared secret to prevent spoofing. You may select any string for a secret, but it must match here and in the configuration used by the Nova Metadata Server. NOTE: Nova uses the same config key, but in [neutron] section. + - (String) When proxying metadata requests, Neutron signs the Instance-ID header with a shared secret to prevent spoofing. You may select any string for a secret, but it must match here and in the configuration used by the Nova Metadata Server. NOTE: Nova uses the same config key, but in [neutron] section. * - ``metadata_proxy_socket`` = ``$state_path/metadata_proxy`` - - (StrOpt) Location for Metadata Proxy UNIX domain socket. + - (String) Location for Metadata Proxy UNIX domain socket. * - ``metadata_proxy_socket_mode`` = ``deduce`` - - (StrOpt) Metadata Proxy UNIX domain socket mode, 4 values allowed: 'deduce': deduce mode from metadata_proxy_user/group values, 'user': set metadata proxy socket mode to 0o644, to use when metadata_proxy_user is agent effective user or root, 'group': set metadata proxy socket mode to 0o664, to use when metadata_proxy_group is agent effective group or root, 'all': set metadata proxy socket mode to 0o666, to use otherwise. + - (String) Metadata Proxy UNIX domain socket mode, 4 values allowed: 'deduce': deduce mode from metadata_proxy_user/group values, 'user': set metadata proxy socket mode to 0o644, to use when metadata_proxy_user is agent effective user or root, 'group': set metadata proxy socket mode to 0o664, to use when metadata_proxy_group is agent effective group or root, 'all': set metadata proxy socket mode to 0o666, to use otherwise. * - ``metadata_proxy_user`` = - - (StrOpt) User (uid or name) running metadata proxy after its initialization (if empty: agent effective user). + - (String) User (uid or name) running metadata proxy after its initialization (if empty: agent effective user). * - ``metadata_proxy_watch_log`` = ``None`` - - (BoolOpt) Enable/Disable log watch by metadata proxy. It should be disabled when metadata_proxy_user/group is not allowed to read/write its log file and copytruncate logrotate option must be used if logrotate is enabled on metadata proxy log files. Option default value is deduced from metadata_proxy_user: watch log is enabled if metadata_proxy_user is agent effective user id/name. - * - ``metadata_workers`` = ``1`` - - (IntOpt) Number of separate worker processes for metadata server (defaults to half of the number of CPUs) + - (Boolean) Enable/Disable log watch by metadata proxy. It should be disabled when metadata_proxy_user/group is not allowed to read/write its log file and copytruncate logrotate option must be used if logrotate is enabled on metadata proxy log files. Option default value is deduced from metadata_proxy_user: watch log is enabled if metadata_proxy_user is agent effective user id/name. + * - ``metadata_workers`` = ``2`` + - (Integer) Number of separate worker processes for metadata server (defaults to half of the number of CPUs) * - ``nova_metadata_insecure`` = ``False`` - - (BoolOpt) Allow to perform insecure SSL (https) requests to nova metadata + - (Boolean) Allow to perform insecure SSL (https) requests to nova metadata * - ``nova_metadata_ip`` = ``127.0.0.1`` - - (StrOpt) IP address used by Nova metadata server. + - (String) IP address used by Nova metadata server. * - ``nova_metadata_port`` = ``8775`` - - (PortOpt) TCP Port used by Nova metadata server. + - (Unknown) TCP Port used by Nova metadata server. * - ``nova_metadata_protocol`` = ``http`` - - (StrOpt) Protocol to access nova metadata, http or https + - (String) Protocol to access nova metadata, http or https diff --git a/doc/config-reference/source/tables/neutron-metering_agent.rst b/doc/config-reference/source/tables/neutron-metering_agent.rst index 2166abd021..62d194f14c 100644 --- a/doc/config-reference/source/tables/neutron-metering_agent.rst +++ b/doc/config-reference/source/tables/neutron-metering_agent.rst @@ -19,10 +19,10 @@ * - **[DEFAULT]** - * - ``driver`` = ``neutron.services.metering.drivers.noop.noop_driver.NoopMeteringDriver`` - - (StrOpt) Metering driver + - (String) Metering driver * - ``measure_interval`` = ``30`` - - (IntOpt) Interval between two metering measures + - (Integer) Interval between two metering measures * - **[AGENT]** - * - ``report_interval`` = ``30`` - - (FloatOpt) Seconds between nodes reporting state to server; should be less than agent_down_time, best if it is half or less than agent_down_time. + - (Floating point) Seconds between nodes reporting state to server; should be less than agent_down_time, best if it is half or less than agent_down_time. diff --git a/doc/config-reference/source/tables/neutron-ml2.rst b/doc/config-reference/source/tables/neutron-ml2.rst index 1e27be0359..cc724d8dc5 100644 --- a/doc/config-reference/source/tables/neutron-ml2.rst +++ b/doc/config-reference/source/tables/neutron-ml2.rst @@ -19,18 +19,16 @@ * - **[ml2]** - * - ``extension_drivers`` = - - (ListOpt) An ordered list of extension driver entrypoints to be loaded from the neutron.ml2.extension_drivers namespace. For example: extension_drivers = port_security,qos + - (List) An ordered list of extension driver entrypoints to be loaded from the neutron.ml2.extension_drivers namespace. For example: extension_drivers = port_security,qos * - ``external_network_type`` = ``None`` - - (StrOpt) Default network type for external networks when no provider attributes are specified. By default it is None, which means that if provider attributes are not specified while creating external networks then they will have the same type as tenant networks. Allowed values for external_network_type config option depend on the network type values configured in type_drivers config option. + - (String) Default network type for external networks when no provider attributes are specified. By default it is None, which means that if provider attributes are not specified while creating external networks then they will have the same type as tenant networks. Allowed values for external_network_type config option depend on the network type values configured in type_drivers config option. * - ``mechanism_drivers`` = - - (ListOpt) An ordered list of networking mechanism driver entrypoints to be loaded from the neutron.ml2.mechanism_drivers namespace. + - (List) An ordered list of networking mechanism driver entrypoints to be loaded from the neutron.ml2.mechanism_drivers namespace. * - ``path_mtu`` = ``1500`` - - (IntOpt) Maximum size of an IP packet (MTU) that can traverse the underlying physical network infrastructure without fragmentation. For instances using a self-service/private network, neutron subtracts the overlay protocol overhead from this value and provides it to instances via DHCP option 26. For example, using a value of 9000, DHCP provides 8950 to instances using a VXLAN network that contains 50 bytes of overhead. Using a value of 0 disables this feature and instances typically default to a 1500 MTU. Only impacts instances, not neutron network components such as bridges and routers. + - (Integer) Maximum size of an IP packet (MTU) that can traverse the underlying physical network infrastructure without fragmentation. For instances using a self-service/private network, neutron subtracts the overlay protocol overhead from this value and provides it to instances via DHCP option 26. For example, using a value of 9000, DHCP provides 8950 to instances using a VXLAN network that contains 50 bytes of overhead. Using a value of 0 disables this feature and instances typically default to a 1500 MTU. Only impacts instances, not neutron network components such as bridges and routers. * - ``physical_network_mtus`` = - - (ListOpt) A list of mappings of physical networks to MTU values. The format of the mapping is :. This mapping allows specifying a physical network MTU value that differs from the default segment_mtu value. - * - ``segment_mtu`` = ``0`` - - (IntOpt) The maximum permissible size of an unfragmented packet travelling a L2 network segment. If <= 0, the segment MTU is indeterminate and no calculation takes place. + - (List) A list of mappings of physical networks to MTU values. The format of the mapping is :. This mapping allows specifying a physical network MTU value that differs from the default segment_mtu value. * - ``tenant_network_types`` = ``local`` - - (ListOpt) Ordered list of network_types to allocate as tenant networks. The default value 'local' is useful for single-box testing but provides no connectivity between hosts. + - (List) Ordered list of network_types to allocate as tenant networks. The default value 'local' is useful for single-box testing but provides no connectivity between hosts. * - ``type_drivers`` = ``local, flat, vlan, gre, vxlan, geneve`` - - (ListOpt) List of network type driver entrypoints to be loaded from the neutron.ml2.type_drivers namespace. + - (List) List of network type driver entrypoints to be loaded from the neutron.ml2.type_drivers namespace. diff --git a/doc/config-reference/source/tables/neutron-ml2_brocade.rst b/doc/config-reference/source/tables/neutron-ml2_brocade.rst deleted file mode 100644 index 5b7c0ad525..0000000000 --- a/doc/config-reference/source/tables/neutron-ml2_brocade.rst +++ /dev/null @@ -1,34 +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. - -.. _neutron-ml2_brocade: - -.. list-table:: Description of ML2 Brocade mechanism driver configuration options - :header-rows: 1 - :class: config-ref-table - - * - Configuration option = Default value - - Description - * - **[ml2_brocade]** - - - * - ``address`` = - - (StrOpt) The address of the host to SSH to - * - ``ostype`` = ``NOS`` - - (StrOpt) OS Type of the switch - * - ``osversion`` = ``4.0.0`` - - (StrOpt) OS Version number - * - ``password`` = ``password`` - - (StrOpt) The SSH password to use - * - ``physical_networks`` = - - (StrOpt) Allowed physical networks - * - ``rbridge_id`` = ``1`` - - (StrOpt) Rbridge id of provider edge router(s) - * - ``username`` = ``admin`` - - (StrOpt) The SSH username to use diff --git a/doc/config-reference/source/tables/neutron-ml2_flat.rst b/doc/config-reference/source/tables/neutron-ml2_flat.rst index 2be3630f47..7e5a9fa134 100644 --- a/doc/config-reference/source/tables/neutron-ml2_flat.rst +++ b/doc/config-reference/source/tables/neutron-ml2_flat.rst @@ -19,4 +19,4 @@ * - **[ml2_type_flat]** - * - ``flat_networks`` = ``*`` - - (ListOpt) List of physical_network names with which flat networks can be created. Use default '*' to allow flat networks with arbitrary physical_network names. Use an empty list to disable flat networks. + - (List) List of physical_network names with which flat networks can be created. Use default '*' to allow flat networks with arbitrary physical_network names. Use an empty list to disable flat networks. diff --git a/doc/config-reference/source/tables/neutron-ml2_geneve.rst b/doc/config-reference/source/tables/neutron-ml2_geneve.rst index 9fd0cfdafb..f198fc1bea 100644 --- a/doc/config-reference/source/tables/neutron-ml2_geneve.rst +++ b/doc/config-reference/source/tables/neutron-ml2_geneve.rst @@ -19,6 +19,6 @@ * - **[ml2_type_geneve]** - * - ``max_header_size`` = ``50`` - - (IntOpt) Geneve encapsulation header size is dynamic, this value is used to calculate the maximum MTU for the driver. This is the sum of the sizes of the outer ETH + IP + UDP + GENEVE header sizes. The default size for this field is 50, which is the size of the Geneve header without any additional option headers. + - (Integer) Geneve encapsulation header size is dynamic, this value is used to calculate the maximum MTU for the driver. This is the sum of the sizes of the outer ETH + IP + UDP + GENEVE header sizes. The default size for this field is 50, which is the size of the Geneve header without any additional option headers. * - ``vni_ranges`` = - - (ListOpt) Comma-separated list of : tuples enumerating ranges of Geneve VNI IDs that are available for tenant network allocation + - (List) Comma-separated list of : tuples enumerating ranges of Geneve VNI IDs that are available for tenant network allocation diff --git a/doc/config-reference/source/tables/neutron-ml2_gre.rst b/doc/config-reference/source/tables/neutron-ml2_gre.rst index 78544c645d..6002847763 100644 --- a/doc/config-reference/source/tables/neutron-ml2_gre.rst +++ b/doc/config-reference/source/tables/neutron-ml2_gre.rst @@ -19,4 +19,4 @@ * - **[ml2_type_gre]** - * - ``tunnel_id_ranges`` = - - (ListOpt) Comma-separated list of : tuples enumerating ranges of GRE tunnel IDs that are available for tenant network allocation + - (List) Comma-separated list of : tuples enumerating ranges of GRE tunnel IDs that are available for tenant network allocation diff --git a/doc/config-reference/source/tables/neutron-ml2_l2pop.rst b/doc/config-reference/source/tables/neutron-ml2_l2pop.rst index 22a96d5384..5525ec1be2 100644 --- a/doc/config-reference/source/tables/neutron-ml2_l2pop.rst +++ b/doc/config-reference/source/tables/neutron-ml2_l2pop.rst @@ -19,4 +19,4 @@ * - **[l2pop]** - * - ``agent_boot_time`` = ``180`` - - (IntOpt) Delay within which agent is expected to update existing ports whent it restarts + - (Integer) Delay within which agent is expected to update existing ports whent it restarts diff --git a/doc/config-reference/source/tables/neutron-ml2_ofa.rst b/doc/config-reference/source/tables/neutron-ml2_ofa.rst index 2b88c71a34..7b5dca28c0 100644 --- a/doc/config-reference/source/tables/neutron-ml2_ofa.rst +++ b/doc/config-reference/source/tables/neutron-ml2_ofa.rst @@ -19,4 +19,4 @@ * - **[AGENT]** - * - ``dont_fragment`` = ``True`` - - (BoolOpt) Set or un-set the don't fragment (DF) bit on outgoing IP packet carrying GRE/VXLAN tunnel. + - (Boolean) Set or un-set the don't fragment (DF) bit on outgoing IP packet carrying GRE/VXLAN tunnel. diff --git a/doc/config-reference/source/tables/neutron-ml2_sriov.rst b/doc/config-reference/source/tables/neutron-ml2_sriov.rst index b338cc5ce1..fecb53f891 100644 --- a/doc/config-reference/source/tables/neutron-ml2_sriov.rst +++ b/doc/config-reference/source/tables/neutron-ml2_sriov.rst @@ -19,4 +19,4 @@ * - **[ml2_sriov]** - * - ``supported_pci_vendor_devs`` = ``15b3:1004, 8086:10ca`` - - (ListOpt) Comma-separated list of supported PCI vendor devices, as defined by vendor_id:product_id according to the PCI ID Repository. Default enables support for Intel and Mellanox SR-IOV capable NICs. + - (List) Comma-separated list of supported PCI vendor devices, as defined by vendor_id:product_id according to the PCI ID Repository. Default enables support for Intel and Mellanox SR-IOV capable NICs. diff --git a/doc/config-reference/source/tables/neutron-ml2_vlan.rst b/doc/config-reference/source/tables/neutron-ml2_vlan.rst index ccdb0707d0..bed1c2c9b5 100644 --- a/doc/config-reference/source/tables/neutron-ml2_vlan.rst +++ b/doc/config-reference/source/tables/neutron-ml2_vlan.rst @@ -19,4 +19,4 @@ * - **[ml2_type_vlan]** - * - ``network_vlan_ranges`` = - - (ListOpt) List of :: or specifying physical_network names usable for VLAN provider and tenant networks, as well as ranges of VLAN tags on each available for allocation to tenant networks. + - (List) List of :: or specifying physical_network names usable for VLAN provider and tenant networks, as well as ranges of VLAN tags on each available for allocation to tenant networks. diff --git a/doc/config-reference/source/tables/neutron-ml2_vxlan.rst b/doc/config-reference/source/tables/neutron-ml2_vxlan.rst index ca20b8a7e6..e946948eb2 100644 --- a/doc/config-reference/source/tables/neutron-ml2_vxlan.rst +++ b/doc/config-reference/source/tables/neutron-ml2_vxlan.rst @@ -19,6 +19,6 @@ * - **[ml2_type_vxlan]** - * - ``vni_ranges`` = - - (ListOpt) Comma-separated list of : tuples enumerating ranges of VXLAN VNI IDs that are available for tenant network allocation + - (List) Comma-separated list of : tuples enumerating ranges of VXLAN VNI IDs that are available for tenant network allocation * - ``vxlan_group`` = ``None`` - - (StrOpt) Multicast group for VXLAN. When configured, will enable sending all broadcast traffic to this multicast group. When left unconfigured, will disable multicast VXLAN mode. + - (String) Multicast group for VXLAN. When configured, will enable sending all broadcast traffic to this multicast group. When left unconfigured, will disable multicast VXLAN mode. diff --git a/doc/config-reference/source/tables/neutron-nec.rst b/doc/config-reference/source/tables/neutron-nec.rst index 128eb6f46a..d98522ddf3 100644 --- a/doc/config-reference/source/tables/neutron-nec.rst +++ b/doc/config-reference/source/tables/neutron-nec.rst @@ -19,4 +19,4 @@ * - **[fwaas]** - * - ``driver`` = - - (StrOpt) Name of the FWaaS Driver + - (String) Name of the FWaaS Driver diff --git a/doc/config-reference/source/tables/neutron-nova.rst b/doc/config-reference/source/tables/neutron-nova.rst index 8ef131e035..c42485d000 100644 --- a/doc/config-reference/source/tables/neutron-nova.rst +++ b/doc/config-reference/source/tables/neutron-nova.rst @@ -19,20 +19,20 @@ * - **[nova]** - * - ``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 * - ``endpoint_type`` = ``public`` - - (StrOpt) Type of the nova endpoint to use. This endpoint will be looked up in the keystone catalog and should be one of public, internal or admin. + - (String) Type of the nova endpoint to use. This endpoint will be looked up in the keystone catalog and should be one of public, internal or admin. * - ``insecure`` = ``False`` - - (BoolOpt) Verify HTTPS connections. + - (Boolean) Verify HTTPS connections. * - ``keyfile`` = ``None`` - - (StrOpt) PEM encoded client certificate key file + - (String) PEM encoded client certificate key file * - ``region_name`` = ``None`` - - (StrOpt) Name of nova region to use. Useful if keystone manages more than one region. + - (String) Name of nova region to use. Useful if keystone manages more than one region. * - ``timeout`` = ``None`` - - (IntOpt) Timeout value for http requests + - (Integer) Timeout value for http requests diff --git a/doc/config-reference/source/tables/neutron-openvswitch_agent.rst b/doc/config-reference/source/tables/neutron-openvswitch_agent.rst index 94c2eaa3cd..a5fd7d2a5b 100644 --- a/doc/config-reference/source/tables/neutron-openvswitch_agent.rst +++ b/doc/config-reference/source/tables/neutron-openvswitch_agent.rst @@ -19,70 +19,70 @@ * - **[DEFAULT]** - * - ``ovs_integration_bridge`` = ``br-int`` - - (StrOpt) Name of Open vSwitch bridge to use + - (String) Name of Open vSwitch bridge to use * - ``ovs_use_veth`` = ``False`` - - (BoolOpt) Uses veth for an OVS interface or not. Support kernels with limited namespace support (e.g. RHEL 6.5) so long as ovs_use_veth is set to True. + - (Boolean) Uses veth for an OVS interface or not. Support kernels with limited namespace support (e.g. RHEL 6.5) so long as ovs_use_veth is set to True. * - ``ovs_vsctl_timeout`` = ``10`` - - (IntOpt) Timeout in seconds for ovs-vsctl commands. If the timeout expires, ovs commands will fail with ALARMCLOCK error. + - (Integer) Timeout in seconds for ovs-vsctl commands. If the timeout expires, ovs commands will fail with ALARMCLOCK error. * - **[AGENT]** - * - ``arp_responder`` = ``False`` - - (BoolOpt) Enable local ARP responder if it is supported. Requires OVS 2.1 and ML2 l2population driver. Allows the switch (when supporting an overlay) to respond to an ARP request locally without performing a costly ARP broadcast into the overlay. + - (Boolean) Enable local ARP responder if it is supported. Requires OVS 2.1 and ML2 l2population driver. Allows the switch (when supporting an overlay) to respond to an ARP request locally without performing a costly ARP broadcast into the overlay. * - ``dont_fragment`` = ``True`` - - (BoolOpt) Set or un-set the don't fragment (DF) bit on outgoing IP packet carrying GRE/VXLAN tunnel. + - (Boolean) Set or un-set the don't fragment (DF) bit on outgoing IP packet carrying GRE/VXLAN tunnel. * - ``drop_flows_on_start`` = ``False`` - - (BoolOpt) Reset flow table on start. Setting this to True will cause brief traffic interruption. + - (Boolean) Reset flow table on start. Setting this to True will cause brief traffic interruption. * - ``enable_distributed_routing`` = ``False`` - - (BoolOpt) Make the l2 agent run in DVR mode. + - (Boolean) Make the l2 agent run in DVR mode. * - ``l2_population`` = ``False`` - - (BoolOpt) Use ML2 l2population mechanism driver to learn remote MAC and IPs and improve tunnel scalability. + - (Boolean) Use ML2 l2population mechanism driver to learn remote MAC and IPs and improve tunnel scalability. * - ``minimize_polling`` = ``True`` - - (BoolOpt) Minimize polling by monitoring ovsdb for interface changes. + - (Boolean) Minimize polling by monitoring ovsdb for interface changes. * - ``ovsdb_monitor_respawn_interval`` = ``30`` - - (IntOpt) The number of seconds to wait before respawning the ovsdb monitor after losing communication with it. + - (Integer) The number of seconds to wait before respawning the ovsdb monitor after losing communication with it. * - ``prevent_arp_spoofing`` = ``True`` - - (BoolOpt) Enable suppression of ARP responses that don't match an IP address that belongs to the port from which they originate. Note: This prevents the VMs attached to this agent from spoofing, it doesn't protect them from other devices which have the capability to spoof (e.g. bare metal or VMs attached to agents without this flag set to True). Spoofing rules will not be added to any ports that have port security disabled. For LinuxBridge, this requires ebtables. For OVS, it requires a version that supports matching ARP headers. This option will be removed in Newton so the only way to disable protection will be via the port security extension. + - (Boolean) DEPRECATED: Enable suppression of ARP responses that don't match an IP address that belongs to the port from which they originate. Note: This prevents the VMs attached to this agent from spoofing, it doesn't protect them from other devices which have the capability to spoof (e.g. bare metal or VMs attached to agents without this flag set to True). Spoofing rules will not be added to any ports that have port security disabled. For LinuxBridge, this requires ebtables. For OVS, it requires a version that supports matching ARP headers. This option will be removed in Newton so the only way to disable protection will be via the port security extension. * - ``quitting_rpc_timeout`` = ``10`` - - (IntOpt) Set new timeout in seconds for new rpc calls after agent receives SIGTERM. If value is set to 0, rpc timeout won't be changed + - (Integer) Set new timeout in seconds for new rpc calls after agent receives SIGTERM. If value is set to 0, rpc timeout won't be changed * - ``tunnel_csum`` = ``False`` - - (BoolOpt) Set or un-set the tunnel header checksum on outgoing IP packet carrying GRE/VXLAN tunnel. + - (Boolean) Set or un-set the tunnel header checksum on outgoing IP packet carrying GRE/VXLAN tunnel. * - ``tunnel_types`` = - - (ListOpt) Network types supported by the agent (gre and/or vxlan). - * - ``veth_mtu`` = ``None`` - - (IntOpt) MTU size of veth interfaces + - (List) Network types supported by the agent (gre and/or vxlan). + * - ``veth_mtu`` = ``9000`` + - (Integer) MTU size of veth interfaces * - ``vxlan_udp_port`` = ``4789`` - - (PortOpt) The UDP port to use for VXLAN tunnels. + - (Unknown) The UDP port to use for VXLAN tunnels. * - **[OVS]** - * - ``bridge_mappings`` = - - (ListOpt) Comma-separated list of : tuples mapping physical network names to the agent's node-specific Open vSwitch bridge names to be used for flat and VLAN networks. The length of bridge names should be no more than 11. Each bridge must exist, and should have a physical network interface configured as a port. All physical networks configured on the server should have mappings to appropriate bridges on each agent. Note: If you remove a bridge from this mapping, make sure to disconnect it from the integration bridge as it won't be managed by the agent anymore. Deprecated for ofagent. + - (List) Comma-separated list of : tuples mapping physical network names to the agent's node-specific Open vSwitch bridge names to be used for flat and VLAN networks. The length of bridge names should be no more than 11. Each bridge must exist, and should have a physical network interface configured as a port. All physical networks configured on the server should have mappings to appropriate bridges on each agent. Note: If you remove a bridge from this mapping, make sure to disconnect it from the integration bridge as it won't be managed by the agent anymore. Deprecated for ofagent. * - ``datapath_type`` = ``system`` - - (StrOpt) OVS datapath to use. 'system' is the default value and corresponds to the kernel datapath. To enable the userspace datapath set this value to 'netdev'. + - (String) OVS datapath to use. 'system' is the default value and corresponds to the kernel datapath. To enable the userspace datapath set this value to 'netdev'. * - ``int_peer_patch_port`` = ``patch-tun`` - - (StrOpt) Peer patch port in integration bridge for tunnel bridge. + - (String) Peer patch port in integration bridge for tunnel bridge. * - ``integration_bridge`` = ``br-int`` - - (StrOpt) Integration bridge to use. Do not change this parameter unless you have a good reason to. This is the name of the OVS integration bridge. There is one per hypervisor. The integration bridge acts as a virtual 'patch bay'. All VM VIFs are attached to this bridge and then 'patched' according to their network connectivity. + - (String) Integration bridge to use. Do not change this parameter unless you have a good reason to. This is the name of the OVS integration bridge. There is one per hypervisor. The integration bridge acts as a virtual 'patch bay'. All VM VIFs are attached to this bridge and then 'patched' according to their network connectivity. * - ``local_ip`` = ``None`` - - (IPOpt) Local IP address of tunnel endpoint. + - (Unknown) Local IP address of tunnel endpoint. * - ``of_connect_timeout`` = ``30`` - - (IntOpt) Timeout in seconds to wait for the local switch connecting the controller. Used only for 'native' driver. + - (Integer) Timeout in seconds to wait for the local switch connecting the controller. Used only for 'native' driver. * - ``of_interface`` = ``ovs-ofctl`` - - (StrOpt) OpenFlow interface to use. + - (String) OpenFlow interface to use. * - ``of_listen_address`` = ``127.0.0.1`` - - (IPOpt) Address to listen on for OpenFlow connections. Used only for 'native' driver. + - (Unknown) Address to listen on for OpenFlow connections. Used only for 'native' driver. * - ``of_listen_port`` = ``6633`` - - (PortOpt) Port to listen on for OpenFlow connections. Used only for 'native' driver. + - (Unknown) Port to listen on for OpenFlow connections. Used only for 'native' driver. * - ``of_request_timeout`` = ``10`` - - (IntOpt) Timeout in seconds to wait for a single OpenFlow request. Used only for 'native' driver. + - (Integer) Timeout in seconds to wait for a single OpenFlow request. Used only for 'native' driver. * - ``ovsdb_connection`` = ``tcp:127.0.0.1:6640`` - - (StrOpt) The connection string for the native OVSDB backend. Requires the native ovsdb_interface to be enabled. + - (String) The connection string for the native OVSDB backend. Requires the native ovsdb_interface to be enabled. * - ``ovsdb_interface`` = ``vsctl`` - - (StrOpt) The interface for interacting with the OVSDB + - (String) The interface for interacting with the OVSDB * - ``tun_peer_patch_port`` = ``patch-int`` - - (StrOpt) Peer patch port in tunnel bridge for integration bridge. + - (String) Peer patch port in tunnel bridge for integration bridge. * - ``tunnel_bridge`` = ``br-tun`` - - (StrOpt) Tunnel bridge to use. + - (String) Tunnel bridge to use. * - ``use_veth_interconnection`` = ``False`` - - (BoolOpt) Use veths instead of patch ports to interconnect the integration bridge to physical networks. Support kernel without Open vSwitch patch port support so long as it is set to True. + - (Boolean) Use veths instead of patch ports to interconnect the integration bridge to physical networks. Support kernel without Open vSwitch patch port support so long as it is set to True. * - ``vhostuser_socket_dir`` = ``/var/run/openvswitch`` - - (StrOpt) OVS vhost-user socket directory. + - (String) OVS vhost-user socket directory. diff --git a/doc/config-reference/source/tables/neutron-pd_linux_agent.rst b/doc/config-reference/source/tables/neutron-pd_linux_agent.rst index 5475a2fe0f..77d60fd828 100644 --- a/doc/config-reference/source/tables/neutron-pd_linux_agent.rst +++ b/doc/config-reference/source/tables/neutron-pd_linux_agent.rst @@ -19,8 +19,8 @@ * - **[DEFAULT]** - * - ``pd_confs`` = ``$state_path/pd`` - - (StrOpt) Location to store IPv6 PD files. + - (String) Location to store IPv6 PD files. * - ``pd_dhcp_driver`` = ``dibbler`` - - (StrOpt) Service to handle DHCPv6 Prefix delegation. + - (String) Service to handle DHCPv6 Prefix delegation. * - ``vendor_pen`` = ``8888`` - - (StrOpt) A decimal value as Vendor's Registered Private Enterprise Number as required by RFC3315 DUID-EN. + - (String) A decimal value as Vendor's Registered Private Enterprise Number as required by RFC3315 DUID-EN. diff --git a/doc/config-reference/source/tables/neutron-policy.rst b/doc/config-reference/source/tables/neutron-policy.rst index e8d082b8e7..738372e0f1 100644 --- a/doc/config-reference/source/tables/neutron-policy.rst +++ b/doc/config-reference/source/tables/neutron-policy.rst @@ -19,4 +19,4 @@ * - **[DEFAULT]** - * - ``allow_overlapping_ips`` = ``False`` - - (BoolOpt) Allow overlapping IP support in Neutron. Attention: the following parameter MUST be set to False if Neutron is being used in conjunction with Nova security groups. + - (Boolean) Allow overlapping IP support in Neutron. Attention: the following parameter MUST be set to False if Neutron is being used in conjunction with Nova security groups. diff --git a/doc/config-reference/source/tables/neutron-qos.rst b/doc/config-reference/source/tables/neutron-qos.rst new file mode 100644 index 0000000000..5019913b27 --- /dev/null +++ b/doc/config-reference/source/tables/neutron-qos.rst @@ -0,0 +1,24 @@ +.. + 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. + +.. _neutron-qos: + +.. list-table:: Description of QoS configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[QOS]** + - + * - ``kernel_hz`` = ``250`` + - (Integer) Value of host kernel tick rate (hz) for calculating minimum burst value in bandwidth limit rules for a port with QoS. See kernel configuration file for HZ value and tc-tbf manual for more information. + * - ``tbf_latency`` = ``50`` + - (Integer) Value of latency (ms) for calculating size of queue for a port with QoS. See tc-tbf manual for more information. diff --git a/doc/config-reference/source/tables/neutron-quotas.rst b/doc/config-reference/source/tables/neutron-quotas.rst index 54c319fa95..23485ed436 100644 --- a/doc/config-reference/source/tables/neutron-quotas.rst +++ b/doc/config-reference/source/tables/neutron-quotas.rst @@ -19,50 +19,50 @@ * - **[DEFAULT]** - * - ``max_routes`` = ``30`` - - (IntOpt) Maximum number of routes per router + - (Integer) Maximum number of routes per router * - **[QUOTAS]** - * - ``default_quota`` = ``-1`` - - (IntOpt) Default number of resource allowed per tenant. A negative value means unlimited. + - (Integer) Default number of resource allowed per tenant. A negative value means unlimited. * - ``quota_driver`` = ``neutron.db.quota.driver.DbQuotaDriver`` - - (StrOpt) Default driver to use for quota checks - * - ``quota_firewall`` = ``1`` - - (IntOpt) Number of firewalls allowed per tenant. A negative value means unlimited. - * - ``quota_firewall_policy`` = ``1`` - - (IntOpt) Number of firewall policies allowed per tenant. A negative value means unlimited. + - (String) Default driver to use for quota checks + * - ``quota_firewall`` = ``10`` + - (Integer) Number of firewalls allowed per tenant. A negative value means unlimited. + * - ``quota_firewall_policy`` = ``10`` + - (Integer) Number of firewall policies allowed per tenant. A negative value means unlimited. * - ``quota_firewall_rule`` = ``100`` - - (IntOpt) Number of firewall rules allowed per tenant. A negative value means unlimited. + - (Integer) Number of firewall rules allowed per tenant. A negative value means unlimited. * - ``quota_floatingip`` = ``50`` - - (IntOpt) Number of floating IPs allowed per tenant. A negative value means unlimited. + - (Integer) Number of floating IPs allowed per tenant. A negative value means unlimited. * - ``quota_health_monitor`` = ``-1`` - - (IntOpt) Number of health monitors allowed per tenant. A negative value means unlimited. + - (Integer) Number of health monitors allowed per tenant. A negative value means unlimited. * - ``quota_healthmonitor`` = ``-1`` - - (IntOpt) Number of health monitors allowed per tenant. A negative value means unlimited. + - (Integer) Number of health monitors allowed per tenant. A negative value means unlimited. * - ``quota_items`` = ``network, subnet, port`` - - (ListOpt) Resource name(s) that are supported in quota features. This option is now deprecated for removal. + - (List) DEPRECATED: Resource name(s) that are supported in quota features. This option is now deprecated for removal. * - ``quota_listener`` = ``-1`` - - (IntOpt) Number of Loadbalancer Listeners allowed per tenant. A negative value means unlimited. + - (Integer) Number of Loadbalancer Listeners allowed per tenant. A negative value means unlimited. * - ``quota_loadbalancer`` = ``10`` - - (IntOpt) Number of LoadBalancers allowed per tenant. A negative value means unlimited. + - (Integer) Number of LoadBalancers allowed per tenant. A negative value means unlimited. * - ``quota_member`` = ``-1`` - - (IntOpt) Number of pool members allowed per tenant. A negative value means unlimited. + - (Integer) Number of pool members allowed per tenant. A negative value means unlimited. * - ``quota_network`` = ``10`` - - (IntOpt) Number of networks allowed per tenant. A negative value means unlimited. + - (Integer) Number of networks allowed per tenant. A negative value means unlimited. * - ``quota_pool`` = ``10`` - - (IntOpt) Number of pools allowed per tenant. A negative value means unlimited. + - (Integer) Number of pools allowed per tenant. A negative value means unlimited. * - ``quota_port`` = ``50`` - - (IntOpt) Number of ports allowed per tenant. A negative value means unlimited. + - (Integer) Number of ports allowed per tenant. A negative value means unlimited. * - ``quota_rbac_policy`` = ``10`` - - (IntOpt) Default number of RBAC entries allowed per tenant. A negative value means unlimited. + - (Integer) Default number of RBAC entries allowed per tenant. A negative value means unlimited. * - ``quota_router`` = ``10`` - - (IntOpt) Number of routers allowed per tenant. A negative value means unlimited. + - (Integer) Number of routers allowed per tenant. A negative value means unlimited. * - ``quota_security_group`` = ``10`` - - (IntOpt) Number of security groups allowed per tenant. A negative value means unlimited. + - (Integer) Number of security groups allowed per tenant. A negative value means unlimited. * - ``quota_security_group_rule`` = ``100`` - - (IntOpt) Number of security rules allowed per tenant. A negative value means unlimited. + - (Integer) Number of security rules allowed per tenant. A negative value means unlimited. * - ``quota_subnet`` = ``10`` - - (IntOpt) Number of subnets allowed per tenant, A negative value means unlimited. + - (Integer) Number of subnets allowed per tenant, A negative value means unlimited. * - ``quota_vip`` = ``10`` - - (IntOpt) Number of vips allowed per tenant. A negative value means unlimited. + - (Integer) Number of vips allowed per tenant. A negative value means unlimited. * - ``track_quota_usage`` = ``True`` - - (BoolOpt) Keep in track in the database of current resourcequota usage. Plugins which do not leverage the neutron database should set this flag to False + - (Boolean) Keep in track in the database of current resourcequota usage. Plugins which do not leverage the neutron database should set this flag to False diff --git a/doc/config-reference/source/tables/neutron-rabbitmq.rst b/doc/config-reference/source/tables/neutron-rabbitmq.rst index 150d41aebd..7c48ebd10b 100644 --- a/doc/config-reference/source/tables/neutron-rabbitmq.rst +++ b/doc/config-reference/source/tables/neutron-rabbitmq.rst @@ -19,58 +19,112 @@ * - **[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. + * - ``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 diff --git a/doc/config-reference/source/tables/neutron-redis.rst b/doc/config-reference/source/tables/neutron-redis.rst index 3345b87f79..6254b3db8f 100644 --- a/doc/config-reference/source/tables/neutron-redis.rst +++ b/doc/config-reference/source/tables/neutron-redis.rst @@ -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. diff --git a/doc/config-reference/source/tables/neutron-rpc.rst b/doc/config-reference/source/tables/neutron-rpc.rst index 10be0a9250..2a65920ff6 100644 --- a/doc/config-reference/source/tables/neutron-rpc.rst +++ b/doc/config-reference/source/tables/neutron-rpc.rst @@ -19,60 +19,68 @@ * - **[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. * - ``rpc_state_report_workers`` = ``1`` - - (IntOpt) Number of RPC worker processes dedicated to state reports queue + - (Integer) Number of RPC worker processes dedicated to state reports queue * - ``rpc_workers`` = ``1`` - - (IntOpt) Number of RPC worker processes for service + - (Integer) Number of RPC worker processes for service * - **[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]** - * - ``event_stream_topic`` = ``neutron_lbaas_event`` - - (StrOpt) topic name for receiving events from a queue + - (String) topic name for receiving events from a queue * - **[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`` = ``[]`` + - (Multi-valued) The Drivers(s) to handle sending notifications. Possible values are messaging, messagingv2, routing, log, test, noop + * - ``topics`` = ``notifications`` + - (List) AMQP topic used for OpenStack notifications. + * - ``transport_url`` = ``None`` + - (String) A URL representing the messaging driver to use for notifications. If not set, we fall back to the same configuration used for RPC. diff --git a/doc/config-reference/source/tables/neutron-scheduler.rst b/doc/config-reference/source/tables/neutron-scheduler.rst index 0c58edfec8..a26c150c60 100644 --- a/doc/config-reference/source/tables/neutron-scheduler.rst +++ b/doc/config-reference/source/tables/neutron-scheduler.rst @@ -19,10 +19,10 @@ * - **[DEFAULT]** - * - ``network_auto_schedule`` = ``True`` - - (BoolOpt) Allow auto scheduling networks to DHCP agent. + - (Boolean) Allow auto scheduling networks to DHCP agent. * - ``network_scheduler_driver`` = ``neutron.scheduler.dhcp_agent_scheduler.WeightScheduler`` - - (StrOpt) Driver to use for scheduling network to DHCP agent + - (String) Driver to use for scheduling network to DHCP agent * - ``router_auto_schedule`` = ``True`` - - (BoolOpt) Allow auto scheduling of routers to L3 agent. + - (Boolean) Allow auto scheduling of routers to L3 agent. * - ``router_scheduler_driver`` = ``neutron.scheduler.l3_agent_scheduler.LeastRoutersScheduler`` - - (StrOpt) Driver to use for scheduling router to a default L3 agent + - (String) Driver to use for scheduling router to a default L3 agent diff --git a/doc/config-reference/source/tables/neutron-securitygroups.rst b/doc/config-reference/source/tables/neutron-securitygroups.rst index c561a308dd..3162e50fae 100644 --- a/doc/config-reference/source/tables/neutron-securitygroups.rst +++ b/doc/config-reference/source/tables/neutron-securitygroups.rst @@ -19,8 +19,8 @@ * - **[SECURITYGROUP]** - * - ``enable_ipset`` = ``True`` - - (BoolOpt) Use ipset to speed-up the iptables based security groups. Enabling ipset support requires that ipset is installed on L2 agent node. + - (Boolean) Use ipset to speed-up the iptables based security groups. Enabling ipset support requires that ipset is installed on L2 agent node. * - ``enable_security_group`` = ``True`` - - (BoolOpt) Controls whether the neutron security group API is enabled in the server. It should be false when using no security groups or using the nova security group API. + - (Boolean) Controls whether the neutron security group API is enabled in the server. It should be false when using no security groups or using the nova security group API. * - ``firewall_driver`` = ``None`` - - (StrOpt) Driver for security groups firewall in the L2 agent + - (String) Driver for security groups firewall in the L2 agent diff --git a/doc/config-reference/source/tables/neutron-service_auth.rst b/doc/config-reference/source/tables/neutron-service_auth.rst index 5463639d71..6480639c39 100644 --- a/doc/config-reference/source/tables/neutron-service_auth.rst +++ b/doc/config-reference/source/tables/neutron-service_auth.rst @@ -19,22 +19,22 @@ * - **[service_auth]** - * - ``admin_password`` = ``password`` - - (StrOpt) The service admin password + - (String) The service admin password * - ``admin_project_domain`` = ``admin`` - - (StrOpt) The admin project domain name + - (String) The admin project domain name * - ``admin_tenant_name`` = ``admin`` - - (StrOpt) The service admin tenant name + - (String) The service admin tenant name * - ``admin_user`` = ``admin`` - - (StrOpt) The service admin user name + - (String) The service admin user name * - ``admin_user_domain`` = ``admin`` - - (StrOpt) The admin user domain name + - (String) The admin user domain name * - ``auth_url`` = ``http://127.0.0.1:5000/v2.0`` - - (StrOpt) Authentication endpoint + - (String) Authentication endpoint * - ``auth_version`` = ``2`` - - (StrOpt) The auth version used to authenticate + - (String) The auth version used to authenticate * - ``endpoint_type`` = ``public`` - - (StrOpt) The endpoint_type to be used + - (String) The endpoint_type to be used * - ``region`` = ``RegionOne`` - - (StrOpt) The deployment region + - (String) The deployment region * - ``service_name`` = ``lbaas`` - - (StrOpt) The name of the service + - (String) The name of the service diff --git a/doc/config-reference/source/tables/neutron-sriov.rst b/doc/config-reference/source/tables/neutron-sriov.rst index bfa91d3e2c..a3c3e29a89 100644 --- a/doc/config-reference/source/tables/neutron-sriov.rst +++ b/doc/config-reference/source/tables/neutron-sriov.rst @@ -19,6 +19,6 @@ * - **[SRIOV_NIC]** - * - ``exclude_devices`` = - - (ListOpt) Comma-separated list of : tuples, mapping network_device to the agent's node-specific list of virtual functions that should not be used for virtual networking. vfs_to_exclude is a semicolon-separated list of virtual functions to exclude from network_device. The network_device in the mapping should appear in the physical_device_mappings list. + - (List) Comma-separated list of : tuples, mapping network_device to the agent's node-specific list of virtual functions that should not be used for virtual networking. vfs_to_exclude is a semicolon-separated list of virtual functions to exclude from network_device. The network_device in the mapping should appear in the physical_device_mappings list. * - ``physical_device_mappings`` = - - (ListOpt) Comma-separated list of : tuples mapping physical network names to the agent's node-specific physical network device interfaces of SR-IOV physical function to be used for VLAN networks. All physical networks listed in network_vlan_ranges on the server should have mappings to appropriate interfaces on each agent. + - (List) Comma-separated list of : tuples mapping physical network names to the agent's node-specific physical network device interfaces of SR-IOV physical function to be used for VLAN networks. All physical networks listed in network_vlan_ranges on the server should have mappings to appropriate interfaces on each agent. diff --git a/doc/config-reference/source/tables/neutron-vpnaas.rst b/doc/config-reference/source/tables/neutron-vpnaas.rst index c3f0fc54e5..c933f7f52f 100644 --- a/doc/config-reference/source/tables/neutron-vpnaas.rst +++ b/doc/config-reference/source/tables/neutron-vpnaas.rst @@ -19,4 +19,4 @@ * - **[vpnagent]** - * - ``vpn_device_driver`` = ``['neutron_vpnaas.services.vpn.device_drivers.ipsec.OpenSwanDriver, neutron_vpnaas.services.vpn.device_drivers.cisco_ipsec.CiscoCsrIPsecDriver, neutron_vpnaas.services.vpn.device_drivers.vyatta_ipsec.VyattaIPSecDriver, neutron_vpnaas.services.vpn.device_drivers.strongswan_ipsec.StrongSwanDriver, neutron_vpnaas.services.vpn.device_drivers.fedora_strongswan_ipsec.FedoraStrongSwanDriver, neutron_vpnaas.services.vpn.device_drivers.libreswan_ipsec.LibreSwanDriver']`` - - (MultiStrOpt) The vpn device drivers Neutron will use + - (Multi-valued) The vpn device drivers Neutron will use diff --git a/doc/config-reference/source/tables/neutron-vpnaas_ipsec.rst b/doc/config-reference/source/tables/neutron-vpnaas_ipsec.rst index 4028e331eb..30f1af9013 100644 --- a/doc/config-reference/source/tables/neutron-vpnaas_ipsec.rst +++ b/doc/config-reference/source/tables/neutron-vpnaas_ipsec.rst @@ -19,16 +19,16 @@ * - **[ipsec]** - * - ``config_base_dir`` = ``$state_path/ipsec`` - - (StrOpt) Location to store ipsec server config files + - (String) Location to store ipsec server config files * - ``enable_detailed_logging`` = ``False`` - - (BoolOpt) Enable detail logging for ipsec pluto process. If the flag set to True, the detailed logging will be written into config_base_dir//log. Note: This setting applies to OpenSwan and LibreSwan only. StrongSwan logs to syslog. + - (Boolean) Enable detail logging for ipsec pluto process. If the flag set to True, the detailed logging will be written into config_base_dir//log. Note: This setting applies to OpenSwan and LibreSwan only. StrongSwan logs to syslog. * - ``ipsec_status_check_interval`` = ``60`` - - (IntOpt) Interval for checking ipsec status + - (Integer) Interval for checking ipsec status * - **[pluto]** - * - ``shutdown_check_back_off`` = ``1.5`` - - (FloatOpt) A factor to increase the retry interval for each retry + - (Floating point) A factor to increase the retry interval for each retry * - ``shutdown_check_retries`` = ``5`` - - (IntOpt) The maximum number of retries for checking for pluto daemon shutdown + - (Integer) The maximum number of retries for checking for pluto daemon shutdown * - ``shutdown_check_timeout`` = ``1`` - - (IntOpt) Initial interval in seconds for checking if pluto daemon is shutdown + - (Integer) Initial interval in seconds for checking if pluto daemon is shutdown diff --git a/doc/config-reference/source/tables/neutron-vpnaas_openswan.rst b/doc/config-reference/source/tables/neutron-vpnaas_openswan.rst index 32cf97e3d8..8137d1d62c 100644 --- a/doc/config-reference/source/tables/neutron-vpnaas_openswan.rst +++ b/doc/config-reference/source/tables/neutron-vpnaas_openswan.rst @@ -19,6 +19,6 @@ * - **[openswan]** - * - ``ipsec_config_template`` = ``/usr/lib/python/site-packages/neutron-vpnaas/neutron_vpnaas/services/vpn/device_drivers/template/openswan/ipsec.conf.template`` - - (StrOpt) Template file for ipsec configuration + - (String) Template file for ipsec configuration * - ``ipsec_secret_template`` = ``/usr/lib/python/site-packages/neutron-vpnaas/neutron_vpnaas/services/vpn/device_drivers/template/openswan/ipsec.secret.template`` - - (StrOpt) Template file for ipsec secret configuration + - (String) Template file for ipsec secret configuration diff --git a/doc/config-reference/source/tables/neutron-vpnaas_strongswan.rst b/doc/config-reference/source/tables/neutron-vpnaas_strongswan.rst index 7b0e04a8d5..dabc8ee34e 100644 --- a/doc/config-reference/source/tables/neutron-vpnaas_strongswan.rst +++ b/doc/config-reference/source/tables/neutron-vpnaas_strongswan.rst @@ -19,10 +19,10 @@ * - **[strongswan]** - * - ``default_config_area`` = ``/etc/strongswan.d`` - - (StrOpt) The area where default StrongSwan configuration files are located. + - (String) The area where default StrongSwan configuration files are located. * - ``ipsec_config_template`` = ``/usr/lib/python/site-packages/neutron-vpnaas/neutron_vpnaas/services/vpn/device_drivers/template/strongswan/ipsec.conf.template`` - - (StrOpt) Template file for ipsec configuration. + - (String) Template file for ipsec configuration. * - ``ipsec_secret_template`` = ``/usr/lib/python/site-packages/neutron-vpnaas/neutron_vpnaas/services/vpn/device_drivers/template/strongswan/ipsec.secret.template`` - - (StrOpt) Template file for ipsec secret configuration. + - (String) Template file for ipsec secret configuration. * - ``strongswan_config_template`` = ``/usr/lib/python/site-packages/neutron-vpnaas/neutron_vpnaas/services/vpn/device_drivers/template/strongswan/strongswan.conf.template`` - - (StrOpt) Template file for strongswan configuration. + - (String) Template file for strongswan configuration. diff --git a/doc/config-reference/source/tables/neutron-zeromq.rst b/doc/config-reference/source/tables/neutron-zeromq.rst index 304944245c..238946fc83 100644 --- a/doc/config-reference/source/tables/neutron-zeromq.rst +++ b/doc/config-reference/source/tables/neutron-zeromq.rst @@ -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). diff --git a/doc/config-reference/source/tables/nova-amqp.rst b/doc/config-reference/source/tables/nova-amqp.rst index 00c08ea917..93edc9f305 100644 --- a/doc/config-reference/source/tables/nova-amqp.rst +++ b/doc/config-reference/source/tables/nova-amqp.rst @@ -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. * - ``default_publisher_id`` = ``None`` - - (StrOpt) Default publisher_id for outgoing notifications + - (String) Default publisher_id for outgoing notifications * - ``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. diff --git a/doc/config-reference/source/tables/nova-api.rst b/doc/config-reference/source/tables/nova-api.rst index 28f6485bb1..f38f918e2a 100644 --- a/doc/config-reference/source/tables/nova-api.rst +++ b/doc/config-reference/source/tables/nova-api.rst @@ -19,64 +19,86 @@ * - **[DEFAULT]** - * - ``api_paste_config`` = ``api-paste.ini`` - - (StrOpt) File name for the paste.deploy config for nova-api + - (String) File name for the paste.deploy config for nova-api * - ``api_rate_limit`` = ``False`` - - (BoolOpt) Whether to use per-user rate limiting for the api. This option is only used by v2 api. Rate limiting is removed from v2.1 api. + - (Boolean) Whether to use per-user rate limiting for the api. This option is only used by v2 api. Rate limiting is removed from v2.1 api. * - ``client_socket_timeout`` = ``900`` - - (IntOpt) Timeout for client connections' socket operations. If an incoming connection is idle for this number of seconds it will be closed. A value of '0' means wait forever. + - (Integer) Timeout for client connections' socket operations. If an incoming connection is idle for this number of seconds it will be closed. A value of '0' means wait forever. * - ``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 * - ``enabled_apis`` = ``osapi_compute, metadata`` - - (ListOpt) A list of APIs to enable by default + - (List) A list of APIs to enable by default * - ``enabled_ssl_apis`` = - - (ListOpt) A list of APIs with enabled SSL + - (List) A list of APIs with enabled SSL * - ``instance_name_template`` = ``instance-%08x`` - - (StrOpt) Template string to be used to generate instance names + - (String) Template string to be used to generate instance names * - ``max_header_line`` = ``16384`` - - (IntOpt) Maximum line size of message headers to be accepted. max_header_line may need to be increased when using large tokens (typically those generated by the Keystone v3 API with big service catalogs). + - (Integer) Maximum line size of message headers to be accepted. max_header_line may need to be increased when using large tokens (typically those generated by the Keystone v3 API with big service catalogs). * - ``multi_instance_display_name_template`` = ``%(name)s-%(count)d`` - - (StrOpt) When creating multiple instances with a single request using the os-multiple-create API extension, this template will be used to build the display name for each instance. The benefit is that the instances end up with different hostnames. To restore legacy behavior of every instance having the same name, set this option to "%(name)s". Valid keys for the template are: name, uuid, count. + - (String) When creating multiple instances with a single request using the os-multiple-create API extension, this template will be used to build the display name for each instance. The benefit is that the instances end up with different hostnames. To restore legacy behavior of every instance having the same name, set this option to "%(name)s". Valid keys for the template are: name, uuid, count. * - ``non_inheritable_image_properties`` = ``cache_in_nova, bittorrent`` - - (ListOpt) These are image properties which a snapshot should not inherit from an instance + - (List) These are image properties which a snapshot should not inherit from an instance * - ``null_kernel`` = ``nokernel`` - - (StrOpt) Kernel image that indicates not to use a kernel, but to use a raw disk image instead + - (String) Kernel image that indicates not to use a kernel, but to use a raw disk image instead * - ``osapi_compute_ext_list`` = - - (ListOpt) DEPRECATED: Specify list of extensions to load when using osapi_compute_extension option with nova.api.openstack.compute.legacy_v2.contrib.select_extensions This option will be removed in the near future. After that point you have to run all of the API. + - (List) DEPRECATED: Specify list of extensions to load when using osapi_compute_extension option with nova.api.openstack.compute.legacy_v2.contrib.select_extensions This option will be removed in the near future. After that point you have to run all of the API. * - ``osapi_compute_extension`` = ``['nova.api.openstack.compute.legacy_v2.contrib.standard_extensions']`` - - (MultiStrOpt) osapi compute extension to load. This option will be removed in the near future. After that point you have to run all of the API. + - (Multi-valued) DEPRECATED: osapi compute extension to load. This option will be removed in the near future. After that point you have to run all of the API. * - ``osapi_compute_link_prefix`` = ``None`` - - (StrOpt) Base URL that will be presented to users in links to the OpenStack Compute API + - (String) Base URL that will be presented to users in links to the OpenStack Compute API * - ``osapi_compute_listen`` = ``0.0.0.0`` - - (StrOpt) The IP address on which the OpenStack API will listen. + - (String) The IP address on which the OpenStack API will listen. * - ``osapi_compute_listen_port`` = ``8774`` - - (IntOpt) The port on which the OpenStack API will listen. + - (Integer) The port on which the OpenStack API will listen. * - ``osapi_compute_workers`` = ``None`` - - (IntOpt) Number of workers for OpenStack API service. The default will be the number of CPUs available. + - (Integer) Number of workers for OpenStack API service. The default will be the number of CPUs available. * - ``osapi_hide_server_address_states`` = ``building`` - - (ListOpt) List of instance states that should hide network info + - (List) List of instance states that should hide network info * - ``secure_proxy_ssl_header`` = ``None`` - - (StrOpt) The HTTP header used to determine the scheme for the original request, even if it was removed by an SSL terminating proxy. Typical value is "HTTP_X_FORWARDED_PROTO". + - (String) The HTTP header used to determine the scheme for the original request, even if it was removed by an SSL terminating proxy. Typical value is "HTTP_X_FORWARDED_PROTO". * - ``servicegroup_driver`` = ``db`` - - (StrOpt) The driver for servicegroup service. + - (String) The driver for servicegroup service. * - ``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 * - ``tcp_keepidle`` = ``600`` - - (IntOpt) Sets the value of TCP_KEEPIDLE in seconds for each server socket. Not supported on OS X. + - (Integer) Sets the value of TCP_KEEPIDLE in seconds for each server socket. Not supported on OS X. * - ``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. * - ``wsgi_default_pool_size`` = ``1000`` - - (IntOpt) Size of the pool of greenthreads used by wsgi + - (Integer) Size of the pool of greenthreads used by wsgi * - ``wsgi_keep_alive`` = ``True`` - - (BoolOpt) If False, closes the client socket connection explicitly. + - (Boolean) If False, closes the client socket connection explicitly. * - ``wsgi_log_format`` = ``%(client_ip)s "%(request_line)s" status: %(status_code)s len: %(body_length)s time: %(wall_seconds).7f`` - - (StrOpt) A python format string that is used as the template to generate log lines. The following values can be formatted into it: client_ip, date_time, request_line, status_code, body_length, wall_seconds. + - (String) A python format string that is used as the template to generate log lines. The following values can be formatted into it: client_ip, date_time, request_line, status_code, body_length, wall_seconds. * - **[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_versionedobjects]** - * - ``fatal_exception_format_errors`` = ``False`` - - (BoolOpt) Make exception message format errors fatal + - (Boolean) Make exception message format errors fatal + * - **[service_auth]** + - + * - ``admin_password`` = ``password`` + - (String) The service admin password + * - ``admin_project_domain`` = ``admin`` + - (String) The admin project domain name + * - ``admin_tenant_name`` = ``admin`` + - (String) The service admin tenant name + * - ``admin_user`` = ``admin`` + - (String) The service admin user name + * - ``admin_user_domain`` = ``admin`` + - (String) The admin user domain name + * - ``auth_url`` = ``http://127.0.0.1:5000/v2.0`` + - (String) Authentication endpoint + * - ``auth_version`` = ``2`` + - (String) The auth version used to authenticate + * - ``endpoint_type`` = ``public`` + - (String) The endpoint_type to be used + * - ``region`` = ``RegionOne`` + - (String) The deployment region + * - ``service_name`` = ``lbaas`` + - (String) The name of the service diff --git a/doc/config-reference/source/tables/nova-apiv21.rst b/doc/config-reference/source/tables/nova-apiv21.rst index 1a3983dbdf..aa550de650 100644 --- a/doc/config-reference/source/tables/nova-apiv21.rst +++ b/doc/config-reference/source/tables/nova-apiv21.rst @@ -19,10 +19,10 @@ * - **[osapi_v21]** - * - ``enabled`` = ``True`` - - (BoolOpt) DEPRECATED: Whether the V2.1 API is enabled or not. This option will be removed in the near future. + - (Boolean) DEPRECATED: Whether the V2.1 API is enabled or not. This option will be removed in the near future. * - ``extensions_blacklist`` = - - (ListOpt) DEPRECATED: A list of v2.1 API extensions to never load. Specify the extension aliases here. This option will be removed in the near future. After that point you have to run all of the API. + - (List) DEPRECATED: A list of v2.1 API extensions to never load. Specify the extension aliases here. This option will be removed in the near future. After that point you have to run all of the API. * - ``extensions_whitelist`` = - - (ListOpt) DEPRECATED: If the list is not empty then a v2.1 API extension will only be loaded if it exists in this list. Specify the extension aliases here. This option will be removed in the near future. After that point you have to run all of the API. + - (List) DEPRECATED: If the list is not empty then a v2.1 API extension will only be loaded if it exists in this list. Specify the extension aliases here. This option will be removed in the near future. After that point you have to run all of the API. * - ``project_id_regex`` = ``None`` - - (StrOpt) DEPRECATED: The validation regex for project_ids used in urls. This defaults to [0-9a-f\-]+ if not set, which matches normal uuids created by keystone. + - (String) DEPRECATED: The validation regex for project_ids used in urls. This defaults to [0-9a-f\-]+ if not set, which matches normal uuids created by keystone. diff --git a/doc/config-reference/source/tables/nova-auth_token.rst b/doc/config-reference/source/tables/nova-auth_token.rst index af99506a98..bd60a89c3f 100644 --- a/doc/config-reference/source/tables/nova-auth_token.rst +++ b/doc/config-reference/source/tables/nova-auth_token.rst @@ -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. diff --git a/doc/config-reference/source/tables/nova-authentication.rst b/doc/config-reference/source/tables/nova-authentication.rst index 85609cd0f2..3b92766e5b 100644 --- a/doc/config-reference/source/tables/nova-authentication.rst +++ b/doc/config-reference/source/tables/nova-authentication.rst @@ -19,4 +19,4 @@ * - **[DEFAULT]** - * - ``auth_strategy`` = ``keystone`` - - (StrOpt) The strategy to use for auth: keystone or noauth2. noauth2 is designed for testing only, as it does no actual credential checking. noauth2 provides administrative credentials only if 'admin' is specified as the username. + - (String) The strategy to use for auth: keystone or noauth2. noauth2 is designed for testing only, as it does no actual credential checking. noauth2 provides administrative credentials only if 'admin' is specified as the username. diff --git a/doc/config-reference/source/tables/nova-availabilityzones.rst b/doc/config-reference/source/tables/nova-availabilityzones.rst index e1e65cc93d..6650441798 100644 --- a/doc/config-reference/source/tables/nova-availabilityzones.rst +++ b/doc/config-reference/source/tables/nova-availabilityzones.rst @@ -19,8 +19,8 @@ * - **[DEFAULT]** - * - ``default_availability_zone`` = ``nova`` - - (StrOpt) Default compute node availability_zone + - (String) Default compute node availability_zone * - ``default_schedule_zone`` = ``None`` - - (StrOpt) Availability zone to use when user doesn't specify one + - (String) Availability zone to use when user doesn't specify one * - ``internal_service_availability_zone`` = ``internal`` - - (StrOpt) The availability_zone to show internal services under + - (String) The availability_zone to show internal services under diff --git a/doc/config-reference/source/tables/nova-barbican.rst b/doc/config-reference/source/tables/nova-barbican.rst index c6ea304768..66fc9b6f1e 100644 --- a/doc/config-reference/source/tables/nova-barbican.rst +++ b/doc/config-reference/source/tables/nova-barbican.rst @@ -19,18 +19,24 @@ * - **[barbican]** - * - ``cafile`` = ``None`` - - (StrOpt) PEM encoded Certificate Authority to use when verifying HTTPs connections. + - (String) PEM encoded Certificate Authority to use when verifying HTTPs connections. * - ``catalog_info`` = ``key-manager:barbican:public`` - - (StrOpt) Info to match when looking for barbican in the service catalog. Format is: separated values of the form: :: + - (String) Info to match when looking for barbican in the service catalog. Format is: separated values of the form: :: * - ``certfile`` = ``None`` - - (StrOpt) PEM encoded client certificate cert file + - (String) PEM encoded client certificate cert file * - ``endpoint_template`` = ``None`` - - (StrOpt) Override service catalog lookup with template for barbican endpoint e.g. http://localhost:9311/v1/%(project_id)s + - (String) Override service catalog lookup with template for barbican endpoint e.g. http://localhost:9311/v1/%(project_id)s * - ``insecure`` = ``False`` - - (BoolOpt) Verify HTTPS connections. + - (Boolean) Verify HTTPS connections. * - ``keyfile`` = ``None`` - - (StrOpt) PEM encoded client certificate key file + - (String) PEM encoded client certificate key file * - ``os_region_name`` = ``None`` - - (StrOpt) Region name of this node + - (String) Region name of this node * - ``timeout`` = ``None`` - - (IntOpt) Timeout value for http requests + - (Integer) Timeout value for http requests + * - **[certificates]** + - + * - ``barbican_auth`` = ``barbican_acl_auth`` + - (String) Name of the Barbican authentication method to use + * - ``cert_manager_type`` = ``barbican`` + - (String) Certificate Manager plugin. Defaults to barbican. diff --git a/doc/config-reference/source/tables/nova-ca.rst b/doc/config-reference/source/tables/nova-ca.rst index 7f5cae933d..f0f36f81ab 100644 --- a/doc/config-reference/source/tables/nova-ca.rst +++ b/doc/config-reference/source/tables/nova-ca.rst @@ -19,30 +19,30 @@ * - **[DEFAULT]** - * - ``ca_file`` = ``cacert.pem`` - - (StrOpt) Filename of root CA + - (String) Filename of root CA * - ``ca_path`` = ``$state_path/CA`` - - (StrOpt) Where we keep our root CA + - (String) Where we keep our root CA * - ``cert`` = ``self.pem`` - - (StrOpt) SSL certificate file + - (String) SSL certificate file * - ``cert_manager`` = ``nova.cert.manager.CertManager`` - - (StrOpt) Full class name for the Manager for cert + - (String) DEPRECATED: Full class name for the Manager for cert * - ``cert_topic`` = ``cert`` - - (StrOpt) Determines the RPC topic that the cert nodes listen on. The default is 'cert', and for most deployments there is no need to ever change it. Possible values: Any string. * Services which consume this: ``nova-cert`` * Related options: None + - (String) Determines the RPC topic that the cert nodes listen on. The default is 'cert', and for most deployments there is no need to ever change it. Possible values: Any string. * Services which consume this: ``nova-cert`` * Related options: None * - ``crl_file`` = ``crl.pem`` - - (StrOpt) Filename of root Certificate Revocation List + - (String) Filename of root Certificate Revocation List * - ``key_file`` = ``private/cakey.pem`` - - (StrOpt) Filename of private key + - (String) Filename of private key * - ``keys_path`` = ``$state_path/keys`` - - (StrOpt) Where we keep our keys + - (String) Where we keep our keys * - ``project_cert_subject`` = ``/C=US/ST=California/O=OpenStack/OU=NovaDev/CN=project-ca-%.16s-%s`` - - (StrOpt) Subject for certificate for projects, %s for project, timestamp + - (String) Subject for certificate for projects, %s for project, timestamp * - ``ssl_ca_file`` = ``None`` - - (StrOpt) CA certificate file to use to verify connecting clients + - (String) CA certificate file to use to verify connecting clients * - ``ssl_cert_file`` = ``None`` - - (StrOpt) SSL certificate of API server + - (String) SSL certificate of API server * - ``ssl_key_file`` = ``None`` - - (StrOpt) SSL private key of API server + - (String) SSL private key of API server * - ``use_project_ca`` = ``False`` - - (BoolOpt) Should we use a CA for each project? + - (Boolean) Should we use a CA for each project? * - ``user_cert_subject`` = ``/C=US/ST=California/O=OpenStack/OU=NovaDev/CN=%.16s-%.16s-%s`` - - (StrOpt) Subject for certificate for users, %s for project, user, timestamp + - (String) Subject for certificate for users, %s for project, user, timestamp diff --git a/doc/config-reference/source/tables/nova-cache.rst b/doc/config-reference/source/tables/nova-cache.rst index b572555cdf..d2c90e68ea 100644 --- a/doc/config-reference/source/tables/nova-cache.rst +++ b/doc/config-reference/source/tables/nova-cache.rst @@ -19,28 +19,28 @@ * - **[cache]** - * - ``backend`` = ``dogpile.cache.null`` - - (StrOpt) Dogpile.cache backend module. It is recommended that Memcache with pooling (oslo_cache.memcache_pool) or Redis (dogpile.cache.redis) be used in production deployments. Small workloads (single process) like devstack can use the dogpile.cache.memory backend. + - (String) Dogpile.cache backend module. It is recommended that Memcache with pooling (oslo_cache.memcache_pool) or Redis (dogpile.cache.redis) be used in production deployments. Small workloads (single process) like devstack can use the dogpile.cache.memory backend. * - ``backend_argument`` = ``[]`` - - (MultiStrOpt) Arguments supplied to the backend module. Specify this option once per argument to be passed to the dogpile.cache backend. Example format: ":". + - (Multi-valued) Arguments supplied to the backend module. Specify this option once per argument to be passed to the dogpile.cache backend. Example format: ":". * - ``config_prefix`` = ``cache.oslo`` - - (StrOpt) Prefix for building the configuration dictionary for the cache region. This should not need to be changed unless there is another dogpile.cache region with the same configuration name. + - (String) Prefix for building the configuration dictionary for the cache region. This should not need to be changed unless there is another dogpile.cache region with the same configuration name. * - ``debug_cache_backend`` = ``False`` - - (BoolOpt) Extra debugging from the cache backend (cache keys, get/set/delete/etc calls). This is only really useful if you need to see the specific cache-backend get/set/delete calls with the keys/values. Typically this should be left set to false. + - (Boolean) Extra debugging from the cache backend (cache keys, get/set/delete/etc calls). This is only really useful if you need to see the specific cache-backend get/set/delete calls with the keys/values. Typically this should be left set to false. * - ``enabled`` = ``False`` - - (BoolOpt) Global toggle for caching. + - (Boolean) Global toggle for caching. * - ``expiration_time`` = ``600`` - - (IntOpt) Default TTL, in seconds, for any cached item in the dogpile.cache region. This applies to any cached method that doesn't have an explicit cache expiration time defined for it. + - (Integer) Default TTL, in seconds, for any cached item in the dogpile.cache region. This applies to any cached method that doesn't have an explicit cache expiration time defined for it. * - ``memcache_dead_retry`` = ``300`` - - (IntOpt) Number of seconds memcached server is considered dead before it is tried again. (dogpile.cache.memcache and oslo_cache.memcache_pool backends only). + - (Integer) Number of seconds memcached server is considered dead before it is tried again. (dogpile.cache.memcache and oslo_cache.memcache_pool backends only). * - ``memcache_pool_connection_get_timeout`` = ``10`` - - (IntOpt) Number of seconds that an operation will wait to get a memcache client connection. + - (Integer) Number of seconds that an operation will wait to get a memcache client connection. * - ``memcache_pool_maxsize`` = ``10`` - - (IntOpt) Max total number of open connections to every memcached server. (oslo_cache.memcache_pool backend only). + - (Integer) Max total number of open connections to every memcached server. (oslo_cache.memcache_pool backend only). * - ``memcache_pool_unused_timeout`` = ``60`` - - (IntOpt) Number of seconds a connection to memcached is held unused in the pool before it is closed. (oslo_cache.memcache_pool backend only). + - (Integer) Number of seconds a connection to memcached is held unused in the pool before it is closed. (oslo_cache.memcache_pool backend only). * - ``memcache_servers`` = ``localhost:11211`` - - (ListOpt) Memcache servers in the format of "host:port". (dogpile.cache.memcache and oslo_cache.memcache_pool backends only). + - (List) Memcache servers in the format of "host:port". (dogpile.cache.memcache and oslo_cache.memcache_pool backends only). * - ``memcache_socket_timeout`` = ``3`` - - (IntOpt) Timeout in seconds for every call to a server. (dogpile.cache.memcache and oslo_cache.memcache_pool backends only). + - (Integer) Timeout in seconds for every call to a server. (dogpile.cache.memcache and oslo_cache.memcache_pool backends only). * - ``proxies`` = - - (ListOpt) Proxy classes to import that will affect the way the dogpile.cache backend functions. See the dogpile.cache documentation on changing-backend-behavior. + - (List) Proxy classes to import that will affect the way the dogpile.cache backend functions. See the dogpile.cache documentation on changing-backend-behavior. diff --git a/doc/config-reference/source/tables/nova-cells.rst b/doc/config-reference/source/tables/nova-cells.rst index 84633f947e..71af34870e 100644 --- a/doc/config-reference/source/tables/nova-cells.rst +++ b/doc/config-reference/source/tables/nova-cells.rst @@ -19,38 +19,38 @@ * - **[cells]** - * - ``call_timeout`` = ``60`` - - (IntOpt) Call timeout Cell messaging module waits for response(s) to be put into the eventlet queue. This option defines the seconds waited for response from a call to a cell. Possible values: * Time in seconds. Services which consume this: * nova-cells Related options: * None + - (Integer) Call timeout Cell messaging module waits for response(s) to be put into the eventlet queue. This option defines the seconds waited for response from a call to a cell. Possible values: * Time in seconds. Services which consume this: * nova-cells Related options: * None * - ``capabilities`` = ``hypervisor=xenserver;kvm, os=linux;windows`` - - (ListOpt) Cell capabilities List of arbitrary key=value pairs defining capabilities of the current cell to be sent to the parent cells. These capabilities are intended to be used in cells scheduler filters/weighers. Possible values: * key=value pairs list for example; ``hypervisor=xenserver;kvm,os=linux;windows`` Services which consume this: * nova-cells Related options: * None + - (List) Cell capabilities List of arbitrary key=value pairs defining capabilities of the current cell to be sent to the parent cells. These capabilities are intended to be used in cells scheduler filters/weighers. Possible values: * key=value pairs list for example; ``hypervisor=xenserver;kvm,os=linux;windows`` Services which consume this: * nova-cells Related options: * None * - ``cell_type`` = ``compute`` - - (StrOpt) Type of cell When cells feature is enabled the hosts in the OpenStack Compute cloud are partitioned into groups. Cells are configured as a tree. The top-level cell's cell_type must be set to ``api``. All other cells are defined as a ``compute cell`` by default. Possible values: * api: Cell type of top-level cell. * compute: Cell type of all child cells. (Default) Services which consume this: * nova-cells Related options: * compute_api_class: This option must be set to cells api driver for the top-level cell (nova.compute.cells_api.ComputeCellsAPI) * quota_driver: Disable quota checking for the child cells. (nova.quota.NoopQuotaDriver) + - (String) Type of cell When cells feature is enabled the hosts in the OpenStack Compute cloud are partitioned into groups. Cells are configured as a tree. The top-level cell's cell_type must be set to ``api``. All other cells are defined as a ``compute cell`` by default. Possible values: * api: Cell type of top-level cell. * compute: Cell type of all child cells. (Default) Services which consume this: * nova-cells Related options: * compute_api_class: This option must be set to cells api driver for the top-level cell (nova.compute.cells_api.ComputeCellsAPI) * quota_driver: Disable quota checking for the child cells. (nova.quota.NoopQuotaDriver) * - ``cells_config`` = ``None`` - - (StrOpt) Configuration file from which to read cells configuration. If given, overrides reading cells from the database. + - (String) Optional cells configuration Configuration file from which to read cells configuration. If given, overrides reading cells from the database. Cells store all inter-cell communication data, including user names and passwords, in the database. Because the cells data is not updated very frequently, use this option to specify a JSON file to store cells data. With this configuration, the database is no longer consulted when reloading the cells data. The file must have columns present in the Cell model (excluding common database fields and the id column). You must specify the queue connection information through a transport_url field, instead of username, password, and so on. The transport_url has the following form: rabbit://USERNAME:PASSWORD@HOSTNAME:PORT/VIRTUAL_HOST Possible values: The scheme can be either qpid or rabbit, the following sample shows this optional configuration: { "parent": { "name": "parent", "api_url": "http://api.example.com:8774", "transport_url": "rabbit://rabbit.example.com", "weight_offset": 0.0, "weight_scale": 1.0, "is_parent": true }, "cell1": { "name": "cell1", "api_url": "http://api.example.com:8774", "transport_url": "rabbit://rabbit1.example.com", "weight_offset": 0.0, "weight_scale": 1.0, "is_parent": false }, "cell2": { "name": "cell2", "api_url": "http://api.example.com:8774", "transport_url": "rabbit://rabbit2.example.com", "weight_offset": 0.0, "weight_scale": 1.0, "is_parent": false } } Services which consume this: * nova-cells Related options: * None * - ``db_check_interval`` = ``60`` - - (IntOpt) Interval, in seconds, for getting fresh cell information from the database. + - (Integer) DB check interval Cell state manager updates cell status for all cells from the DB only after this particular interval time is passed. Otherwise cached status are used. If this value is 0 or negative all cell status are updated from the DB whenever a state is needed. Possible values: * Interval time, in seconds. Services which consume this: * nova-cells Related options: * None * - ``driver`` = ``nova.cells.rpc_driver.CellsRPCDriver`` - - (StrOpt) Cells communication driver Driver for cell<->cell communication via RPC. This is used to setup the RPC consumers as well as to send a message to another cell. 'nova.cells.rpc_driver.CellsRPCDriver' starts up 2 separate servers for handling inter-cell communication via RPC. Possible values: * 'nova.cells.rpc_driver.CellsRPCDriver' is the default driver * Otherwise it should be the full Python path to the class to be used Services which consume this: * nova-cells Related options: * None + - (String) Cells communication driver Driver for cell<->cell communication via RPC. This is used to setup the RPC consumers as well as to send a message to another cell. 'nova.cells.rpc_driver.CellsRPCDriver' starts up 2 separate servers for handling inter-cell communication via RPC. Possible values: * 'nova.cells.rpc_driver.CellsRPCDriver' is the default driver * Otherwise it should be the full Python path to the class to be used Services which consume this: * nova-cells Related options: * None * - ``enable`` = ``False`` - - (BoolOpt) Enable cell functionality When this functionality is enabled, it lets you to scale an OpenStack Compute cloud in a more distributed fashion without having to use complicated technologies like database and message queue clustering. Cells are configured as a tree. The top-level cell should have a host that runs a nova-api service, but no nova-compute services. Each child cell should run all of the typical nova-* services in a regular Compute cloud except for nova-api. You can think of cells as a normal Compute deployment in that each cell has its own database server and message queue broker. Possible values: * True: Enables the feature * False: Disables the feature Services which consume this: * nova-api * nova-cells * nova-compute Related options: * name: A unique cell name must be given when this functionality is enabled. * cell_type: Cell type should be defined for all cells. + - (Boolean) Enable cell functionality When this functionality is enabled, it lets you to scale an OpenStack Compute cloud in a more distributed fashion without having to use complicated technologies like database and message queue clustering. Cells are configured as a tree. The top-level cell should have a host that runs a nova-api service, but no nova-compute services. Each child cell should run all of the typical nova-* services in a regular Compute cloud except for nova-api. You can think of cells as a normal Compute deployment in that each cell has its own database server and message queue broker. Possible values: * True: Enables the feature * False: Disables the feature Services which consume this: * nova-api * nova-cells * nova-compute Related options: * name: A unique cell name must be given when this functionality is enabled. * cell_type: Cell type should be defined for all cells. * - ``instance_update_num_instances`` = ``1`` - - (IntOpt) Instance update num instances On every run of the periodic task, nova cells manager will attempt to sync instance_updated_at_threshold number of instances. When the manager gets the list of instances, it shuffles them so that multiple nova-cells services do not attempt to sync the same instances in lockstep. Possible values: * Positive integer number Services which consume this: * nova-cells Related options: * This value is used with the ``instance_updated_at_threshold`` value in a periodic task run. + - (Integer) Instance update num instances On every run of the periodic task, nova cells manager will attempt to sync instance_updated_at_threshold number of instances. When the manager gets the list of instances, it shuffles them so that multiple nova-cells services do not attempt to sync the same instances in lockstep. Possible values: * Positive integer number Services which consume this: * nova-cells Related options: * This value is used with the ``instance_updated_at_threshold`` value in a periodic task run. * - ``instance_update_sync_database_limit`` = ``100`` - - (IntOpt) Instance update sync database limit Number of instances to pull from the database at one time for a sync. If there are more instances to update the results will be paged through. Possible values: * Number of instances. Services which consume this: * nova-cells Related options: * None + - (Integer) Instance update sync database limit Number of instances to pull from the database at one time for a sync. If there are more instances to update the results will be paged through. Possible values: * Number of instances. Services which consume this: * nova-cells Related options: * None * - ``instance_updated_at_threshold`` = ``3600`` - - (IntOpt) Instance updated at threshold Number of seconds after an instance was updated or deleted to continue to update cells. This option lets cells manager to only attempt to sync instances that have been updated recently. i.e., a threshold of 3600 means to only update instances that have modified in the last hour. Possible values: * Threshold in seconds Services which consume this: * nova-cells Related options: * This value is used with the ``instance_update_num_instances`` value in a periodic task run. + - (Integer) Instance updated at threshold Number of seconds after an instance was updated or deleted to continue to update cells. This option lets cells manager to only attempt to sync instances that have been updated recently. i.e., a threshold of 3600 means to only update instances that have modified in the last hour. Possible values: * Threshold in seconds Services which consume this: * nova-cells Related options: * This value is used with the ``instance_update_num_instances`` value in a periodic task run. * - ``manager`` = ``nova.cells.manager.CellsManager`` - - (StrOpt) Manager for cells The nova-cells manager class. This class defines RPC methods that the local cell may call. This class is NOT used for messages coming from other cells. That communication is driver-specific. Communication to other cells happens via the nova.cells.messaging module. The MessageRunner from that module will handle routing the message to the correct cell via the communication driver. Most methods below create 'targeted' (where we want to route a message to a specific cell) or 'broadcast' (where we want a message to go to multiple cells) messages. Scheduling requests get passed to the scheduler class. Possible values: * 'nova.cells.manager.CellsManager' is the only possible value for this option as of the Mitaka release Services which consume this: * nova-cells Related options: * None + - (String) DEPRECATED: Manager for cells The nova-cells manager class. This class defines RPC methods that the local cell may call. This class is NOT used for messages coming from other cells. That communication is driver-specific. Communication to other cells happens via the nova.cells.messaging module. The MessageRunner from that module will handle routing the message to the correct cell via the communication driver. Most methods below create 'targeted' (where we want to route a message to a specific cell) or 'broadcast' (where we want a message to go to multiple cells) messages. Scheduling requests get passed to the scheduler class. Possible values: * 'nova.cells.manager.CellsManager' is the only possible value for this option as of the Mitaka release Services which consume this: * nova-cells Related options: * None * - ``max_hop_count`` = ``10`` - - (IntOpt) Maximum hop count When processing a targeted message, if the local cell is not the target, a route is defined between neighbouring cells. And the message is processed across the whole routing path. This option defines the maximum hop counts until reaching the target. Possible values: * Positive integer value Services which consume this: * nova-cells Related options: * None + - (Integer) Maximum hop count When processing a targeted message, if the local cell is not the target, a route is defined between neighbouring cells. And the message is processed across the whole routing path. This option defines the maximum hop counts until reaching the target. Possible values: * Positive integer value Services which consume this: * nova-cells Related options: * None * - ``mute_child_interval`` = ``300`` - - (IntOpt) Mute child interval Number of seconds after which a lack of capability and capacity update the child cell is to be treated as a mute cell. Then the child cell will be weighed as recommend highly that it be skipped. Possible values: * Time in seconds. Services which consume this: * nova-cells Related options: * None + - (Integer) Mute child interval Number of seconds after which a lack of capability and capacity update the child cell is to be treated as a mute cell. Then the child cell will be weighed as recommend highly that it be skipped. Possible values: * Time in seconds. Services which consume this: * nova-cells Related options: * None * - ``mute_weight_multiplier`` = ``-10000.0`` - - (FloatOpt) Mute weight multiplier Multiplier used to weigh mute children. Mute children cells are recommended to be skipped so their weight is multiplied by this negative value. Possible values: * Negative numeric number Services which consume this: * nova-cells Related options: * None + - (Floating point) Mute weight multiplier Multiplier used to weigh mute children. Mute children cells are recommended to be skipped so their weight is multiplied by this negative value. Possible values: * Negative numeric number Services which consume this: * nova-cells Related options: * None * - ``name`` = ``nova`` - - (StrOpt) Name of the current cell This value must be unique for each cell. Name of a cell is used as its id, leaving this option unset or setting the same name for two or more cells may cause unexpected behaviour. Possible values: * Unique name string Services which consume this: * nova-cells Related options: * enabled: This option is meaningful only when cells service is enabled + - (String) Name of the current cell This value must be unique for each cell. Name of a cell is used as its id, leaving this option unset or setting the same name for two or more cells may cause unexpected behaviour. Possible values: * Unique name string Services which consume this: * nova-cells Related options: * enabled: This option is meaningful only when cells service is enabled * - ``offset_weight_multiplier`` = ``1.0`` - - (FloatOpt) Offset weight multiplier Multiplier used to weigh offset weigher. Cells with higher weight_offsets in the DB will be preferred. The weight_offset is a property of a cell stored in the database. It can be used by a deployer to have scheduling decisions favor or disfavor cells based on the setting. Possible values: * Numeric multiplier Services which consume this: * nova-cells Related options: * None + - (Floating point) Offset weight multiplier Multiplier used to weigh offset weigher. Cells with higher weight_offsets in the DB will be preferred. The weight_offset is a property of a cell stored in the database. It can be used by a deployer to have scheduling decisions favor or disfavor cells based on the setting. Possible values: * Numeric multiplier Services which consume this: * nova-cells Related options: * None * - ``reserve_percent`` = ``10.0`` - - (FloatOpt) Reserve percentage Percentage of cell capacity to hold in reserve, so the minimum amount of free resource is considered to be; min_free = total * (reserve_percent / 100.0) This option affects both memory and disk utilization. The primary purpose of this reserve is to ensure some space is available for users who want to resize their instance to be larger. Note that currently once the capacity expands into this reserve space this option is ignored. Possible values: * Float percentage value Services which consume this: * nova-cells Related options: * None + - (Floating point) Reserve percentage Percentage of cell capacity to hold in reserve, so the minimum amount of free resource is considered to be; min_free = total * (reserve_percent / 100.0) This option affects both memory and disk utilization. The primary purpose of this reserve is to ensure some space is available for users who want to resize their instance to be larger. Note that currently once the capacity expands into this reserve space this option is ignored. Possible values: * Float percentage value Services which consume this: * nova-cells Related options: * None * - ``topic`` = ``cells`` - - (StrOpt) Topic This is the message queue topic that cells nodes listen on. It is used when the cells service is started up to configure the queue, and whenever an RPC call to the scheduler is made. Possible values: * cells: This is the recommended and the default value. Services which consume this: * nova-cells Related options: * None + - (String) Topic This is the message queue topic that cells nodes listen on. It is used when the cells service is started up to configure the queue, and whenever an RPC call to the scheduler is made. Possible values: * cells: This is the recommended and the default value. Services which consume this: * nova-cells Related options: * None diff --git a/doc/config-reference/source/tables/nova-common.rst b/doc/config-reference/source/tables/nova-common.rst index 97027e6b89..c4a83edbfe 100644 --- a/doc/config-reference/source/tables/nova-common.rst +++ b/doc/config-reference/source/tables/nova-common.rst @@ -19,50 +19,50 @@ * - **[DEFAULT]** - * - ``bindir`` = ``/usr/local/bin`` - - (StrOpt) Directory where nova binaries are installed + - (String) Directory where nova binaries are installed * - ``compute_topic`` = ``compute`` - - (StrOpt) The topic compute nodes listen on + - (String) The topic compute nodes listen on * - ``console_topic`` = ``console`` - - (StrOpt) The topic console proxy nodes listen on + - (String) The topic console proxy nodes listen on * - ``consoleauth_topic`` = ``consoleauth`` - - (StrOpt) The topic console auth proxy nodes listen on + - (String) The topic console auth proxy nodes listen on * - ``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 hostname, FQDN, or IP address. However, the node name must be valid within an AMQP key, and if using ZeroMQ, a valid hostname, FQDN, or IP address + - (String) Name of this node. This can be an opaque identifier. It is not necessarily a hostname, FQDN, or IP address. However, the node name must be valid within an AMQP key, and if using ZeroMQ, a valid hostname, FQDN, or IP address * - ``memcached_servers`` = ``None`` - - (_DeprecatedListOpt) DEPRECATED: Memcached servers or None for in process cache. "memcached_servers" opt is deprecated in Mitaka. In Newton release oslo.cache config options should be used as this option will be removed. Please add a [cache] group in your nova.conf file and add "enable" and "memcache_servers" option in this section. + - (Unknown) DEPRECATED: Memcached servers or None for in process cache. "memcached_servers" opt is deprecated in Mitaka. In Newton release oslo.cache config options should be used as this option will be removed. Please add a [cache] group in your nova.conf file and add "enable" and "memcache_servers" option in this section. * - ``my_ip`` = ``10.0.0.1`` - - (StrOpt) IP address of this host + - (String) IP address of this host * - ``notify_api_faults`` = ``False`` - - (BoolOpt) If set, send api.fault notifications on caught exceptions in the API service. + - (Boolean) If set, send api.fault notifications on caught exceptions in the API service. * - ``notify_on_state_change`` = ``None`` - - (StrOpt) If set, send compute.instance.update notifications on instance state changes. Valid values are None for no notifications, "vm_state" for notifications on VM state changes, or "vm_and_task_state" for notifications on VM and task state changes. + - (String) If set, send compute.instance.update notifications on instance state changes. Valid values are None for no notifications, "vm_state" for notifications on VM state changes, or "vm_and_task_state" for notifications on VM and task state changes. * - ``pybasedir`` = ``/usr/lib/python/site-packages/nova`` - - (StrOpt) Directory where the nova python module is installed + - (String) Directory where the nova python module is installed * - ``report_interval`` = ``10`` - - (IntOpt) Seconds between nodes reporting state to datastore + - (Integer) Seconds between nodes reporting state to datastore * - ``rootwrap_config`` = ``/etc/nova/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 * - ``service_down_time`` = ``60`` - - (IntOpt) Maximum time since last check-in for up service + - (Integer) Maximum time since last check-in for up service * - ``state_path`` = ``$pybasedir`` - - (StrOpt) Top-level directory for maintaining nova's state + - (String) Top-level directory for maintaining nova's state * - ``tempdir`` = ``None`` - - (StrOpt) Explicitly specify the temporary working directory + - (String) Explicitly specify the temporary working directory * - ``use_rootwrap_daemon`` = ``False`` - - (BoolOpt) Start and use a daemon that can run the commands that need to be run with root privileges. This option is usually enabled on nodes that run nova compute processes + - (Boolean) Start and use a daemon that can run the commands that need to be run with root privileges. This option is usually enabled on nodes that run nova compute processes * - **[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. * - **[workarounds]** - * - ``destroy_after_evacuate`` = ``True`` - - (BoolOpt) DEPRECATED: Whether to destroy instances on startup when we suspect they have previously been evacuated. This can result in data loss if undesired. See https://launchpad.net/bugs/1419785 + - (Boolean) DEPRECATED: Whether to destroy instances on startup when we suspect they have previously been evacuated. This can result in data loss if undesired. See https://launchpad.net/bugs/1419785 * - ``disable_libvirt_livesnapshot`` = ``True`` - - (BoolOpt) When using libvirt 1.2.2 live snapshots fail intermittently under load. This config option provides a mechanism to enable live snapshot while this is resolved. See https://bugs.launchpad.net/nova/+bug/1334398 + - (Boolean) When using libvirt 1.2.2 live snapshots fail intermittently under load. This config option provides a mechanism to enable live snapshot while this is resolved. See https://bugs.launchpad.net/nova/+bug/1334398 * - ``disable_rootwrap`` = ``False`` - - (BoolOpt) This option allows a fallback to sudo for performance reasons. For example see https://bugs.launchpad.net/nova/+bug/1415106 + - (Boolean) This option allows a fallback to sudo for performance reasons. For example see https://bugs.launchpad.net/nova/+bug/1415106 * - ``handle_virt_lifecycle_events`` = ``True`` - - (BoolOpt) Whether or not to handle events raised from the compute driver's 'emit_event' method. These are lifecycle events raised from compute drivers that implement the method. An example of a lifecycle event is an instance starting or stopping. If the instance is going through task state changes due to an API operation, like resize, the events are ignored. However, this is an advanced feature which allows the hypervisor to signal to the compute service that an unexpected state change has occurred in an instance and the instance can be shutdown automatically - which can inherently race in reboot operations or when the compute service or host is rebooted, either planned or due to an unexpected outage. Care should be taken when using this and sync_power_state_interval is negative since then if any instances are out of sync between the hypervisor and the Nova database they will have to be synchronized manually. See https://bugs.launchpad.net/bugs/1444630 + - (Boolean) Whether or not to handle events raised from the compute driver's 'emit_event' method. These are lifecycle events raised from compute drivers that implement the method. An example of a lifecycle event is an instance starting or stopping. If the instance is going through task state changes due to an API operation, like resize, the events are ignored. However, this is an advanced feature which allows the hypervisor to signal to the compute service that an unexpected state change has occurred in an instance and the instance can be shutdown automatically - which can inherently race in reboot operations or when the compute service or host is rebooted, either planned or due to an unexpected outage. Care should be taken when using this and sync_power_state_interval is negative since then if any instances are out of sync between the hypervisor and the Nova database they will have to be synchronized manually. See https://bugs.launchpad.net/bugs/1444630 diff --git a/doc/config-reference/source/tables/nova-compute.rst b/doc/config-reference/source/tables/nova-compute.rst index 4c5cd3dc12..e9f3a6c8ab 100644 --- a/doc/config-reference/source/tables/nova-compute.rst +++ b/doc/config-reference/source/tables/nova-compute.rst @@ -19,74 +19,74 @@ * - **[DEFAULT]** - * - ``compute_available_monitors`` = ``None`` - - (MultiStrOpt) Monitor classes available to the compute which may be specified more than once. This option is DEPRECATED and no longer used. Use setuptools entry points to list available monitor plugins. + - (Multi-valued) DEPRECATED: Monitor classes available to the compute which may be specified more than once. This option is DEPRECATED and no longer used. Use setuptools entry points to list available monitor plugins. * - ``compute_driver`` = ``None`` - - (StrOpt) Defines which driver to use for controlling virtualization. Possible values: * ``libvirt.LibvirtDriver`` * ``xenapi.XenAPIDriver`` * ``fake.FakeDriver`` * ``ironic.IronicDriver`` * ``vmwareapi.VMwareVCDriver`` * ``hyperv.HyperVDriver`` Services which consume this: * ``nova-compute`` Interdependencies to other options: * None + - (String) Defines which driver to use for controlling virtualization. Possible values: * ``libvirt.LibvirtDriver`` * ``xenapi.XenAPIDriver`` * ``fake.FakeDriver`` * ``ironic.IronicDriver`` * ``vmwareapi.VMwareVCDriver`` * ``hyperv.HyperVDriver`` Services which consume this: * ``nova-compute`` Interdependencies to other options: * None * - ``compute_manager`` = ``nova.compute.manager.ComputeManager`` - - (StrOpt) Full class name for the Manager for compute + - (String) DEPRECATED: Full class name for the Manager for compute * - ``compute_monitors`` = - - (ListOpt) A list of monitors that can be used for getting compute metrics. You can use the alias/name from the setuptools entry points for nova.compute.monitors.* namespaces. If no namespace is supplied, the "cpu." namespace is assumed for backwards-compatibility. An example value that would enable both the CPU and NUMA memory bandwidth monitors that used the virt driver variant: ["cpu.virt_driver", "numa_mem_bw.virt_driver"] + - (List) A list of monitors that can be used for getting compute metrics. You can use the alias/name from the setuptools entry points for nova.compute.monitors.* namespaces. If no namespace is supplied, the "cpu." namespace is assumed for backwards-compatibility. An example value that would enable both the CPU and NUMA memory bandwidth monitors that used the virt driver variant: ["cpu.virt_driver", "numa_mem_bw.virt_driver"] * - ``compute_resources`` = - - (ListOpt) DEPRECATED: The names of the extra resources to track. The Extensible Resource Tracker is deprecated and will be removed in the 14.0.0 release. If you use this functionality and have custom resources that are managed by the Extensible Resource Tracker, please contact the Nova development team by posting to the openstack-dev mailing list. There is no future planned support for the tracking of custom resources. + - (List) DEPRECATED: The names of the extra resources to track. The Extensible Resource Tracker is deprecated and will be removed in the 14.0.0 release. If you use this functionality and have custom resources that are managed by the Extensible Resource Tracker, please contact the Nova development team by posting to the openstack-dev mailing list. There is no future planned support for the tracking of custom resources. * - ``compute_stats_class`` = ``nova.compute.stats.Stats`` - - (StrOpt) Class that will manage stats for the local compute host + - (String) DEPRECATED: Class that will manage stats for the local compute host * - ``console_host`` = ``localhost`` - - (StrOpt) Console proxy host to use to connect to instances on this host. + - (String) Console proxy host to use to connect to instances on this host. * - ``console_manager`` = ``nova.console.manager.ConsoleProxyManager`` - - (StrOpt) Full class name for the Manager for console proxy + - (String) DEPRECATED: Full class name for the Manager for console proxy * - ``default_flavor`` = ``m1.small`` - - (StrOpt) Default flavor to use for the EC2 API only. The Nova API does not support a default flavor. + - (String) Default flavor to use for the EC2 API only. The Nova API does not support a default flavor. * - ``default_notification_level`` = ``INFO`` - - (StrOpt) Default notification level for outgoing notifications + - (String) Default notification level for outgoing notifications * - ``enable_instance_password`` = ``True`` - - (BoolOpt) Enables returning of the instance password by the relevant server API calls such as create, rebuild or rescue, If the hypervisor does not support password injection then the password returned will not be correct + - (Boolean) Enables returning of the instance password by the relevant server API calls such as create, rebuild or rescue, If the hypervisor does not support password injection then the password returned will not be correct * - ``heal_instance_info_cache_interval`` = ``60`` - - (IntOpt) Number of seconds between instance network information cache updates + - (Integer) Number of seconds between instance network information cache updates * - ``image_cache_manager_interval`` = ``2400`` - - (IntOpt) Number of seconds to wait between runs of the image cache manager. Set to -1 to disable. Setting this to 0 will run at the default rate. + - (Integer) Number of seconds to wait between runs of the image cache manager. Set to -1 to disable. Setting this to 0 will run at the default rate. * - ``image_cache_subdirectory_name`` = ``_base`` - - (StrOpt) Where cached images are stored under $instances_path. This is NOT the full path - just a folder name. For per-compute-host cached images, set to _base_$my_ip + - (String) Where cached images are stored under $instances_path. This is NOT the full path - just a folder name. For per-compute-host cached images, set to _base_$my_ip * - ``instance_build_timeout`` = ``0`` - - (IntOpt) Amount of time in seconds an instance can be in BUILD before going into ERROR status. Set to 0 to disable. + - (Integer) Amount of time in seconds an instance can be in BUILD before going into ERROR status. Set to 0 to disable. * - ``instance_delete_interval`` = ``300`` - - (IntOpt) Interval in seconds for retrying failed instance file deletes. Set to -1 to disable. Setting this to 0 will run at the default rate. + - (Integer) Interval in seconds for retrying failed instance file deletes. Set to -1 to disable. Setting this to 0 will run at the default rate. * - ``instance_usage_audit`` = ``False`` - - (BoolOpt) Generate periodic compute.instance.exists notifications + - (Boolean) Generate periodic compute.instance.exists notifications * - ``instance_usage_audit_period`` = ``month`` - - (StrOpt) Time period to generate instance usages for. Time period must be hour, day, month or year + - (String) Time period to generate instance usages for. Time period must be hour, day, month or year * - ``instances_path`` = ``$state_path/instances`` - - (StrOpt) Where instances are stored on disk + - (String) Where instances are stored on disk * - ``max_concurrent_builds`` = ``10`` - - (IntOpt) Maximum number of instance builds to run concurrently + - (Integer) Maximum number of instance builds to run concurrently * - ``maximum_instance_delete_attempts`` = ``5`` - - (IntOpt) The number of times to attempt to reap an instance's files. + - (Integer) The number of times to attempt to reap an instance's files. * - ``reboot_timeout`` = ``0`` - - (IntOpt) Automatically hard reboot an instance if it has been stuck in a rebooting state longer than N seconds. Set to 0 to disable. + - (Integer) Automatically hard reboot an instance if it has been stuck in a rebooting state longer than N seconds. Set to 0 to disable. * - ``reclaim_instance_interval`` = ``0`` - - (IntOpt) Interval in seconds for reclaiming deleted instances. It takes effect only when value is greater than 0. + - (Integer) Interval in seconds for reclaiming deleted instances. It takes effect only when value is greater than 0. * - ``rescue_timeout`` = ``0`` - - (IntOpt) Automatically unrescue an instance after N seconds. Set to 0 to disable. + - (Integer) Automatically unrescue an instance after N seconds. Set to 0 to disable. * - ``resize_confirm_window`` = ``0`` - - (IntOpt) Automatically confirm resizes after N seconds. Set to 0 to disable. + - (Integer) Automatically confirm resizes and cold migrations after N seconds. Set to 0 to disable. * - ``resume_guests_state_on_host_boot`` = ``False`` - - (BoolOpt) Whether to start guests that were running before the host rebooted + - (Boolean) Whether to start guests that were running before the host rebooted * - ``running_deleted_instance_action`` = ``reap`` - - (StrOpt) Action to take if a running deleted instance is detected.Set to 'noop' to take no action. + - (String) Action to take if a running deleted instance is detected.Set to 'noop' to take no action. * - ``running_deleted_instance_poll_interval`` = ``1800`` - - (IntOpt) Number of seconds to wait between runs of the cleanup task. + - (Integer) Number of seconds to wait between runs of the cleanup task. * - ``running_deleted_instance_timeout`` = ``0`` - - (IntOpt) Number of seconds after being deleted when a running instance should be considered eligible for cleanup. + - (Integer) Number of seconds after being deleted when a running instance should be considered eligible for cleanup. * - ``shelved_offload_time`` = ``0`` - - (IntOpt) Time in seconds before a shelved instance is eligible for removing from a host. -1 never offload, 0 offload immediately when shelved + - (Integer) Time in seconds before a shelved instance is eligible for removing from a host. -1 never offload, 0 offload immediately when shelved * - ``shelved_poll_interval`` = ``3600`` - - (IntOpt) Interval in seconds for polling shelved instances to offload. Set to -1 to disable.Setting this to 0 will run at the default rate. + - (Integer) Interval in seconds for polling shelved instances to offload. Set to -1 to disable.Setting this to 0 will run at the default rate. * - ``shutdown_timeout`` = ``60`` - - (IntOpt) Total amount of time to wait in seconds for an instance to perform a clean shutdown. + - (Integer) Total amount of time to wait in seconds for an instance to perform a clean shutdown. * - ``sync_power_state_interval`` = ``600`` - - (IntOpt) Interval to sync power states between the database and the hypervisor. Set to -1 to disable. Setting this to 0 will run at the default rate. + - (Integer) Interval to sync power states between the database and the hypervisor. Set to -1 to disable. Setting this to 0 will run at the default rate. * - ``update_resources_interval`` = ``0`` - - (IntOpt) Interval in seconds for updating compute resources. A number less than 0 means to disable the task completely. Leaving this at the default of 0 will cause this to run at the default periodic interval. Setting it to any positive value will cause it to run at approximately that number of seconds. + - (Integer) Interval in seconds for updating compute resources. A number less than 0 means to disable the task completely. Leaving this at the default of 0 will cause this to run at the default periodic interval. Setting it to any positive value will cause it to run at approximately that number of seconds. * - ``vif_plugging_is_fatal`` = ``True`` - - (BoolOpt) Determine if instance should boot or fail on VIF plugging timeout. Nova sends a port update to Neutron after an instance has been scheduled, providing Neutron with the necessary information to finish setup of the port. Once completed, Neutron notifies Nova that it has finished setting up the port, at which point Nova resumes the boot of the instance since network connectivity is now supposed to be present. A timeout will occur if the reply is not received after a given interval. This option determines what Nova does when the VIF plugging timeout event happens. When enabled, the instance will error out. When disabled, the instance will continue to boot on the assumption that the port is ready. Possible values: * True: Instances should fail after VIF plugging timeout * False: Instances should continue booting after VIF plugging timeout Services which consume this: * ``nova-compute`` Interdependencies to other options: * None + - (Boolean) Determine if instance should boot or fail on VIF plugging timeout. Nova sends a port update to Neutron after an instance has been scheduled, providing Neutron with the necessary information to finish setup of the port. Once completed, Neutron notifies Nova that it has finished setting up the port, at which point Nova resumes the boot of the instance since network connectivity is now supposed to be present. A timeout will occur if the reply is not received after a given interval. This option determines what Nova does when the VIF plugging timeout event happens. When enabled, the instance will error out. When disabled, the instance will continue to boot on the assumption that the port is ready. Possible values: * True: Instances should fail after VIF plugging timeout * False: Instances should continue booting after VIF plugging timeout Services which consume this: * ``nova-compute`` Interdependencies to other options: * None * - ``vif_plugging_timeout`` = ``300`` - - (IntOpt) Timeout for Neutron VIF plugging event message arrival. Number of seconds to wait for Neutron vif plugging events to arrive before continuing or failing (see 'vif_plugging_is_fatal'). If this is set to zero and 'vif_plugging_is_fatal' is False, events should not be expected to arrive at all. Possible values: * A time interval in seconds Services which consume this: * ``nova-compute`` Interdependencies to other options: * None + - (Integer) Timeout for Neutron VIF plugging event message arrival. Number of seconds to wait for Neutron vif plugging events to arrive before continuing or failing (see 'vif_plugging_is_fatal'). If this is set to zero and 'vif_plugging_is_fatal' is False, events should not be expected to arrive at all. Possible values: * A time interval in seconds Services which consume this: * ``nova-compute`` Interdependencies to other options: * None diff --git a/doc/config-reference/source/tables/nova-conductor.rst b/doc/config-reference/source/tables/nova-conductor.rst index 9d8b3320a8..294638748a 100644 --- a/doc/config-reference/source/tables/nova-conductor.rst +++ b/doc/config-reference/source/tables/nova-conductor.rst @@ -19,14 +19,14 @@ * - **[DEFAULT]** - * - ``migrate_max_retries`` = ``-1`` - - (IntOpt) Number of times to retry live-migration before failing. If == -1, try until out of hosts. If == 0, only try once, no retries. + - (Integer) Number of times to retry live-migration before failing. If == -1, try until out of hosts. If == 0, only try once, no retries. * - **[conductor]** - * - ``manager`` = ``nova.conductor.manager.ConductorManager`` - - (StrOpt) Full class name for the Manager for conductor + - (String) DEPRECATED: Full class name for the Manager for conductor. Removal in 14.0 * - ``topic`` = ``conductor`` - - (StrOpt) The topic on which conductor nodes listen + - (String) The topic on which conductor nodes listen * - ``use_local`` = ``False`` - - (BoolOpt) DEPRECATED: Perform nova-conductor operations locally. This legacy mode was introduced to bridge a gap during the transition to the conductor service. It no longer represents a reasonable alternative for deployers. Removal may be as early as 14.0 + - (Boolean) DEPRECATED: Perform nova-conductor operations locally. This legacy mode was introduced to bridge a gap during the transition to the conductor service. It no longer represents a reasonable alternative for deployers. Removal may be as early as 14.0 * - ``workers`` = ``None`` - - (IntOpt) Number of workers for OpenStack Conductor service. The default will be the number of CPUs available. + - (Integer) Number of workers for OpenStack Conductor service. The default will be the number of CPUs available. diff --git a/doc/config-reference/source/tables/nova-configdrive.rst b/doc/config-reference/source/tables/nova-configdrive.rst index 5e28e1f2ba..bd5b69b79e 100644 --- a/doc/config-reference/source/tables/nova-configdrive.rst +++ b/doc/config-reference/source/tables/nova-configdrive.rst @@ -19,16 +19,16 @@ * - **[DEFAULT]** - * - ``config_drive_format`` = ``iso9660`` - - (StrOpt) Config drive format. + - (String) Config drive format. * - ``config_drive_skip_versions`` = ``1.0 2007-01-19 2007-03-01 2007-08-29 2007-10-10 2007-12-15 2008-02-01 2008-09-01`` - - (StrOpt) List of metadata versions to skip placing into the config drive + - (String) List of metadata versions to skip placing into the config drive * - ``force_config_drive`` = ``False`` - - (BoolOpt) Force injection to take place on a config drive + - (Boolean) Force injection to take place on a config drive * - ``mkisofs_cmd`` = ``genisoimage`` - - (StrOpt) Name and optionally path of the tool used for ISO image creation + - (String) Name and optionally path of the tool used for ISO image creation * - **[hyperv]** - * - ``config_drive_cdrom`` = ``False`` - - (BoolOpt) Attaches the Config Drive image as a cdrom drive instead of a disk drive + - (Boolean) Attaches the Config Drive image as a cdrom drive instead of a disk drive * - ``config_drive_inject_password`` = ``False`` - - (BoolOpt) Sets the admin password in the config drive image + - (Boolean) Sets the admin password in the config drive image diff --git a/doc/config-reference/source/tables/nova-console.rst b/doc/config-reference/source/tables/nova-console.rst index 8d4e9e4a3b..c405abd512 100644 --- a/doc/config-reference/source/tables/nova-console.rst +++ b/doc/config-reference/source/tables/nova-console.rst @@ -19,16 +19,16 @@ * - **[DEFAULT]** - * - ``console_allowed_origins`` = - - (ListOpt) Allowed Origin header hostnames for access to console proxy servers + - (List) Allowed Origin header hostnames for access to console proxy servers * - ``console_public_hostname`` = ``localhost`` - - (StrOpt) Publicly visible name for this console host + - (String) Publicly visible name for this console host * - ``console_token_ttl`` = ``600`` - - (IntOpt) How many seconds before deleting tokens + - (Integer) How many seconds before deleting tokens * - ``consoleauth_manager`` = ``nova.consoleauth.manager.ConsoleAuthManager`` - - (StrOpt) Manager for console auth + - (String) DEPRECATED: Manager for console auth * - **[mks]** - * - ``enabled`` = ``False`` - - (BoolOpt) Enable MKS related features + - (Boolean) Enable MKS related features * - ``mksproxy_base_url`` = ``http://127.0.0.1:6090/`` - - (StrOpt) Location of MKS web console proxy, in the form "http://127.0.0.1:6090/" + - (String) Location of MKS web console proxy, in the form "http://127.0.0.1:6090/" diff --git a/doc/config-reference/source/tables/nova-cors.rst b/doc/config-reference/source/tables/nova-cors.rst index 41df71a54a..1905a77f86 100644 --- a/doc/config-reference/source/tables/nova-cors.rst +++ b/doc/config-reference/source/tables/nova-cors.rst @@ -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. diff --git a/doc/config-reference/source/tables/nova-database.rst b/doc/config-reference/source/tables/nova-database.rst index 3a9a07d636..f2ae0391b5 100644 --- a/doc/config-reference/source/tables/nova-database.rst +++ b/doc/config-reference/source/tables/nova-database.rst @@ -19,74 +19,74 @@ * - **[DEFAULT]** - * - ``db_driver`` = ``nova.db`` - - (StrOpt) The driver to use for database access + - (String) DEPRECATED: The driver to use for database access * - **[api_database]** - * - ``connection`` = ``None`` - - (StrOpt) The SQLAlchemy connection string to use to connect to the Nova API database. + - (String) The SQLAlchemy connection string to use to connect to the Nova API 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. * - ``idle_timeout`` = ``3600`` - - (IntOpt) Timeout before idle SQL connections are reaped. + - (Integer) Timeout before idle SQL connections are reaped. * - ``max_overflow`` = ``None`` - - (IntOpt) If set, use this value for max_overflow with SQLAlchemy. + - (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. * - ``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_synchronous`` = ``True`` - - (BoolOpt) If True, SQLite uses synchronous mode. + - (Boolean) If True, SQLite uses synchronous mode. * - **[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 diff --git a/doc/config-reference/source/tables/nova-debug.rst b/doc/config-reference/source/tables/nova-debug.rst index 28e5109535..c9d1fab142 100644 --- a/doc/config-reference/source/tables/nova-debug.rst +++ b/doc/config-reference/source/tables/nova-debug.rst @@ -19,4 +19,4 @@ * - **[guestfs]** - * - ``debug`` = ``False`` - - (BoolOpt) Enable guestfs debug + - (Boolean) Enable guestfs debug diff --git a/doc/config-reference/source/tables/nova-ephemeral_storage_encryption.rst b/doc/config-reference/source/tables/nova-ephemeral_storage_encryption.rst index 77da819a44..43294948bc 100644 --- a/doc/config-reference/source/tables/nova-ephemeral_storage_encryption.rst +++ b/doc/config-reference/source/tables/nova-ephemeral_storage_encryption.rst @@ -19,8 +19,8 @@ * - **[ephemeral_storage_encryption]** - * - ``cipher`` = ``aes-xts-plain64`` - - (StrOpt) The cipher and mode to be used to encrypt ephemeral storage. Which ciphers are available ciphers depends on kernel support. See /proc/crypto for the list of available options. + - (String) The cipher and mode to be used to encrypt ephemeral storage. Which ciphers are available ciphers depends on kernel support. See /proc/crypto for the list of available options. * - ``enabled`` = ``False`` - - (BoolOpt) Whether to encrypt ephemeral storage + - (Boolean) Whether to encrypt ephemeral storage * - ``key_size`` = ``512`` - - (IntOpt) The bit length of the encryption key to be used to encrypt ephemeral storage (in XTS mode only half of the bits are used for encryption key) + - (Integer) The bit length of the encryption key to be used to encrypt ephemeral storage (in XTS mode only half of the bits are used for encryption key) diff --git a/doc/config-reference/source/tables/nova-fping.rst b/doc/config-reference/source/tables/nova-fping.rst index 5b04fd99da..0e296d2bf3 100644 --- a/doc/config-reference/source/tables/nova-fping.rst +++ b/doc/config-reference/source/tables/nova-fping.rst @@ -19,4 +19,4 @@ * - **[DEFAULT]** - * - ``fping_path`` = ``/usr/sbin/fping`` - - (StrOpt) Full path to fping. + - (String) Full path to fping. diff --git a/doc/config-reference/source/tables/nova-glance.rst b/doc/config-reference/source/tables/nova-glance.rst index 0a002dff1c..91c84d5b94 100644 --- a/doc/config-reference/source/tables/nova-glance.rst +++ b/doc/config-reference/source/tables/nova-glance.rst @@ -19,26 +19,26 @@ * - **[DEFAULT]** - * - ``osapi_glance_link_prefix`` = ``None`` - - (StrOpt) Base URL that will be presented to users in links to glance resources + - (String) Base URL that will be presented to users in links to glance resources * - **[glance]** - * - ``allowed_direct_url_schemes`` = - - (ListOpt) A list of url scheme that can be downloaded directly via the direct_url. Currently supported schemes: [file]. + - (List) A list of url scheme that can be downloaded directly via the direct_url. Currently supported schemes: [file]. * - ``api_insecure`` = ``False`` - - (BoolOpt) Allow to perform insecure SSL (https) requests to glance + - (Boolean) Allow to perform insecure SSL (https) requests to glance * - ``api_servers`` = ``None`` - - (ListOpt) A list of the glance api servers endpoints available to nova. These should be fully qualified urls of the form "scheme://hostname:port[/path]" (i.e. "http://10.0.1.0:9292" or "https://my.glance.server/image") + - (List) A list of the glance api servers endpoints available to nova. These should be fully qualified urls of the form "scheme://hostname:port[/path]" (i.e. "http://10.0.1.0:9292" or "https://my.glance.server/image") * - ``host`` = ``$my_ip`` - - (StrOpt) Glance server hostname or IP address + - (String) DEPRECATED: Glance server hostname or IP address. Use the "api_servers" option instead. * - ``num_retries`` = ``0`` - - (IntOpt) Number of retries when uploading / downloading an image to / from glance. + - (Integer) Number of retries when uploading / downloading an image to / from glance. * - ``port`` = ``9292`` - - (IntOpt) Glance server port + - (Integer) DEPRECATED: Glance server port. Use the "api_servers" option instead. * - ``protocol`` = ``http`` - - (StrOpt) Protocol to use when connecting to glance. Set to https for SSL. + - (String) DEPRECATED: Protocol to use when connecting to glance. Set to https for SSL. Use the "api_servers" option instead. * - ``verify_glance_signatures`` = ``False`` - - (BoolOpt) Require Nova to perform signature verification on each image downloaded from Glance. + - (Boolean) Require Nova to perform signature verification on each image downloaded from Glance. * - **[image_file_url]** - * - ``filesystems`` = - - (ListOpt) List of file systems that are configured in this file in the image_file_url: sections + - (List) List of file systems that are configured in this file in the image_file_url: sections diff --git a/doc/config-reference/source/tables/nova-hyperv.rst b/doc/config-reference/source/tables/nova-hyperv.rst index e12a5bc5e2..30956d739d 100644 --- a/doc/config-reference/source/tables/nova-hyperv.rst +++ b/doc/config-reference/source/tables/nova-hyperv.rst @@ -19,24 +19,24 @@ * - **[hyperv]** - * - ``dynamic_memory_ratio`` = ``1.0`` - - (FloatOpt) Enables dynamic memory allocation (ballooning) when set to a value greater than 1. The value expresses the ratio between the total RAM assigned to an instance and its startup RAM amount. For example a ratio of 2.0 for an instance with 1024MB of RAM implies 512MB of RAM allocated at startup + - (Floating point) Enables dynamic memory allocation (ballooning) when set to a value greater than 1. The value expresses the ratio between the total RAM assigned to an instance and its startup RAM amount. For example a ratio of 2.0 for an instance with 1024MB of RAM implies 512MB of RAM allocated at startup * - ``enable_instance_metrics_collection`` = ``False`` - - (BoolOpt) Enables metrics collections for an instance by using Hyper-V's metric APIs. Collected data can by retrieved by other apps and services, e.g.: Ceilometer. Requires Hyper-V / Windows Server 2012 and above + - (Boolean) Enables metrics collections for an instance by using Hyper-V's metric APIs. Collected data can by retrieved by other apps and services, e.g.: Ceilometer. Requires Hyper-V / Windows Server 2012 and above * - ``instances_path_share`` = - - (StrOpt) The name of a Windows share name mapped to the "instances_path" dir and used by the resize feature to copy files to the target host. If left blank, an administrative share will be used, looking for the same "instances_path" used locally + - (String) The name of a Windows share name mapped to the "instances_path" dir and used by the resize feature to copy files to the target host. If left blank, an administrative share will be used, looking for the same "instances_path" used locally * - ``limit_cpu_features`` = ``False`` - - (BoolOpt) Required for live migration among hosts with different CPU features + - (Boolean) Required for live migration among hosts with different CPU features * - ``mounted_disk_query_retry_count`` = ``10`` - - (IntOpt) The number of times to retry checking for a disk mounted via iSCSI. + - (Integer) The number of times to retry checking for a disk mounted via iSCSI. * - ``mounted_disk_query_retry_interval`` = ``5`` - - (IntOpt) Interval between checks for a mounted iSCSI disk, in seconds. + - (Integer) Interval between checks for a mounted iSCSI disk, in seconds. * - ``power_state_check_timeframe`` = ``60`` - - (IntOpt) The timeframe to be checked for instance power state changes. + - (Integer) The timeframe to be checked for instance power state changes. * - ``power_state_event_polling_interval`` = ``2`` - - (IntOpt) Instance power state change event polling frequency. + - (Integer) Instance power state change event polling frequency. * - ``qemu_img_cmd`` = ``qemu-img.exe`` - - (StrOpt) Path of qemu-img command which is used to convert between different image types + - (String) Path of qemu-img command which is used to convert between different image types * - ``vswitch_name`` = ``None`` - - (StrOpt) External virtual switch Name, if not provided, the first external virtual switch is used + - (String) External virtual switch Name, if not provided, the first external virtual switch is used * - ``wait_soft_reboot_seconds`` = ``60`` - - (IntOpt) Number of seconds to wait for instance to shut down after soft reboot request is made. We fall back to hard reboot if instance does not shutdown within this window. + - (Integer) Number of seconds to wait for instance to shut down after soft reboot request is made. We fall back to hard reboot if instance does not shutdown within this window. diff --git a/doc/config-reference/source/tables/nova-hypervisor.rst b/doc/config-reference/source/tables/nova-hypervisor.rst index bcaa504df4..a2d2c98739 100644 --- a/doc/config-reference/source/tables/nova-hypervisor.rst +++ b/doc/config-reference/source/tables/nova-hypervisor.rst @@ -19,16 +19,16 @@ * - **[DEFAULT]** - * - ``default_ephemeral_format`` = ``None`` - - (StrOpt) The default format an ephemeral_volume will be formatted with on creation. Possible values: * ``ext2`` * ``ext3`` * ``ext4`` * ``xfs`` * ``ntfs`` (only for Windows guests) Services which consume this: * ``nova-compute`` Interdependencies to other options: * None + - (String) The default format an ephemeral_volume will be formatted with on creation. Possible values: * ``ext2`` * ``ext3`` * ``ext4`` * ``xfs`` * ``ntfs`` (only for Windows guests) Services which consume this: * ``nova-compute`` Interdependencies to other options: * None * - ``force_raw_images`` = ``True`` - - (BoolOpt) Force backing images to raw format + - (Boolean) Force conversion of backing images to raw format. Possible values: * True: Backing image files will be converted to raw image format * False: Backing image files will not be converted Services which consume this: * nova-compute Interdependencies to other options: * ``compute_driver``: Only the libvirt driver uses this option. * - ``preallocate_images`` = ``none`` - - (StrOpt) The image preallocation mode to use. Image preallocation allows storage for instance images to be allocated up front when the instance is initially provisioned. This ensures immediate feedback is given if enough space isn't available. In addition, it should significantly improve performance on writes to new blocks and may even improve I/O performance to prewritten blocks due to reduced fragmentation. Possible values: * "none" => no storage provisioning is done up front * "space" => storage is fully allocated at instance start Services which consume this: * ``nova-compute`` Interdependencies to other options: * None + - (String) The image preallocation mode to use. Image preallocation allows storage for instance images to be allocated up front when the instance is initially provisioned. This ensures immediate feedback is given if enough space isn't available. In addition, it should significantly improve performance on writes to new blocks and may even improve I/O performance to prewritten blocks due to reduced fragmentation. Possible values: * "none" => no storage provisioning is done up front * "space" => storage is fully allocated at instance start Services which consume this: * ``nova-compute`` Interdependencies to other options: * None * - ``timeout_nbd`` = ``10`` - - (IntOpt) Amount of time, in seconds, to wait for NBD device start up. + - (Integer) Amount of time, in seconds, to wait for NBD device start up. * - ``use_cow_images`` = ``True`` - - (BoolOpt) Enable use of copy-on-write (cow) images. QEMU/KVM allow the use of qcow2 as backing files. By disabling this, backing files will not be used. Possible values: * True: Enable use of cow images * False: Disable use of cow images Services which consume this: * ``nova-compute`` Interdependencies to other options: * None + - (Boolean) Enable use of copy-on-write (cow) images. QEMU/KVM allow the use of qcow2 as backing files. By disabling this, backing files will not be used. Possible values: * True: Enable use of cow images * False: Disable use of cow images Services which consume this: * ``nova-compute`` Interdependencies to other options: * None * - ``vcpu_pin_set`` = ``None`` - - (StrOpt) Defines which physical CPUs (pCPUs) can be used by instance virtual CPUs (vCPUs). Possible values: * A comma-separated list of physical CPU numbers that virtual CPUs can be allocated to by default. Each element should be either a single CPU number, a range of CPU numbers, or a caret followed by a CPU number to be excluded from a previous range. For example: vcpu_pin_set = "4-12,^8,15" Services which consume this: * ``nova-scheduler`` * ``nova-compute`` Interdependencies to other options: * None + - (String) Defines which physical CPUs (pCPUs) can be used by instance virtual CPUs (vCPUs). Possible values: * A comma-separated list of physical CPU numbers that virtual CPUs can be allocated to by default. Each element should be either a single CPU number, a range of CPU numbers, or a caret followed by a CPU number to be excluded from a previous range. For example: vcpu_pin_set = "4-12,^8,15" Services which consume this: * ``nova-scheduler`` * ``nova-compute`` Interdependencies to other options: * None * - ``virt_mkfs`` = ``[]`` - - (MultiStrOpt) Name of the mkfs commands for ephemeral device. The format is = + - (Multi-valued) Name of the mkfs commands for ephemeral device. The format is = diff --git a/doc/config-reference/source/tables/nova-ipv6.rst b/doc/config-reference/source/tables/nova-ipv6.rst index 4ffd217f95..a64cc43468 100644 --- a/doc/config-reference/source/tables/nova-ipv6.rst +++ b/doc/config-reference/source/tables/nova-ipv6.rst @@ -19,10 +19,10 @@ * - **[DEFAULT]** - * - ``fixed_range_v6`` = ``fd00::/48`` - - (StrOpt) Fixed IPv6 address block + - (String) Fixed IPv6 address block * - ``gateway_v6`` = ``None`` - - (StrOpt) Default IPv6 gateway + - (String) Default IPv6 gateway * - ``ipv6_backend`` = ``rfc2462`` - - (StrOpt) Backend to use for IPv6 generation + - (String) Backend to use for IPv6 generation * - ``use_ipv6`` = ``False`` - - (BoolOpt) Use IPv6 + - (Boolean) Use IPv6 diff --git a/doc/config-reference/source/tables/nova-ironic.rst b/doc/config-reference/source/tables/nova-ironic.rst index 994ac0d0fd..9636018efa 100644 --- a/doc/config-reference/source/tables/nova-ironic.rst +++ b/doc/config-reference/source/tables/nova-ironic.rst @@ -19,22 +19,22 @@ * - **[ironic]** - * - ``admin_auth_token`` = ``None`` - - (StrOpt) Ironic keystone auth token.DEPRECATED: use admin_username, admin_password, and admin_tenant_name instead + - (String) DEPRECATED: Ironic keystone auth token.DEPRECATED: use admin_username, admin_password, and admin_tenant_name instead * - ``admin_password`` = ``None`` - - (StrOpt) Ironic keystone admin password. + - (String) Ironic keystone admin password. * - ``admin_tenant_name`` = ``None`` - - (StrOpt) Ironic keystone tenant name. + - (String) Ironic keystone tenant name. * - ``admin_url`` = ``None`` - - (StrOpt) Keystone public API endpoint. + - (String) Keystone public API endpoint. * - ``admin_username`` = ``None`` - - (StrOpt) Ironic keystone admin name + - (String) Ironic keystone admin name * - ``api_endpoint`` = ``None`` - - (StrOpt) URL for Ironic API endpoint. + - (String) URL for Ironic API endpoint. * - ``api_max_retries`` = ``60`` - - (IntOpt) How many retries when a request does conflict. If <= 0, only try once, no retries. + - (Integer) How many retries when a request does conflict. If <= 0, only try once, no retries. * - ``api_retry_interval`` = ``2`` - - (IntOpt) How often to retry in seconds when a request does conflict + - (Integer) How often to retry in seconds when a request does conflict * - ``api_version`` = ``1`` - - (IntOpt) Version of Ironic API service endpoint. DEPRECATED: Setting the API version is not possible anymore. + - (Integer) DEPRECATED: Version of Ironic API service endpoint. DEPRECATED: Setting the API version is not possible anymore. * - ``client_log_level`` = ``None`` - - (StrOpt) Log level override for ironicclient. Set this in order to override the global "default_log_levels", "verbose", and "debug" settings. DEPRECATED: use standard logging configuration. + - (String) DEPRECATED: Log level override for ironicclient. Set this in order to override the global "default_log_levels", "verbose", and "debug" settings. DEPRECATED: use standard logging configuration. diff --git a/doc/config-reference/source/tables/nova-keymgr.rst b/doc/config-reference/source/tables/nova-keymgr.rst index 347acbfa56..16d9967a55 100644 --- a/doc/config-reference/source/tables/nova-keymgr.rst +++ b/doc/config-reference/source/tables/nova-keymgr.rst @@ -19,6 +19,6 @@ * - **[keymgr]** - * - ``api_class`` = ``nova.keymgr.conf_key_mgr.ConfKeyManager`` - - (StrOpt) The full class name of the key manager API class + - (String) The full class name of the key manager API class * - ``fixed_key`` = ``None`` - - (StrOpt) Fixed key returned by key manager, specified in hex + - (String) Fixed key returned by key manager, specified in hex diff --git a/doc/config-reference/source/tables/nova-ldap.rst b/doc/config-reference/source/tables/nova-ldap.rst index 143d049719..3a08f0b161 100644 --- a/doc/config-reference/source/tables/nova-ldap.rst +++ b/doc/config-reference/source/tables/nova-ldap.rst @@ -19,22 +19,22 @@ * - **[DEFAULT]** - * - ``ldap_dns_base_dn`` = ``ou=hosts,dc=example,dc=org`` - - (StrOpt) Base DN for DNS entries in LDAP + - (String) Base DN for DNS entries in LDAP * - ``ldap_dns_password`` = ``password`` - - (StrOpt) Password for LDAP DNS + - (String) Password for LDAP DNS * - ``ldap_dns_servers`` = ``['dns.example.org']`` - - (MultiStrOpt) DNS Servers for LDAP DNS driver + - (Multi-valued) DNS Servers for LDAP DNS driver * - ``ldap_dns_soa_expiry`` = ``86400`` - - (StrOpt) Expiry interval (in seconds) for LDAP DNS driver Statement of Authority + - (String) Expiry interval (in seconds) for LDAP DNS driver Statement of Authority * - ``ldap_dns_soa_hostmaster`` = ``hostmaster@example.org`` - - (StrOpt) Hostmaster for LDAP DNS driver Statement of Authority + - (String) Hostmaster for LDAP DNS driver Statement of Authority * - ``ldap_dns_soa_minimum`` = ``7200`` - - (StrOpt) Minimum interval (in seconds) for LDAP DNS driver Statement of Authority + - (String) Minimum interval (in seconds) for LDAP DNS driver Statement of Authority * - ``ldap_dns_soa_refresh`` = ``1800`` - - (StrOpt) Refresh interval (in seconds) for LDAP DNS driver Statement of Authority + - (String) Refresh interval (in seconds) for LDAP DNS driver Statement of Authority * - ``ldap_dns_soa_retry`` = ``3600`` - - (StrOpt) Retry interval (in seconds) for LDAP DNS driver Statement of Authority + - (String) Retry interval (in seconds) for LDAP DNS driver Statement of Authority * - ``ldap_dns_url`` = ``ldap://ldap.example.com:389`` - - (StrOpt) URL for LDAP server which will store DNS entries + - (String) URL for LDAP server which will store DNS entries * - ``ldap_dns_user`` = ``uid=admin,ou=people,dc=example,dc=org`` - - (StrOpt) User for LDAP DNS + - (String) User for LDAP DNS diff --git a/doc/config-reference/source/tables/nova-libvirt.rst b/doc/config-reference/source/tables/nova-libvirt.rst index 62b34b17cb..a429b1fcd6 100644 --- a/doc/config-reference/source/tables/nova-libvirt.rst +++ b/doc/config-reference/source/tables/nova-libvirt.rst @@ -19,92 +19,92 @@ * - **[DEFAULT]** - * - ``remove_unused_base_images`` = ``True`` - - (BoolOpt) Should unused base images be removed? + - (Boolean) Should unused base images be removed? * - ``remove_unused_original_minimum_age_seconds`` = ``86400`` - - (IntOpt) Unused unresized base images younger than this will not be removed + - (Integer) Unused unresized base images younger than this will not be removed * - **[libvirt]** - * - ``block_migration_flag`` = ``VIR_MIGRATE_UNDEFINE_SOURCE, VIR_MIGRATE_PEER2PEER, VIR_MIGRATE_LIVE, VIR_MIGRATE_TUNNELLED, VIR_MIGRATE_NON_SHARED_INC`` - - (StrOpt) Migration flags to be set for block migration + - (String) DEPRECATED: Migration flags to be set for block migration The correct block migration flags can be inferred from the new live_migration_tunnelled config option. block_migration_flag will be removed to avoid potential misconfiguration. * - ``checksum_base_images`` = ``False`` - - (BoolOpt) Write a checksum for files in _base to disk + - (Boolean) Write a checksum for files in _base to disk * - ``checksum_interval_seconds`` = ``3600`` - - (IntOpt) How frequently to checksum base images + - (Integer) How frequently to checksum base images * - ``connection_uri`` = - - (StrOpt) Override the default libvirt URI (which is dependent on virt_type) + - (String) Override the default libvirt URI (which is dependent on virt_type) * - ``cpu_mode`` = ``None`` - - (StrOpt) Set to "host-model" to clone the host CPU feature flags; to "host-passthrough" to use the host CPU model exactly; to "custom" to use a named CPU model; to "none" to not set any CPU model. If virt_type="kvm|qemu", it will default to "host-model", otherwise it will default to "none" + - (String) Set to "host-model" to clone the host CPU feature flags; to "host-passthrough" to use the host CPU model exactly; to "custom" to use a named CPU model; to "none" to not set any CPU model. If virt_type="kvm|qemu", it will default to "host-model", otherwise it will default to "none" * - ``cpu_model`` = ``None`` - - (StrOpt) Set to a named libvirt CPU model (see names listed in /usr/share/libvirt/cpu_map.xml). Only has effect if cpu_mode="custom" and virt_type="kvm|qemu" + - (String) Set to a named libvirt CPU model (see names listed in /usr/share/libvirt/cpu_map.xml). Only has effect if cpu_mode="custom" and virt_type="kvm|qemu" * - ``disk_cachemodes`` = - - (ListOpt) Specific cachemodes to use for different disk types e.g: file=directsync,block=none + - (List) Specific cachemodes to use for different disk types e.g: file=directsync,block=none * - ``disk_prefix`` = ``None`` - - (StrOpt) Override the default disk prefix for the devices attached to a server, which is dependent on virt_type. (valid options are: sd, xvd, uvd, vd) + - (String) Override the default disk prefix for the devices attached to a server, which is dependent on virt_type. (valid options are: sd, xvd, uvd, vd) * - ``gid_maps`` = - - (ListOpt) List of guid targets and ranges.Syntax is guest-gid:host-gid:countMaximum of 5 allowed. + - (List) List of guid targets and ranges.Syntax is guest-gid:host-gid:countMaximum of 5 allowed. * - ``hw_disk_discard`` = ``None`` - - (StrOpt) Discard option for nova managed disks. Need Libvirt(1.0.6) Qemu1.5 (raw format) Qemu1.6(qcow2 format) + - (String) Discard option for nova managed disks. Need Libvirt(1.0.6) Qemu1.5 (raw format) Qemu1.6(qcow2 format) * - ``hw_machine_type`` = ``None`` - - (ListOpt) For qemu or KVM guests, set this option to specify a default machine type per host architecture. You can find a list of supported machine types in your environment by checking the output of the "virsh capabilities"command. The format of the value for this config option is host-arch=machine-type. For example: x86_64=machinetype1,armv7l=machinetype2 + - (List) For qemu or KVM guests, set this option to specify a default machine type per host architecture. You can find a list of supported machine types in your environment by checking the output of the "virsh capabilities"command. The format of the value for this config option is host-arch=machine-type. For example: x86_64=machinetype1,armv7l=machinetype2 * - ``image_info_filename_pattern`` = ``$instances_path/$image_cache_subdirectory_name/%(image)s.info`` - - (StrOpt) Allows image information files to be stored in non-standard locations + - (String) Allows image information files to be stored in non-standard locations * - ``images_rbd_ceph_conf`` = - - (StrOpt) Path to the ceph configuration file to use + - (String) Path to the ceph configuration file to use * - ``images_rbd_pool`` = ``rbd`` - - (StrOpt) The RADOS pool in which rbd volumes are stored + - (String) The RADOS pool in which rbd volumes are stored * - ``images_type`` = ``default`` - - (StrOpt) VM Images format. If default is specified, then use_cow_images flag is used instead of this one. + - (String) VM Images format. If default is specified, then use_cow_images flag is used instead of this one. * - ``images_volume_group`` = ``None`` - - (StrOpt) LVM Volume Group that is used for VM images, when you specify images_type=lvm. + - (String) LVM Volume Group that is used for VM images, when you specify images_type=lvm. * - ``inject_key`` = ``False`` - - (BoolOpt) Inject the ssh public key at boot time + - (Boolean) Inject the ssh public key at boot time * - ``inject_partition`` = ``-2`` - - (IntOpt) The partition to inject to : -2 => disable, -1 => inspect (libguestfs only), 0 => not partitioned, >0 => partition number + - (Integer) The partition to inject to : -2 => disable, -1 => inspect (libguestfs only), 0 => not partitioned, >0 => partition number * - ``inject_password`` = ``False`` - - (BoolOpt) Inject the admin password at boot time, without an agent. + - (Boolean) Inject the admin password at boot time, without an agent. * - ``iscsi_iface`` = ``None`` - - (StrOpt) The iSCSI transport iface to use to connect to target in case offload support is desired. Default format is of the form . where is one of (be2iscsi, bnx2i, cxgb3i, cxgb4i, qla4xxx, ocs) and is the MAC address of the interface and can be generated via the iscsiadm -m iface command. Do not confuse the iscsi_iface parameter to be provided here with the actual transport name. + - (String) The iSCSI transport iface to use to connect to target in case offload support is desired. Default format is of the form . where is one of (be2iscsi, bnx2i, cxgb3i, cxgb4i, qla4xxx, ocs) and is the MAC address of the interface and can be generated via the iscsiadm -m iface command. Do not confuse the iscsi_iface parameter to be provided here with the actual transport name. * - ``iscsi_use_multipath`` = ``False`` - - (BoolOpt) Use multipath connection of the iSCSI or FC volume + - (Boolean) Use multipath connection of the iSCSI or FC volume * - ``iser_use_multipath`` = ``False`` - - (BoolOpt) Use multipath connection of the iSER volume + - (Boolean) Use multipath connection of the iSER volume * - ``mem_stats_period_seconds`` = ``10`` - - (IntOpt) A number of seconds to memory usage statistics period. Zero or negative value mean to disable memory usage statistics. + - (Integer) A number of seconds to memory usage statistics period. Zero or negative value mean to disable memory usage statistics. * - ``realtime_scheduler_priority`` = ``1`` - - (IntOpt) In a realtime host context vCPUs for guest will run in that scheduling priority. Priority depends on the host kernel (usually 1-99) + - (Integer) In a realtime host context vCPUs for guest will run in that scheduling priority. Priority depends on the host kernel (usually 1-99) * - ``remove_unused_kernels`` = ``True`` - - (BoolOpt) DEPRECATED: Should unused kernel images be removed? This is only safe to enable if all compute nodes have been updated to support this option (running Grizzly or newer level compute). This will be the default behavior in the 13.0.0 release. + - (Boolean) DEPRECATED: Should unused kernel images be removed? This is only safe to enable if all compute nodes have been updated to support this option (running Grizzly or newer level compute). This will be the default behavior in the 13.0.0 release. * - ``remove_unused_resized_minimum_age_seconds`` = ``3600`` - - (IntOpt) Unused resized base images younger than this will not be removed + - (Integer) Unused resized base images younger than this will not be removed * - ``rescue_image_id`` = ``None`` - - (StrOpt) Rescue ami image. This will not be used if an image id is provided by the user. + - (String) Rescue ami image. This will not be used if an image id is provided by the user. * - ``rescue_kernel_id`` = ``None`` - - (StrOpt) Rescue aki image + - (String) Rescue aki image * - ``rescue_ramdisk_id`` = ``None`` - - (StrOpt) Rescue ari image + - (String) Rescue ari image * - ``rng_dev_path`` = ``None`` - - (StrOpt) A path to a device that will be used as source of entropy on the host. Permitted options are: /dev/random or /dev/hwrng + - (String) A path to a device that will be used as source of entropy on the host. Permitted options are: /dev/random or /dev/hwrng * - ``snapshot_compression`` = ``False`` - - (BoolOpt) Compress snapshot images when possible. This currently applies exclusively to qcow2 images + - (Boolean) Compress snapshot images when possible. This currently applies exclusively to qcow2 images * - ``snapshot_image_format`` = ``None`` - - (StrOpt) Snapshot image format. Defaults to same as source image + - (String) Snapshot image format. Defaults to same as source image * - ``snapshots_directory`` = ``$instances_path/snapshots`` - - (StrOpt) Location where libvirt driver will store snapshots before uploading them to image service + - (String) Location where libvirt driver will store snapshots before uploading them to image service * - ``sparse_logical_volumes`` = ``False`` - - (BoolOpt) Create sparse logical volumes (with virtualsize) if this flag is set to True. + - (Boolean) Create sparse logical volumes (with virtualsize) if this flag is set to True. * - ``sysinfo_serial`` = ``auto`` - - (StrOpt) The data source used to the populate the host "serial" UUID exposed to guest in the virtual BIOS. + - (String) The data source used to the populate the host "serial" UUID exposed to guest in the virtual BIOS. * - ``uid_maps`` = - - (ListOpt) List of uid targets and ranges.Syntax is guest-uid:host-uid:countMaximum of 5 allowed. + - (List) List of uid targets and ranges.Syntax is guest-uid:host-uid:countMaximum of 5 allowed. * - ``use_usb_tablet`` = ``True`` - - (BoolOpt) Sync virtual and real mouse cursors in Windows VMs + - (Boolean) Sync virtual and real mouse cursors in Windows VMs * - ``use_virtio_for_bridges`` = ``True`` - - (BoolOpt) Use virtio for bridge interfaces with KVM/QEMU + - (Boolean) Use virtio for bridge interfaces with KVM/QEMU * - ``virt_type`` = ``kvm`` - - (StrOpt) Libvirt domain type + - (String) Libvirt domain type * - ``volume_clear`` = ``zero`` - - (StrOpt) Method used to wipe old volumes. + - (String) Method used to wipe old volumes. * - ``volume_clear_size`` = ``0`` - - (IntOpt) Size in MiB to wipe at start of old volumes. 0 => all + - (Integer) Size in MiB to wipe at start of old volumes. 0 => all * - ``wait_soft_reboot_seconds`` = ``120`` - - (IntOpt) Number of seconds to wait for instance to shut down after soft reboot request is made. We fall back to hard reboot if instance does not shutdown within this window. + - (Integer) Number of seconds to wait for instance to shut down after soft reboot request is made. We fall back to hard reboot if instance does not shutdown within this window. diff --git a/doc/config-reference/source/tables/nova-livemigration.rst b/doc/config-reference/source/tables/nova-livemigration.rst index fe447861db..bb1348dc76 100644 --- a/doc/config-reference/source/tables/nova-livemigration.rst +++ b/doc/config-reference/source/tables/nova-livemigration.rst @@ -19,28 +19,28 @@ * - **[DEFAULT]** - * - ``live_migration_retry_count`` = ``30`` - - (IntOpt) Number of 1 second retries needed in live_migration + - (Integer) Number of 1 second retries needed in live_migration * - ``max_concurrent_live_migrations`` = ``1`` - - (IntOpt) Maximum number of live migrations to run concurrently. This limit is enforced to avoid outbound live migrations overwhelming the host/network and causing failures. It is not recommended that you change this unless you are very sure that doing so is safe and stable in your environment. + - (Integer) Maximum number of live migrations to run concurrently. This limit is enforced to avoid outbound live migrations overwhelming the host/network and causing failures. It is not recommended that you change this unless you are very sure that doing so is safe and stable in your environment. * - **[libvirt]** - * - ``live_migration_bandwidth`` = ``0`` - - (IntOpt) Maximum bandwidth(in MiB/s) to be used during migration. If set to 0, will choose a suitable default. Some hypervisors do not support this feature and will return an error if bandwidth is not 0. Please refer to the libvirt documentation for further details + - (Integer) Maximum bandwidth(in MiB/s) to be used during migration. If set to 0, will choose a suitable default. Some hypervisors do not support this feature and will return an error if bandwidth is not 0. Please refer to the libvirt documentation for further details * - ``live_migration_completion_timeout`` = ``800`` - - (IntOpt) Time to wait, in seconds, for migration to successfully complete transferring data before aborting the operation. Value is per GiB of guest RAM + disk to be transferred, with lower bound of a minimum of 2 GiB. Should usually be larger than downtime delay * downtime steps. Set to 0 to disable timeouts. + - (Integer) Time to wait, in seconds, for migration to successfully complete transferring data before aborting the operation. Value is per GiB of guest RAM + disk to be transferred, with lower bound of a minimum of 2 GiB. Should usually be larger than downtime delay * downtime steps. Set to 0 to disable timeouts. * - ``live_migration_downtime`` = ``500`` - - (IntOpt) Maximum permitted downtime, in milliseconds, for live migration switchover. Will be rounded up to a minimum of 100ms. Use a large value if guest liveness is unimportant. + - (Integer) Maximum permitted downtime, in milliseconds, for live migration switchover. Will be rounded up to a minimum of 100ms. Use a large value if guest liveness is unimportant. * - ``live_migration_downtime_delay`` = ``75`` - - (IntOpt) Time to wait, in seconds, between each step increase of the migration downtime. Minimum delay is 10 seconds. Value is per GiB of guest RAM + disk to be transferred, with lower bound of a minimum of 2 GiB per device + - (Integer) Time to wait, in seconds, between each step increase of the migration downtime. Minimum delay is 10 seconds. Value is per GiB of guest RAM + disk to be transferred, with lower bound of a minimum of 2 GiB per device * - ``live_migration_downtime_steps`` = ``10`` - - (IntOpt) Number of incremental steps to reach max downtime value. Will be rounded up to a minimum of 3 steps + - (Integer) Number of incremental steps to reach max downtime value. Will be rounded up to a minimum of 3 steps * - ``live_migration_flag`` = ``VIR_MIGRATE_UNDEFINE_SOURCE, VIR_MIGRATE_PEER2PEER, VIR_MIGRATE_LIVE, VIR_MIGRATE_TUNNELLED`` - - (StrOpt) Migration flags to be set for live migration + - (String) DEPRECATED: Migration flags to be set for live migration The correct live migration flags can be inferred from the new live_migration_tunnelled config option. live_migration_flag will be removed to avoid potential misconfiguration. * - ``live_migration_inbound_addr`` = ``None`` - - (StrOpt) Live migration target ip or hostname (if this option is set to be None,the hostname of the migration targetcompute node will be used) + - (String) Live migration target ip or hostname (if this option is set to None, which is the default, the hostname of the migration target compute node will be used) * - ``live_migration_progress_timeout`` = ``150`` - - (IntOpt) Time to wait, in seconds, for migration to make forward progress in transferring data before aborting the operation. Set to 0 to disable timeouts. + - (Integer) Time to wait, in seconds, for migration to make forward progress in transferring data before aborting the operation. Set to 0 to disable timeouts. * - ``live_migration_tunnelled`` = ``None`` - - (BoolOpt) Whether to use tunnelled migration, where migration data is transported over the libvirtd connection. If True, we use the VIR_MIGRATE_TUNNELLED migration flag, avoiding the need to configure the network to allow direct hypervisor to hypervisor communication. If False, use the native transport. If not set, Nova will choose a sensible default based on, for example the availability of native encryption support in the hypervisor. + - (Boolean) Whether to use tunnelled migration, where migration data is transported over the libvirtd connection. If True, we use the VIR_MIGRATE_TUNNELLED migration flag, avoiding the need to configure the network to allow direct hypervisor to hypervisor communication. If False, use the native transport. If not set, Nova will choose a sensible default based on, for example the availability of native encryption support in the hypervisor. * - ``live_migration_uri`` = ``None`` - - (StrOpt) Override the default libvirt live migration target URI (which is dependent on virt_type) (any included "%s" is replaced with the migration target hostname) + - (String) Override the default libvirt live migration target URI (which is dependent on virt_type) (any included "%s" is replaced with the migration target hostname) diff --git a/doc/config-reference/source/tables/nova-logging.rst b/doc/config-reference/source/tables/nova-logging.rst index 0233651662..5c897f6d4e 100644 --- a/doc/config-reference/source/tables/nova-logging.rst +++ b/doc/config-reference/source/tables/nova-logging.rst @@ -19,46 +19,44 @@ * - **[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. * - ``fatal_exception_format_errors`` = ``False`` - - (BoolOpt) Make exception message format errors fatal + - (Boolean) Make exception message format errors fatal * - ``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. diff --git a/doc/config-reference/source/tables/nova-metadata.rst b/doc/config-reference/source/tables/nova-metadata.rst index 464c62aa88..2ddc481d13 100644 --- a/doc/config-reference/source/tables/nova-metadata.rst +++ b/doc/config-reference/source/tables/nova-metadata.rst @@ -19,20 +19,20 @@ * - **[DEFAULT]** - * - ``metadata_cache_expiration`` = ``15`` - - (IntOpt) Time in seconds to cache metadata; 0 to disable metadata caching entirely (not recommended). Increasingthis should improve response times of the metadata API when under heavy load. Higher values may increase memoryusage and result in longer times for host metadata changes to take effect. + - (Integer) Time in seconds to cache metadata; 0 to disable metadata caching entirely (not recommended). Increasingthis should improve response times of the metadata API when under heavy load. Higher values may increase memoryusage and result in longer times for host metadata changes to take effect. * - ``metadata_host`` = ``$my_ip`` - - (StrOpt) The IP address for the metadata API server + - (String) The IP address for the metadata API server * - ``metadata_listen`` = ``0.0.0.0`` - - (StrOpt) The IP address on which the metadata API will listen. + - (String) The IP address on which the metadata API will listen. * - ``metadata_listen_port`` = ``8775`` - - (IntOpt) The port on which the metadata API will listen. + - (Integer) The port on which the metadata API will listen. * - ``metadata_manager`` = ``nova.api.manager.MetadataManager`` - - (StrOpt) OpenStack metadata service manager + - (String) DEPRECATED: OpenStack metadata service manager * - ``metadata_port`` = ``8775`` - - (IntOpt) The port for the metadata API port + - (Integer) The port for the metadata API port * - ``metadata_workers`` = ``None`` - - (IntOpt) Number of workers for metadata service. The default will be the number of CPUs available. + - (Integer) Number of workers for metadata service. The default will be the number of CPUs available. * - ``vendordata_driver`` = ``nova.api.metadata.vendordata_json.JsonFileVendorData`` - - (StrOpt) Driver to use for vendor data + - (String) DEPRECATED: Driver to use for vendor data * - ``vendordata_jsonfile_path`` = ``None`` - - (StrOpt) File to load JSON formatted vendor data from + - (String) File to load JSON formatted vendor data from diff --git a/doc/config-reference/source/tables/nova-network.rst b/doc/config-reference/source/tables/nova-network.rst index 7394d8eecb..015b12bf9f 100644 --- a/doc/config-reference/source/tables/nova-network.rst +++ b/doc/config-reference/source/tables/nova-network.rst @@ -19,130 +19,132 @@ * - **[DEFAULT]** - * - ``allow_same_net_traffic`` = ``True`` - - (BoolOpt) Whether to allow network traffic from same network + - (Boolean) Determine whether to allow network traffic from same network. When set to true, hosts on the same subnet are not filtered and are allowed to pass all types of traffic between them. On a flat network, this allows all instances from all projects unfiltered communication. With VLAN networking, this allows access between instances within the same project. This option only applies when using the ``nova-network`` service. When using another networking services, such as Neutron, security groups or other approaches should be used. Possible values: * True: Network traffic should be allowed pass between all instances on the same network, regardless of their tenant and security policies * False: Network traffic should not be allowed pass between instances unless it is unblocked in a security group Services which consume this: * nova-network Interdependencies to other options: * ``use_neutron``: This must be set to ``False`` to enable ``nova-network`` networking * ``firewall_driver``: This must be set to ``nova.virt.libvirt.firewall.IptablesFirewallDriver`` to ensure the libvirt firewall driver is enabled. * - ``auto_assign_floating_ip`` = ``False`` - - (BoolOpt) Autoassigning floating IP to VM + - (Boolean) Autoassigning floating IP to VM * - ``cnt_vpn_clients`` = ``0`` - - (IntOpt) Number of addresses reserved for vpn clients + - (Integer) Number of addresses reserved for vpn clients * - ``create_unique_mac_address_attempts`` = ``5`` - - (IntOpt) Number of attempts to create unique mac address + - (Integer) Number of attempts to create unique mac address * - ``default_access_ip_network_name`` = ``None`` - - (StrOpt) Name of network to use to set access IPs for instances + - (String) Name of network to use to set access IPs for instances * - ``default_floating_pool`` = ``nova`` - - (StrOpt) Default pool for floating IPs + - (String) Default pool for floating IPs * - ``defer_iptables_apply`` = ``False`` - - (BoolOpt) Whether to batch up the application of IPTables rules during a host restart and apply all at the end of the init phase + - (Boolean) Whether to batch up the application of IPTables rules during a host restart and apply all at the end of the init phase * - ``dhcp_domain`` = ``novalocal`` - - (StrOpt) Domain to use for building the hostnames + - (String) Domain to use for building the hostnames * - ``dhcp_lease_time`` = ``86400`` - - (IntOpt) Lifetime of a DHCP lease in seconds + - (Integer) Lifetime of a DHCP lease in seconds * - ``dhcpbridge`` = ``$bindir/nova-dhcpbridge`` - - (StrOpt) Location of nova-dhcpbridge + - (String) Location of nova-dhcpbridge * - ``dhcpbridge_flagfile`` = ``['/etc/nova/nova-dhcpbridge.conf']`` - - (MultiStrOpt) Location of flagfiles for dhcpbridge + - (Multi-valued) Location of flagfiles for dhcpbridge * - ``dns_server`` = ``[]`` - - (MultiStrOpt) If set, uses specific DNS server for dnsmasq. Can be specified multiple times. + - (Multi-valued) If set, uses specific DNS server for dnsmasq. Can be specified multiple times. * - ``dns_update_periodic_interval`` = ``-1`` - - (IntOpt) Number of seconds to wait between runs of updates to DNS entries. + - (Integer) Number of seconds to wait between runs of updates to DNS entries. * - ``dnsmasq_config_file`` = - - (StrOpt) Override the default dnsmasq settings with this file + - (String) Override the default dnsmasq settings with this file * - ``ebtables_exec_attempts`` = ``3`` - - (IntOpt) Number of times to retry ebtables commands on failure. + - (Integer) Number of times to retry ebtables commands on failure. * - ``ebtables_retry_interval`` = ``1.0`` - - (FloatOpt) Number of seconds to wait between ebtables retries. + - (Floating point) Number of seconds to wait between ebtables retries. * - ``firewall_driver`` = ``None`` - - (StrOpt) Firewall driver (defaults to hypervisor specific iptables driver) + - (String) Firewall driver to use with ``nova-network`` service. This option only applies when using the ``nova-network`` service. When using another networking services, such as Neutron, this should be to set to the ``NoopFirewallDriver``. If unset (the default), this will default to the hypervisor-specified default driver. Possible values: * nova.virt.firewall.IptablesFirewallDriver * nova.virt.firewall.NoopFirewallDriver * nova.virt.libvirt.firewall.IptablesFirewallDriver * [...] Services which consume this: * nova-network Interdependencies to other options: * ``use_neutron``: This must be set to ``False`` to enable ``nova-network`` networking * - ``fixed_ip_disassociate_timeout`` = ``600`` - - (IntOpt) Seconds after which a deallocated IP is disassociated + - (Integer) Seconds after which a deallocated IP is disassociated * - ``flat_injected`` = ``False`` - - (BoolOpt) Whether to attempt to inject network setup into guest + - (Boolean) Whether to attempt to inject network setup into guest * - ``flat_interface`` = ``None`` - - (StrOpt) FlatDhcp will bridge into this interface if set + - (String) FlatDhcp will bridge into this interface if set * - ``flat_network_bridge`` = ``None`` - - (StrOpt) Bridge for simple network instances + - (String) Bridge for simple network instances * - ``flat_network_dns`` = ``8.8.4.4`` - - (StrOpt) DNS server for simple network + - (String) DNS server for simple network * - ``floating_ip_dns_manager`` = ``nova.network.noop_dns_driver.NoopDNSDriver`` - - (StrOpt) Full class name for the DNS Manager for floating IPs + - (String) Full class name for the DNS Manager for floating IPs * - ``force_dhcp_release`` = ``True`` - - (BoolOpt) If True, send a dhcp release on instance termination + - (Boolean) If True, send a dhcp release on instance termination * - ``force_snat_range`` = ``[]`` - - (MultiStrOpt) Traffic to this range will always be snatted to the fallback IP, even if it would normally be bridged out of the node. Can be specified multiple times. + - (Multi-valued) Traffic to this range will always be snatted to the fallback IP, even if it would normally be bridged out of the node. Can be specified multiple times. * - ``forward_bridge_interface`` = ``['all']`` - - (MultiStrOpt) An interface that bridges can forward to. If this is set to all then all traffic will be forwarded. Can be specified multiple times. + - (Multi-valued) An interface that bridges can forward to. If this is set to all then all traffic will be forwarded. Can be specified multiple times. * - ``gateway`` = ``None`` - - (StrOpt) Default IPv4 gateway + - (String) Default IPv4 gateway * - ``injected_network_template`` = ``$pybasedir/nova/virt/interfaces.template`` - - (StrOpt) Template file for injected network + - (String) Template file for injected network * - ``instance_dns_domain`` = - - (StrOpt) Full class name for the DNS Zone for instance IPs + - (String) Full class name for the DNS Zone for instance IPs * - ``instance_dns_manager`` = ``nova.network.noop_dns_driver.NoopDNSDriver`` - - (StrOpt) Full class name for the DNS Manager for instance IPs + - (String) Full class name for the DNS Manager for instance IPs * - ``iptables_bottom_regex`` = - - (StrOpt) Regular expression to match the iptables rule that should always be on the bottom. + - (String) Regular expression to match the iptables rule that should always be on the bottom. * - ``iptables_drop_action`` = ``DROP`` - - (StrOpt) The table that iptables to jump to when a packet is to be dropped. + - (String) The table that iptables to jump to when a packet is to be dropped. * - ``iptables_top_regex`` = - - (StrOpt) Regular expression to match the iptables rule that should always be on the top. + - (String) Regular expression to match the iptables rule that should always be on the top. * - ``l3_lib`` = ``nova.network.l3.LinuxNetL3`` - - (StrOpt) Indicates underlying L3 management library + - (String) Indicates underlying L3 management library * - ``linuxnet_interface_driver`` = ``nova.network.linux_net.LinuxBridgeInterfaceDriver`` - - (StrOpt) Driver used to create ethernet devices. + - (String) Driver used to create ethernet devices. * - ``linuxnet_ovs_integration_bridge`` = ``br-int`` - - (StrOpt) Name of Open vSwitch bridge used with linuxnet + - (String) Name of Open vSwitch bridge used with linuxnet * - ``multi_host`` = ``False`` - - (BoolOpt) Default value for multi_host in networks. Also, if set, some rpc network calls will be sent directly to host. + - (Boolean) Default value for multi_host in networks. Also, if set, some rpc network calls will be sent directly to host. * - ``network_allocate_retries`` = ``0`` - - (IntOpt) Number of times to retry network allocation on failures + - (Integer) Number of times to retry network allocation on failures * - ``network_api_class`` = ``nova.network.api.API`` - - (StrOpt) The full class name of the network API class to use + - (String) DEPRECATED: The full class name of the network API class to use. ``use_neutron`` should be used instead. * - ``network_device_mtu`` = ``None`` - - (IntOpt) DEPRECATED: THIS VALUE SHOULD BE SET WHEN CREATING THE NETWORK. MTU setting for network interface. + - (Integer) DEPRECATED: THIS VALUE SHOULD BE SET WHEN CREATING THE NETWORK. MTU setting for network interface. * - ``network_driver`` = ``nova.network.linux_net`` - - (StrOpt) Driver to use for network creation + - (String) Driver to use for network creation * - ``network_manager`` = ``nova.network.manager.VlanManager`` - - (StrOpt) Full class name for the Manager for network + - (String) Full class name for the Manager for network * - ``network_size`` = ``256`` - - (IntOpt) Number of addresses in each private subnet + - (Integer) Number of addresses in each private subnet * - ``network_topic`` = ``network`` - - (StrOpt) The topic network nodes listen on + - (String) The topic network nodes listen on * - ``networks_path`` = ``$state_path/networks`` - - (StrOpt) Location to keep network config files + - (String) Location to keep network config files * - ``num_networks`` = ``1`` - - (IntOpt) Number of networks to support + - (Integer) Number of networks to support * - ``ovs_vsctl_timeout`` = ``120`` - - (IntOpt) Amount of time, in seconds, that ovs_vsctl should wait for a response from the database. 0 is to wait forever. + - (Integer) Amount of time, in seconds, that ovs_vsctl should wait for a response from the database. 0 is to wait forever. * - ``public_interface`` = ``eth0`` - - (StrOpt) Interface for public IP addresses + - (String) Interface for public IP addresses * - ``routing_source_ip`` = ``$my_ip`` - - (StrOpt) Public IP of network host + - (String) Public IP of network host * - ``security_group_api`` = ``nova`` - - (StrOpt) The full class name of the security API class + - (String) DEPRECATED: The full class name of the security API class * - ``send_arp_for_ha`` = ``False`` - - (BoolOpt) Send gratuitous ARPs for HA setup + - (Boolean) Send gratuitous ARPs for HA setup * - ``send_arp_for_ha_count`` = ``3`` - - (IntOpt) Send this many gratuitous ARPs for HA setup + - (Integer) Send this many gratuitous ARPs for HA setup * - ``share_dhcp_address`` = ``False`` - - (BoolOpt) DEPRECATED: THIS VALUE SHOULD BE SET WHEN CREATING THE NETWORK. If True in multi_host mode, all compute hosts share the same dhcp address. The same IP address used for DHCP will be added on each nova-network node which is only visible to the vms on the same host. + - (Boolean) DEPRECATED: THIS VALUE SHOULD BE SET WHEN CREATING THE NETWORK. If True in multi_host mode, all compute hosts share the same dhcp address. The same IP address used for DHCP will be added on each nova-network node which is only visible to the vms on the same host. * - ``teardown_unused_network_gateway`` = ``False`` - - (BoolOpt) If True, unused gateway devices (VLAN and bridge) are deleted in VLAN network mode with multi hosted networks + - (Boolean) If True, unused gateway devices (VLAN and bridge) are deleted in VLAN network mode with multi hosted networks * - ``update_dns_entries`` = ``False`` - - (BoolOpt) If True, when a DNS entry must be updated, it sends a fanout cast to all network hosts to update their DNS entries in multi host mode + - (Boolean) If True, when a DNS entry must be updated, it sends a fanout cast to all network hosts to update their DNS entries in multi host mode * - ``use_network_dns_servers`` = ``False`` - - (BoolOpt) If set, uses the dns1 and dns2 from the network ref. as dns servers. + - (Boolean) If set, uses the dns1 and dns2 from the network ref. as dns servers. + * - ``use_neutron`` = ``False`` + - (Boolean) Whether to use Neutron or Nova Network as the back end for networking. Defaults to False (indicating Nova network). Set to True to use neutron. * - ``use_neutron_default_nets`` = ``False`` - - (StrOpt) Control for checking for default networks + - (String) Control for checking for default networks * - ``use_single_default_gateway`` = ``False`` - - (BoolOpt) Use single default gateway. Only first nic of vm will get default gateway from dhcp server + - (Boolean) Use single default gateway. Only first nic of vm will get default gateway from dhcp server * - ``vlan_interface`` = ``None`` - - (StrOpt) VLANs will bridge into this interface if set + - (String) VLANs will bridge into this interface if set * - ``vlan_start`` = ``100`` - - (IntOpt) First VLAN for private networks + - (Integer) First VLAN for private networks * - **[libvirt]** - * - ``remote_filesystem_transport`` = ``ssh`` - - (StrOpt) Use ssh or rsync transport for creating, copying, removing files on the remote host. + - (String) Use ssh or rsync transport for creating, copying, removing files on the remote host. * - **[vmware]** - * - ``vlan_interface`` = ``vmnic0`` - - (StrOpt) Physical ethernet adapter name for vlan networking + - (String) Physical ethernet adapter name for vlan networking diff --git a/doc/config-reference/source/tables/nova-neutron.rst b/doc/config-reference/source/tables/nova-neutron.rst index 75dc448918..956410d3f8 100644 --- a/doc/config-reference/source/tables/nova-neutron.rst +++ b/doc/config-reference/source/tables/nova-neutron.rst @@ -19,32 +19,32 @@ * - **[DEFAULT]** - * - ``neutron_default_tenant_id`` = ``default`` - - (StrOpt) Default tenant id when creating neutron networks + - (String) Default tenant id when creating neutron networks * - **[neutron]** - * - ``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 * - ``extension_sync_interval`` = ``600`` - - (IntOpt) Number of seconds before querying neutron for extensions + - (Integer) Number of seconds before querying neutron for extensions * - ``insecure`` = ``False`` - - (BoolOpt) Verify HTTPS connections. + - (Boolean) Verify HTTPS connections. * - ``keyfile`` = ``None`` - - (StrOpt) PEM encoded client certificate key file + - (String) PEM encoded client certificate key file * - ``metadata_proxy_shared_secret`` = - - (StrOpt) Shared secret to validate proxies Neutron metadata requests + - (String) Shared secret to validate proxies Neutron metadata requests * - ``ovs_bridge`` = ``br-int`` - - (StrOpt) Default OVS bridge name to use if not specified by Neutron + - (String) Default OVS bridge name to use if not specified by Neutron * - ``region_name`` = ``None`` - - (StrOpt) Region name for connecting to neutron in admin context + - (String) Region name for connecting to neutron in admin context * - ``service_metadata_proxy`` = ``False`` - - (BoolOpt) Set flag to indicate Neutron will proxy metadata requests and resolve instance ids. + - (Boolean) Set flag to indicate Neutron will proxy metadata requests and resolve instance ids. * - ``timeout`` = ``None`` - - (IntOpt) Timeout value for http requests + - (Integer) Timeout value for http requests * - ``url`` = ``http://127.0.0.1:9696`` - - (StrOpt) URL for connecting to neutron + - (String) URL for connecting to neutron diff --git a/doc/config-reference/source/tables/nova-pci.rst b/doc/config-reference/source/tables/nova-pci.rst index 04f642cf43..3c99dfbd35 100644 --- a/doc/config-reference/source/tables/nova-pci.rst +++ b/doc/config-reference/source/tables/nova-pci.rst @@ -19,6 +19,6 @@ * - **[DEFAULT]** - * - ``pci_alias`` = ``[]`` - - (MultiStrOpt) An alias for a PCI passthrough device requirement. This allows users to specify the alias in the extra_spec for a flavor, without needing to repeat all the PCI property requirements. For example: pci_alias = { "name": "QuickAssist", "product_id": "0443", "vendor_id": "8086", "device_type": "type-PCI" } defines an alias for the Intel QuickAssist card. (multi valued). + - (Multi-valued) An alias for a PCI passthrough device requirement. This allows users to specify the alias in the extra_spec for a flavor, without needing to repeat all the PCI property requirements. Possible Values: * A list of JSON values which describe the aliases. For example: pci_alias = { "name": "QuickAssist", "product_id": "0443", "vendor_id": "8086", "device_type": "type-PCI" } defines an alias for the Intel QuickAssist card. (multi valued). Valid key values are : * "name" * "product_id" * "vendor_id" * "device_type" Services which consume this: * nova-compute Related options: * None * - ``pci_passthrough_whitelist`` = ``[]`` - - (MultiStrOpt) White list of PCI devices available to VMs. For example: pci_passthrough_whitelist = [{"vendor_id": "8086", "product_id": "0443"}] + - (Multi-valued) White list of PCI devices available to VMs. Possible values: * A JSON dictionary which describe a whitelisted PCI device. It should take the following format: ["device_id": "",] ["product_id": "",] ["address": "[[[[]:]]:][][.[]]" | "devname": "PCI Device Name",] {"tag": "",} where '[' indicates zero or one occurrences, '{' indicates zero or multiple occurrences, and '|' mutually exclusive options. Note that any missing fields are automatically wildcarded. Valid examples are: pci_passthrough_whitelist = {"devname":"eth0", "physical_network":"physnet"} pci_passthrough_whitelist = {"address":"*:0a:00.*"} pci_passthrough_whitelist = {"address":":0a:00.", "physical_network":"physnet1"} pci_passthrough_whitelist = {"vendor_id":"1137", "product_id":"0071"} pci_passthrough_whitelist = {"vendor_id":"1137", "product_id":"0071", "address": "0000:0a:00.1", "physical_network":"physnet1"} The following are invalid, as they specify mutually exclusive options: pci_passthrough_whitelist = {"devname":"eth0", "physical_network":"physnet", "address":"*:0a:00.*"} * A JSON list of JSON dictionaries corresponding to the above format. For example: pci_passthrough_whitelist = [{"product_id":"0001", "vendor_id":"8086"}, {"product_id":"0002", "vendor_id":"8086"}] Services which consume this: * nova-compute Related options: * None diff --git a/doc/config-reference/source/tables/nova-periodic.rst b/doc/config-reference/source/tables/nova-periodic.rst index b7c836702b..8fd49b054b 100644 --- a/doc/config-reference/source/tables/nova-periodic.rst +++ b/doc/config-reference/source/tables/nova-periodic.rst @@ -19,6 +19,6 @@ * - **[DEFAULT]** - * - ``periodic_enable`` = ``True`` - - (BoolOpt) Enable periodic tasks + - (Boolean) Enable periodic tasks * - ``periodic_fuzzy_delay`` = ``60`` - - (IntOpt) Range of seconds to randomly delay when starting the periodic task scheduler to reduce stampeding. (Disable by setting to 0) + - (Integer) Range of seconds to randomly delay when starting the periodic task scheduler to reduce stampeding. (Disable by setting to 0) diff --git a/doc/config-reference/source/tables/nova-policy.rst b/doc/config-reference/source/tables/nova-policy.rst index e98757db77..c92bef4b20 100644 --- a/doc/config-reference/source/tables/nova-policy.rst +++ b/doc/config-reference/source/tables/nova-policy.rst @@ -19,30 +19,30 @@ * - **[DEFAULT]** - * - ``allow_instance_snapshots`` = ``True`` - - (BoolOpt) Permit instance snapshot operations. + - (Boolean) Permit instance snapshot operations. * - ``allow_resize_to_same_host`` = ``False`` - - (BoolOpt) Allow destination machine to match source for resize. Useful when testing in single-host environments. + - (Boolean) Allow destination machine to match source for resize. Useful when testing in single-host environments. * - ``max_age`` = ``0`` - - (IntOpt) Number of seconds between subsequent usage refreshes. This defaults to 0(off) to avoid additional load but it is useful to turn on to help keep quota usage up to date and reduce the impact of out of sync usage issues. Note that quotas are not updated on a periodic task, they will update on a new reservation if max_age has passed since the last reservation + - (Integer) Number of seconds between subsequent usage refreshes. This defaults to 0(off) to avoid additional load but it is useful to turn on to help keep quota usage up to date and reduce the impact of out of sync usage issues. Note that quotas are not updated on a periodic task, they will update on a new reservation if max_age has passed since the last reservation * - ``max_local_block_devices`` = ``3`` - - (IntOpt) Maximum number of devices that will result in a local image being created on the hypervisor node. A negative number means unlimited. Setting max_local_block_devices to 0 means that any request that attempts to create a local disk will fail. This option is meant to limit the number of local discs (so root local disc that is the result of --image being used, and any other ephemeral and swap disks). 0 does not mean that images will be automatically converted to volumes and boot instances from volumes - it just means that all requests that attempt to create a local disk will fail. + - (Integer) Maximum number of devices that will result in a local image being created on the hypervisor node. A negative number means unlimited. Setting max_local_block_devices to 0 means that any request that attempts to create a local disk will fail. This option is meant to limit the number of local discs (so root local disc that is the result of --image being used, and any other ephemeral and swap disks). 0 does not mean that images will be automatically converted to volumes and boot instances from volumes - it just means that all requests that attempt to create a local disk will fail. * - ``osapi_compute_unique_server_name_scope`` = - - (StrOpt) When set, compute API will consider duplicate hostnames invalid within the specified scope, regardless of case. Should be empty, "project" or "global". + - (String) When set, compute API will consider duplicate hostnames invalid within the specified scope, regardless of case. Should be empty, "project" or "global". * - ``osapi_max_limit`` = ``1000`` - - (IntOpt) The maximum number of items returned in a single response from a collection resource + - (Integer) The maximum number of items returned in a single response from a collection resource * - ``password_length`` = ``12`` - - (IntOpt) Length of generated instance admin passwords + - (Integer) Length of generated instance admin passwords * - ``reservation_expire`` = ``86400`` - - (IntOpt) Number of seconds until a reservation expires + - (Integer) Number of seconds until a reservation expires * - ``resize_fs_using_block_device`` = ``False`` - - (BoolOpt) Attempt to resize the filesystem by accessing the image over a block device. This is done by the host and may not be necessary if the image contains a recent version of cloud-init. Possible mechanisms require the nbd driver (for qcow and raw), or loop (for raw). + - (Boolean) Attempt to resize the filesystem by accessing the image over a block device. This is done by the host and may not be necessary if the image contains a recent version of cloud-init. Possible mechanisms require the nbd driver (for qcow and raw), or loop (for raw). * - ``until_refresh`` = ``0`` - - (IntOpt) Count of reservations until usage is refreshed. This defaults to 0(off) to avoid additional load but it is useful to turn on to help keep quota usage up to date and reduce the impact of out of sync usage issues. + - (Integer) Count of reservations until usage is refreshed. This defaults to 0(off) to avoid additional load but it is useful to turn on to help keep quota usage up to date and reduce the impact of out of sync usage issues. * - **[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. diff --git a/doc/config-reference/source/tables/nova-quobyte.rst b/doc/config-reference/source/tables/nova-quobyte.rst index 718b540a40..f5215ed591 100644 --- a/doc/config-reference/source/tables/nova-quobyte.rst +++ b/doc/config-reference/source/tables/nova-quobyte.rst @@ -19,6 +19,6 @@ * - **[libvirt]** - * - ``quobyte_client_cfg`` = ``None`` - - (StrOpt) Path to a Quobyte Client configuration file. + - (String) Path to a Quobyte Client configuration file. * - ``quobyte_mount_point_base`` = ``$state_path/mnt`` - - (StrOpt) Directory where the Quobyte volume is mounted on the compute node + - (String) Directory where the Quobyte volume is mounted on the compute node diff --git a/doc/config-reference/source/tables/nova-quota.rst b/doc/config-reference/source/tables/nova-quota.rst index ae1065f34f..ed886d19d7 100644 --- a/doc/config-reference/source/tables/nova-quota.rst +++ b/doc/config-reference/source/tables/nova-quota.rst @@ -19,42 +19,42 @@ * - **[DEFAULT]** - * - ``bandwidth_poll_interval`` = ``600`` - - (IntOpt) Interval to pull network bandwidth usage info. Not supported on all hypervisors. Set to -1 to disable. Setting this to 0 will run at the default rate. + - (Integer) Interval to pull network bandwidth usage info. Not supported on all hypervisors. Set to -1 to disable. Setting this to 0 will run at the default rate. * - ``enable_network_quota`` = ``False`` - - (BoolOpt) Enables or disables quota checking for tenant networks + - (Boolean) Enables or disables quota checking for tenant networks * - ``quota_cores`` = ``20`` - - (IntOpt) Number of instance cores allowed per project + - (Integer) Number of instance cores allowed per project * - ``quota_driver`` = ``nova.quota.DbQuotaDriver`` - - (StrOpt) Default driver to use for quota checks + - (String) Default driver to use for quota checks * - ``quota_fixed_ips`` = ``-1`` - - (IntOpt) Number of fixed IPs allowed per project (this should be at least the number of instances allowed) + - (Integer) Number of fixed IPs allowed per project (this should be at least the number of instances allowed) * - ``quota_floating_ips`` = ``10`` - - (IntOpt) Number of floating IPs allowed per project + - (Integer) Number of floating IPs allowed per project * - ``quota_injected_file_content_bytes`` = ``10240`` - - (IntOpt) Number of bytes allowed per injected file + - (Integer) Number of bytes allowed per injected file * - ``quota_injected_file_path_length`` = ``255`` - - (IntOpt) Length of injected file path + - (Integer) Length of injected file path * - ``quota_injected_files`` = ``5`` - - (IntOpt) Number of injected files allowed + - (Integer) Number of injected files allowed * - ``quota_instances`` = ``10`` - - (IntOpt) Number of instances allowed per project + - (Integer) Number of instances allowed per project * - ``quota_key_pairs`` = ``100`` - - (IntOpt) Number of key pairs per user + - (Integer) Number of key pairs per user * - ``quota_metadata_items`` = ``128`` - - (IntOpt) Number of metadata items allowed per instance + - (Integer) Number of metadata items allowed per instance * - ``quota_networks`` = ``3`` - - (IntOpt) Number of private networks allowed per project + - (Integer) Number of private networks allowed per project * - ``quota_ram`` = ``51200`` - - (IntOpt) Megabytes of instance RAM allowed per project + - (Integer) Megabytes of instance RAM allowed per project * - ``quota_security_group_rules`` = ``20`` - - (IntOpt) Number of security rules per security group + - (Integer) Number of security rules per security group * - ``quota_security_groups`` = ``10`` - - (IntOpt) Number of security groups per project + - (Integer) Number of security groups per project * - ``quota_server_group_members`` = ``10`` - - (IntOpt) Number of servers per server group + - (Integer) Number of servers per server group * - ``quota_server_groups`` = ``10`` - - (IntOpt) Number of server groups per project + - (Integer) Number of server groups per project * - **[cells]** - * - ``bandwidth_update_interval`` = ``600`` - - (IntOpt) Bandwidth update interval Seconds between bandwidth usage cache updates for cells. Possible values: * Time in seconds. Services which consume this: * nova-compute Related options: * None + - (Integer) Bandwidth update interval Seconds between bandwidth usage cache updates for cells. Possible values: * Time in seconds. Services which consume this: * nova-compute Related options: * None diff --git a/doc/config-reference/source/tables/nova-rabbitmq.rst b/doc/config-reference/source/tables/nova-rabbitmq.rst index 6f3c855c75..3d64294d5a 100644 --- a/doc/config-reference/source/tables/nova-rabbitmq.rst +++ b/doc/config-reference/source/tables/nova-rabbitmq.rst @@ -19,58 +19,112 @@ * - **[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. + * - ``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 diff --git a/doc/config-reference/source/tables/nova-rdp.rst b/doc/config-reference/source/tables/nova-rdp.rst index d81eb25771..601c3718ad 100644 --- a/doc/config-reference/source/tables/nova-rdp.rst +++ b/doc/config-reference/source/tables/nova-rdp.rst @@ -19,6 +19,6 @@ * - **[rdp]** - * - ``enabled`` = ``False`` - - (BoolOpt) Enable RDP related features + - (Boolean) Enable RDP related features * - ``html5_proxy_base_url`` = ``http://127.0.0.1:6083/`` - - (StrOpt) Location of RDP html5 console proxy, in the form "http://127.0.0.1:6083/" + - (String) Location of RDP html5 console proxy, in the form "http://127.0.0.1:6083/" diff --git a/doc/config-reference/source/tables/nova-redis.rst b/doc/config-reference/source/tables/nova-redis.rst index 36394b571b..1fac92e949 100644 --- a/doc/config-reference/source/tables/nova-redis.rst +++ b/doc/config-reference/source/tables/nova-redis.rst @@ -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. diff --git a/doc/config-reference/source/tables/nova-rpc.rst b/doc/config-reference/source/tables/nova-rpc.rst index fcab698f51..6da07adc44 100644 --- a/doc/config-reference/source/tables/nova-rpc.rst +++ b/doc/config-reference/source/tables/nova-rpc.rst @@ -19,62 +19,74 @@ * - **[DEFAULT]** - * - ``notification_format`` = ``both`` - - (StrOpt) Specifies which notification format shall be used by nova. + - (String) Specifies which notification format shall be used by nova. * - ``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. * - **[cells]** - * - ``rpc_driver_queue_base`` = ``cells.intercell`` - - (StrOpt) RPC driver queue base When sending a message to another cell by JSON-ifying the message and making an RPC cast to 'process_message', a base queue is used. This option defines the base queue name to be used when communicating between cells. Various topics by message type will be appended to this. Possible values: * The base queue name to be used when communicating between cells. Services which consume this: * nova-cells Related options: * None + - (String) RPC driver queue base When sending a message to another cell by JSON-ifying the message and making an RPC cast to 'process_message', a base queue is used. This option defines the base queue name to be used when communicating between cells. Various topics by message type will be appended to this. Possible values: * The base queue name to be used when communicating between cells. Services which consume this: * nova-cells Related options: * None * - **[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]** + - + * - ``event_stream_topic`` = ``neutron_lbaas_event`` + - (String) topic name for receiving events from a queue * - **[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`` = ``[]`` + - (Multi-valued) The Drivers(s) to handle sending notifications. Possible values are messaging, messagingv2, routing, log, test, noop + * - ``topics`` = ``notifications`` + - (List) AMQP topic used for OpenStack notifications. + * - ``transport_url`` = ``None`` + - (String) A URL representing the messaging driver to use for notifications. If not set, we fall back to the same configuration used for RPC. * - **[upgrade_levels]** - * - ``baseapi`` = ``None`` - - (StrOpt) Set a version cap for messages sent to the base api in any service + - (String) Set a version cap for messages sent to the base api in any service diff --git a/doc/config-reference/source/tables/nova-s3.rst b/doc/config-reference/source/tables/nova-s3.rst index 9290559d3b..dfee9e1814 100644 --- a/doc/config-reference/source/tables/nova-s3.rst +++ b/doc/config-reference/source/tables/nova-s3.rst @@ -19,16 +19,16 @@ * - **[DEFAULT]** - * - ``image_decryption_dir`` = ``/tmp`` - - (StrOpt) Parent directory for tempdir used for image decryption + - (String) Parent directory for tempdir used for image decryption * - ``s3_access_key`` = ``notchecked`` - - (StrOpt) Access key to use for S3 server for images + - (String) Access key to use for S3 server for images * - ``s3_affix_tenant`` = ``False`` - - (BoolOpt) Whether to affix the tenant id to the access key when downloading from S3 + - (Boolean) Whether to affix the tenant id to the access key when downloading from S3 * - ``s3_host`` = ``$my_ip`` - - (StrOpt) Hostname or IP for OpenStack to use when accessing the S3 api + - (String) Hostname or IP for OpenStack to use when accessing the S3 api * - ``s3_port`` = ``3333`` - - (IntOpt) Port used when accessing the S3 api + - (Integer) Port used when accessing the S3 api * - ``s3_secret_key`` = ``notchecked`` - - (StrOpt) Secret key to use for S3 server for images + - (String) Secret key to use for S3 server for images * - ``s3_use_ssl`` = ``False`` - - (BoolOpt) Whether to use SSL when talking to S3 + - (Boolean) Whether to use SSL when talking to S3 diff --git a/doc/config-reference/source/tables/nova-scheduler.rst b/doc/config-reference/source/tables/nova-scheduler.rst index 94ab434795..5161897747 100644 --- a/doc/config-reference/source/tables/nova-scheduler.rst +++ b/doc/config-reference/source/tables/nova-scheduler.rst @@ -19,88 +19,88 @@ * - **[DEFAULT]** - * - ``aggregate_image_properties_isolation_namespace`` = ``None`` - - (StrOpt) Images and hosts can be configured so that certain images can only be scheduled to hosts in a particular aggregate. This is done with metadata values set on the host aggregate that are identified by beginning with the value of this option. If the host is part of an aggregate with such a metadata key, the image in the request spec must have the value of that metadata in its properties in order for the scheduler to consider the host as acceptable. Valid values are strings. This option is only used by the FilterScheduler and its subclasses; if you use a different scheduler, this option has no effect. Also note that this setting only affects scheduling if the 'aggregate_image_properties_isolation' filter is enabled. * Services that use this: ``nova-scheduler`` * Related options: aggregate_image_properties_isolation_separator + - (String) Images and hosts can be configured so that certain images can only be scheduled to hosts in a particular aggregate. This is done with metadata values set on the host aggregate that are identified by beginning with the value of this option. If the host is part of an aggregate with such a metadata key, the image in the request spec must have the value of that metadata in its properties in order for the scheduler to consider the host as acceptable. Valid values are strings. This option is only used by the FilterScheduler and its subclasses; if you use a different scheduler, this option has no effect. Also note that this setting only affects scheduling if the 'aggregate_image_properties_isolation' filter is enabled. * Services that use this: ``nova-scheduler`` * Related options: aggregate_image_properties_isolation_separator * - ``aggregate_image_properties_isolation_separator`` = ``.`` - - (StrOpt) When using the aggregate_image_properties_isolation filter, the relevant metadata keys are prefixed with the namespace defined in the aggregate_image_properties_isolation_namespace configuration option plus a separator. This option defines the separator to be used. It defaults to a period ('.'). Valid values are strings. This option is only used by the FilterScheduler and its subclasses; if you use a different scheduler, this option has no effect. Also note that this setting only affects scheduling if the 'aggregate_image_properties_isolation' filter is enabled. * Services that use this: ``nova-scheduler`` * Related options: aggregate_image_properties_isolation_namespace + - (String) When using the aggregate_image_properties_isolation filter, the relevant metadata keys are prefixed with the namespace defined in the aggregate_image_properties_isolation_namespace configuration option plus a separator. This option defines the separator to be used. It defaults to a period ('.'). Valid values are strings. This option is only used by the FilterScheduler and its subclasses; if you use a different scheduler, this option has no effect. Also note that this setting only affects scheduling if the 'aggregate_image_properties_isolation' filter is enabled. * Services that use this: ``nova-scheduler`` * Related options: aggregate_image_properties_isolation_namespace * - ``baremetal_scheduler_default_filters`` = ``RetryFilter, AvailabilityZoneFilter, ComputeFilter, ComputeCapabilitiesFilter, ImagePropertiesFilter, ExactRamFilter, ExactDiskFilter, ExactCoreFilter`` - - (ListOpt) This option specifies the filters used for filtering baremetal hosts. The value should be a list of strings, with each string being the name of a filter class to be used. When used, they will be applied in order, so place your most restrictive filters first to make the filtering process more efficient. This option is only used by the FilterScheduler and its subclasses; if you use a different scheduler, this option has no effect. * Services that use this: ``nova-scheduler`` * Related options: If the 'scheduler_use_baremetal_filters' option is False, this option has no effect. + - (List) This option specifies the filters used for filtering baremetal hosts. The value should be a list of strings, with each string being the name of a filter class to be used. When used, they will be applied in order, so place your most restrictive filters first to make the filtering process more efficient. This option is only used by the FilterScheduler and its subclasses; if you use a different scheduler, this option has no effect. * Services that use this: ``nova-scheduler`` * Related options: If the 'scheduler_use_baremetal_filters' option is False, this option has no effect. * - ``cpu_allocation_ratio`` = ``0.0`` - - (FloatOpt) Virtual CPU to physical CPU allocation ratio which affects all CPU filters. This configuration specifies a global ratio for CoreFilter. For AggregateCoreFilter, it will fall back to this configuration value if no per-aggregate setting found. NOTE: This can be set per-compute, or if set to 0.0, the value set on the scheduler node(s) will be used and defaulted to 16.0 - * - ``disk_allocation_ratio`` = ``1.0`` - - (FloatOpt) This is the virtual disk to physical disk allocation ratio used by the disk_filter.py script to determine if a host has sufficient disk space to fit a requested instance. A ratio greater than 1.0 will result in over-subscription of the available physical disk, which can be useful for more efficiently packing instances created with images that do not use the entire virtual disk,such as sparse or compressed images. It can be set to a value between 0.0 and 1.0 in order to preserve a percentage of the disk for uses other than instances + - (Floating point) Virtual CPU to physical CPU allocation ratio which affects all CPU filters. This configuration specifies a global ratio for CoreFilter. For AggregateCoreFilter, it will fall back to this configuration value if no per-aggregate setting found. NOTE: This can be set per-compute, or if set to 0.0, the value set on the scheduler node(s) will be used and defaulted to 16.0 + * - ``disk_allocation_ratio`` = ``0.0`` + - (Floating point) This is the virtual disk to physical disk allocation ratio used by the disk_filter.py script to determine if a host has sufficient disk space to fit a requested instance. A ratio greater than 1.0 will result in over-subscription of the available physical disk, which can be useful for more efficiently packing instances created with images that do not use the entire virtual disk,such as sparse or compressed images. It can be set to a value between 0.0 and 1.0 in order to preserve a percentage of the disk for uses other than instances.NOTE: This can be set per-compute, or if set to 0.0, the value set on the scheduler node(s) will be used and defaulted to 1.0 * - ``disk_weight_multiplier`` = ``1.0`` - - (FloatOpt) Multiplier used for weighing free disk space. Negative numbers mean to stack vs spread. + - (Floating point) Multiplier used for weighing free disk space. Negative numbers mean to stack vs spread. * - ``io_ops_weight_multiplier`` = ``-1.0`` - - (FloatOpt) This option determines how hosts with differing workloads are weighed. Negative values, such as the default, will result in the scheduler preferring hosts with lighter workloads whereas positive values will prefer hosts with heavier workloads. Another way to look at it is that positive values for this option will tend to schedule instances onto hosts that are already busy, while negative values will tend to distribute the workload across more hosts. The absolute value, whether positive or negative, controls how strong the io_ops weigher is relative to other weighers. This option is only used by the FilterScheduler and its subclasses; if you use a different scheduler, this option has no effect. Also note that this setting only affects scheduling if the 'io_ops' weigher is enabled. Valid values are numeric, either integer or float. * Services that use this: ``nova-scheduler`` * Related options: None + - (Floating point) This option determines how hosts with differing workloads are weighed. Negative values, such as the default, will result in the scheduler preferring hosts with lighter workloads whereas positive values will prefer hosts with heavier workloads. Another way to look at it is that positive values for this option will tend to schedule instances onto hosts that are already busy, while negative values will tend to distribute the workload across more hosts. The absolute value, whether positive or negative, controls how strong the io_ops weigher is relative to other weighers. This option is only used by the FilterScheduler and its subclasses; if you use a different scheduler, this option has no effect. Also note that this setting only affects scheduling if the 'io_ops' weigher is enabled. Valid values are numeric, either integer or float. * Services that use this: ``nova-scheduler`` * Related options: None * - ``isolated_hosts`` = - - (ListOpt) If there is a need to restrict some images to only run on certain designated hosts, list those host names here. This option is only used by the FilterScheduler and its subclasses; if you use a different scheduler, this option has no effect. Also note that this setting only affects scheduling if the 'IsolatedHostsFilter' filter is enabled. * Services that use this: ``nova-scheduler`` * Related options: scheduler/isolated_images scheduler/restrict_isolated_hosts_to_isolated_images + - (List) If there is a need to restrict some images to only run on certain designated hosts, list those host names here. This option is only used by the FilterScheduler and its subclasses; if you use a different scheduler, this option has no effect. Also note that this setting only affects scheduling if the 'IsolatedHostsFilter' filter is enabled. * Services that use this: ``nova-scheduler`` * Related options: scheduler/isolated_images scheduler/restrict_isolated_hosts_to_isolated_images * - ``isolated_images`` = - - (ListOpt) If there is a need to restrict some images to only run on certain designated hosts, list those image UUIDs here. This option is only used by the FilterScheduler and its subclasses; if you use a different scheduler, this option has no effect. Also note that this setting only affects scheduling if the 'IsolatedHostsFilter' filter is enabled. * Services that use this: ``nova-scheduler`` * Related options: scheduler/isolated_hosts scheduler/restrict_isolated_hosts_to_isolated_images + - (List) If there is a need to restrict some images to only run on certain designated hosts, list those image UUIDs here. This option is only used by the FilterScheduler and its subclasses; if you use a different scheduler, this option has no effect. Also note that this setting only affects scheduling if the 'IsolatedHostsFilter' filter is enabled. * Services that use this: ``nova-scheduler`` * Related options: scheduler/isolated_hosts scheduler/restrict_isolated_hosts_to_isolated_images * - ``max_instances_per_host`` = ``50`` - - (IntOpt) If you need to limit the number of instances on any given host, set this option to the maximum number of instances you want to allow. The num_instances_filter will reject any host that has at least as many instances as this option's value. Valid values are positive integers; setting it to zero will cause all hosts to be rejected if the num_instances_filter is active. This option is only used by the FilterScheduler and its subclasses; if you use a different scheduler, this option has no effect. Also note that this setting only affects scheduling if the 'num_instances_filter' filter is enabled. * Services that use this: ``nova-scheduler`` * Related options: None + - (Integer) If you need to limit the number of instances on any given host, set this option to the maximum number of instances you want to allow. The num_instances_filter will reject any host that has at least as many instances as this option's value. Valid values are positive integers; setting it to zero will cause all hosts to be rejected if the num_instances_filter is active. This option is only used by the FilterScheduler and its subclasses; if you use a different scheduler, this option has no effect. Also note that this setting only affects scheduling if the 'num_instances_filter' filter is enabled. * Services that use this: ``nova-scheduler`` * Related options: None * - ``max_io_ops_per_host`` = ``8`` - - (IntOpt) This setting caps the number of instances on a host that can be actively performing IO (in a build, resize, snapshot, migrate, rescue, or unshelve task state) before that host becomes ineligible to build new instances. Valid values are positive integers: 1 or greater. This option is only used by the FilterScheduler and its subclasses; if you use a different scheduler, this option has no effect. Also note that this setting only affects scheduling if the 'io_ops_filter' filter is enabled. * Services that use this: ``nova-scheduler`` * Related options: None + - (Integer) This setting caps the number of instances on a host that can be actively performing IO (in a build, resize, snapshot, migrate, rescue, or unshelve task state) before that host becomes ineligible to build new instances. Valid values are positive integers: 1 or greater. This option is only used by the FilterScheduler and its subclasses; if you use a different scheduler, this option has no effect. Also note that this setting only affects scheduling if the 'io_ops_filter' filter is enabled. * Services that use this: ``nova-scheduler`` * Related options: None * - ``ram_allocation_ratio`` = ``0.0`` - - (FloatOpt) Virtual ram to physical ram allocation ratio which affects all ram filters. This configuration specifies a global ratio for RamFilter. For AggregateRamFilter, it will fall back to this configuration value if no per-aggregate setting found. NOTE: This can be set per-compute, or if set to 0.0, the value set on the scheduler node(s) will be used and defaulted to 1.5 + - (Floating point) Virtual ram to physical ram allocation ratio which affects all ram filters. This configuration specifies a global ratio for RamFilter. For AggregateRamFilter, it will fall back to this configuration value if no per-aggregate setting found. NOTE: This can be set per-compute, or if set to 0.0, the value set on the scheduler node(s) will be used and defaulted to 1.5 * - ``ram_weight_multiplier`` = ``1.0`` - - (FloatOpt) This option determines how hosts with more or less available RAM are weighed. A positive value will result in the scheduler preferring hosts with more available RAM, and a negative number will result in the scheduler preferring hosts with less available RAM. Another way to look at it is that positive values for this option will tend to spread instances across many hosts, while negative values will tend to fill up (stack) hosts as much as possible before scheduling to a less-used host. The absolute value, whether positive or negative, controls how strong the RAM weigher is relative to other weighers. This option is only used by the FilterScheduler and its subclasses; if you use a different scheduler, this option has no effect. Also note that this setting only affects scheduling if the 'ram' weigher is enabled. Valid values are numeric, either integer or float. * Services that use this: ``nova-scheduler`` * Related options: None + - (Floating point) This option determines how hosts with more or less available RAM are weighed. A positive value will result in the scheduler preferring hosts with more available RAM, and a negative number will result in the scheduler preferring hosts with less available RAM. Another way to look at it is that positive values for this option will tend to spread instances across many hosts, while negative values will tend to fill up (stack) hosts as much as possible before scheduling to a less-used host. The absolute value, whether positive or negative, controls how strong the RAM weigher is relative to other weighers. This option is only used by the FilterScheduler and its subclasses; if you use a different scheduler, this option has no effect. Also note that this setting only affects scheduling if the 'ram' weigher is enabled. Valid values are numeric, either integer or float. * Services that use this: ``nova-scheduler`` * Related options: None * - ``reserved_host_disk_mb`` = ``0`` - - (IntOpt) Amount of disk in MB to reserve for the host + - (Integer) Amount of disk in MB to reserve for the host * - ``reserved_host_memory_mb`` = ``512`` - - (IntOpt) Amount of memory in MB to reserve for the host + - (Integer) Amount of memory in MB to reserve for the host * - ``restrict_isolated_hosts_to_isolated_images`` = ``True`` - - (BoolOpt) This setting determines if the scheduler's isolated_hosts filter will allow non-isolated images on a host designated as an isolated host. When set to True (the default), non-isolated images will not be allowed to be built on isolated hosts. When False, non-isolated images can be built on both isolated and non-isolated hosts alike. This option is only used by the FilterScheduler and its subclasses; if you use a different scheduler, this option has no effect. Also note that this setting only affects scheduling if the 'IsolatedHostsFilter' filter is enabled. Even then, this option doesn't affect the behavior of requests for isolated images, which will *always* be restricted to isolated hosts. * Services that use this: ``nova-scheduler`` * Related options: scheduler/isolated_images scheduler/isolated_hosts + - (Boolean) This setting determines if the scheduler's isolated_hosts filter will allow non-isolated images on a host designated as an isolated host. When set to True (the default), non-isolated images will not be allowed to be built on isolated hosts. When False, non-isolated images can be built on both isolated and non-isolated hosts alike. This option is only used by the FilterScheduler and its subclasses; if you use a different scheduler, this option has no effect. Also note that this setting only affects scheduling if the 'IsolatedHostsFilter' filter is enabled. Even then, this option doesn't affect the behavior of requests for isolated images, which will *always* be restricted to isolated hosts. * Services that use this: ``nova-scheduler`` * Related options: scheduler/isolated_images scheduler/isolated_hosts * - ``scheduler_available_filters`` = ``['nova.scheduler.filters.all_filters']`` - - (MultiStrOpt) This is an unordered list of the filter classes the Nova scheduler may apply. Only the filters specified in the 'scheduler_default_filters' option will be used, but any filter appearing in that option must also be included in this list. By default, this is set to all filters that are included with Nova. If you wish to change this, replace this with a list of strings, where each element is the path to a filter. This option is only used by the FilterScheduler and its subclasses; if you use a different scheduler, this option has no effect. * Services that use this: ``nova-scheduler`` * Related options: scheduler_default_filters + - (Multi-valued) This is an unordered list of the filter classes the Nova scheduler may apply. Only the filters specified in the 'scheduler_default_filters' option will be used, but any filter appearing in that option must also be included in this list. By default, this is set to all filters that are included with Nova. If you wish to change this, replace this with a list of strings, where each element is the path to a filter. This option is only used by the FilterScheduler and its subclasses; if you use a different scheduler, this option has no effect. * Services that use this: ``nova-scheduler`` * Related options: scheduler_default_filters * - ``scheduler_default_filters`` = ``RetryFilter, AvailabilityZoneFilter, RamFilter, DiskFilter, ComputeFilter, ComputeCapabilitiesFilter, ImagePropertiesFilter, ServerGroupAntiAffinityFilter, ServerGroupAffinityFilter`` - - (ListOpt) This option is the list of filter class names that will be used for filtering hosts. The use of 'default' in the name of this option implies that other filters may sometimes be used, but that is not the case. These filters will be applied in the order they are listed, so place your most restrictive filters first to make the filtering process more efficient. This option is only used by the FilterScheduler and its subclasses; if you use a different scheduler, this option has no effect. * Services that use this: ``nova-scheduler`` * Related options: All of the filters in this option *must* be present in the 'scheduler_available_filters' option, or a SchedulerHostFilterNotFound exception will be raised. + - (List) This option is the list of filter class names that will be used for filtering hosts. The use of 'default' in the name of this option implies that other filters may sometimes be used, but that is not the case. These filters will be applied in the order they are listed, so place your most restrictive filters first to make the filtering process more efficient. This option is only used by the FilterScheduler and its subclasses; if you use a different scheduler, this option has no effect. * Services that use this: ``nova-scheduler`` * Related options: All of the filters in this option *must* be present in the 'scheduler_available_filters' option, or a SchedulerHostFilterNotFound exception will be raised. * - ``scheduler_driver`` = ``filter_scheduler`` - - (StrOpt) The class of the driver used by the scheduler. This should be chosen from one of the entrypoints under the namespace 'nova.scheduler.driver' of file 'setup.cfg'. If nothing is specified in this option, the 'filter_scheduler' is used. This option also supports deprecated full Python path to the class to be used. For example, "nova.scheduler.filter_scheduler.FilterScheduler". But note: this support will be dropped in the N Release. Other options are: * 'caching_scheduler' which aggressively caches the system state for better individual scheduler performance at the risk of more retries when running multiple schedulers. * 'chance_scheduler' which simply picks a host at random. * 'fake_scheduler' which is used for testing. * Services that use this: ``nova-scheduler`` * Related options: None + - (String) The class of the driver used by the scheduler. This should be chosen from one of the entrypoints under the namespace 'nova.scheduler.driver' of file 'setup.cfg'. If nothing is specified in this option, the 'filter_scheduler' is used. This option also supports deprecated full Python path to the class to be used. For example, "nova.scheduler.filter_scheduler.FilterScheduler". But note: this support will be dropped in the N Release. Other options are: * 'caching_scheduler' which aggressively caches the system state for better individual scheduler performance at the risk of more retries when running multiple schedulers. * 'chance_scheduler' which simply picks a host at random. * 'fake_scheduler' which is used for testing. * Services that use this: ``nova-scheduler`` * Related options: None * - ``scheduler_driver_task_period`` = ``60`` - - (IntOpt) This value controls how often (in seconds) to run periodic tasks in the scheduler. The specific tasks that are run for each period are determined by the particular scheduler being used. If this is larger than the nova-service 'service_down_time' setting, Nova may report the scheduler service as down. This is because the scheduler driver is responsible for sending a heartbeat and it will only do that as often as this option allows. As each scheduler can work a little differently than the others, be sure to test this with your selected scheduler. * Services that use this: ``nova-scheduler`` * Related options: ``nova-service service_down_time`` + - (Integer) This value controls how often (in seconds) to run periodic tasks in the scheduler. The specific tasks that are run for each period are determined by the particular scheduler being used. If this is larger than the nova-service 'service_down_time' setting, Nova may report the scheduler service as down. This is because the scheduler driver is responsible for sending a heartbeat and it will only do that as often as this option allows. As each scheduler can work a little differently than the others, be sure to test this with your selected scheduler. * Services that use this: ``nova-scheduler`` * Related options: ``nova-service service_down_time`` * - ``scheduler_host_manager`` = ``host_manager`` - - (StrOpt) The scheduler host manager to use, which manages the in-memory picture of the hosts that the scheduler uses. The option value should be chosen from one of the entrypoints under the namespace 'nova.scheduler.host_manager' of file 'setup.cfg'. For example, 'host_manager' is the default setting. Aside from the default, the only other option as of the Mitaka release is 'ironic_host_manager', which should be used if you're using Ironic to provision bare-metal instances. This option also supports a full class path style, for example "nova.scheduler.host_manager.HostManager", but note this support is deprecated and will be dropped in the N release. * Services that use this: ``nova-scheduler`` * Related options: None + - (String) The scheduler host manager to use, which manages the in-memory picture of the hosts that the scheduler uses. The option value should be chosen from one of the entrypoints under the namespace 'nova.scheduler.host_manager' of file 'setup.cfg'. For example, 'host_manager' is the default setting. Aside from the default, the only other option as of the Mitaka release is 'ironic_host_manager', which should be used if you're using Ironic to provision bare-metal instances. This option also supports a full class path style, for example "nova.scheduler.host_manager.HostManager", but note this support is deprecated and will be dropped in the N release. * Services that use this: ``nova-scheduler`` * Related options: None * - ``scheduler_host_subset_size`` = ``1`` - - (IntOpt) New instances will be scheduled on a host chosen randomly from a subset of the N best hosts, where N is the value set by this option. Valid values are 1 or greater. Any value less than one will be treated as 1. Setting this to a value greater than 1 will reduce the chance that multiple scheduler processes handling similar requests will select the same host, creating a potential race condition. By selecting a host randomly from the N hosts that best fit the request, the chance of a conflict is reduced. However, the higher you set this value, the less optimal the chosen host may be for a given request. This option is only used by the FilterScheduler and its subclasses; if you use a different scheduler, this option has no effect. * Services that use this: ``nova-scheduler`` * Related options: None + - (Integer) New instances will be scheduled on a host chosen randomly from a subset of the N best hosts, where N is the value set by this option. Valid values are 1 or greater. Any value less than one will be treated as 1. Setting this to a value greater than 1 will reduce the chance that multiple scheduler processes handling similar requests will select the same host, creating a potential race condition. By selecting a host randomly from the N hosts that best fit the request, the chance of a conflict is reduced. However, the higher you set this value, the less optimal the chosen host may be for a given request. This option is only used by the FilterScheduler and its subclasses; if you use a different scheduler, this option has no effect. * Services that use this: ``nova-scheduler`` * Related options: None * - ``scheduler_instance_sync_interval`` = ``120`` - - (IntOpt) Waiting time interval (seconds) between sending the scheduler a list of current instance UUIDs to verify that its view of instances is in sync with nova. If the CONF option `scheduler_tracks_instance_changes` is False, changing this option will have no effect. + - (Integer) Waiting time interval (seconds) between sending the scheduler a list of current instance UUIDs to verify that its view of instances is in sync with nova. If the CONF option `scheduler_tracks_instance_changes` is False, changing this option will have no effect. * - ``scheduler_json_config_location`` = - - (StrOpt) The absolute path to the scheduler configuration JSON file, if any. This file location is monitored by the scheduler for changes and reloads it if needed. It is converted from JSON to a Python data structure, and passed into the filtering and weighing functions of the scheduler, which can use it for dynamic configuration. * Services that use this: ``nova-scheduler`` * Related options: None + - (String) The absolute path to the scheduler configuration JSON file, if any. This file location is monitored by the scheduler for changes and reloads it if needed. It is converted from JSON to a Python data structure, and passed into the filtering and weighing functions of the scheduler, which can use it for dynamic configuration. * Services that use this: ``nova-scheduler`` * Related options: None * - ``scheduler_manager`` = ``nova.scheduler.manager.SchedulerManager`` - - (StrOpt) Full class name for the Manager for scheduler + - (String) DEPRECATED: Full class name for the Manager for scheduler * - ``scheduler_max_attempts`` = ``3`` - - (IntOpt) This is the maximum number of attempts that will be made to schedule an instance before it is assumed that the failures aren't due to normal occasional race conflicts, but rather some other problem. When this is reached a MaxRetriesExceeded exception is raised, and the instance is set to an error state. Valid values are positive integers (1 or greater). * Services that use this: ``nova-scheduler`` * Related options: None + - (Integer) This is the maximum number of attempts that will be made to schedule an instance before it is assumed that the failures aren't due to normal occasional race conflicts, but rather some other problem. When this is reached a MaxRetriesExceeded exception is raised, and the instance is set to an error state. Valid values are positive integers (1 or greater). * Services that use this: ``nova-scheduler`` * Related options: None * - ``scheduler_topic`` = ``scheduler`` - - (StrOpt) This is the message queue topic that the scheduler 'listens' on. It is used when the scheduler service is started up to configure the queue, and whenever an RPC call to the scheduler is made. There is almost never any reason to ever change this value. * Services that use this: ``nova-scheduler`` * Related options: None + - (String) This is the message queue topic that the scheduler 'listens' on. It is used when the scheduler service is started up to configure the queue, and whenever an RPC call to the scheduler is made. There is almost never any reason to ever change this value. * Services that use this: ``nova-scheduler`` * Related options: None * - ``scheduler_tracks_instance_changes`` = ``True`` - - (BoolOpt) The scheduler may need information about the instances on a host in order to evaluate its filters and weighers. The most common need for this information is for the (anti-)affinity filters, which need to choose a host based on the instances already running on a host. If the configured filters and weighers do not need this information, disabling this option will improve performance. It may also be disabled when the tracking overhead proves too heavy, although this will cause classes requiring host usage data to query the database on each request instead. This option is only used by the FilterScheduler and its subclasses; if you use a different scheduler, this option has no effect. * Services that use this: ``nova-scheduler`` * Related options: None + - (Boolean) The scheduler may need information about the instances on a host in order to evaluate its filters and weighers. The most common need for this information is for the (anti-)affinity filters, which need to choose a host based on the instances already running on a host. If the configured filters and weighers do not need this information, disabling this option will improve performance. It may also be disabled when the tracking overhead proves too heavy, although this will cause classes requiring host usage data to query the database on each request instead. This option is only used by the FilterScheduler and its subclasses; if you use a different scheduler, this option has no effect. * Services that use this: ``nova-scheduler`` * Related options: None * - ``scheduler_use_baremetal_filters`` = ``False`` - - (BoolOpt) Set this to True to tell the nova scheduler that it should use the filters specified in the 'baremetal_scheduler_default_filters' option. If you are not scheduling baremetal nodes, leave this at the default setting of False. This option is only used by the FilterScheduler and its subclasses; if you use a different scheduler, this option has no effect. * Services that use this: ``nova-scheduler`` * Related options: If this option is set to True, then the filters specified in the 'baremetal_scheduler_default_filters' are used instead of the filters specified in 'scheduler_default_filters'. + - (Boolean) Set this to True to tell the nova scheduler that it should use the filters specified in the 'baremetal_scheduler_default_filters' option. If you are not scheduling baremetal nodes, leave this at the default setting of False. This option is only used by the FilterScheduler and its subclasses; if you use a different scheduler, this option has no effect. * Services that use this: ``nova-scheduler`` * Related options: If this option is set to True, then the filters specified in the 'baremetal_scheduler_default_filters' are used instead of the filters specified in 'scheduler_default_filters'. * - ``scheduler_weight_classes`` = ``nova.scheduler.weights.all_weighers`` - - (ListOpt) This is a list of weigher class names. Only hosts which pass the filters are weighed. The weight for any host starts at 0, and the weighers order these hosts by adding to or subtracting from the weight assigned by the previous weigher. Weights may become negative. An instance will be scheduled to one of the N most-weighted hosts, where N is 'scheduler_host_subset_size'. By default, this is set to all weighers that are included with Nova. If you wish to change this, replace this with a list of strings, where each element is the path to a weigher. This option is only used by the FilterScheduler and its subclasses; if you use a different scheduler, this option has no effect. * Services that use this: ``nova-scheduler`` * Related options: None + - (List) This is a list of weigher class names. Only hosts which pass the filters are weighed. The weight for any host starts at 0, and the weighers order these hosts by adding to or subtracting from the weight assigned by the previous weigher. Weights may become negative. An instance will be scheduled to one of the N most-weighted hosts, where N is 'scheduler_host_subset_size'. By default, this is set to all weighers that are included with Nova. If you wish to change this, replace this with a list of strings, where each element is the path to a weigher. This option is only used by the FilterScheduler and its subclasses; if you use a different scheduler, this option has no effect. * Services that use this: ``nova-scheduler`` * Related options: None * - ``soft_affinity_weight_multiplier`` = ``1.0`` - - (FloatOpt) Multiplier used for weighing hosts for group soft-affinity. Only a positive value is meaningful. Negative means that the behavior will change to the opposite, which is soft-anti-affinity. + - (Floating point) Multiplier used for weighing hosts for group soft-affinity. Only a positive value is meaningful. Negative means that the behavior will change to the opposite, which is soft-anti-affinity. * - ``soft_anti_affinity_weight_multiplier`` = ``1.0`` - - (FloatOpt) Multiplier used for weighing hosts for group soft-anti-affinity. Only a positive value is meaningful. Negative means that the behavior will change to the opposite, which is soft-affinity. + - (Floating point) Multiplier used for weighing hosts for group soft-anti-affinity. Only a positive value is meaningful. Negative means that the behavior will change to the opposite, which is soft-affinity. * - **[cells]** - * - ``ram_weight_multiplier`` = ``10.0`` - - (FloatOpt) Ram weight multiplier Multiplier used for weighing ram. Negative numbers indicate that Compute should stack VMs on one host instead of spreading out new VMs to more hosts in the cell. Possible values: * Numeric multiplier Services which consume this: * nova-cells Related options: * None + - (Floating point) Ram weight multiplier Multiplier used for weighing ram. Negative numbers indicate that Compute should stack VMs on one host instead of spreading out new VMs to more hosts in the cell. Possible values: * Numeric multiplier Services which consume this: * nova-cells Related options: * None * - ``scheduler_filter_classes`` = ``nova.cells.filters.all_filters`` - - (ListOpt) Scheduler filter classes Filter classes the cells scheduler should use. An entry of "nova.cells.filters.all_filters" maps to all cells filters included with nova. As of the Mitaka release the following filter classes are available: Different cell filter: A scheduler hint of 'different_cell' with a value of a full cell name may be specified to route a build away from a particular cell. Image properties filter: Image metadata named 'hypervisor_version_requires' with a version specification may be specified to ensure the build goes to a cell which has hypervisors of the required version. If either the version requirement on the image or the hypervisor capability of the cell is not present, this filter returns without filtering out the cells. Target cell filter: A scheduler hint of 'target_cell' with a value of a full cell name may be specified to route a build to a particular cell. No error handling is done as there's no way to know whether the full path is a valid. As an admin user, you can also add a filter that directs builds to a particular cell. Possible values: * 'nova.cells.filters.all_filters' is the default option * Otherwise it should be the full Python path to the class to be used Services which consume this: * nova-cells Related options: * None + - (List) Scheduler filter classes Filter classes the cells scheduler should use. An entry of "nova.cells.filters.all_filters" maps to all cells filters included with nova. As of the Mitaka release the following filter classes are available: Different cell filter: A scheduler hint of 'different_cell' with a value of a full cell name may be specified to route a build away from a particular cell. Image properties filter: Image metadata named 'hypervisor_version_requires' with a version specification may be specified to ensure the build goes to a cell which has hypervisors of the required version. If either the version requirement on the image or the hypervisor capability of the cell is not present, this filter returns without filtering out the cells. Target cell filter: A scheduler hint of 'target_cell' with a value of a full cell name may be specified to route a build to a particular cell. No error handling is done as there's no way to know whether the full path is a valid. As an admin user, you can also add a filter that directs builds to a particular cell. Possible values: * 'nova.cells.filters.all_filters' is the default option * Otherwise it should be the full Python path to the class to be used Services which consume this: * nova-cells Related options: * None * - ``scheduler_retries`` = ``10`` - - (IntOpt) Scheduler retries How many retries when no cells are available. Specifies how many times the scheduler tries to launch a new instance when no cells are available. Possible values: * Positive integer value Services which consume this: * nova-cells Related options: * This value is used with the ``scheduler_retry_delay`` value while retrying to find a suitable cell. + - (Integer) Scheduler retries How many retries when no cells are available. Specifies how many times the scheduler tries to launch a new instance when no cells are available. Possible values: * Positive integer value Services which consume this: * nova-cells Related options: * This value is used with the ``scheduler_retry_delay`` value while retrying to find a suitable cell. * - ``scheduler_retry_delay`` = ``2`` - - (IntOpt) Scheduler retry delay Specifies the delay (in seconds) between scheduling retries when no cell can be found to place the new instance on. When the instance could not be scheduled to a cell after ``scheduler_retries`` in combination with ``scheduler_retry_delay``, then the scheduling of the instance failed. Possible values: * Time in seconds. Services which consume this: * nova-cells Related options: * This value is used with the ``scheduler_retries`` value while retrying to find a suitable cell. + - (Integer) Scheduler retry delay Specifies the delay (in seconds) between scheduling retries when no cell can be found to place the new instance on. When the instance could not be scheduled to a cell after ``scheduler_retries`` in combination with ``scheduler_retry_delay``, then the scheduling of the instance failed. Possible values: * Time in seconds. Services which consume this: * nova-cells Related options: * This value is used with the ``scheduler_retries`` value while retrying to find a suitable cell. * - ``scheduler_weight_classes`` = ``nova.cells.weights.all_weighers`` - - (ListOpt) Scheduler weight classes Weigher classes the cells scheduler should use. An entry of "nova.cells.weights.all_weighers" maps to all cell weighers included with nova. As of the Mitaka release the following weight classes are available: mute_child: Downgrades the likelihood of child cells being chosen for scheduling requests, which haven't sent capacity or capability updates in a while. Options include mute_weight_multiplier (multiplier for mute children; value should be negative). ram_by_instance_type: Select cells with the most RAM capacity for the instance type being requested. Because higher weights win, Compute returns the number of available units for the instance type requested. The ram_weight_multiplier option defaults to 10.0 that adds to the weight by a factor of 10. Use a negative number to stack VMs on one host instead of spreading out new VMs to more hosts in the cell. weight_offset: Allows modifying the database to weight a particular cell. The highest weight will be the first cell to be scheduled for launching an instance. When the weight_offset of a cell is set to 0, it is unlikely to be picked but it could be picked if other cells have a lower weight, like if they're full. And when the weight_offset is set to a very high value (for example, '999999999999999'), it is likely to be picked if another cell do not have a higher weight. Possible values: * 'nova.cells.weights.all_weighers' is the default option * Otherwise it should be the full Python path to the class to be used Services which consume this: * nova-cells Related options: * None + - (List) Scheduler weight classes Weigher classes the cells scheduler should use. An entry of "nova.cells.weights.all_weighers" maps to all cell weighers included with nova. As of the Mitaka release the following weight classes are available: mute_child: Downgrades the likelihood of child cells being chosen for scheduling requests, which haven't sent capacity or capability updates in a while. Options include mute_weight_multiplier (multiplier for mute children; value should be negative). ram_by_instance_type: Select cells with the most RAM capacity for the instance type being requested. Because higher weights win, Compute returns the number of available units for the instance type requested. The ram_weight_multiplier option defaults to 10.0 that adds to the weight by a factor of 10. Use a negative number to stack VMs on one host instead of spreading out new VMs to more hosts in the cell. weight_offset: Allows modifying the database to weight a particular cell. The highest weight will be the first cell to be scheduled for launching an instance. When the weight_offset of a cell is set to 0, it is unlikely to be picked but it could be picked if other cells have a lower weight, like if they're full. And when the weight_offset is set to a very high value (for example, '999999999999999'), it is likely to be picked if another cell do not have a higher weight. Possible values: * 'nova.cells.weights.all_weighers' is the default option * Otherwise it should be the full Python path to the class to be used Services which consume this: * nova-cells Related options: * None * - **[metrics]** - * - ``required`` = ``True`` - - (BoolOpt) This setting determines how any unavailable metrics are treated. If this option is set to True, any hosts for which a metric is unavailable will raise an exception, so it is recommended to also use the MetricFilter to filter out those hosts before weighing. When this option is False, any metric being unavailable for a host will set the host weight to 'weight_of_unavailable'. This option is only used by the FilterScheduler and its subclasses; if you use a different scheduler, this option has no effect. * Services that use this: ``nova-scheduler`` * Related options: weight_of_unavailable + - (Boolean) This setting determines how any unavailable metrics are treated. If this option is set to True, any hosts for which a metric is unavailable will raise an exception, so it is recommended to also use the MetricFilter to filter out those hosts before weighing. When this option is False, any metric being unavailable for a host will set the host weight to 'weight_of_unavailable'. This option is only used by the FilterScheduler and its subclasses; if you use a different scheduler, this option has no effect. * Services that use this: ``nova-scheduler`` * Related options: weight_of_unavailable * - ``weight_multiplier`` = ``1.0`` - - (FloatOpt) When using metrics to weight the suitability of a host, you can use this option to change how the calculated weight influences the weight assigned to a host as follows: * Greater than 1.0: increases the effect of the metric on overall weight. * Equal to 1.0: No change to the calculated weight. * Less than 1.0, greater than 0: reduces the effect of the metric on overall weight. * 0: The metric value is ignored, and the value of the 'weight_of_unavailable' option is returned instead. * Greater than -1.0, less than 0: the effect is reduced and reversed. * -1.0: the effect is reversed * Less than -1.0: the effect is increased proportionally and reversed. Valid values are numeric, either integer or float. This option is only used by the FilterScheduler and its subclasses; if you use a different scheduler, this option has no effect. * Services that use this: ``nova-scheduler`` * Related options: weight_of_unavailable + - (Floating point) When using metrics to weight the suitability of a host, you can use this option to change how the calculated weight influences the weight assigned to a host as follows: * Greater than 1.0: increases the effect of the metric on overall weight. * Equal to 1.0: No change to the calculated weight. * Less than 1.0, greater than 0: reduces the effect of the metric on overall weight. * 0: The metric value is ignored, and the value of the 'weight_of_unavailable' option is returned instead. * Greater than -1.0, less than 0: the effect is reduced and reversed. * -1.0: the effect is reversed * Less than -1.0: the effect is increased proportionally and reversed. Valid values are numeric, either integer or float. This option is only used by the FilterScheduler and its subclasses; if you use a different scheduler, this option has no effect. * Services that use this: ``nova-scheduler`` * Related options: weight_of_unavailable * - ``weight_of_unavailable`` = ``-10000.0`` - - (FloatOpt) When any of the following conditions are met, this value will be used in place of any actual metric value: * One of the metrics named in 'weight_setting' is not available for a host, and the value of 'required' is False. * The ratio specified for a metric in 'weight_setting' is 0. * The 'weight_multiplier' option is set to 0. This option is only used by the FilterScheduler and its subclasses; if you use a different scheduler, this option has no effect. * Services that use this: ``nova-scheduler`` * Related options: weight_setting required weight_multiplier + - (Floating point) When any of the following conditions are met, this value will be used in place of any actual metric value: * One of the metrics named in 'weight_setting' is not available for a host, and the value of 'required' is False. * The ratio specified for a metric in 'weight_setting' is 0. * The 'weight_multiplier' option is set to 0. This option is only used by the FilterScheduler and its subclasses; if you use a different scheduler, this option has no effect. * Services that use this: ``nova-scheduler`` * Related options: weight_setting required weight_multiplier * - ``weight_setting`` = - - (ListOpt) This setting specifies the metrics to be weighed and the relative ratios for each metric. This should be a single string value, consisting of a series of one or more 'name=ratio' pairs, separated by commas, where 'name' is the name of the metric to be weighed, and 'ratio' is the relative weight for that metric. Note that if the ratio is set to 0, the metric value is ignored, and instead the weight will be set to the value of the 'weight_of_unavailable' option. As an example, let's consider the case where this option is set to: ``name1=1.0, name2=-1.3`` The final weight will be: ``(name1.value * 1.0) + (name2.value * -1.3)`` This option is only used by the FilterScheduler and its subclasses; if you use a different scheduler, this option has no effect. * Services that use this: ``nova-scheduler`` * Related options: weight_of_unavailable + - (List) This setting specifies the metrics to be weighed and the relative ratios for each metric. This should be a single string value, consisting of a series of one or more 'name=ratio' pairs, separated by commas, where 'name' is the name of the metric to be weighed, and 'ratio' is the relative weight for that metric. Note that if the ratio is set to 0, the metric value is ignored, and instead the weight will be set to the value of the 'weight_of_unavailable' option. As an example, let's consider the case where this option is set to: ``name1=1.0, name2=-1.3`` The final weight will be: ``(name1.value * 1.0) + (name2.value * -1.3)`` This option is only used by the FilterScheduler and its subclasses; if you use a different scheduler, this option has no effect. * Services that use this: ``nova-scheduler`` * Related options: weight_of_unavailable diff --git a/doc/config-reference/source/tables/nova-serial_console.rst b/doc/config-reference/source/tables/nova-serial_console.rst index 77b0734485..c92512e543 100644 --- a/doc/config-reference/source/tables/nova-serial_console.rst +++ b/doc/config-reference/source/tables/nova-serial_console.rst @@ -19,16 +19,16 @@ * - **[serial_console]** - * - ``base_url`` = ``ws://127.0.0.1:6083/`` - - (StrOpt) The URL an end user would use to connect to the ``nova-serialproxy`` service. The ``nova-serialproxy`` service is called with this token enriched URL and establishes the connection to the proper instance. Possible values: * Services which consume this: * ``nova-compute`` Interdependencies to other options: * The IP address must be identical to the address to which the ``nova-serialproxy`` service is listening (see option ``serialproxy_host`` in this section). * The port must be the same as in the option ``serialproxy_port`` of this section. * If you choose to use a secured websocket connection, then start this option with ``wss://`` instead of the unsecured ``ws://``. The options ``cert`` and ``key`` in the ``[DEFAULT]`` section have to be set for that. + - (String) The URL an end user would use to connect to the ``nova-serialproxy`` service. The ``nova-serialproxy`` service is called with this token enriched URL and establishes the connection to the proper instance. Possible values: * Services which consume this: * ``nova-compute`` Interdependencies to other options: * The IP address must be identical to the address to which the ``nova-serialproxy`` service is listening (see option ``serialproxy_host`` in this section). * The port must be the same as in the option ``serialproxy_port`` of this section. * If you choose to use a secured websocket connection, then start this option with ``wss://`` instead of the unsecured ``ws://``. The options ``cert`` and ``key`` in the ``[DEFAULT]`` section have to be set for that. * - ``enabled`` = ``False`` - - (BoolOpt) Enable the serial console feature. In order to use this feature, the service ``nova-serialproxy`` needs to run. This service is typically executed on the controller node. Possible values: * True: Enables the feature * False: Disables the feature Services which consume this: * ``nova-compute`` Interdependencies to other options: * None + - (Boolean) Enable the serial console feature. In order to use this feature, the service ``nova-serialproxy`` needs to run. This service is typically executed on the controller node. Possible values: * True: Enables the feature * False: Disables the feature Services which consume this: * ``nova-compute`` Interdependencies to other options: * None * - ``listen`` = ``127.0.0.1`` - - (StrOpt) DEPRECATED: this option has no effect anymore. Please use "proxyclient_address" instead. This option is deprecated and will be removed in future releases. + - (String) DEPRECATED: this option has no effect anymore. Please use "proxyclient_address" instead. This option is deprecated and will be removed in future releases. * - ``port_range`` = ``10000:20000`` - - (StrOpt) A range of TCP ports a guest can use for its backend. Each instance which gets created will use one port out of this range. If the range is not big enough to provide another port for an new instance, this instance won't get launched. Possible values: Each string which passes the regex ``\d+:\d+`` For example ``10000:20000``. Be sure that the first port number is lower than the second port number. Services which consume this: * ``nova-compute`` Interdependencies to other options: * None + - (String) A range of TCP ports a guest can use for its backend. Each instance which gets created will use one port out of this range. If the range is not big enough to provide another port for an new instance, this instance won't get launched. Possible values: Each string which passes the regex ``\d+:\d+`` For example ``10000:20000``. Be sure that the first port number is lower than the second port number. Services which consume this: * ``nova-compute`` Interdependencies to other options: * None * - ``proxyclient_address`` = ``127.0.0.1`` - - (StrOpt) The IP address to which proxy clients (like ``nova-serialproxy``) should connect to get the serial console of an instance. This is typically the IP address of the host of a ``nova-compute`` service. Possible values: * An IP address Services which consume this: * ``nova-compute`` Interdependencies to other options: * None + - (String) The IP address to which proxy clients (like ``nova-serialproxy``) should connect to get the serial console of an instance. This is typically the IP address of the host of a ``nova-compute`` service. Possible values: * An IP address Services which consume this: * ``nova-compute`` Interdependencies to other options: * None * - ``serialproxy_host`` = ``0.0.0.0`` - - (StrOpt) The IP address which is used by the ``nova-serialproxy`` service to listen for incoming requests. The ``nova-serialproxy`` service listens on this IP address for incoming connection requests to instances which expose serial console. Possible values: * An IP address Services which consume this: * ``nova-serialproxy`` Interdependencies to other options: * Ensure that this is the same IP address which is defined in the option ``base_url`` of this section or use ``0.0.0.0`` to listen on all addresses. + - (String) The IP address which is used by the ``nova-serialproxy`` service to listen for incoming requests. The ``nova-serialproxy`` service listens on this IP address for incoming connection requests to instances which expose serial console. Possible values: * An IP address Services which consume this: * ``nova-serialproxy`` Interdependencies to other options: * Ensure that this is the same IP address which is defined in the option ``base_url`` of this section or use ``0.0.0.0`` to listen on all addresses. * - ``serialproxy_port`` = ``6083`` - - (IntOpt) The port number which is used by the ``nova-serialproxy`` service to listen for incoming requests. The ``nova-serialproxy`` service listens on this port number for incoming connection requests to instances which expose serial console. Possible values: * A port number Services which consume this: * ``nova-serialproxy`` Interdependencies to other options: * Ensure that this is the same port number which is defined in the option ``base_url`` of this section. + - (Integer) The port number which is used by the ``nova-serialproxy`` service to listen for incoming requests. The ``nova-serialproxy`` service listens on this port number for incoming connection requests to instances which expose serial console. Possible values: * A port number Services which consume this: * ``nova-serialproxy`` Interdependencies to other options: * Ensure that this is the same port number which is defined in the option ``base_url`` of this section. diff --git a/doc/config-reference/source/tables/nova-spice.rst b/doc/config-reference/source/tables/nova-spice.rst index 83ea45b54a..daf6bc3946 100644 --- a/doc/config-reference/source/tables/nova-spice.rst +++ b/doc/config-reference/source/tables/nova-spice.rst @@ -19,18 +19,18 @@ * - **[spice]** - * - ``agent_enabled`` = ``True`` - - (BoolOpt) Enable spice guest agent support + - (Boolean) Enable spice guest agent support * - ``enabled`` = ``False`` - - (BoolOpt) Enable spice related features + - (Boolean) Enable spice related features * - ``html5proxy_base_url`` = ``http://127.0.0.1:6082/spice_auto.html`` - - (StrOpt) Location of spice HTML5 console proxy, in the form "http://127.0.0.1:6082/spice_auto.html" + - (String) Location of spice HTML5 console proxy, in the form "http://127.0.0.1:6082/spice_auto.html" * - ``html5proxy_host`` = ``0.0.0.0`` - - (StrOpt) Host on which to listen for incoming requests + - (String) Host on which to listen for incoming requests * - ``html5proxy_port`` = ``6082`` - - (IntOpt) Port on which to listen for incoming requests + - (Integer) Port on which to listen for incoming requests * - ``keymap`` = ``en-us`` - - (StrOpt) Keymap for spice + - (String) Keymap for spice * - ``server_listen`` = ``127.0.0.1`` - - (StrOpt) IP address on which instance spice server should listen + - (String) IP address on which instance spice server should listen * - ``server_proxyclient_address`` = ``127.0.0.1`` - - (StrOpt) The address to which proxy clients (like nova-spicehtml5proxy) should connect + - (String) The address to which proxy clients (like nova-spicehtml5proxy) should connect diff --git a/doc/config-reference/source/tables/nova-testing.rst b/doc/config-reference/source/tables/nova-testing.rst index af6147effe..00879912ac 100644 --- a/doc/config-reference/source/tables/nova-testing.rst +++ b/doc/config-reference/source/tables/nova-testing.rst @@ -19,10 +19,10 @@ * - **[DEFAULT]** - * - ``fake_call`` = ``False`` - - (BoolOpt) If True, skip using the queue and make local calls + - (Boolean) If True, skip using the queue and make local calls * - ``fake_network`` = ``False`` - - (BoolOpt) If passed, use fake network devices and addresses + - (Boolean) If passed, use fake network devices and addresses * - ``monkey_patch`` = ``False`` - - (BoolOpt) Whether to apply monkey patching + - (Boolean) Whether to apply monkey patching * - ``monkey_patch_modules`` = ``nova.compute.api:nova.notifications.notify_decorator`` - - (ListOpt) List of modules/decorators to monkey patch + - (List) List of modules/decorators to monkey patch diff --git a/doc/config-reference/source/tables/nova-trustedcomputing.rst b/doc/config-reference/source/tables/nova-trustedcomputing.rst index 23d7cdd286..59940cee1f 100644 --- a/doc/config-reference/source/tables/nova-trustedcomputing.rst +++ b/doc/config-reference/source/tables/nova-trustedcomputing.rst @@ -19,16 +19,16 @@ * - **[trusted_computing]** - * - ``attestation_api_url`` = ``/OpenAttestationWebServices/V1.0`` - - (StrOpt) The URL on the attestation server to use. See the `attestation_server` help text for more information about host verification. This value must be just that path portion of the full URL, as it will be joined to the host specified in the attestation_server option. This option is only used by the FilterScheduler and its subclasses; if you use a different scheduler, this option has no effect. Also note that this setting only affects scheduling if the 'TrustedFilter' filter is enabled. * Services that use this: ``nova-scheduler`` * Related options: attestation_server attestation_server_ca_file attestation_port attestation_auth_blob attestation_auth_timeout attestation_insecure_ssl + - (String) The URL on the attestation server to use. See the `attestation_server` help text for more information about host verification. This value must be just that path portion of the full URL, as it will be joined to the host specified in the attestation_server option. This option is only used by the FilterScheduler and its subclasses; if you use a different scheduler, this option has no effect. Also note that this setting only affects scheduling if the 'TrustedFilter' filter is enabled. * Services that use this: ``nova-scheduler`` * Related options: attestation_server attestation_server_ca_file attestation_port attestation_auth_blob attestation_auth_timeout attestation_insecure_ssl * - ``attestation_auth_blob`` = ``None`` - - (StrOpt) Attestation servers require a specific blob that is used to authenticate. The content and format of the blob are determined by the particular attestation server being used. There is no default value; you must supply the value as specified by your attestation service. See the `attestation_server` help text for more information about host verification. This option is only used by the FilterScheduler and its subclasses; if you use a different scheduler, this option has no effect. Also note that this setting only affects scheduling if the 'TrustedFilter' filter is enabled. * Services that use this: ``nova-scheduler`` * Related options: attestation_server attestation_server_ca_file attestation_port attestation_api_url attestation_auth_timeout attestation_insecure_ssl + - (String) Attestation servers require a specific blob that is used to authenticate. The content and format of the blob are determined by the particular attestation server being used. There is no default value; you must supply the value as specified by your attestation service. See the `attestation_server` help text for more information about host verification. This option is only used by the FilterScheduler and its subclasses; if you use a different scheduler, this option has no effect. Also note that this setting only affects scheduling if the 'TrustedFilter' filter is enabled. * Services that use this: ``nova-scheduler`` * Related options: attestation_server attestation_server_ca_file attestation_port attestation_api_url attestation_auth_timeout attestation_insecure_ssl * - ``attestation_auth_timeout`` = ``60`` - - (IntOpt) This value controls how long a successful attestation is cached. Once this period has elapsed, a new attestation request will be made. See the `attestation_server` help text for more information about host verification. The value is in seconds. Valid values must be positive integers for any caching; setting this to zero or a negative value will result in calls to the attestation_server for every request, which may impact performance. This option is only used by the FilterScheduler and its subclasses; if you use a different scheduler, this option has no effect. Also note that this setting only affects scheduling if the 'TrustedFilter' filter is enabled. * Services that use this: ``nova-scheduler`` * Related options: attestation_server attestation_server_ca_file attestation_port attestation_api_url attestation_auth_blob attestation_insecure_ssl + - (Integer) This value controls how long a successful attestation is cached. Once this period has elapsed, a new attestation request will be made. See the `attestation_server` help text for more information about host verification. The value is in seconds. Valid values must be positive integers for any caching; setting this to zero or a negative value will result in calls to the attestation_server for every request, which may impact performance. This option is only used by the FilterScheduler and its subclasses; if you use a different scheduler, this option has no effect. Also note that this setting only affects scheduling if the 'TrustedFilter' filter is enabled. * Services that use this: ``nova-scheduler`` * Related options: attestation_server attestation_server_ca_file attestation_port attestation_api_url attestation_auth_blob attestation_insecure_ssl * - ``attestation_insecure_ssl`` = ``False`` - - (BoolOpt) When set to True, the SSL certificate verification is skipped for the attestation service. See the `attestation_server` help text for more information about host verification. Valid values are True or False. The default is False. This option is only used by the FilterScheduler and its subclasses; if you use a different scheduler, this option has no effect. Also note that this setting only affects scheduling if the 'TrustedFilter' filter is enabled. * Services that use this: ``nova-scheduler`` * Related options: attestation_server attestation_server_ca_file attestation_port attestation_api_url attestation_auth_blob attestation_auth_timeout + - (Boolean) When set to True, the SSL certificate verification is skipped for the attestation service. See the `attestation_server` help text for more information about host verification. Valid values are True or False. The default is False. This option is only used by the FilterScheduler and its subclasses; if you use a different scheduler, this option has no effect. Also note that this setting only affects scheduling if the 'TrustedFilter' filter is enabled. * Services that use this: ``nova-scheduler`` * Related options: attestation_server attestation_server_ca_file attestation_port attestation_api_url attestation_auth_blob attestation_auth_timeout * - ``attestation_port`` = ``8443`` - - (StrOpt) The port to use when connecting to the attestation server. See the `attestation_server` help text for more information about host verification. Valid values are strings, not integers, but must be digits only. This option is only used by the FilterScheduler and its subclasses; if you use a different scheduler, this option has no effect. Also note that this setting only affects scheduling if the 'TrustedFilter' filter is enabled. * Services that use this: ``nova-scheduler`` * Related options: attestation_server attestation_server_ca_file attestation_api_url attestation_auth_blob attestation_auth_timeout attestation_insecure_ssl + - (String) The port to use when connecting to the attestation server. See the `attestation_server` help text for more information about host verification. Valid values are strings, not integers, but must be digits only. This option is only used by the FilterScheduler and its subclasses; if you use a different scheduler, this option has no effect. Also note that this setting only affects scheduling if the 'TrustedFilter' filter is enabled. * Services that use this: ``nova-scheduler`` * Related options: attestation_server attestation_server_ca_file attestation_api_url attestation_auth_blob attestation_auth_timeout attestation_insecure_ssl * - ``attestation_server`` = ``None`` - - (StrOpt) The host to use as the attestation server. Cloud computing pools can involve thousands of compute nodes located at different geographical locations, making it difficult for cloud providers to identify a node's trustworthiness. When using the Trusted filter, users can request that their VMs only be placed on nodes that have been verified by the attestation server specified in this option. The value is a string, and can be either an IP address or FQDN. This option is only used by the FilterScheduler and its subclasses; if you use a different scheduler, this option has no effect. Also note that this setting only affects scheduling if the 'TrustedFilter' filter is enabled. * Services that use this: ``nova-scheduler`` * Related options: attestation_server_ca_file attestation_port attestation_api_url attestation_auth_blob attestation_auth_timeout attestation_insecure_ssl + - (String) The host to use as the attestation server. Cloud computing pools can involve thousands of compute nodes located at different geographical locations, making it difficult for cloud providers to identify a node's trustworthiness. When using the Trusted filter, users can request that their VMs only be placed on nodes that have been verified by the attestation server specified in this option. The value is a string, and can be either an IP address or FQDN. This option is only used by the FilterScheduler and its subclasses; if you use a different scheduler, this option has no effect. Also note that this setting only affects scheduling if the 'TrustedFilter' filter is enabled. * Services that use this: ``nova-scheduler`` * Related options: attestation_server_ca_file attestation_port attestation_api_url attestation_auth_blob attestation_auth_timeout attestation_insecure_ssl * - ``attestation_server_ca_file`` = ``None`` - - (StrOpt) The absolute path to the certificate to use for authentication when connecting to the attestation server. See the `attestation_server` help text for more information about host verification. The value is a string, and must point to a file that is readable by the scheduler. This option is only used by the FilterScheduler and its subclasses; if you use a different scheduler, this option has no effect. Also note that this setting only affects scheduling if the 'TrustedFilter' filter is enabled. * Services that use this: ``nova-scheduler`` * Related options: attestation_server attestation_port attestation_api_url attestation_auth_blob attestation_auth_timeout attestation_insecure_ssl + - (String) The absolute path to the certificate to use for authentication when connecting to the attestation server. See the `attestation_server` help text for more information about host verification. The value is a string, and must point to a file that is readable by the scheduler. This option is only used by the FilterScheduler and its subclasses; if you use a different scheduler, this option has no effect. Also note that this setting only affects scheduling if the 'TrustedFilter' filter is enabled. * Services that use this: ``nova-scheduler`` * Related options: attestation_server attestation_port attestation_api_url attestation_auth_blob attestation_auth_timeout attestation_insecure_ssl diff --git a/doc/config-reference/source/tables/nova-upgrade_levels.rst b/doc/config-reference/source/tables/nova-upgrade_levels.rst index 84b90b95e0..13dbc1ab8e 100644 --- a/doc/config-reference/source/tables/nova-upgrade_levels.rst +++ b/doc/config-reference/source/tables/nova-upgrade_levels.rst @@ -19,24 +19,24 @@ * - **[cells]** - * - ``scheduler`` = ``nova.cells.scheduler.CellsScheduler`` - - (StrOpt) Cells scheduler The class of the driver used by the cells scheduler. This should be the full Python path to the class to be used. If nothing is specified in this option, the CellsScheduler is used. Possible values: * 'nova.cells.scheduler.CellsScheduler' is the default option * Otherwise it should be the full Python path to the class to be used Services which consume this: * nova-cells Related options: * None + - (String) Cells scheduler The class of the driver used by the cells scheduler. This should be the full Python path to the class to be used. If nothing is specified in this option, the CellsScheduler is used. Possible values: * 'nova.cells.scheduler.CellsScheduler' is the default option * Otherwise it should be the full Python path to the class to be used Services which consume this: * nova-cells Related options: * None * - **[upgrade_levels]** - * - ``cells`` = ``None`` - - (StrOpt) Set a version cap for messages sent to local cells services + - (String) Cells version Cells client-side RPC API version. Use this option to set a version cap for messages sent to local cells services. Possible values: * None: This is the default value. * grizzly: message version 1.6. * havana: message version 1.24. * icehouse: message version 1.27. * juno: message version 1.29. * kilo: message version 1.34. * liberty: message version 1.37. Services which consume this: * nova-cells Related options: * None * - ``cert`` = ``None`` - - (StrOpt) Specifies the maximum version for messages sent from cert services. This should be the minimum value that is supported by all of the deployed cert services. Possible values: Any valid OpenStack release name, in lower case, such as 'mitaka' or 'liberty'. Alternatively, it can be any string representing a version number in the format 'N.N'; for example, possible values might be '1.12' or '2.0'. * Services which consume this: ``nova-cert`` * Related options: None + - (String) Specifies the maximum version for messages sent from cert services. This should be the minimum value that is supported by all of the deployed cert services. Possible values: Any valid OpenStack release name, in lower case, such as 'mitaka' or 'liberty'. Alternatively, it can be any string representing a version number in the format 'N.N'; for example, possible values might be '1.12' or '2.0'. * Services which consume this: ``nova-cert`` * Related options: None * - ``compute`` = ``None`` - - (StrOpt) Set a version cap for messages sent to compute services. Set this option to "auto" if you want to let the compute RPC module automatically determine what version to use based on the service versions in the deployment. Otherwise, you can set this to a specific version to pin this service to messages at a particular level. All services of a single type (i.e. compute) should be configured to use the same version, and it should be set to the minimum commonly-supported version of all those services in the deployment. + - (String) Set a version cap for messages sent to compute services. Set this option to "auto" if you want to let the compute RPC module automatically determine what version to use based on the service versions in the deployment. Otherwise, you can set this to a specific version to pin this service to messages at a particular level. All services of a single type (i.e. compute) should be configured to use the same version, and it should be set to the minimum commonly-supported version of all those services in the deployment. * - ``conductor`` = ``None`` - - (StrOpt) Set a version cap for messages sent to conductor services + - (String) Set a version cap for messages sent to conductor services * - ``console`` = ``None`` - - (StrOpt) Set a version cap for messages sent to console services + - (String) Set a version cap for messages sent to console services * - ``consoleauth`` = ``None`` - - (StrOpt) Set a version cap for messages sent to consoleauth services + - (String) Set a version cap for messages sent to consoleauth services * - ``intercell`` = ``None`` - - (StrOpt) Set a version cap for messages sent between cells services + - (String) Intercell version Intercell RPC API is the client side of the Cell<->Cell RPC API. Use this option to set a version cap for messages sent between cells services. Possible values: * None: This is the default value. * grizzly: message version 1.0. Services which consume this: * nova-cells Related options: * None * - ``network`` = ``None`` - - (StrOpt) Set a version cap for messages sent to network services + - (String) Set a version cap for messages sent to network services * - ``scheduler`` = ``None`` - - (StrOpt) Sets a version cap (limit) for messages sent to scheduler services. In the situation where there were multiple scheduler services running, and they were not being upgraded together, you would set this to the lowest deployed version to guarantee that other services never send messages that any of your running schedulers cannot understand. This is rarely needed in practice as most deployments run a single scheduler. It exists mainly for design compatibility with the other services, such as compute, which are routinely upgraded in a rolling fashion. * Services that use this: ``nova-compute, nova-conductor`` * Related options: None + - (String) Sets a version cap (limit) for messages sent to scheduler services. In the situation where there were multiple scheduler services running, and they were not being upgraded together, you would set this to the lowest deployed version to guarantee that other services never send messages that any of your running schedulers cannot understand. This is rarely needed in practice as most deployments run a single scheduler. It exists mainly for design compatibility with the other services, such as compute, which are routinely upgraded in a rolling fashion. * Services that use this: ``nova-compute, nova-conductor`` * Related options: None diff --git a/doc/config-reference/source/tables/nova-varmour.rst b/doc/config-reference/source/tables/nova-varmour.rst new file mode 100644 index 0000000000..f585238a02 --- /dev/null +++ b/doc/config-reference/source/tables/nova-varmour.rst @@ -0,0 +1,28 @@ +.. + 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. + +.. _nova-varmour: + +.. list-table:: Description of vArmour configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[vArmour]** + - + * - ``director`` = ``localhost`` + - (String) vArmour director ip + * - ``director_port`` = ``443`` + - (String) vArmour director port + * - ``password`` = ``varmour`` + - (String) vArmour director password + * - ``username`` = ``varmour`` + - (String) vArmour director username diff --git a/doc/config-reference/source/tables/nova-vmware.rst b/doc/config-reference/source/tables/nova-vmware.rst index c182e68c06..9f3e1ca60f 100644 --- a/doc/config-reference/source/tables/nova-vmware.rst +++ b/doc/config-reference/source/tables/nova-vmware.rst @@ -19,44 +19,44 @@ * - **[vmware]** - * - ``api_retry_count`` = ``10`` - - (IntOpt) The number of times we retry on failures, e.g., socket error, etc. + - (Integer) The number of times we retry on failures, e.g., socket error, etc. * - ``ca_file`` = ``None`` - - (StrOpt) Specify a CA bundle file to use in verifying the vCenter server certificate. + - (String) Specify a CA bundle file to use in verifying the vCenter server certificate. * - ``cache_prefix`` = ``None`` - - (StrOpt) The prefix for where cached images are stored. This is NOT the full path - just a folder prefix. This should only be used when a datastore cache should be shared between compute nodes. Note: this should only be used when the compute nodes have a shared file system. + - (String) The prefix for where cached images are stored. This is NOT the full path - just a folder prefix. This should only be used when a datastore cache should be shared between compute nodes. Note: this should only be used when the compute nodes have a shared file system. * - ``cluster_name`` = ``None`` - - (StrOpt) Name of a VMware Cluster ComputeResource. + - (String) Name of a VMware Cluster ComputeResource. * - ``console_delay_seconds`` = ``None`` - - (IntOpt) Set this value if affected by an increased network latency causing repeated characters when typing in a remote console. + - (Integer) Set this value if affected by an increased network latency causing repeated characters when typing in a remote console. * - ``datastore_regex`` = ``None`` - - (StrOpt) Regex to match the name of a datastore. + - (String) Regex to match the name of a datastore. * - ``host_ip`` = ``None`` - - (StrOpt) Hostname or IP address for connection to VMware vCenter host. + - (String) Hostname or IP address for connection to VMware vCenter host. * - ``host_password`` = ``None`` - - (StrOpt) Password for connection to VMware vCenter host. + - (String) Password for connection to VMware vCenter host. * - ``host_port`` = ``443`` - - (PortOpt) Port for connection to VMware vCenter host. + - (Unknown) Port for connection to VMware vCenter host. * - ``host_username`` = ``None`` - - (StrOpt) Username for connection to VMware vCenter host. + - (String) Username for connection to VMware vCenter host. * - ``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. * - ``integration_bridge`` = ``None`` - - (StrOpt) This option should be configured only when using the NSX-MH Neutron plugin. This is the name of the integration bridge on the ESXi. This should not be set for any other Neutron plugin. Hence the default value is not set. + - (String) This option should be configured only when using the NSX-MH Neutron plugin. This is the name of the integration bridge on the ESXi. This should not be set for any other Neutron plugin. Hence the default value is not set. * - ``maximum_objects`` = ``100`` - - (IntOpt) The maximum number of ObjectContent data objects that should be returned in a single result. A positive value will cause the operation to suspend the retrieval when the count of objects reaches the specified maximum. The server may still limit the count to something less than the configured value. Any remaining objects may be retrieved with additional requests. + - (Integer) The maximum number of ObjectContent data objects that should be returned in a single result. A positive value will cause the operation to suspend the retrieval when the count of objects reaches the specified maximum. The server may still limit the count to something less than the configured value. Any remaining objects may be retrieved with additional requests. * - ``pbm_default_policy`` = ``None`` - - (StrOpt) The PBM default policy. If pbm_wsdl_location is set and there is no defined storage policy for the specific request then this policy will be used. + - (String) The PBM default policy. If pbm_wsdl_location is set and there is no defined storage policy for the specific request then this policy will be used. * - ``pbm_enabled`` = ``False`` - - (BoolOpt) The PBM status. + - (Boolean) The PBM status. * - ``pbm_wsdl_location`` = ``None`` - - (StrOpt) PBM service WSDL file location URL. e.g. file:///opt/SDK/spbm/wsdl/pbmService.wsdl Not setting this will disable storage policy based placement of instances. + - (String) PBM service WSDL file location URL. e.g. file:///opt/SDK/spbm/wsdl/pbmService.wsdl Not setting this will disable storage policy based placement of instances. * - ``serial_port_proxy_uri`` = ``None`` - - (StrOpt) Identifies a proxy service that provides network access to the serial_port_service_uri. This option is ignored if serial_port_service_uri is not specified. + - (String) Identifies a proxy service that provides network access to the serial_port_service_uri. This option is ignored if serial_port_service_uri is not specified. * - ``serial_port_service_uri`` = ``None`` - - (StrOpt) Identifies the remote system that serial port traffic will be sent to. If this is not set, no serial ports will be added to the created VMs. + - (String) Identifies the remote system that serial port traffic will be sent to. If this is not set, no serial ports will be added to the created VMs. * - ``task_poll_interval`` = ``0.5`` - - (FloatOpt) The interval used for polling of remote tasks. + - (Floating point) The interval used for polling of remote tasks. * - ``use_linked_clone`` = ``True`` - - (BoolOpt) Whether to use linked clone + - (Boolean) Whether to use linked clone * - ``wsdl_location`` = ``None`` - - (StrOpt) Optional VIM Service WSDL Location e.g http:///vimService.wsdl. Optional over-ride to default location for bug work-arounds + - (String) Optional VIM Service WSDL Location e.g http:///vimService.wsdl. Optional over-ride to default location for bug work-arounds diff --git a/doc/config-reference/source/tables/nova-vnc.rst b/doc/config-reference/source/tables/nova-vnc.rst index b21075b6cc..4e20e84154 100644 --- a/doc/config-reference/source/tables/nova-vnc.rst +++ b/doc/config-reference/source/tables/nova-vnc.rst @@ -19,42 +19,42 @@ * - **[DEFAULT]** - * - ``daemon`` = ``False`` - - (BoolOpt) Become a daemon (background process) + - (Boolean) Become a daemon (background process) * - ``key`` = ``None`` - - (StrOpt) SSL key file (if separate from cert) + - (String) SSL key file (if separate from cert) * - ``record`` = ``False`` - - (BoolOpt) Record sessions to FILE.[session_number] + - (Boolean) Record sessions to FILE.[session_number] * - ``source_is_ipv6`` = ``False`` - - (BoolOpt) Source is ipv6 + - (Boolean) Source is ipv6 * - ``ssl_only`` = ``False`` - - (BoolOpt) Disallow non-encrypted connections + - (Boolean) Disallow non-encrypted connections * - ``web`` = ``/usr/share/spice-html5`` - - (StrOpt) Run webserver on same port. Serve files from DIR. + - (String) Run webserver on same port. Serve files from DIR. * - **[vmware]** - * - ``vnc_port`` = ``5900`` - - (PortOpt) VNC starting port + - (Unknown) VNC starting port * - ``vnc_port_total`` = ``10000`` - - (IntOpt) Total number of VNC ports + - (Integer) Total number of VNC ports * - **[vnc]** - * - ``enabled`` = ``True`` - - (BoolOpt) Enable VNC related features. Guests will get created with graphical devices to support this. Clients (for example Horizon) can then establish a VNC connection to the guest. Possible values: * True: Enables the feature * False: Disables the feature Services which consume this: * ``nova-compute`` Related options: * None + - (Boolean) Enable VNC related features. Guests will get created with graphical devices to support this. Clients (for example Horizon) can then establish a VNC connection to the guest. Possible values: * True: Enables the feature * False: Disables the feature Services which consume this: * ``nova-compute`` Related options: * None * - ``keymap`` = ``en-us`` - - (StrOpt) Keymap for VNC. The keyboard mapping (keymap) determines which keyboard layout a VNC session should use by default. Possible values: * A keyboard layout which is supported by the underlying hypervisor on this node. This is usually an 'IETF language tag' (for example 'en-us'). If you use QEMU as hypervisor, you should find the list of supported keyboard layouts at ``/usr/share/qemu/keymaps``. Services which consume this: * ``nova-compute`` Related options: * None + - (String) Keymap for VNC. The keyboard mapping (keymap) determines which keyboard layout a VNC session should use by default. Possible values: * A keyboard layout which is supported by the underlying hypervisor on this node. This is usually an 'IETF language tag' (for example 'en-us'). If you use QEMU as hypervisor, you should find the list of supported keyboard layouts at ``/usr/share/qemu/keymaps``. Services which consume this: * ``nova-compute`` Related options: * None * - ``novncproxy_base_url`` = ``http://127.0.0.1:6080/vnc_auto.html`` - - (StrOpt) Public address of noVNC VNC console proxy. The VNC proxy is an OpenStack component that enables compute service users to access their instances through VNC clients. noVNC provides VNC support through a websocket-based client. This option sets the public base URL to which client systems will connect. noVNC clients can use this address to connect to the noVNC instance and, by extension, the VNC sessions. Possible values: * A URL Services which consume this: * ``nova-compute`` Related options: * novncproxy_host * novncproxy_port + - (String) Public address of noVNC VNC console proxy. The VNC proxy is an OpenStack component that enables compute service users to access their instances through VNC clients. noVNC provides VNC support through a websocket-based client. This option sets the public base URL to which client systems will connect. noVNC clients can use this address to connect to the noVNC instance and, by extension, the VNC sessions. Possible values: * A URL Services which consume this: * ``nova-compute`` Related options: * novncproxy_host * novncproxy_port * - ``novncproxy_host`` = ``0.0.0.0`` - - (StrOpt) IP address that the noVNC console proxy should bind to. The VNC proxy is an OpenStack component that enables compute service users to access their instances through VNC clients. noVNC provides VNC support through a websocket-based client. This option sets the private address to which the noVNC console proxy service should bind to. Possible values: * An IP address Services which consume this: * ``nova-compute`` Related options: * novncproxy_port * novncproxy_base_url + - (String) IP address that the noVNC console proxy should bind to. The VNC proxy is an OpenStack component that enables compute service users to access their instances through VNC clients. noVNC provides VNC support through a websocket-based client. This option sets the private address to which the noVNC console proxy service should bind to. Possible values: * An IP address Services which consume this: * ``nova-compute`` Related options: * novncproxy_port * novncproxy_base_url * - ``novncproxy_port`` = ``6080`` - - (IntOpt) Port that the noVNC console proxy should bind to. The VNC proxy is an OpenStack component that enables compute service users to access their instances through VNC clients. noVNC provides VNC support through a websocket-based client. This option sets the private port to which the noVNC console proxy service should bind to. Possible values: * A port number Services which consume this: * ``nova-compute`` Related options: * novncproxy_host * novncproxy_base_url + - (Integer) Port that the noVNC console proxy should bind to. The VNC proxy is an OpenStack component that enables compute service users to access their instances through VNC clients. noVNC provides VNC support through a websocket-based client. This option sets the private port to which the noVNC console proxy service should bind to. Possible values: * A port number Services which consume this: * ``nova-compute`` Related options: * novncproxy_host * novncproxy_base_url * - ``vncserver_listen`` = ``127.0.0.1`` - - (StrOpt) The IP address on which an instance should listen to for incoming VNC connection requests on this node. Possible values: * An IP address Services which consume this: * ``nova-compute`` Related options: * None + - (String) The IP address on which an instance should listen to for incoming VNC connection requests on this node. Possible values: * An IP address Services which consume this: * ``nova-compute`` Related options: * None * - ``vncserver_proxyclient_address`` = ``127.0.0.1`` - - (StrOpt) Private, internal address of VNC console proxy. The VNC proxy is an OpenStack component that enables compute service users to access their instances through VNC clients. This option sets the private address to which proxy clients, such as ``nova-xvpvncproxy``, should connect to. Possible values: * An IP address Services which consume this: * ``nova-compute`` Related options: * None + - (String) Private, internal address of VNC console proxy. The VNC proxy is an OpenStack component that enables compute service users to access their instances through VNC clients. This option sets the private address to which proxy clients, such as ``nova-xvpvncproxy``, should connect to. Possible values: * An IP address Services which consume this: * ``nova-compute`` Related options: * None * - ``xvpvncproxy_base_url`` = ``http://127.0.0.1:6081/console`` - - (StrOpt) Public address of XVP VNC console proxy. The VNC proxy is an OpenStack component that enables compute service users to access their instances through VNC clients. Xen provides the Xenserver VNC Proxy, or XVP, as an alternative to the websocket-based noVNC proxy used by Libvirt. In contrast to noVNC, XVP clients are Java-based. This option sets the public base URL to which client systems will connect. XVP clients can use this address to connect to the XVP instance and, by extension, the VNC sessions. Possible values: * A URL Services which consume this: * ``nova-compute`` Related options: * xvpvncproxy_host * xvpvncproxy_port + - (String) Public address of XVP VNC console proxy. The VNC proxy is an OpenStack component that enables compute service users to access their instances through VNC clients. Xen provides the Xenserver VNC Proxy, or XVP, as an alternative to the websocket-based noVNC proxy used by Libvirt. In contrast to noVNC, XVP clients are Java-based. This option sets the public base URL to which client systems will connect. XVP clients can use this address to connect to the XVP instance and, by extension, the VNC sessions. Possible values: * A URL Services which consume this: * ``nova-compute`` Related options: * xvpvncproxy_host * xvpvncproxy_port * - ``xvpvncproxy_host`` = ``0.0.0.0`` - - (StrOpt) IP address that the XVP VNC console proxy should bind to. The VNC proxy is an OpenStack component that enables compute service users to access their instances through VNC clients. Xen provides the Xenserver VNC Proxy, or XVP, as an alternative to the websocket-based noVNC proxy used by Libvirt. In contrast to noVNC, XVP clients are Java-based. This option sets the private address to which the XVP VNC console proxy service should bind to. Possible values: * An IP address Services which consume this: * ``nova-compute`` Related options: * xvpvncproxy_port * xvpvncproxy_base_url + - (String) IP address that the XVP VNC console proxy should bind to. The VNC proxy is an OpenStack component that enables compute service users to access their instances through VNC clients. Xen provides the Xenserver VNC Proxy, or XVP, as an alternative to the websocket-based noVNC proxy used by Libvirt. In contrast to noVNC, XVP clients are Java-based. This option sets the private address to which the XVP VNC console proxy service should bind to. Possible values: * An IP address Services which consume this: * ``nova-compute`` Related options: * xvpvncproxy_port * xvpvncproxy_base_url * - ``xvpvncproxy_port`` = ``6081`` - - (IntOpt) Port that the XVP VNC console proxy should bind to. The VNC proxy is an OpenStack component that enables compute service users to access their instances through VNC clients. Xen provides the Xenserver VNC Proxy, or XVP, as an alternative to the websocket-based noVNC proxy used by Libvirt. In contrast to noVNC, XVP clients are Java-based. This option sets the private port to which the XVP VNC console proxy service should bind to. Possible values: * A port number Services which consume this: * ``nova-compute`` Related options: * xvpvncproxy_host * xvpvncproxy_base_url + - (Integer) Port that the XVP VNC console proxy should bind to. The VNC proxy is an OpenStack component that enables compute service users to access their instances through VNC clients. Xen provides the Xenserver VNC Proxy, or XVP, as an alternative to the websocket-based noVNC proxy used by Libvirt. In contrast to noVNC, XVP clients are Java-based. This option sets the private port to which the XVP VNC console proxy service should bind to. Possible values: * A port number Services which consume this: * ``nova-compute`` Related options: * xvpvncproxy_host * xvpvncproxy_base_url diff --git a/doc/config-reference/source/tables/nova-volumes.rst b/doc/config-reference/source/tables/nova-volumes.rst index adc8b1633f..65b1102652 100644 --- a/doc/config-reference/source/tables/nova-volumes.rst +++ b/doc/config-reference/source/tables/nova-volumes.rst @@ -19,74 +19,74 @@ * - **[DEFAULT]** - * - ``block_device_allocate_retries`` = ``60`` - - (IntOpt) Number of times to retry block device allocation on failures. Starting with Liberty, Cinder can use image volume cache. This may help with block device allocation performance. Look at the cinder image_volume_cache_enabled configuration option. + - (Integer) Number of times to retry block device allocation on failures. Starting with Liberty, Cinder can use image volume cache. This may help with block device allocation performance. Look at the cinder image_volume_cache_enabled configuration option. * - ``block_device_allocate_retries_interval`` = ``3`` - - (IntOpt) Waiting time interval (seconds) between block device allocation retries on failures + - (Integer) Waiting time interval (seconds) between block device allocation retries on failures * - ``my_block_storage_ip`` = ``$my_ip`` - - (StrOpt) Block storage IP address of this host + - (String) Block storage IP address of this host * - ``volume_api_class`` = ``nova.volume.cinder.API`` - - (StrOpt) The full class name of the volume API class to use + - (String) DEPRECATED: The full class name of the volume API class to use * - ``volume_usage_poll_interval`` = ``0`` - - (IntOpt) Interval in seconds for gathering volume usages + - (Integer) Interval in seconds for gathering volume usages * - **[cinder]** - * - ``cafile`` = ``None`` - - (StrOpt) PEM encoded Certificate Authority to use when verifying HTTPs connections. + - (String) PEM encoded Certificate Authority to use when verifying HTTPs connections. * - ``catalog_info`` = ``volumev2:cinderv2:publicURL`` - - (StrOpt) Info to match when looking for cinder in the service catalog. Format is: separated values of the form: :: + - (String) Info to match when looking for cinder in the service catalog. Format is: separated values of the form: :: * - ``certfile`` = ``None`` - - (StrOpt) PEM encoded client certificate cert file + - (String) PEM encoded client certificate cert file * - ``cross_az_attach`` = ``True`` - - (BoolOpt) Allow attach between instance and volume in different availability zones. If False, volumes attached to an instance must be in the same availability zone in Cinder as the instance availability zone in Nova. This also means care should be taken when booting an instance from a volume where source is not "volume" because Nova will attempt to create a volume using the same availability zone as what is assigned to the instance. If that AZ is not in Cinder (or allow_availability_zone_fallback=False in cinder.conf), the volume create request will fail and the instance will fail the build request. + - (Boolean) Allow attach between instance and volume in different availability zones. If False, volumes attached to an instance must be in the same availability zone in Cinder as the instance availability zone in Nova. This also means care should be taken when booting an instance from a volume where source is not "volume" because Nova will attempt to create a volume using the same availability zone as what is assigned to the instance. If that AZ is not in Cinder (or allow_availability_zone_fallback=False in cinder.conf), the volume create request will fail and the instance will fail the build request. * - ``endpoint_template`` = ``None`` - - (StrOpt) Override service catalog lookup with template for cinder endpoint e.g. http://localhost:8776/v1/%(project_id)s + - (String) Override service catalog lookup with template for cinder endpoint e.g. http://localhost:8776/v1/%(project_id)s * - ``http_retries`` = ``3`` - - (IntOpt) Number of cinderclient retries on failed http calls + - (Integer) Number of cinderclient retries on failed http calls * - ``insecure`` = ``False`` - - (BoolOpt) Verify HTTPS connections. + - (Boolean) Verify HTTPS connections. * - ``keyfile`` = ``None`` - - (StrOpt) PEM encoded client certificate key file + - (String) PEM encoded client certificate key file * - ``os_region_name`` = ``None`` - - (StrOpt) Region name of this node + - (String) Region name of this node * - ``timeout`` = ``None`` - - (IntOpt) Timeout value for http requests + - (Integer) Timeout value for http requests * - **[hyperv]** - * - ``force_volumeutils_v1`` = ``False`` - - (BoolOpt) Force V1 volume utility class + - (Boolean) DEPRECATED: Force V1 volume utility class * - ``volume_attach_retry_count`` = ``10`` - - (IntOpt) The number of times to retry to attach a volume + - (Integer) The number of times to retry to attach a volume * - ``volume_attach_retry_interval`` = ``5`` - - (IntOpt) Interval between volume attachment attempts, in seconds + - (Integer) Interval between volume attachment attempts, in seconds * - **[libvirt]** - * - ``glusterfs_mount_point_base`` = ``$state_path/mnt`` - - (StrOpt) Directory where the glusterfs volume is mounted on the compute node + - (String) Directory where the glusterfs volume is mounted on the compute node * - ``nfs_mount_options`` = ``None`` - - (StrOpt) Mount options passed to the NFS client. See section of the nfs man page for details + - (String) Mount options passed to the NFS client. See section of the nfs man page for details * - ``nfs_mount_point_base`` = ``$state_path/mnt`` - - (StrOpt) Directory where the NFS volume is mounted on the compute node + - (String) Directory where the NFS volume is mounted on the compute node * - ``num_aoe_discover_tries`` = ``3`` - - (IntOpt) Number of times to rediscover AoE target to find volume + - (Integer) Number of times to rediscover AoE target to find volume * - ``num_iscsi_scan_tries`` = ``5`` - - (IntOpt) Number of times to rescan iSCSI target to find volume + - (Integer) Number of times to rescan iSCSI target to find volume * - ``num_iser_scan_tries`` = ``5`` - - (IntOpt) Number of times to rescan iSER target to find volume + - (Integer) Number of times to rescan iSER target to find volume * - ``qemu_allowed_storage_drivers`` = - - (ListOpt) Protocols listed here will be accessed directly from QEMU. Currently supported protocols: [gluster] + - (List) Protocols listed here will be accessed directly from QEMU. Currently supported protocols: [gluster] * - ``rbd_secret_uuid`` = ``None`` - - (StrOpt) The libvirt UUID of the secret for the rbd_uservolumes + - (String) The libvirt UUID of the secret for the rbd_uservolumes * - ``rbd_user`` = ``None`` - - (StrOpt) The RADOS client name for accessing rbd volumes + - (String) The RADOS client name for accessing rbd volumes * - ``scality_sofs_config`` = ``None`` - - (StrOpt) Path or URL to Scality SOFS configuration file + - (String) Path or URL to Scality SOFS configuration file * - ``scality_sofs_mount_point`` = ``$state_path/scality`` - - (StrOpt) Base dir where Scality SOFS shall be mounted + - (String) Base dir where Scality SOFS shall be mounted * - ``smbfs_mount_options`` = - - (StrOpt) Mount options passed to the SMBFS client. See mount.cifs man page for details. Note that the libvirt-qemu uid and gid must be specified. + - (String) Mount options passed to the SMBFS client. See mount.cifs man page for details. Note that the libvirt-qemu uid and gid must be specified. * - ``smbfs_mount_point_base`` = ``$state_path/mnt`` - - (StrOpt) Directory where the SMBFS shares are mounted on the compute node + - (String) Directory where the SMBFS shares are mounted on the compute node * - **[xenserver]** - * - ``block_device_creation_timeout`` = ``10`` - - (IntOpt) Time to wait for a block device to be created + - (Integer) Time to wait for a block device to be created diff --git a/doc/config-reference/source/tables/nova-vpn.rst b/doc/config-reference/source/tables/nova-vpn.rst index 85b4ff0d0d..64f6a118db 100644 --- a/doc/config-reference/source/tables/nova-vpn.rst +++ b/doc/config-reference/source/tables/nova-vpn.rst @@ -19,20 +19,20 @@ * - **[DEFAULT]** - * - ``boot_script_template`` = ``$pybasedir/nova/cloudpipe/bootscript.template`` - - (StrOpt) Template for cloudpipe instance boot script + - (String) Template for cloudpipe instance boot script * - ``dmz_cidr`` = - - (ListOpt) A list of dmz ranges that should be accepted + - (List) A list of dmz ranges that should be accepted * - ``dmz_mask`` = ``255.255.255.0`` - - (StrOpt) Netmask to push into openvpn config + - (String) Netmask to push into openvpn config * - ``dmz_net`` = ``10.0.0.0`` - - (StrOpt) Network to push into openvpn config + - (String) Network to push into openvpn config * - ``vpn_flavor`` = ``m1.tiny`` - - (StrOpt) Flavor for vpn instances + - (String) Flavor for vpn instances * - ``vpn_image_id`` = ``0`` - - (StrOpt) Image ID used when starting up a cloudpipe vpn server + - (String) Image ID used when starting up a cloudpipe vpn server * - ``vpn_ip`` = ``$my_ip`` - - (StrOpt) Public IP for the cloudpipe VPN servers + - (String) Public IP for the cloudpipe VPN servers * - ``vpn_key_suffix`` = ``-vpn`` - - (StrOpt) Suffix to add to project name for vpn key and secgroups + - (String) Suffix to add to project name for vpn key and secgroups * - ``vpn_start`` = ``1000`` - - (IntOpt) First Vpn port for private networks + - (Integer) First Vpn port for private networks diff --git a/doc/config-reference/source/tables/nova-xen.rst b/doc/config-reference/source/tables/nova-xen.rst index b805f19521..62e8f2a73c 100644 --- a/doc/config-reference/source/tables/nova-xen.rst +++ b/doc/config-reference/source/tables/nova-xen.rst @@ -19,112 +19,112 @@ * - **[DEFAULT]** - * - ``console_driver`` = ``nova.console.xvp.XVPConsoleProxy`` - - (StrOpt) Driver to use for the console proxy + - (String) Driver to use for the console proxy * - ``console_xvp_conf`` = ``/etc/xvp.conf`` - - (StrOpt) Generated XVP conf file + - (String) Generated XVP conf file * - ``console_xvp_conf_template`` = ``$pybasedir/nova/console/xvp.conf.template`` - - (StrOpt) XVP conf template + - (String) XVP conf template * - ``console_xvp_log`` = ``/var/log/xvp.log`` - - (StrOpt) XVP log file + - (String) XVP log file * - ``console_xvp_multiplex_port`` = ``5900`` - - (IntOpt) Port for XVP to multiplex VNC connections on + - (Integer) Port for XVP to multiplex VNC connections on * - ``console_xvp_pid`` = ``/var/run/xvp.pid`` - - (StrOpt) XVP master process pid file + - (String) XVP master process pid file * - ``stub_compute`` = ``False`` - - (BoolOpt) Stub calls to compute worker for tests + - (Boolean) Stub calls to compute worker for tests * - **[libvirt]** - * - ``xen_hvmloader_path`` = ``/usr/lib/xen/boot/hvmloader`` - - (StrOpt) Location where the Xen hvmloader is kept + - (String) Location where the Xen hvmloader is kept * - **[xenserver]** - * - ``agent_path`` = ``usr/sbin/xe-update-networking`` - - (StrOpt) Specifies the path in which the XenAPI guest agent should be located. If the agent is present, network configuration is not injected into the image. Used if compute_driver=xenapi.XenAPIDriver and flat_injected=True + - (String) Specifies the path in which the XenAPI guest agent should be located. If the agent is present, network configuration is not injected into the image. Used if compute_driver=xenapi.XenAPIDriver and flat_injected=True * - ``agent_resetnetwork_timeout`` = ``60`` - - (IntOpt) Number of seconds to wait for agent reply to resetnetwork request + - (Integer) Number of seconds to wait for agent reply to resetnetwork request * - ``agent_timeout`` = ``30`` - - (IntOpt) Number of seconds to wait for agent reply + - (Integer) Number of seconds to wait for agent reply * - ``agent_version_timeout`` = ``300`` - - (IntOpt) Number of seconds to wait for agent to be fully operational + - (Integer) Number of seconds to wait for agent to be fully operational * - ``cache_images`` = ``all`` - - (StrOpt) Cache glance images locally. `all` will cache all images, `some` will only cache images that have the image_property `cache_in_nova=True`, and `none` turns off caching entirely + - (String) Cache glance images locally. `all` will cache all images, `some` will only cache images that have the image_property `cache_in_nova=True`, and `none` turns off caching entirely * - ``check_host`` = ``True`` - - (BoolOpt) Ensure compute service is running on host XenAPI connects to. + - (Boolean) Ensure compute service is running on host XenAPI connects to. * - ``connection_concurrent`` = ``5`` - - (IntOpt) Maximum number of concurrent XenAPI connections. Used only if compute_driver=xenapi.XenAPIDriver + - (Integer) Maximum number of concurrent XenAPI connections. Used only if compute_driver=xenapi.XenAPIDriver * - ``connection_password`` = ``None`` - - (StrOpt) Password for connection to XenServer/Xen Cloud Platform. Used only if compute_driver=xenapi.XenAPIDriver + - (String) Password for connection to XenServer/Xen Cloud Platform. Used only if compute_driver=xenapi.XenAPIDriver * - ``connection_url`` = ``None`` - - (StrOpt) URL for connection to XenServer/Xen Cloud Platform. A special value of unix://local can be used to connect to the local unix socket. Required if compute_driver=xenapi.XenAPIDriver + - (String) URL for connection to XenServer/Xen Cloud Platform. A special value of unix://local can be used to connect to the local unix socket. Required if compute_driver=xenapi.XenAPIDriver * - ``connection_username`` = ``root`` - - (StrOpt) Username for connection to XenServer/Xen Cloud Platform. Used only if compute_driver=xenapi.XenAPIDriver + - (String) Username for connection to XenServer/Xen Cloud Platform. Used only if compute_driver=xenapi.XenAPIDriver * - ``default_os_type`` = ``linux`` - - (StrOpt) Default OS type + - (String) Default OS type * - ``disable_agent`` = ``False`` - - (BoolOpt) Disables the use of the XenAPI agent in any image regardless of what image properties are present. + - (Boolean) Disables the use of the XenAPI agent in any image regardless of what image properties are present. * - ``image_compression_level`` = ``None`` - - (IntOpt) Compression level for images, e.g., 9 for gzip -9. Range is 1-9, 9 being most compressed but most CPU intensive on dom0. + - (Integer) Compression level for images, e.g., 9 for gzip -9. Range is 1-9, 9 being most compressed but most CPU intensive on dom0. * - ``image_upload_handler`` = ``nova.virt.xenapi.image.glance.GlanceStore`` - - (StrOpt) Dom0 plugin driver used to handle image uploads. + - (String) Dom0 plugin driver used to handle image uploads. * - ``introduce_vdi_retry_wait`` = ``20`` - - (IntOpt) Number of seconds to wait for an SR to settle if the VDI does not exist when first introduced + - (Integer) Number of seconds to wait for an SR to settle if the VDI does not exist when first introduced * - ``ipxe_boot_menu_url`` = ``None`` - - (StrOpt) URL to the iPXE boot menu + - (String) URL to the iPXE boot menu * - ``ipxe_mkisofs_cmd`` = ``mkisofs`` - - (StrOpt) Name and optionally path of the tool used for ISO image creation + - (String) Name and optionally path of the tool used for ISO image creation * - ``ipxe_network_name`` = ``None`` - - (StrOpt) Name of network to use for booting iPXE ISOs + - (String) Name of network to use for booting iPXE ISOs * - ``iqn_prefix`` = ``iqn.2010-10.org.openstack`` - - (StrOpt) IQN Prefix + - (String) IQN Prefix * - ``login_timeout`` = ``10`` - - (IntOpt) Timeout in seconds for XenAPI login. + - (Integer) Timeout in seconds for XenAPI login. * - ``max_kernel_ramdisk_size`` = ``16777216`` - - (IntOpt) Maximum size in bytes of kernel or ramdisk images + - (Integer) Maximum size in bytes of kernel or ramdisk images * - ``num_vbd_unplug_retries`` = ``10`` - - (IntOpt) Maximum number of retries to unplug VBD. if <=0, should try once and no retry + - (Integer) Maximum number of retries to unplug VBD. if <=0, should try once and no retry * - ``ovs_integration_bridge`` = ``xapi1`` - - (StrOpt) Name of Integration Bridge used by Open vSwitch + - (String) Name of Integration Bridge used by Open vSwitch * - ``remap_vbd_dev`` = ``False`` - - (BoolOpt) Used to enable the remapping of VBD dev (Works around an issue in Ubuntu Maverick) + - (Boolean) Used to enable the remapping of VBD dev (Works around an issue in Ubuntu Maverick) * - ``remap_vbd_dev_prefix`` = ``sd`` - - (StrOpt) Specify prefix to remap VBD dev to (ex. /dev/xvdb -> /dev/sdb) + - (String) Specify prefix to remap VBD dev to (ex. /dev/xvdb -> /dev/sdb) * - ``running_timeout`` = ``60`` - - (IntOpt) Number of seconds to wait for instance to go to running state + - (Integer) Number of seconds to wait for instance to go to running state * - ``sparse_copy`` = ``True`` - - (BoolOpt) Whether to use sparse_copy for copying data on a resize down (False will use standard dd). This speeds up resizes down considerably since large runs of zeros won't have to be rsynced + - (Boolean) Whether to use sparse_copy for copying data on a resize down (False will use standard dd). This speeds up resizes down considerably since large runs of zeros won't have to be rsynced * - ``sr_base_path`` = ``/var/run/sr-mount`` - - (StrOpt) Base path to the storage repository + - (String) Base path to the storage repository * - ``sr_matching_filter`` = ``default-sr:true`` - - (StrOpt) Filter for finding the SR to be used to install guest instances on. To use the Local Storage in default XenServer/XCP installations set this flag to other-config:i18n-key=local-storage. To select an SR with a different matching criteria, you could set it to other-config:my_favorite_sr=true. On the other hand, to fall back on the Default SR, as displayed by XenCenter, set this flag to: default-sr:true + - (String) Filter for finding the SR to be used to install guest instances on. To use the Local Storage in default XenServer/XCP installations set this flag to other-config:i18n-key=local-storage. To select an SR with a different matching criteria, you could set it to other-config:my_favorite_sr=true. On the other hand, to fall back on the Default SR, as displayed by XenCenter, set this flag to: default-sr:true * - ``target_host`` = ``None`` - - (StrOpt) The iSCSI Target Host + - (String) The iSCSI Target Host * - ``target_port`` = ``3260`` - - (StrOpt) The iSCSI Target Port, default is port 3260 + - (String) The iSCSI Target Port, default is port 3260 * - ``torrent_base_url`` = ``None`` - - (StrOpt) Base URL for torrent files; must contain a slash character (see RFC 1808, step 6) + - (String) Base URL for torrent files; must contain a slash character (see RFC 1808, step 6) * - ``torrent_download_stall_cutoff`` = ``600`` - - (IntOpt) Number of seconds a download can remain at the same progress percentage w/o being considered a stall + - (Integer) Number of seconds a download can remain at the same progress percentage w/o being considered a stall * - ``torrent_images`` = ``none`` - - (StrOpt) Whether or not to download images via Bit Torrent. + - (String) Whether or not to download images via Bit Torrent. * - ``torrent_listen_port_end`` = ``6891`` - - (IntOpt) End of port range to listen on + - (Integer) End of port range to listen on * - ``torrent_listen_port_start`` = ``6881`` - - (IntOpt) Beginning of port range to listen on + - (Integer) Beginning of port range to listen on * - ``torrent_max_last_accessed`` = ``86400`` - - (IntOpt) Cached torrent files not accessed within this number of seconds can be reaped + - (Integer) Cached torrent files not accessed within this number of seconds can be reaped * - ``torrent_max_seeder_processes_per_host`` = ``1`` - - (IntOpt) Maximum number of seeder processes to run concurrently within a given dom0. (-1 = no limit) + - (Integer) Maximum number of seeder processes to run concurrently within a given dom0. (-1 = no limit) * - ``torrent_seed_chance`` = ``1.0`` - - (FloatOpt) Probability that peer will become a seeder. (1.0 = 100%) + - (Floating point) Probability that peer will become a seeder. (1.0 = 100%) * - ``torrent_seed_duration`` = ``3600`` - - (IntOpt) Number of seconds after downloading an image via BitTorrent that it should be seeded for other peers. + - (Integer) Number of seconds after downloading an image via BitTorrent that it should be seeded for other peers. * - ``use_agent_default`` = ``False`` - - (BoolOpt) Determines if the XenAPI agent should be used when the image used does not contain a hint to declare if the agent is present or not. The hint is a glance property "xenapi_use_agent" that has the value "True" or "False". Note that waiting for the agent when it is not present will significantly increase server boot times. + - (Boolean) Determines if the XenAPI agent should be used when the image used does not contain a hint to declare if the agent is present or not. The hint is a glance property "xenapi_use_agent" that has the value "True" or "False". Note that waiting for the agent when it is not present will significantly increase server boot times. * - ``use_join_force`` = ``True`` - - (BoolOpt) To use for hosts with different CPUs + - (Boolean) To use for hosts with different CPUs * - ``vhd_coalesce_max_attempts`` = ``20`` - - (IntOpt) Max number of times to poll for VHD to coalesce. Used only if compute_driver=xenapi.XenAPIDriver + - (Integer) Max number of times to poll for VHD to coalesce. Used only if compute_driver=xenapi.XenAPIDriver * - ``vhd_coalesce_poll_interval`` = ``5.0`` - - (FloatOpt) The interval used for polling of coalescing vhds. Used only if compute_driver=xenapi.XenAPIDriver + - (Floating point) The interval used for polling of coalescing vhds. Used only if compute_driver=xenapi.XenAPIDriver * - ``vif_driver`` = ``nova.virt.xenapi.vif.XenAPIBridgeDriver`` - - (StrOpt) The XenAPI VIF driver using XenServer Network APIs. + - (String) The XenAPI VIF driver using XenServer Network APIs. diff --git a/doc/config-reference/source/tables/nova-zeromq.rst b/doc/config-reference/source/tables/nova-zeromq.rst index 0f6a732809..886cbb50c0 100644 --- a/doc/config-reference/source/tables/nova-zeromq.rst +++ b/doc/config-reference/source/tables/nova-zeromq.rst @@ -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). diff --git a/doc/config-reference/source/tables/sahara-amqp.rst b/doc/config-reference/source/tables/sahara-amqp.rst index b63b84ed07..5961899714 100644 --- a/doc/config-reference/source/tables/sahara-amqp.rst +++ b/doc/config-reference/source/tables/sahara-amqp.rst @@ -19,16 +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. - * - ``notification_driver`` = ``[]`` - - (MultiStrOpt) The Drivers(s) to handle sending notifications. Possible values are messaging, messagingv2, routing, log, test, noop - * - ``notification_level`` = ``INFO`` - - (StrOpt) Notification level for outgoing notifications - * - ``notification_publisher_id`` = ``None`` - - (StrOpt) Notification publisher_id for outgoing notifications - * - ``notification_topics`` = ``notifications`` - - (ListOpt) AMQP topic used for OpenStack notifications. - * - ``notification_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) 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. diff --git a/doc/config-reference/source/tables/sahara-api.rst b/doc/config-reference/source/tables/sahara-api.rst index 981d6b639e..9193ad5191 100644 --- a/doc/config-reference/source/tables/sahara-api.rst +++ b/doc/config-reference/source/tables/sahara-api.rst @@ -19,12 +19,34 @@ * - **[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. * - **[retries]** - * - ``retries_number`` = ``5`` - - (IntOpt) Number of times to retry the request to client before failing + - (Integer) Number of times to retry the request to client before failing * - ``retry_after`` = ``10`` - - (IntOpt) Time between the retries to client (in seconds). + - (Integer) Time between the retries to client (in seconds). + * - **[service_auth]** + - + * - ``admin_password`` = ``password`` + - (String) The service admin password + * - ``admin_project_domain`` = ``admin`` + - (String) The admin project domain name + * - ``admin_tenant_name`` = ``admin`` + - (String) The service admin tenant name + * - ``admin_user`` = ``admin`` + - (String) The service admin user name + * - ``admin_user_domain`` = ``admin`` + - (String) The admin user domain name + * - ``auth_url`` = ``http://127.0.0.1:5000/v2.0`` + - (String) Authentication endpoint + * - ``auth_version`` = ``2`` + - (String) The auth version used to authenticate + * - ``endpoint_type`` = ``public`` + - (String) The endpoint_type to be used + * - ``region`` = ``RegionOne`` + - (String) The deployment region + * - ``service_name`` = ``lbaas`` + - (String) The name of the service diff --git a/doc/config-reference/source/tables/sahara-auth_token.rst b/doc/config-reference/source/tables/sahara-auth_token.rst index 6676d51963..7e24c3cc84 100644 --- a/doc/config-reference/source/tables/sahara-auth_token.rst +++ b/doc/config-reference/source/tables/sahara-auth_token.rst @@ -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. - * - ``auth_plugin`` = ``None`` - - (StrOpt) Name of the plugin to load + - (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 (http or https). Deprecated, use identity_uri. + - (String) Protocol of the admin Identity API endpoint. Deprecated, use identity_uri. * - ``auth_section`` = ``None`` - - (StrOpt) Config Section from which to load plugin specific options + - (Unknown) Config Section from which to load plugin specific options + * - ``auth_type`` = ``None`` + - (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. Acceptable values are MAC or ENCRYPT. 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. diff --git a/doc/config-reference/source/tables/sahara-clients.rst b/doc/config-reference/source/tables/sahara-clients.rst index 3a0ed84857..825d7e8e92 100644 --- a/doc/config-reference/source/tables/sahara-clients.rst +++ b/doc/config-reference/source/tables/sahara-clients.rst @@ -19,58 +19,58 @@ * - **[cinder]** - * - ``api_insecure`` = ``False`` - - (BoolOpt) Allow to perform insecure SSL requests to cinder. + - (Boolean) Allow to perform insecure SSL requests to cinder. * - ``api_version`` = ``2`` - - (IntOpt) Version of the Cinder API to use. + - (Integer) Version of the Cinder API to use. * - ``ca_file`` = ``None`` - - (StrOpt) Location of ca certificates file to use for cinder client requests. + - (String) Location of ca certificates file to use for cinder client requests. * - ``endpoint_type`` = ``internalURL`` - - (StrOpt) Endpoint type for cinder client requests + - (String) Endpoint type for cinder client requests * - **[heat]** - * - ``api_insecure`` = ``False`` - - (BoolOpt) Allow to perform insecure SSL requests to heat. + - (Boolean) Allow to perform insecure SSL requests to heat. * - ``ca_file`` = ``None`` - - (StrOpt) Location of ca certificates file to use for heat client requests. + - (String) Location of ca certificates file to use for heat client requests. * - ``endpoint_type`` = ``internalURL`` - - (StrOpt) Endpoint type for heat client requests + - (String) Endpoint type for heat client requests * - **[keystone]** - * - ``api_insecure`` = ``False`` - - (BoolOpt) Allow to perform insecure SSL requests to keystone. + - (Boolean) Allow to perform insecure SSL requests to keystone. * - ``ca_file`` = ``None`` - - (StrOpt) Location of ca certificates file to use for keystone client requests. + - (String) Location of ca certificates file to use for keystone client requests. * - ``endpoint_type`` = ``internalURL`` - - (StrOpt) Endpoint type for keystone client requests + - (String) Endpoint type for keystone client requests * - **[manila]** - * - ``api_insecure`` = ``True`` - - (BoolOpt) Allow to perform insecure SSL requests to manila. + - (Boolean) Allow to perform insecure SSL requests to manila. * - ``api_version`` = ``1`` - - (IntOpt) Version of the manila API to use. + - (Integer) Version of the manila API to use. * - ``ca_file`` = ``None`` - - (StrOpt) Location of ca certificates file to use for manila client requests. + - (String) Location of ca certificates file to use for manila client requests. * - **[neutron]** - * - ``api_insecure`` = ``False`` - - (BoolOpt) Allow to perform insecure SSL requests to neutron. + - (Boolean) Allow to perform insecure SSL requests to neutron. * - ``ca_file`` = ``None`` - - (StrOpt) Location of ca certificates file to use for neutron client requests. + - (String) Location of ca certificates file to use for neutron client requests. * - ``endpoint_type`` = ``internalURL`` - - (StrOpt) Endpoint type for neutron client requests + - (String) Endpoint type for neutron client requests * - **[nova]** - * - ``api_insecure`` = ``False`` - - (BoolOpt) Allow to perform insecure SSL requests to nova. + - (Boolean) Allow to perform insecure SSL requests to nova. * - ``ca_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. * - ``endpoint_type`` = ``internalURL`` - - (StrOpt) Endpoint type for nova client requests + - (String) Endpoint type for nova client requests * - **[swift]** - * - ``api_insecure`` = ``False`` - - (BoolOpt) Allow to perform insecure SSL requests to swift. + - (Boolean) Allow to perform insecure SSL requests to swift. * - ``ca_file`` = ``None`` - - (StrOpt) Location of ca certificates file to use for swift client requests. + - (String) Location of ca certificates file to use for swift client requests. * - ``endpoint_type`` = ``internalURL`` - - (StrOpt) Endpoint type for swift client requests + - (String) Endpoint type for swift client requests diff --git a/doc/config-reference/source/tables/sahara-common.rst b/doc/config-reference/source/tables/sahara-common.rst index 3177bb3a6a..5c3b0223a0 100644 --- a/doc/config-reference/source/tables/sahara-common.rst +++ b/doc/config-reference/source/tables/sahara-common.rst @@ -19,84 +19,108 @@ * - **[DEFAULT]** - * - ``admin_project_domain_name`` = ``default`` - - (StrOpt) The name of the domain for the service project(ex. tenant). + - (String) The name of the domain for the service project(ex. tenant). * - ``admin_user_domain_name`` = ``default`` - - (StrOpt) The name of the domain to which the admin user belongs. + - (String) The name of the domain to which the admin user belongs. * - ``api_workers`` = ``1`` - - (IntOpt) Number of workers for Sahara API service (0 means all-in-one-thread configuration). + - (Integer) Number of workers for Sahara API service (0 means all-in-one-thread configuration). * - ``cleanup_time_for_incomplete_clusters`` = ``0`` - - (IntOpt) Maximal time (in hours) for clusters allowed to be in states other than "Active", "Deleting" or "Error". If a cluster is not in "Active", "Deleting" or "Error" state and last update of it was longer than "cleanup_time_for_incomplete_clusters" hours ago then it will be deleted automatically. (0 value means that automatic clean up is disabled). - * - ``cluster_operation_trust_expiration_hours`` = ``24`` - - (IntOpt) Defines the period of time (in hours) after which trusts created to allow sahara to create or scale a cluster will expire. Note that this value should be significantly larger than the value of the cleanup_time_for_incomplete_clusters configuration key if use of the cluster cleanup feature is desired (the trust must last at least as long as a cluster could validly take to stall in its creation, plus the timeout value set in that key, plus one hour for the period of the cleanup job). + - (Integer) Maximal time (in hours) for clusters allowed to be in states other than "Active", "Deleting" or "Error". If a cluster is not in "Active", "Deleting" or "Error" state and last update of it was longer than "cleanup_time_for_incomplete_clusters" hours ago then it will be deleted automatically. (0 value means that automatic clean up is disabled). * - ``cluster_remote_threshold`` = ``70`` - - (IntOpt) The same as global_remote_threshold, but for a single cluster. + - (Integer) The same as global_remote_threshold, but for a single cluster. * - ``compute_topology_file`` = ``etc/sahara/compute.topology`` - - (StrOpt) File with nova compute topology. It should contain mapping between nova computes and racks. + - (String) File with nova compute topology. It should contain mapping between nova computes and racks. + * - ``coordinator_heartbeat_interval`` = ``1`` + - (Integer) Interval size between heartbeat execution in seconds. Heartbeats are executed to make sure that connection to the coordination server is active. * - ``default_ntp_server`` = ``pool.ntp.org`` - - (StrOpt) Default ntp server for time sync + - (String) Default ntp server for time sync * - ``disable_event_log`` = ``False`` - - (BoolOpt) Disables event log feature. + - (Boolean) Disables event log feature. * - ``enable_data_locality`` = ``False`` - - (BoolOpt) Enables data locality for hadoop cluster. Also enables data locality for Swift used by hadoop. If enabled, 'compute_topology' and 'swift_topology' configuration parameters should point to OpenStack and Swift topology correspondingly. + - (Boolean) Enables data locality for hadoop cluster. Also enables data locality for Swift used by hadoop. If enabled, 'compute_topology' and 'swift_topology' configuration parameters should point to OpenStack and Swift topology correspondingly. * - ``enable_hypervisor_awareness`` = ``True`` - - (BoolOpt) Enables four-level topology for data locality. Works only if corresponding plugin supports such mode. - * - ``enable_notifications`` = ``False`` - - (BoolOpt) Enables sending notifications to Ceilometer + - (Boolean) Enables four-level topology for data locality. Works only if corresponding plugin supports such mode. * - ``executor_thread_pool_size`` = ``64`` - - (IntOpt) Size of executor thread pool. + - (Integer) Size of executor thread pool. * - ``global_remote_threshold`` = ``100`` - - (IntOpt) Maximum number of remote operations that will be running at the same time. Note that each remote operation requires its own process to run. + - (Integer) Maximum number of remote operations that will be running at the same time. Note that each remote operation requires its own process to run. + * - ``hash_ring_replicas_count`` = ``40`` + - (Integer) Number of points that belongs to each member on a hash ring. The larger number leads to a better distribution. + * - ``heat_enable_wait_condition`` = ``True`` + - (Boolean) Enable wait condition feature to reduce polling during cluster creation * - ``heat_stack_tags`` = ``data-processing-cluster`` - - (ListOpt) List of tags to be used during operating with stack. + - (List) List of tags to be used during operating with stack. * - ``infrastructure_engine`` = ``heat`` - - (StrOpt) An engine which will be used to provision infrastructure for Hadoop cluster. + - (String) DEPRECATED: An engine which will be used to provision infrastructure for Hadoop cluster. * - ``job_binary_max_KB`` = ``5120`` - - (IntOpt) Maximum length of job binary data in kilobytes that may be stored or retrieved in a single operation. + - (Integer) Maximum length of job binary data in kilobytes that may be stored or retrieved in a single operation. * - ``job_canceling_timeout`` = ``300`` - - (IntOpt) Timeout for canceling job execution (in seconds). Sahara will try to cancel job execution during this time. + - (Integer) Timeout for canceling job execution (in seconds). Sahara will try to cancel job execution during this time. * - ``job_workflow_postfix`` = - - (StrOpt) Postfix for storing jobs in hdfs. Will be added to '/user//' path. + - (String) Postfix for storing jobs in hdfs. Will be added to '/user//' path. * - ``memcached_servers`` = ``None`` - - (ListOpt) Memcached servers or None for in process cache. + - (List) Memcached servers or None for in process cache. * - ``min_transient_cluster_active_time`` = ``30`` - - (IntOpt) Minimal "lifetime" in seconds for a transient cluster. Cluster is guaranteed to be "alive" within this time period. + - (Integer) Minimal "lifetime" in seconds for a transient cluster. Cluster is guaranteed to be "alive" within this time period. * - ``node_domain`` = ``novalocal`` - - (StrOpt) The suffix of the node's FQDN. In nova-network that is the dhcp_domain config parameter. + - (String) The suffix of the node's FQDN. In nova-network that is the dhcp_domain config parameter. * - ``os_region_name`` = ``None`` - - (StrOpt) Region name used to get services endpoints. + - (String) Region name used to get services endpoints. + * - ``periodic_coordinator_backend_url`` = ``None`` + - (String) The backend URL to use for distributed periodic tasks coordination. * - ``periodic_enable`` = ``True`` - - (BoolOpt) Enable periodic tasks. + - (Boolean) Enable periodic tasks. * - ``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_max`` = ``60`` - - (IntOpt) Max interval size between periodic tasks execution in seconds. - * - ``plugins`` = ``vanilla, hdp, spark, cdh`` - - (ListOpt) List of plugins to be loaded. Sahara preserves the order of the list when returning it. + - (Integer) Max interval size between periodic tasks execution in seconds. + * - ``periodic_workers_number`` = ``1`` + - (Integer) Number of threads to run periodic tasks. + * - ``plugins`` = ``vanilla, spark, cdh, ambari`` + - (List) List of plugins to be loaded. Sahara preserves the order of the list when returning it. * - ``proxy_command`` = - - (StrOpt) Proxy command used to connect to instances. If set, this command should open a netcat socket, that Sahara will use for SSH and HTTP connections. Use {host} and {port} to describe the destination. Other available keywords: {tenant_id}, {network_id}, {router_id}. + - (String) Proxy command used to connect to instances. If set, this command should open a netcat socket, that Sahara will use for SSH and HTTP connections. Use {host} and {port} to describe the destination. Other available keywords: {tenant_id}, {network_id}, {router_id}. * - ``remote`` = ``ssh`` - - (StrOpt) A method for Sahara to execute commands on VMs. + - (String) A method for Sahara to execute commands on VMs. * - ``rootwrap_command`` = ``sudo sahara-rootwrap /etc/sahara/rootwrap.conf`` - - (StrOpt) Rootwrap command to leverage. Use in conjunction with use_rootwrap=True + - (String) Rootwrap command to leverage. Use in conjunction with use_rootwrap=True * - ``swift_topology_file`` = ``etc/sahara/swift.topology`` - - (StrOpt) File with Swift topology.It should contain mapping between Swift nodes and racks. - * - ``use_external_key_manager`` = ``False`` - - (BoolOpt) Enable Sahara to use an external key manager service provided by the identity service catalog. Sahara will store all keys with the manager service. + - (String) File with Swift topology.It should contain mapping between Swift nodes and racks. + * - ``use_barbican_key_manager`` = ``False`` + - (Boolean) Enable the usage of the OpenStack Key Management service provided by barbican. * - ``use_floating_ips`` = ``True`` - - (BoolOpt) If set to True, Sahara will use floating IPs to communicate with instances. To make sure that all instances have floating IPs assigned in Nova Network set "auto_assign_floating_ip=True" in nova.conf. If Neutron is used for networking, make sure that all Node Groups have "floating_ip_pool" parameter defined. + - (Boolean) If set to True, Sahara will use floating IPs to communicate with instances. To make sure that all instances have floating IPs assigned in Nova Network set "auto_assign_floating_ip=True" in nova.conf. If Neutron is used for networking, make sure that all Node Groups have "floating_ip_pool" parameter defined. * - ``use_identity_api_v3`` = ``True`` - - (BoolOpt) Enables Sahara to use Keystone API v3. If that flag is disabled, per-job clusters will not be terminated automatically. + - (Boolean) Enables Sahara to use Keystone API v3. If that flag is disabled, per-job clusters will not be terminated automatically. * - ``use_namespaces`` = ``False`` - - (BoolOpt) Use network namespaces for communication (only valid to use in conjunction with use_neutron=True). + - (Boolean) Use network namespaces for communication (only valid to use in conjunction with use_neutron=True). * - ``use_neutron`` = ``False`` - - (BoolOpt) Use Neutron Networking (False indicates the use of Nova networking). + - (Boolean) Use Neutron Networking (False indicates the use of Nova networking). * - ``use_rootwrap`` = ``False`` - - (BoolOpt) Use rootwrap facility to allow non-root users to run the sahara-all server instance and access private network IPs (only valid to use in conjunction with use_namespaces=True) + - (Boolean) Use rootwrap facility to allow non-root users to run the sahara-all server instance and access private network IPs (only valid to use in conjunction with use_namespaces=True) + * - **[castellan]** + - + * - ``barbican_api_endpoint`` = ``None`` + - (String) The endpoint to use for connecting to the barbican api controller. By default, castellan will use the URL from the service catalog. + * - ``barbican_api_version`` = ``v1`` + - (String) Version of the barbican API, for example: "v1" + * - **[certificates]** + - + * - ``barbican_auth`` = ``barbican_acl_auth`` + - (String) Name of the Barbican authentication method to use + * - ``cert_manager_type`` = ``barbican`` + - (String) Certificate Manager plugin. Defaults to barbican. + * - **[cluster_verifications]** + - + * - ``verification_enable`` = ``True`` + - (Boolean) Option to enable verifications for all clusters + * - ``verification_periodic_interval`` = ``600`` + - (Integer) Interval between two consecutive periodic tasks forverifications, in seconds. * - **[conductor]** - * - ``use_local`` = ``True`` - - (BoolOpt) Perform sahara-conductor operations locally. + - (Boolean) Perform sahara-conductor operations locally. * - **[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. diff --git a/doc/config-reference/source/tables/sahara-cors.rst b/doc/config-reference/source/tables/sahara-cors.rst index 6b438c50a7..4e7bd69cf9 100644 --- a/doc/config-reference/source/tables/sahara-cors.rst +++ b/doc/config-reference/source/tables/sahara-cors.rst @@ -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. diff --git a/doc/config-reference/source/tables/sahara-database.rst b/doc/config-reference/source/tables/sahara-database.rst index 70b9c31bda..cb3463ab16 100644 --- a/doc/config-reference/source/tables/sahara-database.rst +++ b/doc/config-reference/source/tables/sahara-database.rst @@ -19,46 +19,46 @@ * - **[DEFAULT]** - * - ``db_driver`` = ``sahara.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. diff --git a/doc/config-reference/source/tables/sahara-domain.rst b/doc/config-reference/source/tables/sahara-domain.rst index f6a1333448..e9b04ab1c1 100644 --- a/doc/config-reference/source/tables/sahara-domain.rst +++ b/doc/config-reference/source/tables/sahara-domain.rst @@ -19,8 +19,8 @@ * - **[DEFAULT]** - * - ``proxy_user_domain_name`` = ``None`` - - (StrOpt) The domain Sahara will use to create new proxy users for Swift object access. + - (String) The domain Sahara will use to create new proxy users for Swift object access. * - ``proxy_user_role_names`` = ``Member`` - - (ListOpt) A list of the role names that the proxy user should assume through trust for Swift object access. + - (List) A list of the role names that the proxy user should assume through trust for Swift object access. * - ``use_domain_for_proxy_users`` = ``False`` - - (BoolOpt) Enables Sahara to use a domain for creating temporary proxy users to access Swift. If this is enabled a domain must be created for Sahara to use. + - (Boolean) Enables Sahara to use a domain for creating temporary proxy users to access Swift. If this is enabled a domain must be created for Sahara to use. diff --git a/doc/config-reference/source/tables/sahara-logging.rst b/doc/config-reference/source/tables/sahara-logging.rst index d24c5d5590..c5449b2c9d 100644 --- a/doc/config-reference/source/tables/sahara-logging.rst +++ b/doc/config-reference/source/tables/sahara-logging.rst @@ -19,44 +19,42 @@ * - **[DEFAULT]** - * - ``debug`` = ``False`` - - (BoolOpt) Print debugging output (set logging level to DEBUG instead of 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`` = ``amqplib=WARN, qpid.messaging=INFO, stevedore=INFO, eventlet.wsgi.server=WARN, sqlalchemy=WARN, boto=WARN, suds=INFO, keystone=INFO, paramiko=WARN, requests=WARN, iso8601=WARN, oslo_messaging=INFO, neutronclient=INFO`` - - (ListOpt) List of 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. + - (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) 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 output to. If no default is set, logging will go to stdout. 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) Data to append to log format when level 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 without context. + - (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) Format string for user_identity field of the 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) (Optional) Enables or disables syslog rfc5424 format for logging. If enabled, prefixes the MSG part of the syslog message with APP-NAME (RFC5424). The format without the APP-NAME is deprecated in Kilo, and will be removed in Mitaka, along with this option. 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, will disable INFO logging level, making WARNING the default. + - (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) (Optional) 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. diff --git a/doc/config-reference/source/tables/sahara-object_store_access.rst b/doc/config-reference/source/tables/sahara-object_store_access.rst index f22cf2b87a..78f471492c 100644 --- a/doc/config-reference/source/tables/sahara-object_store_access.rst +++ b/doc/config-reference/source/tables/sahara-object_store_access.rst @@ -19,6 +19,6 @@ * - **[object_store_access]** - * - ``public_identity_ca_file`` = ``None`` - - (StrOpt) Location of ca certificate file to use for identity client requests via public endpoint + - (String) Location of ca certificate file to use for identity client requests via public endpoint * - ``public_object_store_ca_file`` = ``None`` - - (StrOpt) Location of ca certificate file to use for object-store client requests via public endpoint + - (String) Location of ca certificate file to use for object-store client requests via public endpoint diff --git a/doc/config-reference/source/tables/sahara-policy.rst b/doc/config-reference/source/tables/sahara-policy.rst index fd351f8b34..906dfb07f7 100644 --- a/doc/config-reference/source/tables/sahara-policy.rst +++ b/doc/config-reference/source/tables/sahara-policy.rst @@ -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. diff --git a/doc/config-reference/source/tables/sahara-qpid.rst b/doc/config-reference/source/tables/sahara-qpid.rst deleted file mode 100644 index 764a43165c..0000000000 --- a/doc/config-reference/source/tables/sahara-qpid.rst +++ /dev/null @@ -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. - -.. _sahara-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. diff --git a/doc/config-reference/source/tables/sahara-rabbitmq.rst b/doc/config-reference/source/tables/sahara-rabbitmq.rst index 6334b76496..2e8d4a819f 100644 --- a/doc/config-reference/source/tables/sahara-rabbitmq.rst +++ b/doc/config-reference/source/tables/sahara-rabbitmq.rst @@ -19,50 +19,112 @@ * - **[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`` + - (String) EXPERIMENTAL: Possible values are: gzip, bz2. If not set compression will not be used. This option may notbe available in future versions. + * - ``kombu_failover_strategy`` = ``round-robin`` + - (String) Determines how the next RabbitMQ node is chosen in case the one we are currently connected to becomes unavailable. Takes effect only if more than one RabbitMQ node is provided in config. + * - ``kombu_missing_consumer_retry_timeout`` = ``60`` + - (Integer) How long to wait a missing client 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. - * - ``kombu_reconnect_timeout`` = ``60`` - - (IntOpt) How long to wait before considering a reconnect attempt to have failed. This value should not be longer than rpc_response_timeout. + - (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`` + - (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`` - - (IntOpt) 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`` + - (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. + - (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. - * - ``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. + - (String) The RabbitMQ virtual host. + * - ``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 diff --git a/doc/config-reference/source/tables/sahara-redis.rst b/doc/config-reference/source/tables/sahara-redis.rst index e8d8e272fb..4a07731c84 100644 --- a/doc/config-reference/source/tables/sahara-redis.rst +++ b/doc/config-reference/source/tables/sahara-redis.rst @@ -16,19 +16,21 @@ * - Configuration option = Default value - Description - * - **[DEFAULT]** - - - * - ``host`` = ``127.0.0.1`` - - (StrOpt) Host to locate redis. - * - ``password`` = - - (StrOpt) Password for Redis server (optional). - * - ``port`` = ``6379`` - - (IntOpt) Use this port to connect to redis host. * - **[matchmaker_redis]** - + * - ``check_timeout`` = ``20000`` + - (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`` - - (IntOpt) Use this port to connect to redis host. + - (Unknown) Use this port to connect to redis host. + * - ``sentinel_group_name`` = ``oslo-messaging-zeromq`` + - (String) Redis replica set name. + * - ``sentinel_hosts`` = + - (List) List of Redis Sentinel hosts (fault tolerance mode) e.g. [host:port, host1:port ... ] + * - ``socket_timeout`` = ``1000`` + - (Integer) Timeout in ms on blocking socket operations + * - ``wait_timeout`` = ``500`` + - (Integer) Time in ms to wait between connection attempts. diff --git a/doc/config-reference/source/tables/sahara-rpc.rst b/doc/config-reference/source/tables/sahara-rpc.rst index c5b45beae3..ba48d0cbf9 100644 --- a/doc/config-reference/source/tables/sahara-rpc.rst +++ b/doc/config-reference/source/tables/sahara-rpc.rst @@ -19,52 +19,70 @@ * - **[DEFAULT]** - * - ``rpc_backend`` = ``rabbit`` - - (StrOpt) The messaging driver to use, defaults to rabbit. Other drivers include qpid and zmq. - * - ``rpc_cast_timeout`` = ``30`` - - (IntOpt) Seconds to wait before a cast expires (TTL). Only supported by impl_zmq. + - (String) The messaging driver to use, defaults to rabbit. Other drivers include amqp and zmq. + * - ``rpc_cast_timeout`` = ``-1`` + - (Integer) Seconds to wait before a cast expires (TTL). The default value of -1 specifies an infinite linger period. The value of 0 specifies no linger period. Pending messages shall be discarded immediately when the socket is closed. Only supported by impl_zmq. * - ``rpc_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_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]** + - + * - ``event_stream_topic`` = ``neutron_lbaas_event`` + - (String) topic name for receiving events from a queue * - **[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`` = ``[]`` + - (Multi-valued) The Drivers(s) to handle sending notifications. Possible values are messaging, messagingv2, routing, log, test, noop + * - ``enable`` = ``False`` + - (Boolean) Enables sending notifications to Ceilometer + * - ``level`` = ``INFO`` + - (String) Notification level for outgoing notifications + * - ``publisher_id`` = ``None`` + - (String) Notification publisher_id for outgoing notifications + * - ``topics`` = ``notifications`` + - (List) AMQP topic used for OpenStack notifications. + * - ``transport_url`` = ``None`` + - (String) A URL representing the messaging driver to use for notifications. If not set, we fall back to the same configuration used for RPC. diff --git a/doc/config-reference/source/tables/sahara-ssh.rst b/doc/config-reference/source/tables/sahara-ssh.rst index 6ee1ca384f..13d9ffd522 100644 --- a/doc/config-reference/source/tables/sahara-ssh.rst +++ b/doc/config-reference/source/tables/sahara-ssh.rst @@ -19,8 +19,8 @@ * - **[DEFAULT]** - * - ``ssh_timeout_common`` = ``300`` - - (IntOpt) Overrides timeout for common ssh operations, in seconds + - (Integer) Overrides timeout for common ssh operations, in seconds * - ``ssh_timeout_files`` = ``120`` - - (IntOpt) Overrides timeout for ssh operations with files, in seconds + - (Integer) Overrides timeout for ssh operations with files, in seconds * - ``ssh_timeout_interactive`` = ``1800`` - - (IntOpt) Overrides timeout for interactive ssh operations, in seconds + - (Integer) Overrides timeout for interactive ssh operations, in seconds diff --git a/doc/config-reference/source/tables/sahara-timeouts.rst b/doc/config-reference/source/tables/sahara-timeouts.rst index 8fbb7d1e67..928f010fbe 100644 --- a/doc/config-reference/source/tables/sahara-timeouts.rst +++ b/doc/config-reference/source/tables/sahara-timeouts.rst @@ -18,17 +18,11 @@ - Description * - **[timeouts]** - - * - ``await_attach_volumes`` = ``10`` - - (IntOpt) Wait for attaching volumes to instances, in seconds - * - ``await_for_instances_active`` = ``10800`` - - (IntOpt) Wait for instances to become active, in seconds * - ``delete_instances_timeout`` = ``10800`` - - (IntOpt) Wait for instances to be deleted, in seconds + - (Integer) Wait for instances to be deleted, in seconds * - ``detach_volume_timeout`` = ``300`` - - (IntOpt) Timeout for detaching volumes from instance, in seconds + - (Integer) Timeout for detaching volumes from instance, in seconds * - ``ips_assign_timeout`` = ``10800`` - - (IntOpt) Assign IPs timeout, in seconds - * - ``volume_available_timeout`` = ``10800`` - - (IntOpt) Wait for volumes to become available, in seconds + - (Integer) Assign IPs timeout, in seconds * - ``wait_until_accessible`` = ``10800`` - - (IntOpt) Wait for instance accessibility, in seconds + - (Integer) Wait for instance accessibility, in seconds diff --git a/doc/config-reference/source/tables/sahara-varmour.rst b/doc/config-reference/source/tables/sahara-varmour.rst new file mode 100644 index 0000000000..a531d1e807 --- /dev/null +++ b/doc/config-reference/source/tables/sahara-varmour.rst @@ -0,0 +1,28 @@ +.. + 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. + +.. _sahara-varmour: + +.. list-table:: Description of vArmour configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[vArmour]** + - + * - ``director`` = ``localhost`` + - (String) vArmour director ip + * - ``director_port`` = ``443`` + - (String) vArmour director port + * - ``password`` = ``varmour`` + - (String) vArmour director password + * - ``username`` = ``varmour`` + - (String) vArmour director username diff --git a/doc/config-reference/source/tables/sahara-zeromq.rst b/doc/config-reference/source/tables/sahara-zeromq.rst index 9705f5c0a0..780b4689f7 100644 --- a/doc/config-reference/source/tables/sahara-zeromq.rst +++ b/doc/config-reference/source/tables/sahara-zeromq.rst @@ -18,27 +18,27 @@ - Description * - **[DEFAULT]** - - * - ``rpc_zmq_all_req_rep`` = ``True`` - - (BoolOpt) Use REQ/REP pattern for all methods CALL/CAST/FANOUT. * - ``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`` - - (IntOpt) 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. - * - ``zmq_use_broker`` = ``True`` - - (BoolOpt) Shows whether zmq-messaging uses broker or not. + - (Integer) Maximum number of ingress messages to locally buffer per topic. Default is unlimited. + * - ``use_pub_sub`` = ``True`` + - (Boolean) Use PUB/SUB pattern for fanout methods. PUB/SUB always uses proxy. + * - ``zmq_target_expire`` = ``120`` + - (Integer) Expiration timeout in seconds of a name service record about existing target ( < 0 means no timeout). diff --git a/doc/config-reference/source/tables/trove-amqp.rst b/doc/config-reference/source/tables/trove-amqp.rst index f0cc3134e7..ba39fddfd0 100644 --- a/doc/config-reference/source/tables/trove-amqp.rst +++ b/doc/config-reference/source/tables/trove-amqp.rst @@ -19,18 +19,12 @@ * - **[DEFAULT]** - * - ``conductor_manager`` = ``trove.conductor.manager.Manager`` - - (StrOpt) Qualified class name to use for conductor manager. + - (String) Qualified class name to use for conductor manager. * - ``conductor_queue`` = ``trove-conductor`` - - (StrOpt) Message queue name the Conductor will listen on. + - (String) Message queue name the Conductor will listen on. * - ``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. - * - ``notification_driver`` = ``[]`` - - (MultiStrOpt) The Drivers(s) to handle sending notifications. Possible values are messaging, messagingv2, routing, log, test, noop + - (String) The default exchange under which topics are scoped. May be overridden by an exchange name specified in the transport_url option. * - ``notification_service_id`` = ``{'mongodb': 'c8c907af-7375-456f-b929-b637ff9209ee', 'percona': 'fd1723f5-68d2-409c-994f-a4a197892a17', 'mysql': '2f3ff068-2bfb-4f70-9a9d-a6bb65bc084b', 'pxc': '75a628c3-f81b-4ffb-b10a-4087c26bc854', 'db2': 'e040cd37-263d-4869-aaa6-c62aa97523b5', 'cassandra': '459a230d-4e97-4344-9067-2a54a310b0ed', 'mariadb': '7a4f82cc-10d2-4bc6-aadc-d9aacc2a3cb5', 'postgresql': 'ac277e0d-4f21-40aa-b347-1ea31e571720', 'couchbase': 'fa62fe68-74d9-4779-a24e-36f19602c415', 'couchdb': 'f0a9ab7b-66f7-4352-93d7-071521d44c7c', 'redis': 'b216ffc5-1947-456c-a4cf-70f94c05f7d0', 'vertica': 'a8d805ae-a3b2-c4fd-gb23-b62cee5201ae'}`` - - (DictOpt) Unique ID to tag notification events. - * - ``notification_topics`` = ``notifications`` - - (ListOpt) AMQP topic used for OpenStack notifications. - * - ``notification_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. + - (Dict) Unique ID to tag notification events. * - ``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. diff --git a/doc/config-reference/source/tables/trove-api.rst b/doc/config-reference/source/tables/trove-api.rst index 2f5a5bd8bd..d7e5a47e26 100644 --- a/doc/config-reference/source/tables/trove-api.rst +++ b/doc/config-reference/source/tables/trove-api.rst @@ -19,58 +19,58 @@ * - **[DEFAULT]** - * - ``admin_roles`` = ``admin`` - - (ListOpt) Roles to add to an admin user. + - (List) Roles to add to an admin user. * - ``api_paste_config`` = ``api-paste.ini`` - - (StrOpt) File name for the paste.deploy config for trove-api. + - (String) File name for the paste.deploy config for trove-api. * - ``bind_host`` = ``0.0.0.0`` - - (IPOpt) IP address the API server will listen on. + - (Unknown) IP address the API server will listen on. * - ``bind_port`` = ``8779`` - - (PortOpt) Port the API server will listen on. + - (Unknown) Port the API server will listen on. * - ``black_list_regex`` = ``None`` - - (StrOpt) Exclude IP addresses that match this regular expression. + - (String) Exclude IP addresses that match this regular expression. * - ``db_api_implementation`` = ``trove.db.sqlalchemy.api`` - - (StrOpt) API Implementation for Trove database access. + - (String) API Implementation for Trove database access. * - ``hostname_require_valid_ip`` = ``True`` - - (BoolOpt) Require user hostnames to be valid IP addresses. + - (Boolean) Require user hostnames to be valid IP addresses. * - ``http_delete_rate`` = ``200`` - - (IntOpt) Maximum number of HTTP 'DELETE' requests (per minute). + - (Integer) Maximum number of HTTP 'DELETE' requests (per minute). * - ``http_get_rate`` = ``200`` - - (IntOpt) Maximum number of HTTP 'GET' requests (per minute). + - (Integer) Maximum number of HTTP 'GET' requests (per minute). * - ``http_mgmt_post_rate`` = ``200`` - - (IntOpt) Maximum number of management HTTP 'POST' requests (per minute). + - (Integer) Maximum number of management HTTP 'POST' requests (per minute). * - ``http_post_rate`` = ``200`` - - (IntOpt) Maximum number of HTTP 'POST' requests (per minute). + - (Integer) Maximum number of HTTP 'POST' requests (per minute). * - ``http_put_rate`` = ``200`` - - (IntOpt) Maximum number of HTTP 'PUT' requests (per minute). + - (Integer) Maximum number of HTTP 'PUT' requests (per minute). * - ``injected_config_location`` = ``/etc/trove/conf.d`` - - (StrOpt) Path to folder on the Guest where config files will be injected during instance creation. + - (String) Path to folder on the Guest where config files will be injected during instance creation. * - ``instances_page_size`` = ``20`` - - (IntOpt) Page size for listing instances. + - (Integer) Page size for listing instances. * - ``max_header_line`` = ``16384`` - - (IntOpt) Maximum line size of message headers to be accepted. max_header_line may need to be increased when using large tokens (typically those generated by the Keystone v3 API with big service catalogs). + - (Integer) Maximum line size of message headers to be accepted. max_header_line may need to be increased when using large tokens (typically those generated by the Keystone v3 API with big service catalogs). * - ``os_region_name`` = ``RegionOne`` - - (StrOpt) Region name of this node. Used when searching catalog. + - (String) Region name of this node. Used when searching catalog. * - ``region`` = ``LOCAL_DEV`` - - (StrOpt) The region this service is located. + - (String) The region this service is located. * - ``tcp_keepidle`` = ``600`` - - (IntOpt) Sets the value of TCP_KEEPIDLE in seconds for each server socket. Not supported on OS X. + - (Integer) Sets the value of TCP_KEEPIDLE in seconds for each server socket. Not supported on OS X. * - ``trove_api_workers`` = ``None`` - - (IntOpt) Number of workers for the API service. The default will be the number of CPUs available. + - (Integer) Number of workers for the API service. The default will be the number of CPUs available. * - ``trove_auth_url`` = ``http://0.0.0.0:5000/v2.0`` - - (StrOpt) Trove authentication URL. + - (String) Trove authentication URL. * - ``trove_conductor_workers`` = ``None`` - - (IntOpt) Number of workers for the Conductor service. The default will be the number of CPUs available. + - (Integer) Number of workers for the Conductor service. The default will be the number of CPUs available. * - ``trove_security_group_name_prefix`` = ``SecGroup`` - - (StrOpt) Prefix to use when creating Security Groups. + - (String) Prefix to use when creating Security Groups. * - ``trove_security_group_rule_cidr`` = ``0.0.0.0/0`` - - (StrOpt) CIDR to use when creating Security Group Rules. + - (String) CIDR to use when creating Security Group Rules. * - ``trove_security_groups_support`` = ``True`` - - (BoolOpt) Whether Trove should add Security Groups on create. + - (Boolean) Whether Trove should add Security Groups on create. * - ``users_page_size`` = ``20`` - - (IntOpt) Page size for listing users. + - (Integer) Page size for listing users. * - **[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. diff --git a/doc/config-reference/source/tables/trove-auth_token.rst b/doc/config-reference/source/tables/trove-auth_token.rst index bf4c246705..3d73223217 100644 --- a/doc/config-reference/source/tables/trove-auth_token.rst +++ b/doc/config-reference/source/tables/trove-auth_token.rst @@ -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. - * - ``auth_plugin`` = ``None`` - - (StrOpt) Name of the plugin to load + - (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 (http or https). Deprecated, use identity_uri. + - (String) Protocol of the admin Identity API endpoint. Deprecated, use identity_uri. * - ``auth_section`` = ``None`` - - (StrOpt) Config Section from which to load plugin specific options + - (Unknown) Config Section from which to load plugin specific options + * - ``auth_type`` = ``None`` + - (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. Acceptable values are MAC or ENCRYPT. 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. diff --git a/doc/config-reference/source/tables/trove-backup.rst b/doc/config-reference/source/tables/trove-backup.rst index 87eceff5d1..673c8eadee 100644 --- a/doc/config-reference/source/tables/trove-backup.rst +++ b/doc/config-reference/source/tables/trove-backup.rst @@ -19,22 +19,22 @@ * - **[DEFAULT]** - * - ``backup_aes_cbc_key`` = ``default_aes_cbc_key`` - - (StrOpt) Default OpenSSL aes_cbc key. + - (String) Default OpenSSL aes_cbc key. * - ``backup_chunk_size`` = ``65536`` - - (IntOpt) Chunk size (in bytes) to stream to the Swift container. This should be in multiples of 128 bytes, since this is the size of an md5 digest block allowing the process to update the file checksum during streaming. See: http://stackoverflow.com/questions/1131220/ + - (Integer) Chunk size (in bytes) to stream to the Swift container. This should be in multiples of 128 bytes, since this is the size of an md5 digest block allowing the process to update the file checksum during streaming. See: http://stackoverflow.com/questions/1131220/ * - ``backup_runner`` = ``trove.guestagent.backup.backup_types.InnoBackupEx`` - - (StrOpt) Runner to use for backups. + - (String) Runner to use for backups. * - ``backup_runner_options`` = ``{}`` - - (DictOpt) Additional options to be passed to the backup runner. + - (Dict) Additional options to be passed to the backup runner. * - ``backup_segment_max_size`` = ``2147483648`` - - (IntOpt) Maximum size (in bytes) of each segment of the backup file. + - (Integer) Maximum size (in bytes) of each segment of the backup file. * - ``backup_swift_container`` = ``database_backups`` - - (StrOpt) Swift container to put backups in. + - (String) Swift container to put backups in. * - ``backup_use_gzip_compression`` = ``True`` - - (BoolOpt) Compress backups using gzip. + - (Boolean) Compress backups using gzip. * - ``backup_use_openssl_encryption`` = ``True`` - - (BoolOpt) Encrypt backups using OpenSSL. + - (Boolean) Encrypt backups using OpenSSL. * - ``backup_use_snet`` = ``False`` - - (BoolOpt) Send backup files over snet. + - (Boolean) Send backup files over snet. * - ``backups_page_size`` = ``20`` - - (IntOpt) Page size for listing backups. + - (Integer) Page size for listing backups. diff --git a/doc/config-reference/source/tables/trove-clients.rst b/doc/config-reference/source/tables/trove-clients.rst index ec9413b099..0d010957a6 100644 --- a/doc/config-reference/source/tables/trove-clients.rst +++ b/doc/config-reference/source/tables/trove-clients.rst @@ -19,16 +19,16 @@ * - **[DEFAULT]** - * - ``remote_cinder_client`` = ``trove.common.remote.cinder_client`` - - (StrOpt) Client to send Cinder calls to. + - (String) Client to send Cinder calls to. * - ``remote_dns_client`` = ``trove.common.remote.dns_client`` - - (StrOpt) Client to send DNS calls to. + - (String) Client to send DNS calls to. * - ``remote_guest_client`` = ``trove.common.remote.guest_client`` - - (StrOpt) Client to send Guest Agent calls to. + - (String) Client to send Guest Agent calls to. * - ``remote_heat_client`` = ``trove.common.remote.heat_client`` - - (StrOpt) Client to send Heat calls to. + - (String) Client to send Heat calls to. * - ``remote_neutron_client`` = ``trove.common.remote.neutron_client`` - - (StrOpt) Client to send Neutron calls to. + - (String) Client to send Neutron calls to. * - ``remote_nova_client`` = ``trove.common.remote.nova_client`` - - (StrOpt) Client to send Nova calls to. + - (String) Client to send Nova calls to. * - ``remote_swift_client`` = ``trove.common.remote.swift_client`` - - (StrOpt) Client to send Swift calls to. + - (String) Client to send Swift calls to. diff --git a/doc/config-reference/source/tables/trove-cluster.rst b/doc/config-reference/source/tables/trove-cluster.rst index a404a6738f..475971de90 100644 --- a/doc/config-reference/source/tables/trove-cluster.rst +++ b/doc/config-reference/source/tables/trove-cluster.rst @@ -19,8 +19,8 @@ * - **[DEFAULT]** - * - ``cluster_delete_time_out`` = ``180`` - - (IntOpt) Maximum time (in seconds) to wait for a cluster delete. + - (Integer) Maximum time (in seconds) to wait for a cluster delete. * - ``cluster_usage_timeout`` = ``36000`` - - (IntOpt) Maximum time (in seconds) to wait for a cluster to become active. + - (Integer) Maximum time (in seconds) to wait for a cluster to become active. * - ``clusters_page_size`` = ``20`` - - (IntOpt) Page size for listing clusters. + - (Integer) Page size for listing clusters. diff --git a/doc/config-reference/source/tables/trove-common.rst b/doc/config-reference/source/tables/trove-common.rst index 3a8f4893e0..7100e06c22 100644 --- a/doc/config-reference/source/tables/trove-common.rst +++ b/doc/config-reference/source/tables/trove-common.rst @@ -19,36 +19,72 @@ * - **[DEFAULT]** - * - ``configurations_page_size`` = ``20`` - - (IntOpt) Page size for listing configurations. + - (Integer) Page size for listing configurations. * - ``databases_page_size`` = ``20`` - - (IntOpt) Page size for listing databases. + - (Integer) Page size for listing databases. * - ``default_datastore`` = ``None`` - - (StrOpt) The default datastore id or name to use if one is not provided by the user. If the default value is None, the field becomes required in the instance create request. + - (String) The default datastore id or name to use if one is not provided by the user. If the default value is None, the field becomes required in the instance create request. * - ``default_neutron_networks`` = - - (ListOpt) List of IDs for management networks which should be attached to the instance regardless of what NICs are specified in the create API call. + - (List) List of IDs for management networks which should be attached to the instance regardless of what NICs are specified in the create API call. * - ``default_password_length`` = ``36`` - - (IntOpt) Character length of generated passwords. + - (Integer) Character length of generated passwords. * - ``executor_thread_pool_size`` = ``64`` - - (IntOpt) Size of executor thread pool. + - (Integer) Size of executor thread pool. * - ``expected_filetype_suffixes`` = ``json`` - - (ListOpt) Filetype endings not to be reattached to an ID by the utils method correct_id_with_req. + - (List) Filetype endings not to be reattached to an ID by the utils method correct_id_with_req. * - ``host`` = ``0.0.0.0`` - - (IPOpt) Host to listen for RPC messages. + - (Unknown) Host to listen for RPC messages. * - ``memcached_servers`` = ``None`` - - (ListOpt) Memcached servers or None for in process cache. + - (List) Memcached servers or None for in process cache. + * - ``module_aes_cbc_key`` = ``module_aes_cbc_key`` + - (String) OpenSSL aes_cbc key for module encryption. + * - ``module_types`` = ``ping`` + - (List) A list of module types supported. A module type corresponds to the name of a ModuleDriver. + * - ``modules_page_size`` = ``20`` + - (Integer) Page size for listing modules. * - ``pybasedir`` = ``/usr/lib/python/site-packages/trove/trove`` - - (StrOpt) Directory where the Trove python module is installed. + - (String) Directory where the Trove python module is installed. * - ``pydev_path`` = ``None`` - - (StrOpt) Set path to pydevd library, used if pydevd is not found in python sys.path. + - (String) Set path to pydevd library, used if pydevd is not found in python sys.path. + * - ``quota_notification_interval`` = ``3600`` + - (Integer) Seconds to wait between pushing events. * - ``taskmanager_queue`` = ``taskmanager`` - - (StrOpt) Message queue name the Taskmanager will listen to. + - (String) Message queue name the Taskmanager will listen to. * - ``template_path`` = ``/etc/trove/templates/`` - - (StrOpt) Path which leads to datastore templates. + - (String) Path which leads to datastore templates. * - ``timeout_wait_for_service`` = ``120`` - - (IntOpt) Maximum time (in seconds) to wait for a service to become alive. + - (Integer) Maximum time (in seconds) to wait for a service to become alive. * - ``usage_timeout`` = ``900`` - - (IntOpt) Maximum time (in seconds) to wait for a Guest to become active. + - (Integer) Maximum time (in seconds) to wait for a Guest to become active. + * - **[certificates]** + - + * - ``barbican_auth`` = ``barbican_acl_auth`` + - (String) Name of the Barbican authentication method to use + * - ``cert_manager_type`` = ``barbican`` + - (String) Certificate Manager plugin. Defaults to barbican. * - **[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. + * - **[service_auth]** + - + * - ``admin_password`` = ``password`` + - (String) The service admin password + * - ``admin_project_domain`` = ``admin`` + - (String) The admin project domain name + * - ``admin_tenant_name`` = ``admin`` + - (String) The service admin tenant name + * - ``admin_user`` = ``admin`` + - (String) The service admin user name + * - ``admin_user_domain`` = ``admin`` + - (String) The admin user domain name + * - ``auth_url`` = ``http://127.0.0.1:5000/v2.0`` + - (String) Authentication endpoint + * - ``auth_version`` = ``2`` + - (String) The auth version used to authenticate + * - ``endpoint_type`` = ``public`` + - (String) The endpoint_type to be used + * - ``region`` = ``RegionOne`` + - (String) The deployment region + * - ``service_name`` = ``lbaas`` + - (String) The name of the service diff --git a/doc/config-reference/source/tables/trove-compute.rst b/doc/config-reference/source/tables/trove-compute.rst index 97b9bee793..ab68024a31 100644 --- a/doc/config-reference/source/tables/trove-compute.rst +++ b/doc/config-reference/source/tables/trove-compute.rst @@ -19,16 +19,16 @@ * - **[DEFAULT]** - * - ``ip_regex`` = ``None`` - - (StrOpt) List IP addresses that match this regular expression. - * - ``nova_client_version`` = ``2`` - - (IntOpt) The version of of the compute service client. + - (String) List IP addresses that match this regular expression. + * - ``nova_client_version`` = ``2.12`` + - (String) The version of of the compute service client. * - ``nova_compute_endpoint_type`` = ``publicURL`` - - (StrOpt) Service endpoint type to use when searching catalog. + - (String) Service endpoint type to use when searching catalog. * - ``nova_compute_service_type`` = ``compute`` - - (StrOpt) Service type to use when searching catalog. + - (String) Service type to use when searching catalog. * - ``nova_compute_url`` = ``None`` - - (StrOpt) URL without the tenant segment. + - (String) URL without the tenant segment. * - ``root_grant`` = ``ALL`` - - (ListOpt) Permissions to grant to the 'root' user. + - (List) Permissions to grant to the 'root' user. * - ``root_grant_option`` = ``True`` - - (BoolOpt) Assign the 'root' user GRANT permissions. + - (Boolean) Assign the 'root' user GRANT permissions. diff --git a/doc/config-reference/source/tables/trove-cors.rst b/doc/config-reference/source/tables/trove-cors.rst index 341ea2cf61..b5b7ea3a72 100644 --- a/doc/config-reference/source/tables/trove-cors.rst +++ b/doc/config-reference/source/tables/trove-cors.rst @@ -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. diff --git a/doc/config-reference/source/tables/trove-database.rst b/doc/config-reference/source/tables/trove-database.rst index b7ab66fc2a..ad578cf04e 100644 --- a/doc/config-reference/source/tables/trove-database.rst +++ b/doc/config-reference/source/tables/trove-database.rst @@ -19,12 +19,48 @@ * - **[DEFAULT]** - * - ``sql_query_logging`` = ``False`` - - (BoolOpt) Allow insecure logging while executing queries through SQLAlchemy. + - (Boolean) Allow insecure logging while executing queries through SQLAlchemy. * - **[database]** - + * - ``backend`` = ``sqlalchemy`` + - (String) The back end to use for the database. * - ``connection`` = ``sqlite:///trove_test.sqlite`` - - (StrOpt) SQL Connection. + - (String) SQL Connection. + * - ``connection_debug`` = ``0`` + - (Integer) Verbosity of SQL debugging information: 0=None, 100=Everything. + * - ``connection_trace`` = ``False`` + - (Boolean) Add Python stack traces to SQL as comment strings. + * - ``db_inc_retry_interval`` = ``True`` + - (Boolean) If True, increases the interval between retries of a database operation up to db_max_retry_interval. + * - ``db_max_retries`` = ``20`` + - (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`` + - (Integer) If db_inc_retry_interval is set, the maximum seconds between retries of a database operation. + * - ``db_retry_interval`` = ``1`` + - (Integer) Seconds between retries of a database transaction. * - ``idle_timeout`` = ``3600`` - - (IntOpt) No help text available for this option. + - (Integer) No help text available for this option. + * - ``max_overflow`` = ``None`` + - (Integer) If set, use this value for max_overflow with SQLAlchemy. + * - ``max_pool_size`` = ``None`` + - (Integer) Maximum number of SQL connections to keep open in a pool. + * - ``max_retries`` = ``10`` + - (Integer) Maximum number of database connection retries during startup. Set to -1 to specify an infinite retry count. + * - ``min_pool_size`` = ``1`` + - (Integer) Minimum number of SQL connections to keep open in a pool. + * - ``mysql_sql_mode`` = ``TRADITIONAL`` + - (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`` + - (Integer) If set, use this value for pool_timeout with SQLAlchemy. * - ``query_log`` = ``False`` - - (BoolOpt) No help text available for this option. + - (Boolean) DEPRECATED: No help text available for this option. + * - ``retry_interval`` = ``10`` + - (Integer) Interval between retries of opening a SQL connection. + * - ``slave_connection`` = ``None`` + - (String) The SQLAlchemy connection string to use to connect to the slave database. + * - ``sqlite_db`` = ``oslo.sqlite`` + - (String) The file name to use with SQLite. + * - ``sqlite_synchronous`` = ``True`` + - (Boolean) If True, SQLite uses synchronous mode. + * - ``use_db_reconnect`` = ``False`` + - (Boolean) Enable the experimental use of database reconnect on connection lost. diff --git a/doc/config-reference/source/tables/trove-db_cassandra.rst b/doc/config-reference/source/tables/trove-db_cassandra.rst index e3a4d20f6e..7af97f70f1 100644 --- a/doc/config-reference/source/tables/trove-db_cassandra.rst +++ b/doc/config-reference/source/tables/trove-db_cassandra.rst @@ -18,25 +18,39 @@ - Description * - **[cassandra]** - + * - ``api_strategy`` = ``trove.common.strategies.cluster.experimental.cassandra.api.CassandraAPIStrategy`` + - (String) Class that implements datastore-specific API logic. * - ``backup_incremental_strategy`` = ``{}`` - - (DictOpt) Incremental Backup Runner based on the default strategy. For strategies that do not implement an incremental, the runner will use the default full backup. - * - ``backup_namespace`` = ``None`` - - (StrOpt) Namespace to load backup strategies from. - * - ``backup_strategy`` = ``None`` - - (StrOpt) Default strategy to perform backups. + - (Dict) Incremental strategy based on the default backup strategy. For strategies that do not implement incremental backups, the runner performs full backup instead. + * - ``backup_namespace`` = ``trove.guestagent.strategies.backup.experimental.cassandra_impl`` + - (String) Namespace to load backup strategies from. + * - ``backup_strategy`` = ``NodetoolSnapshot`` + - (String) Default strategy to perform backups. + * - ``cluster_support`` = ``True`` + - (Boolean) Enable clusters to be created and managed. * - ``device_path`` = ``/dev/vdb`` - - (StrOpt) Device path for volume if volume support is enabled. + - (String) Device path for volume if volume support is enabled. + * - ``guest_log_exposed_logs`` = + - (String) List of Guest Logs to expose for publishing. + * - ``guestagent_strategy`` = ``trove.common.strategies.cluster.experimental.cassandra.guestagent.CassandraGuestAgentStrategy`` + - (String) Class that implements datastore-specific Guest Agent API logic. + * - ``ignore_dbs`` = ``system, system_auth, system_traces`` + - (List) Databases to exclude when listing databases. + * - ``ignore_users`` = ``os_admin`` + - (List) Users to exclude when listing users. * - ``mount_point`` = ``/var/lib/cassandra`` - - (StrOpt) Filesystem path for mounting volumes if volume support is enabled. + - (String) Filesystem path for mounting volumes if volume support is enabled. * - ``replication_strategy`` = ``None`` - - (StrOpt) Default strategy for replication. - * - ``restore_namespace`` = ``None`` - - (StrOpt) Namespace to load restore strategies from. - * - ``root_controller`` = ``trove.extensions.common.service.DefaultRootController`` - - (StrOpt) Root controller implementation for cassandra. - * - ``tcp_ports`` = ``7000, 7001, 9042, 9160`` - - (ListOpt) List of TCP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True). + - (String) Default strategy for replication. + * - ``restore_namespace`` = ``trove.guestagent.strategies.restore.experimental.cassandra_impl`` + - (String) Namespace to load restore strategies from. + * - ``root_controller`` = ``trove.extensions.cassandra.service.CassandraRootController`` + - (String) Root controller implementation for Cassandra. + * - ``taskmanager_strategy`` = ``trove.common.strategies.cluster.experimental.cassandra.taskmanager.CassandraTaskManagerStrategy`` + - (String) Class that implements datastore-specific task manager logic. + * - ``tcp_ports`` = ``7000, 7001, 7199, 9042, 9160`` + - (List) List of TCP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True). * - ``udp_ports`` = - - (ListOpt) List of UDP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True). + - (List) List of UDP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True). * - ``volume_support`` = ``True`` - - (BoolOpt) Whether to provision a Cinder volume for datadir. + - (Boolean) Whether to provision a Cinder volume for datadir. diff --git a/doc/config-reference/source/tables/trove-db_couchbase.rst b/doc/config-reference/source/tables/trove-db_couchbase.rst index 7847b76d25..62455a8a30 100644 --- a/doc/config-reference/source/tables/trove-db_couchbase.rst +++ b/doc/config-reference/source/tables/trove-db_couchbase.rst @@ -19,52 +19,32 @@ * - **[couchbase]** - * - ``backup_incremental_strategy`` = ``{}`` - - (DictOpt) Incremental Backup Runner based on the default strategy. For strategies that do not implement an incremental, the runner will use the default full backup. + - (Dict) Incremental Backup Runner based on the default strategy. For strategies that do not implement an incremental, the runner will use the default full backup. * - ``backup_namespace`` = ``trove.guestagent.strategies.backup.experimental.couchbase_impl`` - - (StrOpt) Namespace to load backup strategies from. + - (String) Namespace to load backup strategies from. * - ``backup_strategy`` = ``CbBackup`` - - (StrOpt) Default strategy to perform backups. + - (String) Default strategy to perform backups. * - ``device_path`` = ``/dev/vdb`` - - (StrOpt) Device path for volume if volume support is enabled. + - (String) Device path for volume if volume support is enabled. + * - ``guest_log_exposed_logs`` = + - (String) List of Guest Logs to expose for publishing. * - ``mount_point`` = ``/var/lib/couchbase`` - - (StrOpt) Filesystem path for mounting volumes if volume support is enabled. + - (String) Filesystem path for mounting volumes if volume support is enabled. * - ``replication_strategy`` = ``None`` - - (StrOpt) Default strategy for replication. + - (String) Default strategy for replication. * - ``restore_namespace`` = ``trove.guestagent.strategies.restore.experimental.couchbase_impl`` - - (StrOpt) Namespace to load restore strategies from. + - (String) Namespace to load restore strategies from. * - ``root_controller`` = ``trove.extensions.common.service.DefaultRootController`` - - (StrOpt) Root controller implementation for couchbase. + - (String) Root controller implementation for couchbase. * - ``root_on_create`` = ``False`` - - (BoolOpt) Enable the automatic creation of the root user for the service during instance-create. The generated password for the root user is immediately returned in the response of instance-create as the 'password' field. + - (Boolean) Enable the automatic creation of the root user for the service during instance-create. The generated password for the root user is immediately returned in the response of instance-create as the 'password' field. * - ``tcp_ports`` = ``8091, 8092, 4369, 11209-11211, 21100-21199`` - - (ListOpt) List of TCP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True). + - (List) List of TCP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True). * - ``udp_ports`` = - - (ListOpt) List of UDP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True). + - (List) List of UDP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True). * - ``volume_support`` = ``True`` - - (BoolOpt) Whether to provision a Cinder volume for datadir. + - (Boolean) Whether to provision a Cinder volume for datadir. * - **[couchdb]** - - * - ``backup_incremental_strategy`` = ``{}`` - - (DictOpt) Incremental Backup Runner based on the default strategy. For strategies that do not implement an incremental, the runner will use the default full backup. - * - ``backup_namespace`` = ``None`` - - (StrOpt) Namespace to load backup strategies from. - * - ``backup_strategy`` = ``None`` - - (StrOpt) Default strategy to perform backups. - * - ``device_path`` = ``/dev/vdb`` - - (StrOpt) Device path for volume if volume support is enabled. - * - ``mount_point`` = ``/var/lib/couchdb`` - - (StrOpt) Filesystem path for mounting volumes if volume support is enabled. - * - ``replication_strategy`` = ``None`` - - (StrOpt) Default strategy for replication. - * - ``restore_namespace`` = ``None`` - - (StrOpt) Namespace to load restore strategies from. - * - ``root_controller`` = ``trove.extensions.common.service.DefaultRootController`` - - (StrOpt) Root controller implementation for couchdb. - * - ``root_on_create`` = ``False`` - - (BoolOpt) Enable the automatic creation of the root user for the service during instance-create. The generated password for the root user is immediately returned in the response of instance-create as the "password" field. - * - ``tcp_ports`` = ``5984`` - - (ListOpt) List of TCP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True). - * - ``udp_ports`` = - - (ListOpt) List of UDP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True). * - ``volume_support`` = ``True`` - - (BoolOpt) Whether to provision a Cinder volume for datadir. + - (Boolean) Whether to provision a Cinder volume for datadir. diff --git a/doc/config-reference/source/tables/trove-db_couchdb.rst b/doc/config-reference/source/tables/trove-db_couchdb.rst new file mode 100644 index 0000000000..58c578242d --- /dev/null +++ b/doc/config-reference/source/tables/trove-db_couchdb.rst @@ -0,0 +1,48 @@ +.. + 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. + +.. _trove-db_couchdb: + +.. list-table:: Description of db_couchdb configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[couchdb]** + - + * - ``backup_incremental_strategy`` = ``{}`` + - (Dict) Incremental Backup Runner based on the default strategy. For strategies that do not implement an incremental, the runner will use the default full backup. + * - ``backup_namespace`` = ``trove.guestagent.strategies.backup.experimental.couchdb_impl`` + - (String) Namespace to load backup strategies from. + * - ``backup_strategy`` = ``CouchDBBackup`` + - (String) Default strategy to perform backups. + * - ``device_path`` = ``/dev/vdb`` + - (String) Device path for volume if volume support is enabled. + * - ``guest_log_exposed_logs`` = + - (String) List of Guest Logs to expose for publishing. + * - ``ignore_dbs`` = ``_users, _replicator`` + - (List) Databases to exclude when listing databases. + * - ``ignore_users`` = ``os_admin, root`` + - (List) Users to exclude when listing users. + * - ``mount_point`` = ``/var/lib/couchdb`` + - (String) Filesystem path for mounting volumes if volume support is enabled. + * - ``replication_strategy`` = ``None`` + - (String) Default strategy for replication. + * - ``restore_namespace`` = ``trove.guestagent.strategies.restore.experimental.couchdb_impl`` + - (String) Namespace to load restore strategies from. + * - ``root_controller`` = ``trove.extensions.common.service.DefaultRootController`` + - (String) Root controller implementation for couchdb. + * - ``root_on_create`` = ``False`` + - (Boolean) Enable the automatic creation of the root user for the service during instance-create. The generated password for the root user is immediately returned in the response of instance-create as the "password" field. + * - ``tcp_ports`` = ``5984`` + - (List) List of TCP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True). + * - ``udp_ports`` = + - (List) List of UDP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True). diff --git a/doc/config-reference/source/tables/trove-db_db2.rst b/doc/config-reference/source/tables/trove-db_db2.rst index 8bad7f481e..aaa9fd158d 100644 --- a/doc/config-reference/source/tables/trove-db_db2.rst +++ b/doc/config-reference/source/tables/trove-db_db2.rst @@ -19,28 +19,30 @@ * - **[db2]** - * - ``backup_incremental_strategy`` = ``{}`` - - (DictOpt) Incremental Backup Runner based on the default strategy. For strategies that do not implement an incremental, the runner will use the default full backup. - * - ``backup_namespace`` = ``None`` - - (StrOpt) Namespace to load backup strategies from. - * - ``backup_strategy`` = ``None`` - - (StrOpt) Default strategy to perform backups. + - (Dict) Incremental Backup Runner based on the default strategy. For strategies that do not implement an incremental, the runner will use the default full backup. + * - ``backup_namespace`` = ``trove.guestagent.strategies.backup.experimental.db2_impl`` + - (String) Namespace to load backup strategies from. + * - ``backup_strategy`` = ``DB2Backup`` + - (String) Default strategy to perform backups. * - ``device_path`` = ``/dev/vdb`` - - (StrOpt) Device path for volume if volume support is enabled. + - (String) Device path for volume if volume support is enabled. + * - ``guest_log_exposed_logs`` = + - (String) List of Guest Logs to expose for publishing. * - ``ignore_users`` = ``PUBLIC, DB2INST1`` - - (ListOpt) No help text available for this option. + - (List) No help text available for this option. * - ``mount_point`` = ``/home/db2inst1/db2inst1`` - - (StrOpt) Filesystem path for mounting volumes if volume support is enabled. + - (String) Filesystem path for mounting volumes if volume support is enabled. * - ``replication_strategy`` = ``None`` - - (StrOpt) Default strategy for replication. - * - ``restore_namespace`` = ``None`` - - (StrOpt) Namespace to load restore strategies from. + - (String) Default strategy for replication. + * - ``restore_namespace`` = ``trove.guestagent.strategies.restore.experimental.db2_impl`` + - (String) Namespace to load restore strategies from. * - ``root_controller`` = ``trove.extensions.common.service.DefaultRootController`` - - (StrOpt) Root controller implementation for db2. + - (String) Root controller implementation for db2. * - ``root_on_create`` = ``False`` - - (BoolOpt) Enable the automatic creation of the root user for the service during instance-create. The generated password for the root user is immediately returned in the response of instance-create as the 'password' field. + - (Boolean) Enable the automatic creation of the root user for the service during instance-create. The generated password for the root user is immediately returned in the response of instance-create as the 'password' field. * - ``tcp_ports`` = ``50000`` - - (ListOpt) List of TCP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True). + - (List) List of TCP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True). * - ``udp_ports`` = - - (ListOpt) List of UDP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True). + - (List) List of UDP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True). * - ``volume_support`` = ``True`` - - (BoolOpt) Whether to provision a Cinder volume for datadir. + - (Boolean) Whether to provision a Cinder volume for datadir. diff --git a/doc/config-reference/source/tables/trove-db_mariadb.rst b/doc/config-reference/source/tables/trove-db_mariadb.rst index 7a0fe3f626..da0fc52611 100644 --- a/doc/config-reference/source/tables/trove-db_mariadb.rst +++ b/doc/config-reference/source/tables/trove-db_mariadb.rst @@ -18,35 +18,49 @@ - Description * - **[mariadb]** - + * - ``api_strategy`` = ``trove.common.strategies.cluster.experimental.galera_common.api.GaleraCommonAPIStrategy`` + - (String) Class that implements datastore-specific API logic. * - ``backup_incremental_strategy`` = ``{'InnoBackupEx': 'InnoBackupExIncremental'}`` - - (DictOpt) Incremental Backup Runner based on the default strategy. For strategies that do not implement an incremental backup, the runner will use the default full backup. + - (Dict) Incremental Backup Runner based on the default strategy. For strategies that do not implement an incremental backup, the runner will use the default full backup. * - ``backup_namespace`` = ``trove.guestagent.strategies.backup.mysql_impl`` - - (StrOpt) Namespace to load backup strategies from. + - (String) Namespace to load backup strategies from. * - ``backup_strategy`` = ``InnoBackupEx`` - - (StrOpt) Default strategy to perform backups. + - (String) Default strategy to perform backups. + * - ``cluster_support`` = ``True`` + - (Boolean) Enable clusters to be created and managed. * - ``device_path`` = ``/dev/vdb`` - - (StrOpt) Device path for volume if volume support is enabled. + - (String) Device path for volume if volume support is enabled. + * - ``guest_log_exposed_logs`` = ``general,slow_query`` + - (String) List of Guest Logs to expose for publishing. + * - ``guest_log_long_query_time`` = ``1000`` + - (Integer) The time in milliseconds that a statement must take in in order to be logged in the slow_query log. + * - ``guestagent_strategy`` = ``trove.common.strategies.cluster.experimental.galera_common.guestagent.GaleraCommonGuestAgentStrategy`` + - (String) Class that implements datastore-specific Guest Agent API logic. * - ``ignore_dbs`` = ``mysql, information_schema, performance_schema`` - - (ListOpt) Databases to exclude when listing databases. + - (List) Databases to exclude when listing databases. * - ``ignore_users`` = ``os_admin, root`` - - (ListOpt) Users to exclude when listing users. + - (List) Users to exclude when listing users. + * - ``min_cluster_member_count`` = ``3`` + - (Integer) Minimum number of members in MariaDB cluster. * - ``mount_point`` = ``/var/lib/mysql`` - - (StrOpt) Filesystem path for mounting volumes if volume support is enabled. - * - ``replication_namespace`` = ``trove.guestagent.strategies.replication.mysql_binlog`` - - (StrOpt) Namespace to load replication strategies from. - * - ``replication_strategy`` = ``MysqlBinlogReplication`` - - (StrOpt) Default strategy for replication. + - (String) Filesystem path for mounting volumes if volume support is enabled. + * - ``replication_namespace`` = ``trove.guestagent.strategies.replication.experimental.mariadb_gtid`` + - (String) Namespace to load replication strategies from. + * - ``replication_strategy`` = ``MariaDBGTIDReplication`` + - (String) Default strategy for replication. * - ``restore_namespace`` = ``trove.guestagent.strategies.restore.mysql_impl`` - - (StrOpt) Namespace to load restore strategies from. + - (String) Namespace to load restore strategies from. * - ``root_controller`` = ``trove.extensions.common.service.DefaultRootController`` - - (StrOpt) Root controller implementation for mysql. + - (String) Root controller implementation for mysql. * - ``root_on_create`` = ``False`` - - (BoolOpt) Enable the automatic creation of the root user for the service during instance-create. The generated password for the root user is immediately returned in the response of instance-create as the 'password' field. - * - ``tcp_ports`` = ``3306`` - - (ListOpt) List of TCP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True). + - (Boolean) Enable the automatic creation of the root user for the service during instance-create. The generated password for the root user is immediately returned in the response of instance-create as the 'password' field. + * - ``taskmanager_strategy`` = ``trove.common.strategies.cluster.experimental.galera_common.taskmanager.GaleraCommonTaskManagerStrategy`` + - (String) Class that implements datastore-specific task manager logic. + * - ``tcp_ports`` = ``3306, 4444, 4567, 4568`` + - (List) List of TCP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True). * - ``udp_ports`` = - - (ListOpt) List of UDP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True). + - (List) List of UDP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True). * - ``usage_timeout`` = ``400`` - - (IntOpt) Maximum time (in seconds) to wait for a Guest to become active. + - (Integer) Maximum time (in seconds) to wait for a Guest to become active. * - ``volume_support`` = ``True`` - - (BoolOpt) Whether to provision a Cinder volume for datadir. + - (Boolean) Whether to provision a Cinder volume for datadir. diff --git a/doc/config-reference/source/tables/trove-db_mongodb.rst b/doc/config-reference/source/tables/trove-db_mongodb.rst index 92880abca2..6a0865ed35 100644 --- a/doc/config-reference/source/tables/trove-db_mongodb.rst +++ b/doc/config-reference/source/tables/trove-db_mongodb.rst @@ -19,46 +19,50 @@ * - **[mongodb]** - * - ``add_members_timeout`` = ``300`` - - (IntOpt) Maximum time to wait (in seconds) for a replica set initialization process to complete. + - (Integer) Maximum time to wait (in seconds) for a replica set initialization process to complete. * - ``api_strategy`` = ``trove.common.strategies.cluster.experimental.mongodb.api.MongoDbAPIStrategy`` - - (StrOpt) Class that implements datastore-specific API logic. + - (String) Class that implements datastore-specific API logic. * - ``backup_incremental_strategy`` = ``{}`` - - (DictOpt) Incremental Backup Runner based on the default strategy. For strategies that do not implement an incremental, the runner will use the default full backup. + - (Dict) Incremental Backup Runner based on the default strategy. For strategies that do not implement an incremental, the runner will use the default full backup. * - ``backup_namespace`` = ``trove.guestagent.strategies.backup.experimental.mongo_impl`` - - (StrOpt) Namespace to load backup strategies from. + - (String) Namespace to load backup strategies from. * - ``backup_strategy`` = ``MongoDump`` - - (StrOpt) Default strategy to perform backups. + - (String) Default strategy to perform backups. + * - ``cluster_secure`` = ``True`` + - (Boolean) Create secure clusters. If False then the Role-Based Access Control will be disabled. * - ``cluster_support`` = ``True`` - - (BoolOpt) Enable clusters to be created and managed. + - (Boolean) Enable clusters to be created and managed. * - ``configsvr_port`` = ``27019`` - - (PortOpt) Port for instances running as config servers. + - (Unknown) Port for instances running as config servers. * - ``device_path`` = ``/dev/vdb`` - - (StrOpt) Device path for volume if volume support is enabled. + - (String) Device path for volume if volume support is enabled. + * - ``guest_log_exposed_logs`` = + - (String) List of Guest Logs to expose for publishing. * - ``guestagent_strategy`` = ``trove.common.strategies.cluster.experimental.mongodb.guestagent.MongoDbGuestAgentStrategy`` - - (StrOpt) Class that implements datastore-specific Guest Agent API logic. + - (String) Class that implements datastore-specific Guest Agent API logic. * - ``ignore_dbs`` = ``admin, local, config`` - - (ListOpt) Databases to exclude when listing databases. + - (List) Databases to exclude when listing databases. * - ``ignore_users`` = ``admin.os_admin, admin.root`` - - (ListOpt) Users to exclude when listing users. + - (List) Users to exclude when listing users. * - ``mongodb_port`` = ``27017`` - - (PortOpt) Port for mongod and mongos instances. + - (Unknown) Port for mongod and mongos instances. * - ``mount_point`` = ``/var/lib/mongodb`` - - (StrOpt) Filesystem path for mounting volumes if volume support is enabled. + - (String) Filesystem path for mounting volumes if volume support is enabled. * - ``num_config_servers_per_cluster`` = ``3`` - - (IntOpt) The number of config servers to create per cluster. + - (Integer) The number of config servers to create per cluster. * - ``num_query_routers_per_cluster`` = ``1`` - - (IntOpt) The number of query routers (mongos) to create per cluster. + - (Integer) The number of query routers (mongos) to create per cluster. * - ``replication_strategy`` = ``None`` - - (StrOpt) Default strategy for replication. + - (String) Default strategy for replication. * - ``restore_namespace`` = ``trove.guestagent.strategies.restore.experimental.mongo_impl`` - - (StrOpt) Namespace to load restore strategies from. - * - ``root_controller`` = ``trove.extensions.common.service.DefaultRootController`` - - (StrOpt) Root controller implementation for mongodb. + - (String) Namespace to load restore strategies from. + * - ``root_controller`` = ``trove.extensions.mongodb.service.MongoDBRootController`` + - (String) Root controller implementation for mongodb. * - ``taskmanager_strategy`` = ``trove.common.strategies.cluster.experimental.mongodb.taskmanager.MongoDbTaskManagerStrategy`` - - (StrOpt) Class that implements datastore-specific task manager logic. - * - ``tcp_ports`` = ``2500, 27017`` - - (ListOpt) List of TCP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True). + - (String) Class that implements datastore-specific task manager logic. + * - ``tcp_ports`` = ``2500, 27017, 27019`` + - (List) List of TCP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True). * - ``udp_ports`` = - - (ListOpt) List of UDP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True). + - (List) List of UDP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True). * - ``volume_support`` = ``True`` - - (BoolOpt) Whether to provision a Cinder volume for datadir. + - (Boolean) Whether to provision a Cinder volume for datadir. diff --git a/doc/config-reference/source/tables/trove-db_mysql.rst b/doc/config-reference/source/tables/trove-db_mysql.rst index 90d9d19d6a..e16e961a76 100644 --- a/doc/config-reference/source/tables/trove-db_mysql.rst +++ b/doc/config-reference/source/tables/trove-db_mysql.rst @@ -19,34 +19,38 @@ * - **[mysql]** - * - ``backup_incremental_strategy`` = ``{'InnoBackupEx': 'InnoBackupExIncremental'}`` - - (DictOpt) Incremental Backup Runner based on the default strategy. For strategies that do not implement an incremental backup, the runner will use the default full backup. + - (Dict) Incremental Backup Runner based on the default strategy. For strategies that do not implement an incremental backup, the runner will use the default full backup. * - ``backup_namespace`` = ``trove.guestagent.strategies.backup.mysql_impl`` - - (StrOpt) Namespace to load backup strategies from. + - (String) Namespace to load backup strategies from. * - ``backup_strategy`` = ``InnoBackupEx`` - - (StrOpt) Default strategy to perform backups. + - (String) Default strategy to perform backups. * - ``device_path`` = ``/dev/vdb`` - - (StrOpt) Device path for volume if volume support is enabled. + - (String) Device path for volume if volume support is enabled. + * - ``guest_log_exposed_logs`` = ``general,slow_query`` + - (String) List of Guest Logs to expose for publishing. + * - ``guest_log_long_query_time`` = ``1000`` + - (Integer) The time in milliseconds that a statement must take in in order to be logged in the slow_query log. * - ``ignore_dbs`` = ``mysql, information_schema, performance_schema`` - - (ListOpt) Databases to exclude when listing databases. + - (List) Databases to exclude when listing databases. * - ``ignore_users`` = ``os_admin, root`` - - (ListOpt) Users to exclude when listing users. + - (List) Users to exclude when listing users. * - ``mount_point`` = ``/var/lib/mysql`` - - (StrOpt) Filesystem path for mounting volumes if volume support is enabled. + - (String) Filesystem path for mounting volumes if volume support is enabled. * - ``replication_namespace`` = ``trove.guestagent.strategies.replication.mysql_gtid`` - - (StrOpt) Namespace to load replication strategies from. + - (String) Namespace to load replication strategies from. * - ``replication_strategy`` = ``MysqlGTIDReplication`` - - (StrOpt) Default strategy for replication. + - (String) Default strategy for replication. * - ``restore_namespace`` = ``trove.guestagent.strategies.restore.mysql_impl`` - - (StrOpt) Namespace to load restore strategies from. - * - ``root_controller`` = ``trove.extensions.common.service.DefaultRootController`` - - (StrOpt) Root controller implementation for mysql. + - (String) Namespace to load restore strategies from. + * - ``root_controller`` = ``trove.extensions.mysql.service.MySQLRootController`` + - (String) Root controller implementation for mysql. * - ``root_on_create`` = ``False`` - - (BoolOpt) Enable the automatic creation of the root user for the service during instance-create. The generated password for the root user is immediately returned in the response of instance-create as the 'password' field. + - (Boolean) Enable the automatic creation of the root user for the service during instance-create. The generated password for the root user is immediately returned in the response of instance-create as the 'password' field. * - ``tcp_ports`` = ``3306`` - - (ListOpt) List of TCP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True). + - (List) List of TCP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True). * - ``udp_ports`` = - - (ListOpt) List of UDP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True). + - (List) List of UDP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True). * - ``usage_timeout`` = ``400`` - - (IntOpt) Maximum time (in seconds) to wait for a Guest to become active. + - (Integer) Maximum time (in seconds) to wait for a Guest to become active. * - ``volume_support`` = ``True`` - - (BoolOpt) Whether to provision a Cinder volume for datadir. + - (Boolean) Whether to provision a Cinder volume for datadir. diff --git a/doc/config-reference/source/tables/trove-db_percona.rst b/doc/config-reference/source/tables/trove-db_percona.rst index 8088d8463a..aeccfc2ebb 100644 --- a/doc/config-reference/source/tables/trove-db_percona.rst +++ b/doc/config-reference/source/tables/trove-db_percona.rst @@ -19,38 +19,42 @@ * - **[percona]** - * - ``backup_incremental_strategy`` = ``{'InnoBackupEx': 'InnoBackupExIncremental'}`` - - (DictOpt) Incremental Backup Runner based on the default strategy. For strategies that do not implement an incremental backup, the runner will use the default full backup. + - (Dict) Incremental Backup Runner based on the default strategy. For strategies that do not implement an incremental backup, the runner will use the default full backup. * - ``backup_namespace`` = ``trove.guestagent.strategies.backup.mysql_impl`` - - (StrOpt) Namespace to load backup strategies from. + - (String) Namespace to load backup strategies from. * - ``backup_strategy`` = ``InnoBackupEx`` - - (StrOpt) Default strategy to perform backups. + - (String) Default strategy to perform backups. * - ``device_path`` = ``/dev/vdb`` - - (StrOpt) Device path for volume if volume support is enabled. + - (String) Device path for volume if volume support is enabled. + * - ``guest_log_exposed_logs`` = ``general,slow_query`` + - (String) List of Guest Logs to expose for publishing. + * - ``guest_log_long_query_time`` = ``1000`` + - (Integer) The time in milliseconds that a statement must take in in order to be logged in the slow_query log. * - ``ignore_dbs`` = ``mysql, information_schema, performance_schema`` - - (ListOpt) Databases to exclude when listing databases. + - (List) Databases to exclude when listing databases. * - ``ignore_users`` = ``os_admin, root`` - - (ListOpt) Users to exclude when listing users. + - (List) Users to exclude when listing users. * - ``mount_point`` = ``/var/lib/mysql`` - - (StrOpt) Filesystem path for mounting volumes if volume support is enabled. + - (String) Filesystem path for mounting volumes if volume support is enabled. * - ``replication_namespace`` = ``trove.guestagent.strategies.replication.mysql_gtid`` - - (StrOpt) Namespace to load replication strategies from. + - (String) Namespace to load replication strategies from. * - ``replication_password`` = ``NETOU7897NNLOU`` - - (StrOpt) Password for replication slave user. + - (String) Password for replication slave user. * - ``replication_strategy`` = ``MysqlGTIDReplication`` - - (StrOpt) Default strategy for replication. + - (String) Default strategy for replication. * - ``replication_user`` = ``slave_user`` - - (StrOpt) Userid for replication slave. + - (String) Userid for replication slave. * - ``restore_namespace`` = ``trove.guestagent.strategies.restore.mysql_impl`` - - (StrOpt) Namespace to load restore strategies from. + - (String) Namespace to load restore strategies from. * - ``root_controller`` = ``trove.extensions.common.service.DefaultRootController`` - - (StrOpt) Root controller implementation for percona. + - (String) Root controller implementation for percona. * - ``root_on_create`` = ``False`` - - (BoolOpt) Enable the automatic creation of the root user for the service during instance-create. The generated password for the root user is immediately returned in the response of instance-create as the 'password' field. + - (Boolean) Enable the automatic creation of the root user for the service during instance-create. The generated password for the root user is immediately returned in the response of instance-create as the 'password' field. * - ``tcp_ports`` = ``3306`` - - (ListOpt) List of TCP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True). + - (List) List of TCP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True). * - ``udp_ports`` = - - (ListOpt) List of UDP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True). + - (List) List of UDP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True). * - ``usage_timeout`` = ``450`` - - (IntOpt) Maximum time (in seconds) to wait for a Guest to become active. + - (Integer) Maximum time (in seconds) to wait for a Guest to become active. * - ``volume_support`` = ``True`` - - (BoolOpt) Whether to provision a Cinder volume for datadir. + - (Boolean) Whether to provision a Cinder volume for datadir. diff --git a/doc/config-reference/source/tables/trove-db_postgresql.rst b/doc/config-reference/source/tables/trove-db_postgresql.rst index 3ed7e419f4..e1d00d6df0 100644 --- a/doc/config-reference/source/tables/trove-db_postgresql.rst +++ b/doc/config-reference/source/tables/trove-db_postgresql.rst @@ -19,28 +19,34 @@ * - **[postgresql]** - * - ``backup_incremental_strategy`` = ``{}`` - - (DictOpt) Incremental Backup Runner based on the default strategy. For strategies that do not implement an incremental, the runner will use the default full backup. + - (Dict) Incremental Backup Runner based on the default strategy. For strategies that do not implement an incremental, the runner will use the default full backup. * - ``backup_namespace`` = ``trove.guestagent.strategies.backup.experimental.postgresql_impl`` - - (StrOpt) Namespace to load backup strategies from. + - (String) Namespace to load backup strategies from. * - ``backup_strategy`` = ``PgDump`` - - (StrOpt) Default strategy to perform backups. + - (String) Default strategy to perform backups. * - ``device_path`` = ``/dev/vdb`` - - (StrOpt) No help text available for this option. + - (String) No help text available for this option. + * - ``guest_log_exposed_logs`` = ``general`` + - (String) List of Guest Logs to expose for publishing. + * - ``guest_log_long_query_time`` = ``0`` + - (Integer) The time in milliseconds that a statement must take in in order to be logged in the 'general' log. A value of '0' logs all statements, while '-1' turns off statement logging. * - ``ignore_dbs`` = ``postgres`` - - (ListOpt) No help text available for this option. + - (List) No help text available for this option. * - ``ignore_users`` = ``os_admin, postgres, root`` - - (ListOpt) No help text available for this option. + - (List) No help text available for this option. * - ``mount_point`` = ``/var/lib/postgresql`` - - (StrOpt) Filesystem path for mounting volumes if volume support is enabled. + - (String) Filesystem path for mounting volumes if volume support is enabled. + * - ``postgresql_port`` = ``5432`` + - (Unknown) The TCP port the server listens on. * - ``restore_namespace`` = ``trove.guestagent.strategies.restore.experimental.postgresql_impl`` - - (StrOpt) Namespace to load restore strategies from. + - (String) Namespace to load restore strategies from. * - ``root_controller`` = ``trove.extensions.common.service.DefaultRootController`` - - (StrOpt) Root controller implementation for postgresql. + - (String) Root controller implementation for postgresql. * - ``root_on_create`` = ``False`` - - (BoolOpt) Enable the automatic creation of the root user for the service during instance-create. The generated password for the root user is immediately returned in the response of instance-create as the 'password' field. + - (Boolean) Enable the automatic creation of the root user for the service during instance-create. The generated password for the root user is immediately returned in the response of instance-create as the 'password' field. * - ``tcp_ports`` = ``5432`` - - (ListOpt) List of TCP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True). + - (List) List of TCP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True). * - ``udp_ports`` = - - (ListOpt) List of UDP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True). + - (List) List of UDP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True). * - ``volume_support`` = ``True`` - - (BoolOpt) Whether to provision a Cinder volume for datadir. + - (Boolean) Whether to provision a Cinder volume for datadir. diff --git a/doc/config-reference/source/tables/trove-db_pxc.rst b/doc/config-reference/source/tables/trove-db_pxc.rst index dd0cc7bcc3..7ec5aa26c3 100644 --- a/doc/config-reference/source/tables/trove-db_pxc.rst +++ b/doc/config-reference/source/tables/trove-db_pxc.rst @@ -18,47 +18,51 @@ - Description * - **[pxc]** - - * - ``api_strategy`` = ``trove.common.strategies.cluster.experimental.pxc.api.PXCAPIStrategy`` - - (StrOpt) Class that implements datastore-specific API logic. + * - ``api_strategy`` = ``trove.common.strategies.cluster.experimental.galera_common.api.GaleraCommonAPIStrategy`` + - (String) Class that implements datastore-specific API logic. * - ``backup_incremental_strategy`` = ``{'InnoBackupEx': 'InnoBackupExIncremental'}`` - - (DictOpt) Incremental Backup Runner based on the default strategy. For strategies that do not implement an incremental backup, the runner will use the default full backup. + - (Dict) Incremental Backup Runner based on the default strategy. For strategies that do not implement an incremental backup, the runner will use the default full backup. * - ``backup_namespace`` = ``trove.guestagent.strategies.backup.mysql_impl`` - - (StrOpt) Namespace to load backup strategies from. + - (String) Namespace to load backup strategies from. * - ``backup_strategy`` = ``InnoBackupEx`` - - (StrOpt) Default strategy to perform backups. + - (String) Default strategy to perform backups. * - ``cluster_support`` = ``True`` - - (BoolOpt) Enable clusters to be created and managed. + - (Boolean) Enable clusters to be created and managed. * - ``device_path`` = ``/dev/vdb`` - - (StrOpt) Device path for volume if volume support is enabled. - * - ``guestagent_strategy`` = ``trove.common.strategies.cluster.experimental.pxc.guestagent.PXCGuestAgentStrategy`` - - (StrOpt) Class that implements datastore-specific Guest Agent API logic. + - (String) Device path for volume if volume support is enabled. + * - ``guest_log_exposed_logs`` = ``general,slow_query`` + - (String) List of Guest Logs to expose for publishing. + * - ``guest_log_long_query_time`` = ``1000`` + - (Integer) The time in milliseconds that a statement must take in in order to be logged in the slow_query log. + * - ``guestagent_strategy`` = ``trove.common.strategies.cluster.experimental.galera_common.guestagent.GaleraCommonGuestAgentStrategy`` + - (String) Class that implements datastore-specific Guest Agent API logic. * - ``ignore_dbs`` = ``mysql, information_schema, performance_schema`` - - (ListOpt) Databases to exclude when listing databases. + - (List) Databases to exclude when listing databases. * - ``ignore_users`` = ``os_admin, root, clusterrepuser`` - - (ListOpt) Users to exclude when listing users. + - (List) Users to exclude when listing users. * - ``min_cluster_member_count`` = ``3`` - - (IntOpt) Minimum number of members in PXC cluster. + - (Integer) Minimum number of members in PXC cluster. * - ``mount_point`` = ``/var/lib/mysql`` - - (StrOpt) Filesystem path for mounting volumes if volume support is enabled. + - (String) Filesystem path for mounting volumes if volume support is enabled. * - ``replication_namespace`` = ``trove.guestagent.strategies.replication.mysql_gtid`` - - (StrOpt) Namespace to load replication strategies from. + - (String) Namespace to load replication strategies from. * - ``replication_strategy`` = ``MysqlGTIDReplication`` - - (StrOpt) Default strategy for replication. + - (String) Default strategy for replication. * - ``replication_user`` = ``slave_user`` - - (StrOpt) Userid for replication slave. + - (String) Userid for replication slave. * - ``restore_namespace`` = ``trove.guestagent.strategies.restore.mysql_impl`` - - (StrOpt) Namespace to load restore strategies from. - * - ``root_controller`` = ``trove.extensions.common.service.DefaultRootController`` - - (StrOpt) Root controller implementation for pxc. + - (String) Namespace to load restore strategies from. + * - ``root_controller`` = ``trove.extensions.pxc.service.PxcRootController`` + - (String) Root controller implementation for pxc. * - ``root_on_create`` = ``False`` - - (BoolOpt) Enable the automatic creation of the root user for the service during instance-create. The generated password for the root user is immediately returned in the response of instance-create as the 'password' field. - * - ``taskmanager_strategy`` = ``trove.common.strategies.cluster.experimental.pxc.taskmanager.PXCTaskManagerStrategy`` - - (StrOpt) Class that implements datastore-specific task manager logic. + - (Boolean) Enable the automatic creation of the root user for the service during instance-create. The generated password for the root user is immediately returned in the response of instance-create as the 'password' field. + * - ``taskmanager_strategy`` = ``trove.common.strategies.cluster.experimental.galera_common.taskmanager.GaleraCommonTaskManagerStrategy`` + - (String) Class that implements datastore-specific task manager logic. * - ``tcp_ports`` = ``3306, 4444, 4567, 4568`` - - (ListOpt) List of TCP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True). + - (List) List of TCP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True). * - ``udp_ports`` = - - (ListOpt) List of UDP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True). + - (List) List of UDP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True). * - ``usage_timeout`` = ``450`` - - (IntOpt) Maximum time (in seconds) to wait for a Guest to become active. + - (Integer) Maximum time (in seconds) to wait for a Guest to become active. * - ``volume_support`` = ``True`` - - (BoolOpt) Whether to provision a Cinder volume for datadir. + - (Boolean) Whether to provision a Cinder volume for datadir. diff --git a/doc/config-reference/source/tables/trove-db_redis.rst b/doc/config-reference/source/tables/trove-db_redis.rst index 4b6009367a..3901aa58a8 100644 --- a/doc/config-reference/source/tables/trove-db_redis.rst +++ b/doc/config-reference/source/tables/trove-db_redis.rst @@ -19,34 +19,36 @@ * - **[redis]** - * - ``api_strategy`` = ``trove.common.strategies.cluster.experimental.redis.api.RedisAPIStrategy`` - - (StrOpt) Class that implements datastore-specific API logic. + - (String) Class that implements datastore-specific API logic. * - ``backup_incremental_strategy`` = ``{}`` - - (DictOpt) Incremental Backup Runner based on the default strategy. For strategies that do not implement an incremental, the runner will use the default full backup. + - (Dict) Incremental Backup Runner based on the default strategy. For strategies that do not implement an incremental, the runner will use the default full backup. * - ``backup_namespace`` = ``trove.guestagent.strategies.backup.experimental.redis_impl`` - - (StrOpt) Namespace to load backup strategies from. + - (String) Namespace to load backup strategies from. * - ``backup_strategy`` = ``RedisBackup`` - - (StrOpt) Default strategy to perform backups. + - (String) Default strategy to perform backups. * - ``cluster_support`` = ``True`` - - (BoolOpt) Enable clusters to be created and managed. - * - ``device_path`` = ``None`` - - (StrOpt) Device path for volume if volume support is enabled. + - (Boolean) Enable clusters to be created and managed. + * - ``device_path`` = ``/dev/vdb`` + - (String) Device path for volume if volume support is enabled. + * - ``guest_log_exposed_logs`` = + - (String) List of Guest Logs to expose for publishing. * - ``guestagent_strategy`` = ``trove.common.strategies.cluster.experimental.redis.guestagent.RedisGuestAgentStrategy`` - - (StrOpt) Class that implements datastore-specific Guest Agent API logic. + - (String) Class that implements datastore-specific Guest Agent API logic. * - ``mount_point`` = ``/var/lib/redis`` - - (StrOpt) Filesystem path for mounting volumes if volume support is enabled. + - (String) Filesystem path for mounting volumes if volume support is enabled. * - ``replication_namespace`` = ``trove.guestagent.strategies.replication.experimental.redis_sync`` - - (StrOpt) Namespace to load replication strategies from. + - (String) Namespace to load replication strategies from. * - ``replication_strategy`` = ``RedisSyncReplication`` - - (StrOpt) Default strategy for replication. + - (String) Default strategy for replication. * - ``restore_namespace`` = ``trove.guestagent.strategies.restore.experimental.redis_impl`` - - (StrOpt) Namespace to load restore strategies from. + - (String) Namespace to load restore strategies from. * - ``root_controller`` = ``trove.extensions.common.service.DefaultRootController`` - - (StrOpt) Root controller implementation for redis. + - (String) Root controller implementation for redis. * - ``taskmanager_strategy`` = ``trove.common.strategies.cluster.experimental.redis.taskmanager.RedisTaskManagerStrategy`` - - (StrOpt) Class that implements datastore-specific task manager logic. + - (String) Class that implements datastore-specific task manager logic. * - ``tcp_ports`` = ``6379, 16379`` - - (ListOpt) List of TCP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True). + - (List) List of TCP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True). * - ``udp_ports`` = - - (ListOpt) List of UDP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True). + - (List) List of UDP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True). * - ``volume_support`` = ``True`` - - (BoolOpt) Whether to provision a Cinder volume for datadir. + - (Boolean) Whether to provision a Cinder volume for datadir. diff --git a/doc/config-reference/source/tables/trove-db_vertica.rst b/doc/config-reference/source/tables/trove-db_vertica.rst index 91450fcf1f..4d3130c1ef 100644 --- a/doc/config-reference/source/tables/trove-db_vertica.rst +++ b/doc/config-reference/source/tables/trove-db_vertica.rst @@ -19,36 +19,40 @@ * - **[vertica]** - * - ``api_strategy`` = ``trove.common.strategies.cluster.experimental.vertica.api.VerticaAPIStrategy`` - - (StrOpt) Class that implements datastore-specific API logic. + - (String) Class that implements datastore-specific API logic. * - ``backup_incremental_strategy`` = ``{}`` - - (DictOpt) Incremental Backup Runner based on the default strategy. For strategies that do not implement an incremental, the runner will use the default full backup. + - (Dict) Incremental Backup Runner based on the default strategy. For strategies that do not implement an incremental, the runner will use the default full backup. * - ``backup_namespace`` = ``None`` - - (StrOpt) Namespace to load backup strategies from. + - (String) Namespace to load backup strategies from. * - ``backup_strategy`` = ``None`` - - (StrOpt) Default strategy to perform backups. + - (String) Default strategy to perform backups. * - ``cluster_member_count`` = ``3`` - - (IntOpt) Number of members in Vertica cluster. + - (Integer) Number of members in Vertica cluster. * - ``cluster_support`` = ``True`` - - (BoolOpt) Enable clusters to be created and managed. + - (Boolean) Enable clusters to be created and managed. * - ``device_path`` = ``/dev/vdb`` - - (StrOpt) Device path for volume if volume support is enabled. + - (String) Device path for volume if volume support is enabled. + * - ``guest_log_exposed_logs`` = + - (String) List of Guest Logs to expose for publishing. * - ``guestagent_strategy`` = ``trove.common.strategies.cluster.experimental.vertica.guestagent.VerticaGuestAgentStrategy`` - - (StrOpt) Class that implements datastore-specific Guest Agent API logic. + - (String) Class that implements datastore-specific Guest Agent API logic. + * - ``min_ksafety`` = ``0`` + - (Integer) Minimum k-safety setting permitted for vertica clusters * - ``mount_point`` = ``/var/lib/vertica`` - - (StrOpt) Filesystem path for mounting volumes if volume support is enabled. + - (String) Filesystem path for mounting volumes if volume support is enabled. * - ``readahead_size`` = ``2048`` - - (IntOpt) Size(MB) to be set as readahead_size for data volume + - (Integer) Size(MB) to be set as readahead_size for data volume * - ``replication_strategy`` = ``None`` - - (StrOpt) Default strategy for replication. + - (String) Default strategy for replication. * - ``restore_namespace`` = ``None`` - - (StrOpt) Namespace to load restore strategies from. + - (String) Namespace to load restore strategies from. * - ``root_controller`` = ``trove.extensions.vertica.service.VerticaRootController`` - - (StrOpt) Root controller implementation for Vertica. + - (String) Root controller implementation for Vertica. * - ``taskmanager_strategy`` = ``trove.common.strategies.cluster.experimental.vertica.taskmanager.VerticaTaskManagerStrategy`` - - (StrOpt) Class that implements datastore-specific task manager logic. + - (String) Class that implements datastore-specific task manager logic. * - ``tcp_ports`` = ``5433, 5434, 22, 5444, 5450, 4803`` - - (ListOpt) List of TCP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True). + - (List) List of TCP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True). * - ``udp_ports`` = ``5433, 4803, 4804, 6453`` - - (ListOpt) List of UDP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True). + - (List) List of UDP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True). * - ``volume_support`` = ``True`` - - (BoolOpt) Whether to provision a Cinder volume for datadir. + - (Boolean) Whether to provision a Cinder volume for datadir. diff --git a/doc/config-reference/source/tables/trove-debug.rst b/doc/config-reference/source/tables/trove-debug.rst index 3988d9070d..9303cd5dd1 100644 --- a/doc/config-reference/source/tables/trove-debug.rst +++ b/doc/config-reference/source/tables/trove-debug.rst @@ -19,16 +19,18 @@ * - **[DEFAULT]** - * - ``backlog`` = ``4096`` - - (IntOpt) Number of backlog requests to configure the socket with + - (Integer) Number of backlog requests to configure the socket with * - ``pydev_debug`` = ``disabled`` - - (StrOpt) Enable or disable pydev remote debugging. If value is 'auto' tries to connect to remote debugger server, but in case of error continues running with debugging disabled. + - (String) Enable or disable pydev remote debugging. If value is 'auto' tries to connect to remote debugger server, but in case of error continues running with debugging disabled. * - ``pydev_debug_host`` = ``None`` - - (StrOpt) Pydev debug server host (localhost by default). + - (String) Pydev debug server host (localhost by default). * - ``pydev_debug_port`` = ``5678`` - - (PortOpt) Pydev debug server port (5678 by default). + - (Unknown) Pydev debug server port (5678 by default). * - **[profiler]** - * - ``enabled`` = ``False`` - - (BoolOpt) If False fully disable profiling feature. - * - ``trace_sqlalchemy`` = ``True`` - - (BoolOpt) If False doesn't trace SQL requests. + - (Boolean) Enables the profiling for all services on this node. Default value is False (fully disable the profiling feature). Possible values: * True: Enables the feature * False: Disables the feature. The profiling cannot be started via this project operations. If the profiling is triggered by another project, this project part will be empty. + * - ``hmac_keys`` = ``SECRET_KEY`` + - (String) Secret key(s) to use for encrypting context data for performance profiling. This string value should have the following format: [,,...], where each key is some random string. A user who triggers the profiling via the REST API has to set one of these keys in the headers of the REST API call to include profiling results of this node for this particular project. Both "enabled" flag and "hmac_keys" config options should be set to enable profiling. Also, to generate correct profiling information across all services at least one key needs to be consistent between OpenStack projects. This ensures it can be used from client side to generate the trace, containing information from all possible resources. + * - ``trace_sqlalchemy`` = ``False`` + - (Boolean) Enables SQL requests profiling in services. Default value is False (SQL requests won't be traced). Possible values: * True: Enables SQL requests profiling. Each SQL query will be part of the trace and can the be analyzed by how much time was spent for that. * False: Disables SQL requests profiling. The spent time is only shown on a higher level of operations. Single SQL queries cannot be analyzed this way. diff --git a/doc/config-reference/source/tables/trove-dns.rst b/doc/config-reference/source/tables/trove-dns.rst index 6635d1edc8..9df447b735 100644 --- a/doc/config-reference/source/tables/trove-dns.rst +++ b/doc/config-reference/source/tables/trove-dns.rst @@ -19,34 +19,34 @@ * - **[DEFAULT]** - * - ``dns_account_id`` = - - (StrOpt) Tenant ID for DNSaaS. + - (String) Tenant ID for DNSaaS. * - ``dns_auth_url`` = - - (StrOpt) Authentication URL for DNSaaS. + - (String) Authentication URL for DNSaaS. * - ``dns_domain_id`` = - - (StrOpt) Domain ID used for adding DNS entries. + - (String) Domain ID used for adding DNS entries. * - ``dns_domain_name`` = - - (StrOpt) Domain name used for adding DNS entries. + - (String) Domain name used for adding DNS entries. * - ``dns_driver`` = ``trove.dns.driver.DnsDriver`` - - (StrOpt) Driver for DNSaaS. + - (String) Driver for DNSaaS. * - ``dns_endpoint_url`` = ``0.0.0.0`` - - (StrOpt) Endpoint URL for DNSaaS. + - (String) Endpoint URL for DNSaaS. * - ``dns_hostname`` = - - (StrOpt) Hostname used for adding DNS entries. + - (String) Hostname used for adding DNS entries. * - ``dns_instance_entry_factory`` = ``trove.dns.driver.DnsInstanceEntryFactory`` - - (StrOpt) Factory for adding DNS entries. + - (String) Factory for adding DNS entries. * - ``dns_management_base_url`` = - - (StrOpt) Management URL for DNSaaS. + - (String) Management URL for DNSaaS. * - ``dns_passkey`` = - - (StrOpt) Passkey for DNSaaS. + - (String) Passkey for DNSaaS. * - ``dns_region`` = - - (StrOpt) Region name for DNSaaS. + - (String) Region name for DNSaaS. * - ``dns_service_type`` = - - (StrOpt) Service Type for DNSaaS. + - (String) Service Type for DNSaaS. * - ``dns_time_out`` = ``120`` - - (IntOpt) Maximum time (in seconds) to wait for a DNS entry add. + - (Integer) Maximum time (in seconds) to wait for a DNS entry add. * - ``dns_ttl`` = ``300`` - - (IntOpt) Time (in seconds) before a refresh of DNS information occurs. + - (Integer) Time (in seconds) before a refresh of DNS information occurs. * - ``dns_username`` = - - (StrOpt) Username for DNSaaS. + - (String) Username for DNSaaS. * - ``trove_dns_support`` = ``False`` - - (BoolOpt) Whether Trove should add DNS entries on create (using Designate DNSaaS). + - (Boolean) Whether Trove should add DNS entries on create (using Designate DNSaaS). diff --git a/doc/config-reference/source/tables/trove-guestagent.rst b/doc/config-reference/source/tables/trove-guestagent.rst index b4a7045e5a..05dad97c88 100644 --- a/doc/config-reference/source/tables/trove-guestagent.rst +++ b/doc/config-reference/source/tables/trove-guestagent.rst @@ -19,26 +19,32 @@ * - **[DEFAULT]** - * - ``agent_call_high_timeout`` = ``60`` - - (IntOpt) Maximum time (in seconds) to wait for Guest Agent 'slow' requests (such as restarting the database). + - (Integer) Maximum time (in seconds) to wait for Guest Agent 'slow' requests (such as restarting the database). * - ``agent_call_low_timeout`` = ``5`` - - (IntOpt) Maximum time (in seconds) to wait for Guest Agent 'quick'requests (such as retrieving a list of users or databases). + - (Integer) Maximum time (in seconds) to wait for Guest Agent 'quick'requests (such as retrieving a list of users or databases). * - ``agent_heartbeat_expiry`` = ``60`` - - (IntOpt) Time (in seconds) after which a guest is considered unreachable + - (Integer) Time (in seconds) after which a guest is considered unreachable * - ``agent_heartbeat_time`` = ``10`` - - (IntOpt) Maximum time (in seconds) for the Guest Agent to reply to a heartbeat request. + - (Integer) Maximum time (in seconds) for the Guest Agent to reply to a heartbeat request. * - ``agent_replication_snapshot_timeout`` = ``36000`` - - (IntOpt) Maximum time (in seconds) to wait for taking a Guest Agent replication snapshot. + - (Integer) Maximum time (in seconds) to wait for taking a Guest Agent replication snapshot. * - ``guest_config`` = ``/etc/trove/trove-guestagent.conf`` - - (StrOpt) Path to the Guest Agent config file to be injected during instance creation. + - (String) Path to the Guest Agent config file to be injected during instance creation. * - ``guest_id`` = ``None`` - - (StrOpt) ID of the Guest Instance. + - (String) ID of the Guest Instance. * - ``guest_info`` = ``guest_info.conf`` - - (StrOpt) The guest info filename found in the injected config location. If a full path is specified then it will be used as the path to the guest info file + - (String) The guest info filename found in the injected config location. If a full path is specified then it will be used as the path to the guest info file + * - ``guest_log_container_name`` = ``database_logs`` + - (String) Name of container that stores guest log components. + * - ``guest_log_expiry`` = ``2592000`` + - (Integer) Expiry (in seconds) of objects in guest log container. + * - ``guest_log_limit`` = ``1000000`` + - (Integer) Maximum size of a chunk saved in guest log container. * - ``mount_options`` = ``defaults,noatime`` - - (StrOpt) Options to use when mounting a volume. - * - ``storage_namespace`` = ``trove.guestagent.strategies.storage.swift`` - - (StrOpt) Namespace to load the default storage strategy from. + - (String) Options to use when mounting a volume. + * - ``storage_namespace`` = ``trove.common.strategies.storage.swift`` + - (String) Namespace to load the default storage strategy from. * - ``storage_strategy`` = ``SwiftStorage`` - - (StrOpt) Default strategy to store backups. + - (String) Default strategy to store backups. * - ``usage_sleep_time`` = ``5`` - - (IntOpt) Time to sleep during the check for an active Guest. + - (Integer) Time to sleep during the check for an active Guest. diff --git a/doc/config-reference/source/tables/trove-heat.rst b/doc/config-reference/source/tables/trove-heat.rst index 1fa1f39059..75c1649530 100644 --- a/doc/config-reference/source/tables/trove-heat.rst +++ b/doc/config-reference/source/tables/trove-heat.rst @@ -19,10 +19,10 @@ * - **[DEFAULT]** - * - ``heat_endpoint_type`` = ``publicURL`` - - (StrOpt) Service endpoint type to use when searching catalog. + - (String) Service endpoint type to use when searching catalog. * - ``heat_service_type`` = ``orchestration`` - - (StrOpt) Service type to use when searching catalog. + - (String) Service type to use when searching catalog. * - ``heat_time_out`` = ``60`` - - (IntOpt) Maximum time (in seconds) to wait for a Heat request to complete. + - (Integer) Maximum time (in seconds) to wait for a Heat request to complete. * - ``heat_url`` = ``None`` - - (StrOpt) URL without the tenant segment. + - (String) URL without the tenant segment. diff --git a/doc/config-reference/source/tables/trove-logging.rst b/doc/config-reference/source/tables/trove-logging.rst index 0c1f65c1c7..c961517890 100644 --- a/doc/config-reference/source/tables/trove-logging.rst +++ b/doc/config-reference/source/tables/trove-logging.rst @@ -19,48 +19,46 @@ * - **[DEFAULT]** - * - ``debug`` = ``False`` - - (BoolOpt) Print debugging output (set logging level to DEBUG instead of 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`` - - (ListOpt) List of logger=LEVEL pairs. This option is ignored if log_config_append is set. + - (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`` + - (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. * - ``format_options`` = ``-m 5`` - - (StrOpt) Options to use when formatting a volume. + - (String) Options to use when formatting a volume. * - ``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. + - (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) 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 output to. If no default is set, logging will go to stdout. 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) Data to append to log format when level 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 without context. + - (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) Format string for user_identity field of the logging_context_format_string + - (String) Defines the format string for %(user_identity)s that is used in logging_context_format_string. * - ``network_label_regex`` = ``^private$`` - - (StrOpt) Regular expression to match Trove network labels. + - (String) Regular expression to match Trove network labels. * - ``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) (Optional) Enables or disables syslog rfc5424 format for logging. If enabled, prefixes the MSG part of the syslog message with APP-NAME (RFC5424). The format without the APP-NAME is deprecated in Kilo, and will be removed in Mitaka, along with this option. 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, will disable INFO logging level, making WARNING the default. + - (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) (Optional) 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. diff --git a/doc/config-reference/source/tables/trove-network.rst b/doc/config-reference/source/tables/trove-network.rst index 5c2e51d5d4..9b8c55616f 100644 --- a/doc/config-reference/source/tables/trove-network.rst +++ b/doc/config-reference/source/tables/trove-network.rst @@ -19,10 +19,10 @@ * - **[DEFAULT]** - * - ``network_driver`` = ``trove.network.nova.NovaNetwork`` - - (StrOpt) Describes the actual network manager used for the management of network attributes (security groups, floating IPs, etc.). + - (String) Describes the actual network manager used for the management of network attributes (security groups, floating IPs, etc.). * - ``neutron_endpoint_type`` = ``publicURL`` - - (StrOpt) Service endpoint type to use when searching catalog. + - (String) Service endpoint type to use when searching catalog. * - ``neutron_service_type`` = ``network`` - - (StrOpt) Service type to use when searching catalog. + - (String) Service type to use when searching catalog. * - ``neutron_url`` = ``None`` - - (StrOpt) URL without the tenant segment. + - (String) URL without the tenant segment. diff --git a/doc/config-reference/source/tables/trove-nova.rst b/doc/config-reference/source/tables/trove-nova.rst index 03f3fc812e..8116ad6109 100644 --- a/doc/config-reference/source/tables/trove-nova.rst +++ b/doc/config-reference/source/tables/trove-nova.rst @@ -19,10 +19,10 @@ * - **[DEFAULT]** - * - ``nova_proxy_admin_pass`` = - - (StrOpt) Admin password used to connect to Nova. + - (String) Admin password used to connect to Nova. * - ``nova_proxy_admin_tenant_id`` = - - (StrOpt) Admin tenant ID used to connect to Nova. + - (String) Admin tenant ID used to connect to Nova. * - ``nova_proxy_admin_tenant_name`` = - - (StrOpt) Admin tenant name used to connect to Nova. + - (String) Admin tenant name used to connect to Nova. * - ``nova_proxy_admin_user`` = - - (StrOpt) Admin username used to connect to Nova. + - (String) Admin username used to connect to Nova. diff --git a/doc/config-reference/source/tables/trove-qpid.rst b/doc/config-reference/source/tables/trove-qpid.rst deleted file mode 100644 index 9a20cf4b4e..0000000000 --- a/doc/config-reference/source/tables/trove-qpid.rst +++ /dev/null @@ -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. - -.. _trove-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. diff --git a/doc/config-reference/source/tables/trove-quota.rst b/doc/config-reference/source/tables/trove-quota.rst index 10af6a522d..bde31d9963 100644 --- a/doc/config-reference/source/tables/trove-quota.rst +++ b/doc/config-reference/source/tables/trove-quota.rst @@ -19,12 +19,12 @@ * - **[DEFAULT]** - * - ``max_accepted_volume_size`` = ``5`` - - (IntOpt) Default maximum volume size (in GB) for an instance. + - (Integer) Default maximum volume size (in GB) for an instance. * - ``max_backups_per_tenant`` = ``50`` - - (IntOpt) Default maximum number of backups created by a tenant. + - (Integer) Default maximum number of backups created by a tenant. * - ``max_instances_per_tenant`` = ``5`` - - (IntOpt) Default maximum number of instances per tenant. + - (Integer) Default maximum number of instances per tenant. * - ``max_volumes_per_tenant`` = ``20`` - - (IntOpt) Default maximum volume capacity (in GB) spanning across all Trove volumes per tenant. + - (Integer) Default maximum volume capacity (in GB) spanning across all Trove volumes per tenant. * - ``quota_driver`` = ``trove.quota.quota.DbQuotaDriver`` - - (StrOpt) Default driver to use for quota checks. + - (String) Default driver to use for quota checks. diff --git a/doc/config-reference/source/tables/trove-rabbitmq.rst b/doc/config-reference/source/tables/trove-rabbitmq.rst index 407930cbdb..059d9191c6 100644 --- a/doc/config-reference/source/tables/trove-rabbitmq.rst +++ b/doc/config-reference/source/tables/trove-rabbitmq.rst @@ -19,50 +19,112 @@ * - **[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`` + - (String) EXPERIMENTAL: Possible values are: gzip, bz2. If not set compression will not be used. This option may notbe available in future versions. + * - ``kombu_failover_strategy`` = ``round-robin`` + - (String) Determines how the next RabbitMQ node is chosen in case the one we are currently connected to becomes unavailable. Takes effect only if more than one RabbitMQ node is provided in config. + * - ``kombu_missing_consumer_retry_timeout`` = ``60`` + - (Integer) How long to wait a missing client 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. - * - ``kombu_reconnect_timeout`` = ``60`` - - (IntOpt) How long to wait before considering a reconnect attempt to have failed. This value should not be longer than rpc_response_timeout. + - (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`` + - (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`` - - (IntOpt) 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`` + - (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. + - (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. - * - ``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. + - (String) The RabbitMQ virtual host. + * - ``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 diff --git a/doc/config-reference/source/tables/trove-redis.rst b/doc/config-reference/source/tables/trove-redis.rst index fc2f838226..baf9239b5f 100644 --- a/doc/config-reference/source/tables/trove-redis.rst +++ b/doc/config-reference/source/tables/trove-redis.rst @@ -16,17 +16,21 @@ * - Configuration option = Default value - Description - * - **[DEFAULT]** - - - * - ``password`` = - - (StrOpt) Password for Redis server (optional). - * - ``port`` = ``6379`` - - (IntOpt) Use this port to connect to redis host. * - **[matchmaker_redis]** - + * - ``check_timeout`` = ``20000`` + - (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`` - - (IntOpt) Use this port to connect to redis host. + - (Unknown) Use this port to connect to redis host. + * - ``sentinel_group_name`` = ``oslo-messaging-zeromq`` + - (String) Redis replica set name. + * - ``sentinel_hosts`` = + - (List) List of Redis Sentinel hosts (fault tolerance mode) e.g. [host:port, host1:port ... ] + * - ``socket_timeout`` = ``1000`` + - (Integer) Timeout in ms on blocking socket operations + * - ``wait_timeout`` = ``500`` + - (Integer) Time in ms to wait between connection attempts. diff --git a/doc/config-reference/source/tables/trove-rpc.rst b/doc/config-reference/source/tables/trove-rpc.rst index c5d481495c..02962857f4 100644 --- a/doc/config-reference/source/tables/trove-rpc.rst +++ b/doc/config-reference/source/tables/trove-rpc.rst @@ -19,56 +19,68 @@ * - **[DEFAULT]** - * - ``num_tries`` = ``3`` - - (IntOpt) Number of times to check if a volume exists. + - (Integer) Number of times to check if a volume exists. * - ``report_interval`` = ``30`` - - (IntOpt) The interval (in seconds) which periodic tasks are run. + - (Integer) The interval (in seconds) which periodic tasks are run. * - ``rpc_backend`` = ``rabbit`` - - (StrOpt) The messaging driver to use, defaults to rabbit. Other drivers include qpid and zmq. - * - ``rpc_cast_timeout`` = ``30`` - - (IntOpt) Seconds to wait before a cast expires (TTL). Only supported by impl_zmq. + - (String) The messaging driver to use, defaults to rabbit. Other drivers include amqp and zmq. + * - ``rpc_cast_timeout`` = ``-1`` + - (Integer) Seconds to wait before a cast expires (TTL). The default value of -1 specifies an infinite linger period. The value of 0 specifies no linger period. Pending messages shall be discarded immediately when the socket is closed. Only supported by impl_zmq. * - ``rpc_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_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]** + - + * - ``event_stream_topic`` = ``neutron_lbaas_event`` + - (String) topic name for receiving events from a queue * - **[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`` = ``[]`` + - (Multi-valued) The Drivers(s) to handle sending notifications. Possible values are messaging, messagingv2, routing, log, test, noop + * - ``topics`` = ``notifications`` + - (List) AMQP topic used for OpenStack notifications. + * - ``transport_url`` = ``None`` + - (String) A URL representing the messaging driver to use for notifications. If not set, we fall back to the same configuration used for RPC. diff --git a/doc/config-reference/source/tables/trove-swift.rst b/doc/config-reference/source/tables/trove-swift.rst index 9809f9f6b8..d1147be947 100644 --- a/doc/config-reference/source/tables/trove-swift.rst +++ b/doc/config-reference/source/tables/trove-swift.rst @@ -19,8 +19,8 @@ * - **[DEFAULT]** - * - ``swift_endpoint_type`` = ``publicURL`` - - (StrOpt) Service endpoint type to use when searching catalog. + - (String) Service endpoint type to use when searching catalog. * - ``swift_service_type`` = ``object-store`` - - (StrOpt) Service type to use when searching catalog. + - (String) Service type to use when searching catalog. * - ``swift_url`` = ``None`` - - (StrOpt) URL ending in AUTH\_. + - (String) URL ending in ``AUTH_``. diff --git a/doc/config-reference/source/tables/trove-taskmanager.rst b/doc/config-reference/source/tables/trove-taskmanager.rst index df77309184..0066533e59 100644 --- a/doc/config-reference/source/tables/trove-taskmanager.rst +++ b/doc/config-reference/source/tables/trove-taskmanager.rst @@ -19,38 +19,38 @@ * - **[DEFAULT]** - * - ``cloudinit_location`` = ``/etc/trove/cloudinit`` - - (StrOpt) Path to folder with cloudinit scripts. + - (String) Path to folder with cloudinit scripts. * - ``datastore_manager`` = ``None`` - - (StrOpt) Manager class in the Guest Agent, set up by the Taskmanager on instance provision. + - (String) Manager class in the Guest Agent, set up by the Taskmanager on instance provision. * - ``datastore_registry_ext`` = ``{}`` - - (DictOpt) Extension for default datastore managers. Allows the use of custom managers for each of the datastores supported by Trove. + - (Dict) Extension for default datastore managers. Allows the use of custom managers for each of the datastores supported by Trove. * - ``exists_notification_interval`` = ``3600`` - - (IntOpt) Seconds to wait between pushing events. + - (Integer) Seconds to wait between pushing events. * - ``exists_notification_transformer`` = ``None`` - - (StrOpt) Transformer for exists notifications. + - (String) Transformer for exists notifications. * - ``reboot_time_out`` = ``120`` - - (IntOpt) Maximum time (in seconds) to wait for a server reboot. + - (Integer) Maximum time (in seconds) to wait for a server reboot. * - ``resize_time_out`` = ``600`` - - (IntOpt) Maximum time (in seconds) to wait for a server resize. + - (Integer) Maximum time (in seconds) to wait for a server resize. * - ``restore_usage_timeout`` = ``36000`` - - (IntOpt) Maximum time (in seconds) to wait for a Guest instance restored from a backup to become active. + - (Integer) Maximum time (in seconds) to wait for a Guest instance restored from a backup to become active. * - ``revert_time_out`` = ``600`` - - (IntOpt) Maximum time (in seconds) to wait for a server resize revert. + - (Integer) Maximum time (in seconds) to wait for a server resize revert. * - ``server_delete_time_out`` = ``60`` - - (IntOpt) Maximum time (in seconds) to wait for a server delete. + - (Integer) Maximum time (in seconds) to wait for a server delete. * - ``state_change_poll_time`` = ``3`` - - (IntOpt) Interval between state change poll requests (seconds). + - (Integer) Interval between state change poll requests (seconds). * - ``state_change_wait_time`` = ``180`` - - (IntOpt) Maximum time (in seconds) to wait for a state change. + - (Integer) Maximum time (in seconds) to wait for a state change. * - ``update_status_on_fail`` = ``True`` - - (BoolOpt) Set the service and instance task statuses to ERROR when an instance fails to become active within the configured usage_timeout. + - (Boolean) Set the service and instance task statuses to ERROR when an instance fails to become active within the configured usage_timeout. * - ``usage_sleep_time`` = ``5`` - - (IntOpt) Time to sleep during the check for an active Guest. + - (Integer) Time to sleep during the check for an active Guest. * - ``use_heat`` = ``False`` - - (BoolOpt) Use Heat for provisioning. + - (Boolean) Use Heat for provisioning. * - ``use_nova_server_config_drive`` = ``False`` - - (BoolOpt) Use config drive for file injection when booting instance. + - (Boolean) Use config drive for file injection when booting instance. * - ``use_nova_server_volume`` = ``False`` - - (BoolOpt) Whether to provision a Cinder volume for the Nova instance. + - (Boolean) Whether to provision a Cinder volume for the Nova instance. * - ``verify_swift_checksum_on_restore`` = ``True`` - - (BoolOpt) Enable verification of Swift checksum before starting restore. Makes sure the checksum of original backup matches the checksum of the Swift backup file. + - (Boolean) Enable verification of Swift checksum before starting restore. Makes sure the checksum of original backup matches the checksum of the Swift backup file. diff --git a/doc/config-reference/source/tables/trove-upgrades.rst b/doc/config-reference/source/tables/trove-upgrades.rst index 1f22da953e..28fb7a9bba 100644 --- a/doc/config-reference/source/tables/trove-upgrades.rst +++ b/doc/config-reference/source/tables/trove-upgrades.rst @@ -19,8 +19,8 @@ * - **[upgrade_levels]** - * - ``conductor`` = ``icehouse`` - - (StrOpt) Set a version cap for messages sent to conductor services + - (String) Set a version cap for messages sent to conductor services * - ``guestagent`` = ``icehouse`` - - (StrOpt) Set a version cap for messages sent to guestagent services + - (String) Set a version cap for messages sent to guestagent services * - ``taskmanager`` = ``icehouse`` - - (StrOpt) Set a version cap for messages sent to taskmanager services + - (String) Set a version cap for messages sent to taskmanager services diff --git a/doc/config-reference/source/tables/trove-varmour.rst b/doc/config-reference/source/tables/trove-varmour.rst new file mode 100644 index 0000000000..0c5dbf4023 --- /dev/null +++ b/doc/config-reference/source/tables/trove-varmour.rst @@ -0,0 +1,28 @@ +.. + 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. + +.. _trove-varmour: + +.. list-table:: Description of vArmour configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[vArmour]** + - + * - ``director`` = ``localhost`` + - (String) vArmour director ip + * - ``director_port`` = ``443`` + - (String) vArmour director port + * - ``password`` = ``varmour`` + - (String) vArmour director password + * - ``username`` = ``varmour`` + - (String) vArmour director username diff --git a/doc/config-reference/source/tables/trove-volume.rst b/doc/config-reference/source/tables/trove-volume.rst index 7007001ff7..40e3ad491b 100644 --- a/doc/config-reference/source/tables/trove-volume.rst +++ b/doc/config-reference/source/tables/trove-volume.rst @@ -19,22 +19,22 @@ * - **[DEFAULT]** - * - ``block_device_mapping`` = ``vdb`` - - (StrOpt) Block device to map onto the created instance. + - (String) Block device to map onto the created instance. * - ``cinder_endpoint_type`` = ``publicURL`` - - (StrOpt) Service endpoint type to use when searching catalog. + - (String) Service endpoint type to use when searching catalog. * - ``cinder_service_type`` = ``volumev2`` - - (StrOpt) Service type to use when searching catalog. + - (String) Service type to use when searching catalog. * - ``cinder_url`` = ``None`` - - (StrOpt) URL without the tenant segment. + - (String) URL without the tenant segment. * - ``cinder_volume_type`` = ``None`` - - (StrOpt) Volume type to use when provisioning a Cinder volume. + - (String) Volume type to use when provisioning a Cinder volume. * - ``device_path`` = ``/dev/vdb`` - - (StrOpt) Device path for volume if volume support is enabled. + - (String) Device path for volume if volume support is enabled. * - ``trove_volume_support`` = ``True`` - - (BoolOpt) Whether to provision a Cinder volume for datadir. + - (Boolean) Whether to provision a Cinder volume for datadir. * - ``volume_format_timeout`` = ``120`` - - (IntOpt) Maximum time (in seconds) to wait for a volume format. + - (Integer) Maximum time (in seconds) to wait for a volume format. * - ``volume_fstype`` = ``ext3`` - - (StrOpt) File system type used to format a volume. + - (String) File system type used to format a volume. * - ``volume_time_out`` = ``60`` - - (IntOpt) Maximum time (in seconds) to wait for a volume attach. + - (Integer) Maximum time (in seconds) to wait for a volume attach. diff --git a/doc/config-reference/source/tables/trove-zeromq.rst b/doc/config-reference/source/tables/trove-zeromq.rst index e552f89308..8ab2ac1d1f 100644 --- a/doc/config-reference/source/tables/trove-zeromq.rst +++ b/doc/config-reference/source/tables/trove-zeromq.rst @@ -18,27 +18,27 @@ - Description * - **[DEFAULT]** - - * - ``rpc_zmq_all_req_rep`` = ``True`` - - (BoolOpt) Use REQ/REP pattern for all methods CALL/CAST/FANOUT. * - ``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`` - - (IntOpt) 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. - * - ``zmq_use_broker`` = ``True`` - - (BoolOpt) Shows whether zmq-messaging uses broker or not. + - (Integer) Maximum number of ingress messages to locally buffer per topic. Default is unlimited. + * - ``use_pub_sub`` = ``True`` + - (Boolean) Use PUB/SUB pattern for fanout methods. PUB/SUB always uses proxy. + * - ``zmq_target_expire`` = ``120`` + - (Integer) Expiration timeout in seconds of a name service record about existing target ( < 0 means no timeout). diff --git a/doc/config-reference/source/tables/zaqar-api.rst b/doc/config-reference/source/tables/zaqar-api.rst index ae51f2b775..ea50383198 100644 --- a/doc/config-reference/source/tables/zaqar-api.rst +++ b/doc/config-reference/source/tables/zaqar-api.rst @@ -19,24 +19,24 @@ * - **[DEFAULT]** - * - ``admin_mode`` = ``False`` - - (BoolOpt) Activate privileged endpoints. + - (Boolean) Activate privileged endpoints. * - ``daemon`` = ``False`` - - (BoolOpt) Run Zaqar server in the background. + - (Boolean) Run Zaqar server in the background. * - ``unreliable`` = ``False`` - - (BoolOpt) Disable all reliability constraints. + - (Boolean) Disable all reliability constraints. * - **[notification]** - * - ``smtp_command`` = ``/usr/sbin/sendmail -t -oi`` - - (StrOpt) The command of smtp to send email. The format is "command_name arg1 arg2". + - (String) The command of smtp to send email. The format is "command_name arg1 arg2". * - **[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. * - **[signed_url]** - * - ``secret_key`` = ``None`` - - (StrOpt) Secret key used to encrypt pre-signed URLs. + - (String) Secret key used to encrypt pre-signed URLs. diff --git a/doc/config-reference/source/tables/zaqar-auth_token.rst b/doc/config-reference/source/tables/zaqar-auth_token.rst index cb250b145e..27f58a4683 100644 --- a/doc/config-reference/source/tables/zaqar-auth_token.rst +++ b/doc/config-reference/source/tables/zaqar-auth_token.rst @@ -16,85 +16,81 @@ * - Configuration option = Default value - Description - * - **[DEFAULT]** - - - * - ``memcached_servers`` = ``None`` - - (ListOpt) Memcached servers or None for in process cache. * - **[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 (http or https). 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. Acceptable values are MAC or ENCRYPT. 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. diff --git a/doc/config-reference/source/tables/zaqar-authentication.rst b/doc/config-reference/source/tables/zaqar-authentication.rst index e053eaa71f..7e487cd4b4 100644 --- a/doc/config-reference/source/tables/zaqar-authentication.rst +++ b/doc/config-reference/source/tables/zaqar-authentication.rst @@ -19,4 +19,4 @@ * - **[DEFAULT]** - * - ``auth_strategy`` = - - (StrOpt) Backend to use for authentication. For no auth, keep it empty. Existing strategies: keystone. See also the keystone_authtoken section below + - (String) Backend to use for authentication. For no auth, keep it empty. Existing strategies: keystone. See also the keystone_authtoken section below diff --git a/doc/config-reference/source/tables/zaqar-cache.rst b/doc/config-reference/source/tables/zaqar-cache.rst index 8399b937d9..d02b3e9185 100644 --- a/doc/config-reference/source/tables/zaqar-cache.rst +++ b/doc/config-reference/source/tables/zaqar-cache.rst @@ -19,28 +19,28 @@ * - **[cache]** - * - ``backend`` = ``dogpile.cache.null`` - - (StrOpt) Dogpile.cache backend module. It is recommended that Memcache with pooling (oslo_cache.memcache_pool) or Redis (dogpile.cache.redis) be used in production deployments. Small workloads (single process) like devstack can use the dogpile.cache.memory backend. + - (String) Dogpile.cache backend module. It is recommended that Memcache with pooling (oslo_cache.memcache_pool) or Redis (dogpile.cache.redis) be used in production deployments. Small workloads (single process) like devstack can use the dogpile.cache.memory backend. * - ``backend_argument`` = ``[]`` - - (MultiStrOpt) Arguments supplied to the backend module. Specify this option once per argument to be passed to the dogpile.cache backend. Example format: ":". + - (Multi-valued) Arguments supplied to the backend module. Specify this option once per argument to be passed to the dogpile.cache backend. Example format: ":". * - ``config_prefix`` = ``cache.oslo`` - - (StrOpt) Prefix for building the configuration dictionary for the cache region. This should not need to be changed unless there is another dogpile.cache region with the same configuration name. + - (String) Prefix for building the configuration dictionary for the cache region. This should not need to be changed unless there is another dogpile.cache region with the same configuration name. * - ``debug_cache_backend`` = ``False`` - - (BoolOpt) Extra debugging from the cache backend (cache keys, get/set/delete/etc calls). This is only really useful if you need to see the specific cache-backend get/set/delete calls with the keys/values. Typically this should be left set to false. + - (Boolean) Extra debugging from the cache backend (cache keys, get/set/delete/etc calls). This is only really useful if you need to see the specific cache-backend get/set/delete calls with the keys/values. Typically this should be left set to false. * - ``enabled`` = ``False`` - - (BoolOpt) Global toggle for caching. + - (Boolean) Global toggle for caching. * - ``expiration_time`` = ``600`` - - (IntOpt) Default TTL, in seconds, for any cached item in the dogpile.cache region. This applies to any cached method that doesn't have an explicit cache expiration time defined for it. + - (Integer) Default TTL, in seconds, for any cached item in the dogpile.cache region. This applies to any cached method that doesn't have an explicit cache expiration time defined for it. * - ``memcache_dead_retry`` = ``300`` - - (IntOpt) Number of seconds memcached server is considered dead before it is tried again. (dogpile.cache.memcache and oslo_cache.memcache_pool backends only). + - (Integer) Number of seconds memcached server is considered dead before it is tried again. (dogpile.cache.memcache and oslo_cache.memcache_pool backends only). * - ``memcache_pool_connection_get_timeout`` = ``10`` - - (IntOpt) Number of seconds that an operation will wait to get a memcache client connection. + - (Integer) Number of seconds that an operation will wait to get a memcache client connection. * - ``memcache_pool_maxsize`` = ``10`` - - (IntOpt) Max total number of open connections to every memcached server. (oslo_cache.memcache_pool backend only). + - (Integer) Max total number of open connections to every memcached server. (oslo_cache.memcache_pool backend only). * - ``memcache_pool_unused_timeout`` = ``60`` - - (IntOpt) Number of seconds a connection to memcached is held unused in the pool before it is closed. (oslo_cache.memcache_pool backend only). + - (Integer) Number of seconds a connection to memcached is held unused in the pool before it is closed. (oslo_cache.memcache_pool backend only). * - ``memcache_servers`` = ``localhost:11211`` - - (ListOpt) Memcache servers in the format of "host:port". (dogpile.cache.memcache and oslo_cache.memcache_pool backends only). + - (List) Memcache servers in the format of "host:port". (dogpile.cache.memcache and oslo_cache.memcache_pool backends only). * - ``memcache_socket_timeout`` = ``3`` - - (IntOpt) Timeout in seconds for every call to a server. (dogpile.cache.memcache and oslo_cache.memcache_pool backends only). + - (Integer) Timeout in seconds for every call to a server. (dogpile.cache.memcache and oslo_cache.memcache_pool backends only). * - ``proxies`` = - - (ListOpt) Proxy classes to import that will affect the way the dogpile.cache backend functions. See the dogpile.cache documentation on changing-backend-behavior. + - (List) Proxy classes to import that will affect the way the dogpile.cache backend functions. See the dogpile.cache documentation on changing-backend-behavior. diff --git a/doc/config-reference/source/tables/zaqar-drivers.rst b/doc/config-reference/source/tables/zaqar-drivers.rst index 66b10ff5bf..3fff5086b5 100644 --- a/doc/config-reference/source/tables/zaqar-drivers.rst +++ b/doc/config-reference/source/tables/zaqar-drivers.rst @@ -19,8 +19,8 @@ * - **[drivers]** - * - ``management_store`` = ``mongodb`` - - (StrOpt) Storage driver to use as the management store. + - (String) Storage driver to use as the management store. * - ``message_store`` = ``mongodb`` - - (StrOpt) Storage driver to use as the messaging store. + - (String) Storage driver to use as the messaging store. * - ``transport`` = ``wsgi`` - - (StrOpt) Transport driver to use. + - (String) Transport driver to use. diff --git a/doc/config-reference/source/tables/zaqar-logging.rst b/doc/config-reference/source/tables/zaqar-logging.rst index ee84cff227..2f390c1660 100644 --- a/doc/config-reference/source/tables/zaqar-logging.rst +++ b/doc/config-reference/source/tables/zaqar-logging.rst @@ -19,44 +19,42 @@ * - **[DEFAULT]** - * - ``debug`` = ``False`` - - (BoolOpt) Print debugging output (set logging level to DEBUG instead of 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`` - - (ListOpt) List of logger=LEVEL pairs. This option is ignored if log_config_append is set. + - (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`` + - (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. + - (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) 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 output to. If no default is set, logging will go to stdout. 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) Data to append to log format when level 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 without context. + - (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) Format string for user_identity field of the 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) (Optional) Enables or disables syslog rfc5424 format for logging. If enabled, prefixes the MSG part of the syslog message with APP-NAME (RFC5424). The format without the APP-NAME is deprecated in Kilo, and will be removed in Mitaka, along with this option. 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, will disable INFO logging level, making WARNING the default. + - (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) (Optional) 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. diff --git a/doc/config-reference/source/tables/zaqar-mongodb.rst b/doc/config-reference/source/tables/zaqar-mongodb.rst index 03f97f844d..2743ed59f2 100644 --- a/doc/config-reference/source/tables/zaqar-mongodb.rst +++ b/doc/config-reference/source/tables/zaqar-mongodb.rst @@ -19,50 +19,50 @@ * - **[drivers:management_store:mongodb]** - * - ``database`` = ``zaqar`` - - (StrOpt) Database name. + - (String) Database name. * - ``max_attempts`` = ``1000`` - - (IntOpt) Maximum number of times to retry a failed operation. Currently only used for retrying a message post. + - (Integer) Maximum number of times to retry a failed operation. Currently only used for retrying a message post. * - ``max_reconnect_attempts`` = ``10`` - - (IntOpt) Maximum number of times to retry an operation that failed due to a primary node failover. + - (Integer) Maximum number of times to retry an operation that failed due to a primary node failover. * - ``max_retry_jitter`` = ``0.005`` - - (FloatOpt) Maximum jitter interval, to be added to the sleep interval, in order to decrease probability that parallel requests will retry at the same instant. + - (Floating point) Maximum jitter interval, to be added to the sleep interval, in order to decrease probability that parallel requests will retry at the same instant. * - ``max_retry_sleep`` = ``0.1`` - - (FloatOpt) Maximum sleep interval between retries (actual sleep time increases linearly according to number of attempts performed). + - (Floating point) Maximum sleep interval between retries (actual sleep time increases linearly according to number of attempts performed). * - ``reconnect_sleep`` = ``0.02`` - - (FloatOpt) Base sleep interval between attempts to reconnect after a primary node failover. The actual sleep time increases exponentially (power of 2) each time the operation is retried. + - (Floating point) Base sleep interval between attempts to reconnect after a primary node failover. The actual sleep time increases exponentially (power of 2) each time the operation is retried. * - ``ssl_ca_certs`` = ``None`` - - (StrOpt) The ca_certs file contains a set of concatenated "certification authority" certificates, which are used to validate certificates passed from the other end of the connection. + - (String) The ca_certs file contains a set of concatenated "certification authority" certificates, which are used to validate certificates passed from the other end of the connection. * - ``ssl_cert_reqs`` = ``CERT_REQUIRED`` - - (StrOpt) Specifies whether a certificate is required from the other side of the connection, and whether it will be validated if provided. It must be one of the three values ``CERT_NONE``(certificates ignored), ``CERT_OPTIONAL``(not required, but validated if provided), or ``CERT_REQUIRED``(required and validated). If the value of this parameter is not ``CERT_NONE``, then the ``ssl_ca_cert`` parameter must point to a file of CA certificates. + - (String) Specifies whether a certificate is required from the other side of the connection, and whether it will be validated if provided. It must be one of the three values ``CERT_NONE``(certificates ignored), ``CERT_OPTIONAL``(not required, but validated if provided), or ``CERT_REQUIRED``(required and validated). If the value of this parameter is not ``CERT_NONE``, then the ``ssl_ca_cert`` parameter must point to a file of CA certificates. * - ``ssl_certfile`` = ``None`` - - (StrOpt) The certificate file used to identify the local connection against mongod. + - (String) The certificate file used to identify the local connection against mongod. * - ``ssl_keyfile`` = ``None`` - - (StrOpt) The private keyfile used to identify the local connection against mongod. If included with the ``certifle`` then only the ``ssl_certfile`` is needed. + - (String) The private keyfile used to identify the local connection against mongod. If included with the ``certifle`` then only the ``ssl_certfile`` is needed. * - ``uri`` = ``None`` - - (StrOpt) Mongodb Connection URI. If ssl connection enabled, then ``ssl_keyfile``, ``ssl_certfile``, ``ssl_cert_reqs``, ``ssl_ca_certs`` need to be set accordingly. + - (String) Mongodb Connection URI. If ssl connection enabled, then ``ssl_keyfile``, ``ssl_certfile``, ``ssl_cert_reqs``, ``ssl_ca_certs`` need to be set accordingly. * - **[drivers:message_store:mongodb]** - * - ``database`` = ``zaqar`` - - (StrOpt) Database name. + - (String) Database name. * - ``max_attempts`` = ``1000`` - - (IntOpt) Maximum number of times to retry a failed operation. Currently only used for retrying a message post. + - (Integer) Maximum number of times to retry a failed operation. Currently only used for retrying a message post. * - ``max_reconnect_attempts`` = ``10`` - - (IntOpt) Maximum number of times to retry an operation that failed due to a primary node failover. + - (Integer) Maximum number of times to retry an operation that failed due to a primary node failover. * - ``max_retry_jitter`` = ``0.005`` - - (FloatOpt) Maximum jitter interval, to be added to the sleep interval, in order to decrease probability that parallel requests will retry at the same instant. + - (Floating point) Maximum jitter interval, to be added to the sleep interval, in order to decrease probability that parallel requests will retry at the same instant. * - ``max_retry_sleep`` = ``0.1`` - - (FloatOpt) Maximum sleep interval between retries (actual sleep time increases linearly according to number of attempts performed). + - (Floating point) Maximum sleep interval between retries (actual sleep time increases linearly according to number of attempts performed). * - ``partitions`` = ``2`` - - (IntOpt) Number of databases across which to partition message data, in order to reduce writer lock %. DO NOT change this setting after initial deployment. It MUST remain static. Also, you should not need a large number of partitions to improve performance, esp. if deploying MongoDB on SSD storage. + - (Integer) Number of databases across which to partition message data, in order to reduce writer lock %. DO NOT change this setting after initial deployment. It MUST remain static. Also, you should not need a large number of partitions to improve performance, esp. if deploying MongoDB on SSD storage. * - ``reconnect_sleep`` = ``0.02`` - - (FloatOpt) Base sleep interval between attempts to reconnect after a primary node failover. The actual sleep time increases exponentially (power of 2) each time the operation is retried. + - (Floating point) Base sleep interval between attempts to reconnect after a primary node failover. The actual sleep time increases exponentially (power of 2) each time the operation is retried. * - ``ssl_ca_certs`` = ``None`` - - (StrOpt) The ca_certs file contains a set of concatenated "certification authority" certificates, which are used to validate certificates passed from the other end of the connection. + - (String) The ca_certs file contains a set of concatenated "certification authority" certificates, which are used to validate certificates passed from the other end of the connection. * - ``ssl_cert_reqs`` = ``CERT_REQUIRED`` - - (StrOpt) Specifies whether a certificate is required from the other side of the connection, and whether it will be validated if provided. It must be one of the three values ``CERT_NONE``(certificates ignored), ``CERT_OPTIONAL``(not required, but validated if provided), or ``CERT_REQUIRED``(required and validated). If the value of this parameter is not ``CERT_NONE``, then the ``ssl_ca_cert`` parameter must point to a file of CA certificates. + - (String) Specifies whether a certificate is required from the other side of the connection, and whether it will be validated if provided. It must be one of the three values ``CERT_NONE``(certificates ignored), ``CERT_OPTIONAL``(not required, but validated if provided), or ``CERT_REQUIRED``(required and validated). If the value of this parameter is not ``CERT_NONE``, then the ``ssl_ca_cert`` parameter must point to a file of CA certificates. * - ``ssl_certfile`` = ``None`` - - (StrOpt) The certificate file used to identify the local connection against mongod. + - (String) The certificate file used to identify the local connection against mongod. * - ``ssl_keyfile`` = ``None`` - - (StrOpt) The private keyfile used to identify the local connection against mongod. If included with the ``certifle`` then only the ``ssl_certfile`` is needed. + - (String) The private keyfile used to identify the local connection against mongod. If included with the ``certifle`` then only the ``ssl_certfile`` is needed. * - ``uri`` = ``None`` - - (StrOpt) Mongodb Connection URI. If ssl connection enabled, then ``ssl_keyfile``, ``ssl_certfile``, ``ssl_cert_reqs``, ``ssl_ca_certs`` need to be set accordingly. + - (String) Mongodb Connection URI. If ssl connection enabled, then ``ssl_keyfile``, ``ssl_certfile``, ``ssl_cert_reqs``, ``ssl_ca_certs`` need to be set accordingly. diff --git a/doc/config-reference/source/tables/zaqar-pooling.rst b/doc/config-reference/source/tables/zaqar-pooling.rst index 9d6fd001c6..55bd9b015d 100644 --- a/doc/config-reference/source/tables/zaqar-pooling.rst +++ b/doc/config-reference/source/tables/zaqar-pooling.rst @@ -19,8 +19,8 @@ * - **[DEFAULT]** - * - ``pooling`` = ``False`` - - (BoolOpt) Enable pooling across multiple storage backends. If pooling is enabled, the storage driver configuration is used to determine where the catalogue/control plane data is kept. + - (Boolean) Enable pooling across multiple storage backends. If pooling is enabled, the storage driver configuration is used to determine where the catalogue/control plane data is kept. * - **[pooling:catalog]** - * - ``enable_virtual_pool`` = ``False`` - - (BoolOpt) If enabled, the message_store will be used as the storage for the virtual pool. + - (Boolean) If enabled, the message_store will be used as the storage for the virtual pool. diff --git a/doc/config-reference/source/tables/zaqar-redis.rst b/doc/config-reference/source/tables/zaqar-redis.rst index d71aa8d1f0..02ea846d74 100644 --- a/doc/config-reference/source/tables/zaqar-redis.rst +++ b/doc/config-reference/source/tables/zaqar-redis.rst @@ -19,16 +19,16 @@ * - **[drivers:management_store:redis]** - * - ``max_reconnect_attempts`` = ``10`` - - (IntOpt) Maximum number of times to retry an operation that failed due to a redis node failover. + - (Integer) Maximum number of times to retry an operation that failed due to a redis node failover. * - ``reconnect_sleep`` = ``1.0`` - - (FloatOpt) Base sleep interval between attempts to reconnect after a redis node failover. + - (Floating point) Base sleep interval between attempts to reconnect after a redis node failover. * - ``uri`` = ``redis://127.0.0.1:6379`` - - (StrOpt) Redis connection URI, taking one of three forms. For a direct connection to a Redis server, use the form "redis://host[:port][?options]", where port defaults to 6379 if not specified. For an HA master-slave Redis cluster using Redis Sentinel, use the form "redis://host1[:port1][,host2[:port2],...,hostN[:portN]][?options]", where each host specified corresponds to an instance of redis-sentinel. In this form, the name of the Redis master used in the Sentinel configuration must be included in the query string as "master=". Finally, to connect to a local instance of Redis over a unix socket, you may use the form "redis:/path/to/redis.sock[?options]". In all forms, the "socket_timeout" option may be specified in the query string. Its value is given in seconds. If not provided, "socket_timeout" defaults to 0.1 seconds. + - (String) Redis connection URI, taking one of three forms. For a direct connection to a Redis server, use the form "redis://host[:port][?options]", where port defaults to 6379 if not specified. For an HA master-slave Redis cluster using Redis Sentinel, use the form "redis://host1[:port1][,host2[:port2],...,hostN[:portN]][?options]", where each host specified corresponds to an instance of redis-sentinel. In this form, the name of the Redis master used in the Sentinel configuration must be included in the query string as "master=". Finally, to connect to a local instance of Redis over a unix socket, you may use the form "redis:/path/to/redis.sock[?options]". In all forms, the "socket_timeout" option may be specified in the query string. Its value is given in seconds. If not provided, "socket_timeout" defaults to 0.1 seconds. * - **[drivers:message_store:redis]** - * - ``max_reconnect_attempts`` = ``10`` - - (IntOpt) Maximum number of times to retry an operation that failed due to a redis node failover. + - (Integer) Maximum number of times to retry an operation that failed due to a redis node failover. * - ``reconnect_sleep`` = ``1.0`` - - (FloatOpt) Base sleep interval between attempts to reconnect after a redis node failover. + - (Floating point) Base sleep interval between attempts to reconnect after a redis node failover. * - ``uri`` = ``redis://127.0.0.1:6379`` - - (StrOpt) Redis connection URI, taking one of three forms. For a direct connection to a Redis server, use the form "redis://host[:port][?options]", where port defaults to 6379 if not specified. For an HA master-slave Redis cluster using Redis Sentinel, use the form "redis://host1[:port1][,host2[:port2],...,hostN[:portN]][?options]", where each host specified corresponds to an instance of redis-sentinel. In this form, the name of the Redis master used in the Sentinel configuration must be included in the query string as "master=". Finally, to connect to a local instance of Redis over a unix socket, you may use the form "redis:/path/to/redis.sock[?options]". In all forms, the "socket_timeout" option may be specified in the query string. Its value is given in seconds. If not provided, "socket_timeout" defaults to 0.1 seconds. + - (String) Redis connection URI, taking one of three forms. For a direct connection to a Redis server, use the form "redis://host[:port][?options]", where port defaults to 6379 if not specified. For an HA master-slave Redis cluster using Redis Sentinel, use the form "redis://host1[:port1][,host2[:port2],...,hostN[:portN]][?options]", where each host specified corresponds to an instance of redis-sentinel. In this form, the name of the Redis master used in the Sentinel configuration must be included in the query string as "master=". Finally, to connect to a local instance of Redis over a unix socket, you may use the form "redis:/path/to/redis.sock[?options]". In all forms, the "socket_timeout" option may be specified in the query string. Its value is given in seconds. If not provided, "socket_timeout" defaults to 0.1 seconds. diff --git a/doc/config-reference/source/tables/zaqar-sqlalchemy.rst b/doc/config-reference/source/tables/zaqar-sqlalchemy.rst index 7e6bb302c3..9b8b966672 100644 --- a/doc/config-reference/source/tables/zaqar-sqlalchemy.rst +++ b/doc/config-reference/source/tables/zaqar-sqlalchemy.rst @@ -19,4 +19,4 @@ * - **[drivers:management_store:sqlalchemy]** - * - ``uri`` = ``sqlite:///:memory:`` - - (StrOpt) An sqlalchemy URL + - (String) An sqlalchemy URL diff --git a/doc/config-reference/source/tables/zaqar-storage.rst b/doc/config-reference/source/tables/zaqar-storage.rst index d47ce1820a..fc1de83f62 100644 --- a/doc/config-reference/source/tables/zaqar-storage.rst +++ b/doc/config-reference/source/tables/zaqar-storage.rst @@ -19,10 +19,10 @@ * - **[storage]** - * - ``claim_pipeline`` = - - (ListOpt) Pipeline to use for processing claim operations. This pipeline will be consumed before calling the storage driver's controller methods. + - (List) Pipeline to use for processing claim operations. This pipeline will be consumed before calling the storage driver's controller methods. * - ``message_pipeline`` = - - (ListOpt) Pipeline to use for processing message operations. This pipeline will be consumed before calling the storage driver's controller methods. + - (List) Pipeline to use for processing message operations. This pipeline will be consumed before calling the storage driver's controller methods. * - ``queue_pipeline`` = - - (ListOpt) Pipeline to use for processing queue operations. This pipeline will be consumed before calling the storage driver's controller methods. + - (List) Pipeline to use for processing queue operations. This pipeline will be consumed before calling the storage driver's controller methods. * - ``subscription_pipeline`` = - - (ListOpt) Pipeline to use for processing subscription operations. This pipeline will be consumed before calling the storage driver's controller methods. + - (List) Pipeline to use for processing subscription operations. This pipeline will be consumed before calling the storage driver's controller methods. diff --git a/doc/config-reference/source/tables/zaqar-transport.rst b/doc/config-reference/source/tables/zaqar-transport.rst index 2f0e0fd899..d3ca149f79 100644 --- a/doc/config-reference/source/tables/zaqar-transport.rst +++ b/doc/config-reference/source/tables/zaqar-transport.rst @@ -19,28 +19,30 @@ * - **[transport]** - * - ``default_claim_grace`` = ``60`` - - (IntOpt) Defines the message grace period in seconds. + - (Integer) Defines the message grace period in seconds. * - ``default_claim_ttl`` = ``300`` - - (IntOpt) Defines how long a message will be in claimed state. + - (Integer) Defines how long a message will be in claimed state. * - ``default_message_ttl`` = ``3600`` - - (IntOpt) Defines how long a message will be accessible. + - (Integer) Defines how long a message will be accessible. + * - ``default_subscription_ttl`` = ``3600`` + - (Integer) Defines how long a subscription will be available. * - ``max_claim_grace`` = ``43200`` - - (IntOpt) Defines the maximum message grace period in seconds. + - (Integer) Defines the maximum message grace period in seconds. * - ``max_claim_ttl`` = ``43200`` - - (IntOpt) Maximum length of a message in claimed state. + - (Integer) Maximum length of a message in claimed state. * - ``max_message_ttl`` = ``1209600`` - - (IntOpt) Maximum amount of time a message will be available. + - (Integer) Maximum amount of time a message will be available. * - ``max_messages_per_claim_or_pop`` = ``20`` - - (IntOpt) The maximum number of messages that can be claimed (OR) popped in a single request + - (Integer) The maximum number of messages that can be claimed (OR) popped in a single request * - ``max_messages_per_page`` = ``20`` - - (IntOpt) Defines the maximum number of messages per page. + - (Integer) Defines the maximum number of messages per page. * - ``max_messages_post_size`` = ``262144`` - - (IntOpt) Defines the maximum size of message posts. + - (Integer) Defines the maximum size of message posts. * - ``max_queue_metadata`` = ``65536`` - - (IntOpt) Defines the maximum amount of metadata in a queue. + - (Integer) Defines the maximum amount of metadata in a queue. * - ``max_queues_per_page`` = ``20`` - - (IntOpt) Defines the maximum number of queues per page. + - (Integer) Defines the maximum number of queues per page. * - ``max_subscriptions_per_page`` = ``20`` - - (IntOpt) Defines the maximum number of subscriptions per page. + - (Integer) Defines the maximum number of subscriptions per page. * - ``subscriber_types`` = ``http, https, mailto`` - - (ListOpt) Defines supported subscriber types. + - (List) Defines supported subscriber types. diff --git a/doc/config-reference/source/tables/zaqar-websocket.rst b/doc/config-reference/source/tables/zaqar-websocket.rst index d17ca705ce..afafe2ca44 100644 --- a/doc/config-reference/source/tables/zaqar-websocket.rst +++ b/doc/config-reference/source/tables/zaqar-websocket.rst @@ -19,8 +19,8 @@ * - **[drivers:transport:websocket]** - * - ``bind`` = ``127.0.0.1`` - - (IPOpt) Address on which the self-hosting server will listen. + - (Unknown) Address on which the self-hosting server will listen. * - ``external_port`` = ``None`` - - (PortOpt) Port on which the service is provided to the user. + - (Unknown) Port on which the service is provided to the user. * - ``port`` = ``9000`` - - (PortOpt) Port on which the self-hosting server will listen. + - (Unknown) Port on which the self-hosting server will listen. diff --git a/doc/config-reference/source/tables/zaqar-wsgi.rst b/doc/config-reference/source/tables/zaqar-wsgi.rst index b79721acb6..545fa1478c 100644 --- a/doc/config-reference/source/tables/zaqar-wsgi.rst +++ b/doc/config-reference/source/tables/zaqar-wsgi.rst @@ -19,6 +19,6 @@ * - **[drivers:transport:wsgi]** - * - ``bind`` = ``127.0.0.1`` - - (IPOpt) Address on which the self-hosting server will listen. + - (Unknown) Address on which the self-hosting server will listen. * - ``port`` = ``8888`` - - (PortOpt) Port on which the self-hosting server will listen. + - (Unknown) Port on which the self-hosting server will listen. diff --git a/doc/config-reference/source/telemetry/alarming_service_config_opts.rst b/doc/config-reference/source/telemetry/alarming_service_config_opts.rst index 514429a68c..29469d8a3a 100644 --- a/doc/config-reference/source/telemetry/alarming_service_config_opts.rst +++ b/doc/config-reference/source/telemetry/alarming_service_config_opts.rst @@ -8,14 +8,12 @@ Alarming service configuration options. .. include:: ../tables/aodh-amqp.rst .. include:: ../tables/aodh-api.rst .. include:: ../tables/aodh-auth_token.rst -.. include:: ../tables/aodh-auth.rst .. include:: ../tables/aodh-common.rst .. include:: ../tables/aodh-coordination.rst .. include:: ../tables/aodh-cors.rst .. include:: ../tables/aodh-database.rst .. include:: ../tables/aodh-logging.rst .. include:: ../tables/aodh-policy.rst -.. include:: ../tables/aodh-qpid.rst .. include:: ../tables/aodh-rabbitmq.rst .. include:: ../tables/aodh-redis.rst .. include:: ../tables/aodh-rpc.rst diff --git a/doc/config-reference/source/telemetry/telemetry_service_config_opts.rst b/doc/config-reference/source/telemetry/telemetry_service_config_opts.rst index 019c8ac36e..3fe6a9364a 100644 --- a/doc/config-reference/source/telemetry/telemetry_service_config_opts.rst +++ b/doc/config-reference/source/telemetry/telemetry_service_config_opts.rst @@ -19,13 +19,13 @@ configuration options. .. include:: ../tables/ceilometer-events.rst .. include:: ../tables/ceilometer-exchange.rst .. include:: ../tables/ceilometer-glance.rst +.. include:: ../tables/ceilometer-hyperv.rst .. include:: ../tables/ceilometer-inspector.rst .. include:: ../tables/ceilometer-ipmi.rst .. include:: ../tables/ceilometer-logging.rst .. include:: ../tables/ceilometer-magnetodb.rst .. include:: ../tables/ceilometer-notification.rst .. include:: ../tables/ceilometer-policy.rst -.. include:: ../tables/ceilometer-qpid.rst .. include:: ../tables/ceilometer-rabbitmq.rst .. include:: ../tables/ceilometer-redis.rst .. include:: ../tables/ceilometer-rgw.rst diff --git a/tools/autogenerate-config-flagmappings/aodh.flagmappings b/tools/autogenerate-config-flagmappings/aodh.flagmappings index 0b98c6714c..819b8d7dcf 100644 --- a/tools/autogenerate-config-flagmappings/aodh.flagmappings +++ b/tools/autogenerate-config-flagmappings/aodh.flagmappings @@ -52,7 +52,6 @@ transport_url amqp use_pub_sub zeromq use_stderr logging use_syslog logging -use_syslog_rfc_format logging user_alarm_quota common verbose logging watch_log_file logging @@ -166,9 +165,17 @@ oslo_messaging_notifications/topics rpc oslo_messaging_notifications/transport_url rpc oslo_messaging_rabbit/amqp_auto_delete rabbitmq oslo_messaging_rabbit/amqp_durable_queues rabbitmq +oslo_messaging_rabbit/channel_max rabbitmq +oslo_messaging_rabbit/default_notification_exchange rabbitmq +oslo_messaging_rabbit/default_notification_retry_attempts rabbitmq +oslo_messaging_rabbit/default_rpc_exchange rabbitmq +oslo_messaging_rabbit/default_rpc_retry_attempts rabbitmq oslo_messaging_rabbit/fake_rabbit rabbitmq +oslo_messaging_rabbit/frame_max rabbitmq +oslo_messaging_rabbit/heartbeat_interval rabbitmq oslo_messaging_rabbit/heartbeat_rate rabbitmq oslo_messaging_rabbit/heartbeat_timeout_threshold rabbitmq +oslo_messaging_rabbit/host_connection_reconnect_delay rabbitmq oslo_messaging_rabbit/kombu_compression rabbitmq oslo_messaging_rabbit/kombu_failover_strategy rabbitmq oslo_messaging_rabbit/kombu_missing_consumer_retry_timeout rabbitmq @@ -177,6 +184,14 @@ oslo_messaging_rabbit/kombu_ssl_ca_certs rabbitmq oslo_messaging_rabbit/kombu_ssl_certfile rabbitmq oslo_messaging_rabbit/kombu_ssl_keyfile rabbitmq oslo_messaging_rabbit/kombu_ssl_version rabbitmq +oslo_messaging_rabbit/notification_listener_prefetch_count rabbitmq +oslo_messaging_rabbit/notification_persistence rabbitmq +oslo_messaging_rabbit/notification_retry_delay rabbitmq +oslo_messaging_rabbit/pool_max_overflow rabbitmq +oslo_messaging_rabbit/pool_max_size rabbitmq +oslo_messaging_rabbit/pool_recycle rabbitmq +oslo_messaging_rabbit/pool_stale rabbitmq +oslo_messaging_rabbit/pool_timeout rabbitmq oslo_messaging_rabbit/rabbit_ha_queues rabbitmq oslo_messaging_rabbit/rabbit_host rabbitmq oslo_messaging_rabbit/rabbit_hosts rabbitmq @@ -192,6 +207,17 @@ oslo_messaging_rabbit/rabbit_transient_queues_ttl rabbitmq oslo_messaging_rabbit/rabbit_use_ssl rabbitmq oslo_messaging_rabbit/rabbit_userid rabbitmq oslo_messaging_rabbit/rabbit_virtual_host rabbitmq +oslo_messaging_rabbit/rpc_listener_prefetch_count rpc +oslo_messaging_rabbit/rpc_queue_expiration rpc +oslo_messaging_rabbit/rpc_reply_exchange rpc +oslo_messaging_rabbit/rpc_reply_listener_prefetch_count rpc +oslo_messaging_rabbit/rpc_reply_retry_attempts rpc +oslo_messaging_rabbit/rpc_reply_retry_delay rpc +oslo_messaging_rabbit/rpc_retry_delay rpc +oslo_messaging_rabbit/socket_timeout rpc +oslo_messaging_rabbit/ssl rpc +oslo_messaging_rabbit/ssl_options rpc +oslo_messaging_rabbit/tcp_user_timeout rpc oslo_middleware/max_request_body_size api oslo_middleware/secure_proxy_ssl_header api oslo_policy/policy_default_rule policy diff --git a/tools/autogenerate-config-flagmappings/ceilometer.flagmappings b/tools/autogenerate-config-flagmappings/ceilometer.flagmappings index 6751f7066d..af307e0562 100644 --- a/tools/autogenerate-config-flagmappings/ceilometer.flagmappings +++ b/tools/autogenerate-config-flagmappings/ceilometer.flagmappings @@ -78,7 +78,6 @@ trove_control_exchange exchange use_pub_sub zeromq use_stderr logging use_syslog logging -use_syslog_rfc_format logging verbose logging watch_log_file logging zaqar_control_exchange zaqar @@ -98,6 +97,7 @@ collector/requeue_sample_on_dispatcher_error collector collector/udp_address collector collector/udp_port collector collector/workers collector +compute/resource_update_interval common compute/workload_partitioning common coordination/backend_url common coordination/check_watchers common @@ -157,6 +157,7 @@ hardware/meter_definitions_file tripleo hardware/readonly_user_name tripleo hardware/readonly_user_password tripleo hardware/url_scheme tripleo +hyperv/force_volumeutils_v1 hyperv ipmi/node_manager_init_retry ipmi ipmi/polling_retry ipmi keystone_authtoken/admin_password auth_token @@ -238,9 +239,17 @@ oslo_messaging_notifications/topics rpc oslo_messaging_notifications/transport_url rpc oslo_messaging_rabbit/amqp_auto_delete rabbitmq oslo_messaging_rabbit/amqp_durable_queues rabbitmq +oslo_messaging_rabbit/channel_max rabbitmq +oslo_messaging_rabbit/default_notification_exchange rabbitmq +oslo_messaging_rabbit/default_notification_retry_attempts rabbitmq +oslo_messaging_rabbit/default_rpc_exchange rabbitmq +oslo_messaging_rabbit/default_rpc_retry_attempts rabbitmq oslo_messaging_rabbit/fake_rabbit rabbitmq +oslo_messaging_rabbit/frame_max rabbitmq +oslo_messaging_rabbit/heartbeat_interval rabbitmq oslo_messaging_rabbit/heartbeat_rate rabbitmq oslo_messaging_rabbit/heartbeat_timeout_threshold rabbitmq +oslo_messaging_rabbit/host_connection_reconnect_delay rabbitmq oslo_messaging_rabbit/kombu_compression rabbitmq oslo_messaging_rabbit/kombu_failover_strategy rabbitmq oslo_messaging_rabbit/kombu_missing_consumer_retry_timeout rabbitmq @@ -249,6 +258,14 @@ oslo_messaging_rabbit/kombu_ssl_ca_certs rabbitmq oslo_messaging_rabbit/kombu_ssl_certfile rabbitmq oslo_messaging_rabbit/kombu_ssl_keyfile rabbitmq oslo_messaging_rabbit/kombu_ssl_version rabbitmq +oslo_messaging_rabbit/notification_listener_prefetch_count rabbitmq +oslo_messaging_rabbit/notification_persistence rabbitmq +oslo_messaging_rabbit/notification_retry_delay rabbitmq +oslo_messaging_rabbit/pool_max_overflow rabbitmq +oslo_messaging_rabbit/pool_max_size rabbitmq +oslo_messaging_rabbit/pool_recycle rabbitmq +oslo_messaging_rabbit/pool_stale rabbitmq +oslo_messaging_rabbit/pool_timeout rabbitmq oslo_messaging_rabbit/rabbit_ha_queues rabbitmq oslo_messaging_rabbit/rabbit_host rabbitmq oslo_messaging_rabbit/rabbit_hosts rabbitmq @@ -264,6 +281,17 @@ oslo_messaging_rabbit/rabbit_transient_queues_ttl rabbitmq oslo_messaging_rabbit/rabbit_use_ssl rabbitmq oslo_messaging_rabbit/rabbit_userid rabbitmq oslo_messaging_rabbit/rabbit_virtual_host rabbitmq +oslo_messaging_rabbit/rpc_listener_prefetch_count rpc +oslo_messaging_rabbit/rpc_queue_expiration rpc +oslo_messaging_rabbit/rpc_reply_exchange rpc +oslo_messaging_rabbit/rpc_reply_listener_prefetch_count rpc +oslo_messaging_rabbit/rpc_reply_retry_attempts rpc +oslo_messaging_rabbit/rpc_reply_retry_delay rpc +oslo_messaging_rabbit/rpc_retry_delay rpc +oslo_messaging_rabbit/socket_timeout rpc +oslo_messaging_rabbit/ssl rpc +oslo_messaging_rabbit/ssl_options rpc +oslo_messaging_rabbit/tcp_user_timeout rpc oslo_middleware/max_request_body_size api oslo_middleware/secure_proxy_ssl_header api oslo_policy/policy_default_rule policy @@ -288,6 +316,7 @@ service_credentials/timeout auth service_types/glance service_types service_types/kwapi service_types service_types/neutron service_types +service_types/neutron_lbaas_version service_types service_types/nova service_types service_types/radosgw service_types service_types/swift service_types diff --git a/tools/autogenerate-config-flagmappings/ceilometer.headers b/tools/autogenerate-config-flagmappings/ceilometer.headers index b898f65e6d..5996eba836 100644 --- a/tools/autogenerate-config-flagmappings/ceilometer.headers +++ b/tools/autogenerate-config-flagmappings/ceilometer.headers @@ -3,6 +3,7 @@ dispatcher_http HTTP dispatcher dispatcher_gnocchi Gnocchi dispatcher events events exchange exchange +hyperv HyperV inspector inspector magnetodb MagnetoDB notification notification diff --git a/tools/autogenerate-config-flagmappings/cinder.flagmappings b/tools/autogenerate-config-flagmappings/cinder.flagmappings index ac7f8b250e..4cea9a639b 100644 --- a/tools/autogenerate-config-flagmappings/cinder.flagmappings +++ b/tools/autogenerate-config-flagmappings/cinder.flagmappings @@ -61,6 +61,7 @@ backup_topic backups backup_tsm_compression backups_tsm backup_tsm_password backups_tsm backup_tsm_volume_prefix backups_tsm +backup_use_same_host backups blockbridge_api_host blockbridge blockbridge_api_port blockbridge blockbridge_auth_password blockbridge @@ -98,7 +99,6 @@ compute_api_class common consistencygroup_api_class common control_exchange amqp datera_api_port datera -datera_api_token datera datera_api_version datera datera_num_replicas datera db_driver database @@ -113,7 +113,6 @@ dell_sc_ssn dellsc dell_sc_verify_cert dellsc dell_sc_volume_folder dellsc destroy_empty_storage_group emc -direct_over_proxy zeromq disco_client disco disco_client_port disco disco_wsdl_path disco @@ -127,15 +126,23 @@ dpl_pool prophetstor_dpl dpl_port prophetstor_dpl drbdmanage_devs_on_controller drbd drbdmanage_redundancy drbd +drbdmanage_resize_plugin drbd +drbdmanage_resize_policy drbd +drbdmanage_resource_plugin drbd +drbdmanage_resource_policy drbd +drbdmanage_snapshot_plugin drbd +drbdmanage_snapshot_policy drbd driver_client_cert datera driver_client_cert_key datera driver_data_namespace common +driver_ssl_cert_path common driver_ssl_cert_verify common driver_use_ssl xio enable_force_upload common enable_new_services common enable_v1_api api enable_v2_api api +enable_v3_api api enabled_backends storage end_time common enforce_multipath_for_image_xfer common @@ -302,7 +309,6 @@ log_config_append logging log_date_format logging log_dir logging log_file logging -log_format logging logging_context_format_string logging logging_debug_format_suffix logging logging_default_format_string logging @@ -316,6 +322,7 @@ management_ips api max_age quota max_luns_per_storage_group emc max_over_subscription_ratio common +memcached_servers common migration_create_volume_timeout_secs storage monkey_patch common monkey_patch_modules common @@ -384,10 +391,8 @@ nexenta_volume_group nexenta nfs_mount_attempts storage_nfs nfs_mount_options storage_nfs nfs_mount_point_base storage_nfs -nfs_oversub_ratio storage_nfs nfs_shares_config storage_nfs nfs_sparsed_volumes storage_nfs -nfs_used_ratio storage_nfs nimble_pool_name nimble nimble_subnet_label nimble no_snapshot_gb_quota common @@ -413,15 +418,18 @@ osapi_volume_extension api osapi_volume_listen api osapi_volume_listen_port api osapi_volume_workers api -password api per_volume_size_limit api periodic_fuzzy_delay common periodic_interval common -port api public_endpoint api publish_errors logging pure_api_token pure pure_automatic_max_oversubscription_ratio pure +pure_eradicate_on_delete pure +pure_replica_interval_default pure +pure_replica_retention_long_term_default pure +pure_replica_retention_long_term_per_day_default pure +pure_replica_retention_short_term_default pure query_volume_filters api quobyte_client_cfg quobyte quobyte_mount_point_base quobyte @@ -507,7 +515,6 @@ sf_template_account_name solidfire sf_volume_prefix solidfire sheepdog_store_address sheepdog sheepdog_store_port sheepdog -sio_force_delete emc_sio sio_protection_domain_id emc_sio sio_protection_domain_name emc_sio sio_rest_server_port emc_sio @@ -529,7 +536,6 @@ smbfs_used_ratio smbfs snapshot_check_timeout backups snapshot_name_template backups snapshot_same_host backups -sqlite_clean_db common ssh_conn_timeout san ssh_hosts_key_file common ssh_max_pool_conn san @@ -540,6 +546,7 @@ storage_availability_zone common storage_vnx_authentication_type emc storage_vnx_pool_names emc storage_vnx_security_file_dir emc +storwize_san_secondary_ip storwize storwize_svc_allow_tenant_qos storwize storwize_svc_flashcopy_rate storwize storwize_svc_flashcopy_timeout storwize @@ -557,6 +564,7 @@ storwize_svc_vol_rsize storwize storwize_svc_vol_warning storwize storwize_svc_volpool_name storwize strict_ssh_host_key_policy common +suppress_requests_ssl_warnings common swift_catalog_info backups_swift syslog_log_facility logging tcp_keepalive common @@ -567,6 +575,8 @@ tegile_default_project tegile thres_avl_size_perc_start netapp_7mode_nfs netapp_cdot_nfs thres_avl_size_perc_stop netapp_7mode_nfs netapp_cdot_nfs tintri_api_version tintri +tintri_image_cache_expiry_days tintri +tintri_image_shares_config tintri tintri_server_hostname tintri tintri_server_password tintri tintri_server_username tintri @@ -580,7 +590,6 @@ use_multipath_for_image_xfer images use_pub_sub zeromq use_stderr logging use_syslog logging -use_syslog_rfc_format logging verbose logging violin_request_timeout violin vmware_api_retry_count vmware @@ -646,6 +655,7 @@ zfssa_lun_compression zfssa-iscsi zfssa_lun_logbias zfssa-iscsi zfssa_lun_sparse zfssa-iscsi zfssa_lun_volblocksize zfssa-iscsi +zfssa_manage_policy zfssa-nfs zfssa_nfs_mount_options zfssa-nfs zfssa_nfs_pool zfssa-nfs zfssa_nfs_project zfssa-nfs @@ -661,15 +671,27 @@ zfssa_target_interfaces zfssa-iscsi zfssa_target_password zfssa-iscsi zfssa_target_portal zfssa-iscsi zfssa_target_user zfssa-iscsi +zmq_target_expire zeromq zoning_mode zoning BRCD_FABRIC_EXAMPLE/fc_fabric_address zoning_fabric BRCD_FABRIC_EXAMPLE/fc_fabric_password zoning_fabric BRCD_FABRIC_EXAMPLE/fc_fabric_port zoning_fabric +BRCD_FABRIC_EXAMPLE/fc_fabric_ssh_cert_path zoning_fabric BRCD_FABRIC_EXAMPLE/fc_fabric_user zoning_fabric +BRCD_FABRIC_EXAMPLE/fc_southbound_protocol zoning_fabric +BRCD_FABRIC_EXAMPLE/fc_virtual_fabric_id zoning_fabric BRCD_FABRIC_EXAMPLE/principal_switch_wwn zoning_fabric BRCD_FABRIC_EXAMPLE/zone_activate zoning_fabric BRCD_FABRIC_EXAMPLE/zone_name_prefix zoning_fabric BRCD_FABRIC_EXAMPLE/zoning_policy zoning_fabric +CISCO_FABRIC_EXAMPLE/cisco_fc_fabric_address zoning_fabric +CISCO_FABRIC_EXAMPLE/cisco_fc_fabric_password zoning_fabric +CISCO_FABRIC_EXAMPLE/cisco_fc_fabric_port zoning_fabric +CISCO_FABRIC_EXAMPLE/cisco_fc_fabric_user zoning_fabric +CISCO_FABRIC_EXAMPLE/cisco_zone_activate zoning_fabric +CISCO_FABRIC_EXAMPLE/cisco_zone_name_prefix zoning_fabric +CISCO_FABRIC_EXAMPLE/cisco_zoning_policy zoning_fabric +CISCO_FABRIC_EXAMPLE/cisco_zoning_vsan zoning_fabric coordination/backend_url coordination coordination/heartbeat coordination coordination/initial_reconnect_backoff coordination @@ -707,7 +729,8 @@ database/sqlite_db database database/sqlite_synchronous database database/use_db_reconnect database database/use_tpool database -fc-zone-manager/brcd_sb_connector zoning_manager +fc-zone-manager/brcd_sb_connector zoning +fc-zone-manager/cisco_sb_connector zoning fc-zone-manager/fc_fabric_names zoning fc-zone-manager/fc_san_lookup_service zoning fc-zone-manager/zone_driver zoning @@ -755,9 +778,14 @@ keystone_authtoken/region_name auth_token keystone_authtoken/revocation_cache_time auth_token keystone_authtoken/signing_dir auth_token keystone_authtoken/token_cache_time auth_token +matchmaker_redis/check_timeout redis matchmaker_redis/host redis matchmaker_redis/password redis matchmaker_redis/port redis +matchmaker_redis/sentinel_group_name redis +matchmaker_redis/sentinel_hosts redis +matchmaker_redis/socket_timeout redis +matchmaker_redis/wait_timeout redis oslo_concurrency/disable_process_locking rpc oslo_concurrency/lock_path rpc oslo_messaging_amqp/allow_insecure_clients rpc @@ -781,9 +809,18 @@ oslo_messaging_notifications/topics rpc oslo_messaging_notifications/transport_url rpc oslo_messaging_rabbit/amqp_auto_delete rabbitmq oslo_messaging_rabbit/amqp_durable_queues rabbitmq +oslo_messaging_rabbit/channel_max rabbitmq +oslo_messaging_rabbit/default_notification_exchange rabbitmq +oslo_messaging_rabbit/default_notification_retry_attempts rabbitmq +oslo_messaging_rabbit/default_rpc_exchange rabbitmq +oslo_messaging_rabbit/default_rpc_retry_attempts rabbitmq oslo_messaging_rabbit/fake_rabbit rabbitmq +oslo_messaging_rabbit/frame_max rabbitmq +oslo_messaging_rabbit/heartbeat_interval rabbitmq oslo_messaging_rabbit/heartbeat_rate rabbitmq oslo_messaging_rabbit/heartbeat_timeout_threshold rabbitmq +oslo_messaging_rabbit/host_connection_reconnect_delay rabbitmq +oslo_messaging_rabbit/kombu_compression rabbitmq oslo_messaging_rabbit/kombu_failover_strategy rabbitmq oslo_messaging_rabbit/kombu_missing_consumer_retry_timeout rabbitmq oslo_messaging_rabbit/kombu_reconnect_delay rabbitmq @@ -791,24 +828,46 @@ oslo_messaging_rabbit/kombu_ssl_ca_certs rabbitmq oslo_messaging_rabbit/kombu_ssl_certfile rabbitmq oslo_messaging_rabbit/kombu_ssl_keyfile rabbitmq oslo_messaging_rabbit/kombu_ssl_version rabbitmq +oslo_messaging_rabbit/notification_listener_prefetch_count rabbitmq +oslo_messaging_rabbit/notification_persistence rabbitmq +oslo_messaging_rabbit/notification_retry_delay rabbitmq +oslo_messaging_rabbit/pool_max_overflow rabbitmq +oslo_messaging_rabbit/pool_max_size rabbitmq +oslo_messaging_rabbit/pool_recycle rabbitmq +oslo_messaging_rabbit/pool_stale rabbitmq +oslo_messaging_rabbit/pool_timeout rabbitmq oslo_messaging_rabbit/rabbit_ha_queues rabbitmq oslo_messaging_rabbit/rabbit_host rabbitmq oslo_messaging_rabbit/rabbit_hosts rabbitmq +oslo_messaging_rabbit/rabbit_interval_max rabbitmq oslo_messaging_rabbit/rabbit_login_method rabbitmq oslo_messaging_rabbit/rabbit_max_retries rabbitmq oslo_messaging_rabbit/rabbit_password rabbitmq oslo_messaging_rabbit/rabbit_port rabbitmq +oslo_messaging_rabbit/rabbit_qos_prefetch_count rabbitmq oslo_messaging_rabbit/rabbit_retry_backoff rabbitmq oslo_messaging_rabbit/rabbit_retry_interval rabbitmq +oslo_messaging_rabbit/rabbit_transient_queues_ttl rabbitmq oslo_messaging_rabbit/rabbit_use_ssl rabbitmq oslo_messaging_rabbit/rabbit_userid rabbitmq oslo_messaging_rabbit/rabbit_virtual_host rabbitmq +oslo_messaging_rabbit/rpc_listener_prefetch_count rpc +oslo_messaging_rabbit/rpc_queue_expiration rpc +oslo_messaging_rabbit/rpc_reply_exchange rpc +oslo_messaging_rabbit/rpc_reply_listener_prefetch_count rpc +oslo_messaging_rabbit/rpc_reply_retry_attempts rpc +oslo_messaging_rabbit/rpc_reply_retry_delay rpc +oslo_messaging_rabbit/rpc_retry_delay rpc +oslo_messaging_rabbit/socket_timeout rpc +oslo_messaging_rabbit/ssl rpc +oslo_messaging_rabbit/ssl_options rpc +oslo_messaging_rabbit/tcp_user_timeout rpc oslo_middleware/max_request_body_size api oslo_middleware/secure_proxy_ssl_header api oslo_policy/policy_default_rule api oslo_policy/policy_dirs api oslo_policy/policy_file api oslo_versionedobjects/fatal_exception_format_errors api +profiler/enabled profiler profiler/hmac_keys profiler -profiler/profiler_enabled profiler profiler/trace_sqlalchemy profiler diff --git a/tools/autogenerate-config-flagmappings/glance.flagmappings b/tools/autogenerate-config-flagmappings/glance.flagmappings index 2ae211b347..1f53e4a739 100644 --- a/tools/autogenerate-config-flagmappings/glance.flagmappings +++ b/tools/autogenerate-config-flagmappings/glance.flagmappings @@ -33,7 +33,6 @@ enable_v1_api api enable_v1_registry api enable_v2_api api enable_v2_registry api -enable_v3_api api executor_thread_pool_size common fatal_deprecations logging http_keepalive api @@ -116,7 +115,6 @@ transport_url amqp use_pub_sub zeromq use_stderr logging use_syslog logging -use_syslog_rfc_format logging use_user_token api user_storage_quota common verbose logging @@ -161,18 +159,27 @@ glance_store/cinder_ca_certificates_file cinder glance_store/cinder_catalog_info cinder glance_store/cinder_endpoint_template cinder glance_store/cinder_http_retries cinder +glance_store/cinder_os_region_name cinder +glance_store/cinder_state_transition_timeout cinder +glance_store/cinder_store_auth_address cinder +glance_store/cinder_store_password cinder +glance_store/cinder_store_project_name cinder +glance_store/cinder_store_user_name cinder glance_store/default_store api glance_store/default_swift_reference swift glance_store/filesystem_store_datadir filesystem glance_store/filesystem_store_datadirs filesystem glance_store/filesystem_store_file_perm filesystem glance_store/filesystem_store_metadata_file filesystem -glance_store/os_region_name common +glance_store/http_proxy_information http +glance_store/https_ca_certificates_file http +glance_store/https_insecure http glance_store/rados_connect_timeout rbd glance_store/rbd_store_ceph_conf rbd glance_store/rbd_store_chunk_size rbd glance_store/rbd_store_pool rbd glance_store/rbd_store_user rbd +glance_store/rootwrap_config common glance_store/s3_store_access_key s3 glance_store/s3_store_bucket s3 glance_store/s3_store_bucket_url_format s3 @@ -203,6 +210,7 @@ glance_store/swift_store_container swift glance_store/swift_store_create_container_on_put swift glance_store/swift_store_endpoint swift glance_store/swift_store_endpoint_type swift +glance_store/swift_store_expire_soon_interval swift glance_store/swift_store_key swift glance_store/swift_store_large_object_chunk_size swift glance_store/swift_store_large_object_size swift @@ -212,10 +220,12 @@ glance_store/swift_store_region swift glance_store/swift_store_retry_get_count swift glance_store/swift_store_service_type swift glance_store/swift_store_ssl_compression swift +glance_store/swift_store_use_trusts swift glance_store/swift_store_user swift -glance_store/vmware_api_insecure vmware glance_store/vmware_api_retry_count vmware +glance_store/vmware_ca_file vmware glance_store/vmware_datastores vmware +glance_store/vmware_insecure vmware glance_store/vmware_server_host vmware glance_store/vmware_server_password vmware glance_store/vmware_server_username vmware @@ -292,9 +302,17 @@ oslo_messaging_notifications/topics amqp oslo_messaging_notifications/transport_url amqp oslo_messaging_rabbit/amqp_auto_delete rabbitmq oslo_messaging_rabbit/amqp_durable_queues rabbitmq +oslo_messaging_rabbit/channel_max rabbitmq +oslo_messaging_rabbit/default_notification_exchange rabbitmq +oslo_messaging_rabbit/default_notification_retry_attempts rabbitmq +oslo_messaging_rabbit/default_rpc_exchange rabbitmq +oslo_messaging_rabbit/default_rpc_retry_attempts rabbitmq oslo_messaging_rabbit/fake_rabbit rabbitmq +oslo_messaging_rabbit/frame_max rabbitmq +oslo_messaging_rabbit/heartbeat_interval rabbitmq oslo_messaging_rabbit/heartbeat_rate rabbitmq oslo_messaging_rabbit/heartbeat_timeout_threshold rabbitmq +oslo_messaging_rabbit/host_connection_reconnect_delay rabbitmq oslo_messaging_rabbit/kombu_compression rabbitmq oslo_messaging_rabbit/kombu_failover_strategy rabbitmq oslo_messaging_rabbit/kombu_missing_consumer_retry_timeout rabbitmq @@ -303,6 +321,14 @@ oslo_messaging_rabbit/kombu_ssl_ca_certs rabbitmq oslo_messaging_rabbit/kombu_ssl_certfile rabbitmq oslo_messaging_rabbit/kombu_ssl_keyfile rabbitmq oslo_messaging_rabbit/kombu_ssl_version rabbitmq +oslo_messaging_rabbit/notification_listener_prefetch_count rabbitmq +oslo_messaging_rabbit/notification_persistence rabbitmq +oslo_messaging_rabbit/notification_retry_delay rabbitmq +oslo_messaging_rabbit/pool_max_overflow rabbitmq +oslo_messaging_rabbit/pool_max_size rabbitmq +oslo_messaging_rabbit/pool_recycle rabbitmq +oslo_messaging_rabbit/pool_stale rabbitmq +oslo_messaging_rabbit/pool_timeout rabbitmq oslo_messaging_rabbit/rabbit_ha_queues rabbitmq oslo_messaging_rabbit/rabbit_host rabbitmq oslo_messaging_rabbit/rabbit_hosts rabbitmq @@ -318,6 +344,17 @@ oslo_messaging_rabbit/rabbit_transient_queues_ttl rabbitmq oslo_messaging_rabbit/rabbit_use_ssl rabbitmq oslo_messaging_rabbit/rabbit_userid rabbitmq oslo_messaging_rabbit/rabbit_virtual_host rabbitmq +oslo_messaging_rabbit/rpc_listener_prefetch_count rpc +oslo_messaging_rabbit/rpc_queue_expiration rpc +oslo_messaging_rabbit/rpc_reply_exchange rpc +oslo_messaging_rabbit/rpc_reply_listener_prefetch_count rpc +oslo_messaging_rabbit/rpc_reply_retry_attempts rpc +oslo_messaging_rabbit/rpc_reply_retry_delay rpc +oslo_messaging_rabbit/rpc_retry_delay rpc +oslo_messaging_rabbit/socket_timeout rpc +oslo_messaging_rabbit/ssl rpc +oslo_messaging_rabbit/ssl_options rpc +oslo_messaging_rabbit/tcp_user_timeout rpc oslo_middleware/max_request_body_size api oslo_middleware/secure_proxy_ssl_header api oslo_policy/policy_default_rule policy diff --git a/tools/autogenerate-config-flagmappings/heat.flagmappings b/tools/autogenerate-config-flagmappings/heat.flagmappings index 6bb5a20e52..2acbd4167d 100644 --- a/tools/autogenerate-config-flagmappings/heat.flagmappings +++ b/tools/autogenerate-config-flagmappings/heat.flagmappings @@ -1,5 +1,6 @@ action_retry_limit api auth_encryption_key crypt +client_retry_limit common cloud_backend clients_backends control_exchange amqp convergence_engine common @@ -36,36 +37,32 @@ log_config_append logging log_date_format logging log_dir logging log_file logging -log_format logging logging_context_format_string logging logging_debug_format_suffix logging logging_default_format_string logging logging_exception_prefix logging logging_user_identity_format logging max_events_per_stack quota +max_interface_check_attempts common max_json_body_size api max_nested_stack_depth quota max_resources_per_stack quota max_stacks_per_tenant quota max_template_size quota memcached_servers common -notification_driver amqp -notification_topics amqp -notification_transport_url amqp num_engine_workers api +observe_on_update api onready notification -password common periodic_interval common plugin_dirs common -port common publish_errors logging +reauthentication_auth_method common region_name_for_services clients rpc_backend rpc rpc_cast_timeout rpc rpc_conn_pool_size rpc rpc_poll_timeout rpc rpc_response_timeout rpc -rpc_zmq_all_req_rep zeromq rpc_zmq_bind_address zeromq rpc_zmq_bind_port_retries zeromq rpc_zmq_concurrency zeromq @@ -82,15 +79,16 @@ stack_domain_admin_password api stack_scheduler_hints api stack_user_domain_id api stack_user_domain_name api +stale_token_duration api syslog_log_facility logging transport_url amqp trusts_delegated_roles api +use_pub_sub zeromq use_stderr logging use_syslog logging -use_syslog_rfc_format logging verbose logging watch_log_file common -zmq_use_broker zeromq +zmq_target_expire zeromq auth_password/allowed_auth_uris api auth_password/multi_cloud api cache/backend common @@ -238,10 +236,10 @@ keystone_authtoken/admin_token auth_token keystone_authtoken/admin_user auth_token keystone_authtoken/auth_admin_prefix auth_token keystone_authtoken/auth_host auth_token -keystone_authtoken/auth_plugin auth_token keystone_authtoken/auth_port auth_token keystone_authtoken/auth_protocol auth_token keystone_authtoken/auth_section auth_token +keystone_authtoken/auth_type auth_token keystone_authtoken/auth_uri auth_token keystone_authtoken/auth_version auth_token keystone_authtoken/cache auth_token @@ -270,9 +268,14 @@ keystone_authtoken/region_name auth_token keystone_authtoken/revocation_cache_time auth_token keystone_authtoken/signing_dir auth_token keystone_authtoken/token_cache_time auth_token +matchmaker_redis/check_timeout redis matchmaker_redis/host redis matchmaker_redis/password redis matchmaker_redis/port redis +matchmaker_redis/sentinel_group_name redis +matchmaker_redis/sentinel_hosts redis +matchmaker_redis/socket_timeout redis +matchmaker_redis/wait_timeout redis oslo_concurrency/disable_process_locking rpc oslo_concurrency/lock_path rpc oslo_messaging_amqp/allow_insecure_clients rpc @@ -291,44 +294,64 @@ oslo_messaging_amqp/ssl_key_file rpc oslo_messaging_amqp/ssl_key_password rpc oslo_messaging_amqp/trace rpc oslo_messaging_amqp/username rpc -oslo_messaging_qpid/amqp_auto_delete qpid -oslo_messaging_qpid/amqp_durable_queues qpid -oslo_messaging_qpid/qpid_heartbeat qpid -oslo_messaging_qpid/qpid_hostname qpid -oslo_messaging_qpid/qpid_hosts qpid -oslo_messaging_qpid/qpid_password qpid -oslo_messaging_qpid/qpid_port qpid -oslo_messaging_qpid/qpid_protocol qpid -oslo_messaging_qpid/qpid_receiver_capacity qpid -oslo_messaging_qpid/qpid_sasl_mechanisms qpid -oslo_messaging_qpid/qpid_tcp_nodelay qpid -oslo_messaging_qpid/qpid_topology_version qpid -oslo_messaging_qpid/qpid_username qpid -oslo_messaging_qpid/send_single_reply qpid +oslo_messaging_notifications/driver rpc +oslo_messaging_notifications/topics rpc +oslo_messaging_notifications/transport_url rpc oslo_messaging_rabbit/amqp_auto_delete rabbitmq oslo_messaging_rabbit/amqp_durable_queues rabbitmq +oslo_messaging_rabbit/channel_max rabbitmq +oslo_messaging_rabbit/default_notification_exchange rabbitmq +oslo_messaging_rabbit/default_notification_retry_attempts rabbitmq +oslo_messaging_rabbit/default_rpc_exchange rabbitmq +oslo_messaging_rabbit/default_rpc_retry_attempts rabbitmq oslo_messaging_rabbit/fake_rabbit rabbitmq +oslo_messaging_rabbit/frame_max rabbitmq +oslo_messaging_rabbit/heartbeat_interval rabbitmq oslo_messaging_rabbit/heartbeat_rate rabbitmq oslo_messaging_rabbit/heartbeat_timeout_threshold rabbitmq +oslo_messaging_rabbit/host_connection_reconnect_delay rabbitmq +oslo_messaging_rabbit/kombu_compression rabbitmq +oslo_messaging_rabbit/kombu_failover_strategy rabbitmq +oslo_messaging_rabbit/kombu_missing_consumer_retry_timeout rabbitmq oslo_messaging_rabbit/kombu_reconnect_delay rabbitmq -oslo_messaging_rabbit/kombu_reconnect_timeout rabbitmq oslo_messaging_rabbit/kombu_ssl_ca_certs rabbitmq oslo_messaging_rabbit/kombu_ssl_certfile rabbitmq oslo_messaging_rabbit/kombu_ssl_keyfile rabbitmq oslo_messaging_rabbit/kombu_ssl_version rabbitmq +oslo_messaging_rabbit/notification_listener_prefetch_count rabbitmq +oslo_messaging_rabbit/notification_persistence rabbitmq +oslo_messaging_rabbit/notification_retry_delay rabbitmq +oslo_messaging_rabbit/pool_max_overflow rabbitmq +oslo_messaging_rabbit/pool_max_size rabbitmq +oslo_messaging_rabbit/pool_recycle rabbitmq +oslo_messaging_rabbit/pool_stale rabbitmq +oslo_messaging_rabbit/pool_timeout rabbitmq oslo_messaging_rabbit/rabbit_ha_queues rabbitmq oslo_messaging_rabbit/rabbit_host rabbitmq oslo_messaging_rabbit/rabbit_hosts rabbitmq +oslo_messaging_rabbit/rabbit_interval_max rabbitmq oslo_messaging_rabbit/rabbit_login_method rabbitmq oslo_messaging_rabbit/rabbit_max_retries rabbitmq oslo_messaging_rabbit/rabbit_password rabbitmq oslo_messaging_rabbit/rabbit_port rabbitmq +oslo_messaging_rabbit/rabbit_qos_prefetch_count rabbitmq oslo_messaging_rabbit/rabbit_retry_backoff rabbitmq oslo_messaging_rabbit/rabbit_retry_interval rabbitmq +oslo_messaging_rabbit/rabbit_transient_queues_ttl rabbitmq oslo_messaging_rabbit/rabbit_use_ssl rabbitmq oslo_messaging_rabbit/rabbit_userid rabbitmq oslo_messaging_rabbit/rabbit_virtual_host rabbitmq -oslo_messaging_rabbit/send_single_reply rabbitmq +oslo_messaging_rabbit/rpc_listener_prefetch_count rabbitmq +oslo_messaging_rabbit/rpc_queue_expiration rabbitmq +oslo_messaging_rabbit/rpc_reply_exchange rabbitmq +oslo_messaging_rabbit/rpc_reply_listener_prefetch_count rabbitmq +oslo_messaging_rabbit/rpc_reply_retry_attempts rabbitmq +oslo_messaging_rabbit/rpc_reply_retry_delay rabbitmq +oslo_messaging_rabbit/rpc_retry_delay rabbitmq +oslo_messaging_rabbit/socket_timeout rabbitmq +oslo_messaging_rabbit/ssl rabbitmq +oslo_messaging_rabbit/ssl_options rabbitmq +oslo_messaging_rabbit/tcp_user_timeout rabbitmq oslo_middleware/max_request_body_size api oslo_middleware/secure_proxy_ssl_header api oslo_policy/policy_default_rule api @@ -337,9 +360,11 @@ oslo_policy/policy_file api oslo_versionedobjects/fatal_exception_format_errors api paste_deploy/api_paste_config api paste_deploy/flavor api +profiler/enabled testing profiler/hmac_keys testing -profiler/profiler_enabled testing profiler/trace_sqlalchemy testing +resource_finder_cache/caching common +resource_finder_cache/expiration_time common revision/heat_revision common service_extension_cache/caching common service_extension_cache/expiration_time common diff --git a/tools/autogenerate-config-flagmappings/ironic.flagmappings b/tools/autogenerate-config-flagmappings/ironic.flagmappings index 9e72cfee27..59fc52c25d 100644 --- a/tools/autogenerate-config-flagmappings/ironic.flagmappings +++ b/tools/autogenerate-config-flagmappings/ironic.flagmappings @@ -2,6 +2,7 @@ auth_strategy auth bindir common control_exchange amqp debug logging +debug_tracebacks_in_api logging default_log_levels logging enabled_drivers common executor_thread_pool_size common @@ -21,7 +22,6 @@ log_config_append logging log_date_format logging log_dir logging log_file logging -log_format logging logging_context_format_string logging logging_debug_format_suffix logging logging_default_format_string logging @@ -29,14 +29,9 @@ logging_exception_prefix logging logging_user_identity_format logging memcached_servers common my_ip common -notification_driver amqp -notification_topics amqp -notification_transport_url amqp parallel_image_downloads common -password redis pecan_debug debug periodic_interval common -port redis publish_errors logging pybasedir common rootwrap_config common @@ -45,7 +40,6 @@ rpc_cast_timeout rpc rpc_conn_pool_size rpc rpc_poll_timeout rpc rpc_response_timeout rpc -rpc_zmq_all_req_rep zeromq rpc_zmq_bind_address zeromq rpc_zmq_bind_port_retries zeromq rpc_zmq_concurrency zeromq @@ -60,12 +54,12 @@ state_path common syslog_log_facility logging tempdir common transport_url amqp +use_pub_sub zeromq use_stderr logging use_syslog logging -use_syslog_rfc_format logging verbose logging watch_log_file logging -zmq_use_broker zeromq +zmq_target_expire zeromq agent/agent_api_version agent agent/agent_pxe_append_params agent agent/agent_pxe_config_template agent @@ -74,10 +68,13 @@ agent/manage_agent_boot agent agent/memory_consumed_by_agent agent agent/post_deploy_get_power_state_retries agent agent/post_deploy_get_power_state_retry_interval agent +agent/stream_raw_images agent amt/action_wait amt +amt/awake_interval amt amt/max_attempts amt amt/protocol amt api/api_workers api +api/enable_ssl_api api api/host_ip api api/max_limit api api/port api @@ -87,9 +84,9 @@ cimc/max_retry cisco_ucs cisco_ucs/action_interval cisco_ucs cisco_ucs/max_retry cisco_ucs conductor/api_url conductor +conductor/automated_clean conductor conductor/check_provision_state_interval conductor conductor/clean_callback_timeout conductor -conductor/clean_nodes conductor conductor/configdrive_swift_container conductor conductor/configdrive_use_swift conductor conductor/deploy_callback_timeout conductor @@ -145,22 +142,21 @@ database/slave_connection database database/sqlite_db database database/sqlite_synchronous database database/use_db_reconnect database -deploy/dd_block_size deploy -deploy/efi_system_partition_size deploy deploy/erase_devices_iterations deploy deploy/erase_devices_priority deploy deploy/http_root deploy deploy/http_url deploy -deploy/iscsi_verify_attempts deploy dhcp/dhcp_provider dhcp disk_partitioner/check_device_interval disk_partitioner disk_partitioner/check_device_max_retries disk_partitioner -drac/client_retry_count drac -drac/client_retry_delay drac +disk_utils/dd_block_size disk_partitioner +disk_utils/efi_system_partition_size disk_partitioner +disk_utils/iscsi_verify_attempts disk_partitioner glance/allowed_direct_url_schemes glance glance/auth_strategy glance glance/glance_api_insecure glance glance/glance_api_servers glance +glance/glance_cafile glance glance/glance_host glance glance/glance_num_retries glance glance/glance_port glance @@ -170,7 +166,9 @@ glance/swift_api_version glance glance/swift_container glance glance/swift_endpoint_url glance glance/swift_store_multiple_containers_seed glance +glance/swift_temp_url_cache_enabled glance glance/swift_temp_url_duration glance +glance/swift_temp_url_expected_download_start_delay glance glance/swift_temp_url_key glance glance/temp_url_endpoint_type glance iboot/max_retry iboot @@ -205,6 +203,12 @@ irmc/remote_image_user_domain irmc irmc/remote_image_user_name irmc irmc/remote_image_user_password irmc irmc/sensor_method irmc +irmc/snmp_community irmc +irmc/snmp_port irmc +irmc/snmp_security irmc +irmc/snmp_version irmc +ironic_lib/fatal_exception_format_errors common +ironic_lib/root_helper common keystone/region_name keystone keystone_authtoken/admin_password auth_token keystone_authtoken/admin_tenant_name auth_token @@ -212,10 +216,10 @@ keystone_authtoken/admin_token auth_token keystone_authtoken/admin_user auth_token keystone_authtoken/auth_admin_prefix auth_token keystone_authtoken/auth_host auth_token -keystone_authtoken/auth_plugin auth_token keystone_authtoken/auth_port auth_token keystone_authtoken/auth_protocol auth_token keystone_authtoken/auth_section auth_token +keystone_authtoken/auth_type auth_token keystone_authtoken/auth_uri auth_token keystone_authtoken/auth_version auth_token keystone_authtoken/cache auth_token @@ -244,9 +248,14 @@ keystone_authtoken/region_name auth_token keystone_authtoken/revocation_cache_time auth_token keystone_authtoken/signing_dir auth_token keystone_authtoken/token_cache_time auth_token +matchmaker_redis/check_timeout redis matchmaker_redis/host redis matchmaker_redis/password redis matchmaker_redis/port redis +matchmaker_redis/sentinel_group_name redis +matchmaker_redis/sentinel_hosts redis +matchmaker_redis/socket_timeout redis +matchmaker_redis/wait_timeout redis neutron/auth_strategy neutron neutron/cleaning_network_uuid neutron neutron/retries neutron @@ -276,44 +285,64 @@ oslo_messaging_amqp/ssl_key_file rpc oslo_messaging_amqp/ssl_key_password rpc oslo_messaging_amqp/trace rpc oslo_messaging_amqp/username rpc -oslo_messaging_qpid/amqp_auto_delete qpid -oslo_messaging_qpid/amqp_durable_queues qpid -oslo_messaging_qpid/qpid_heartbeat qpid -oslo_messaging_qpid/qpid_hostname qpid -oslo_messaging_qpid/qpid_hosts qpid -oslo_messaging_qpid/qpid_password qpid -oslo_messaging_qpid/qpid_port qpid -oslo_messaging_qpid/qpid_protocol qpid -oslo_messaging_qpid/qpid_receiver_capacity qpid -oslo_messaging_qpid/qpid_sasl_mechanisms qpid -oslo_messaging_qpid/qpid_tcp_nodelay qpid -oslo_messaging_qpid/qpid_topology_version qpid -oslo_messaging_qpid/qpid_username qpid -oslo_messaging_qpid/send_single_reply qpid +oslo_messaging_notifications/driver rpc +oslo_messaging_notifications/topics rpc +oslo_messaging_notifications/transport_url rpc oslo_messaging_rabbit/amqp_auto_delete rabbitmq oslo_messaging_rabbit/amqp_durable_queues rabbitmq +oslo_messaging_rabbit/channel_max rabbitmq +oslo_messaging_rabbit/default_notification_exchange rabbitmq +oslo_messaging_rabbit/default_notification_retry_attempts rabbitmq +oslo_messaging_rabbit/default_rpc_exchange rabbitmq +oslo_messaging_rabbit/default_rpc_retry_attempts rabbitmq oslo_messaging_rabbit/fake_rabbit rabbitmq +oslo_messaging_rabbit/frame_max rabbitmq +oslo_messaging_rabbit/heartbeat_interval rabbitmq oslo_messaging_rabbit/heartbeat_rate rabbitmq oslo_messaging_rabbit/heartbeat_timeout_threshold rabbitmq +oslo_messaging_rabbit/host_connection_reconnect_delay rabbitmq +oslo_messaging_rabbit/kombu_compression rabbitmq +oslo_messaging_rabbit/kombu_failover_strategy rabbitmq +oslo_messaging_rabbit/kombu_missing_consumer_retry_timeout rabbitmq oslo_messaging_rabbit/kombu_reconnect_delay rabbitmq -oslo_messaging_rabbit/kombu_reconnect_timeout rabbitmq oslo_messaging_rabbit/kombu_ssl_ca_certs rabbitmq oslo_messaging_rabbit/kombu_ssl_certfile rabbitmq oslo_messaging_rabbit/kombu_ssl_keyfile rabbitmq oslo_messaging_rabbit/kombu_ssl_version rabbitmq +oslo_messaging_rabbit/notification_listener_prefetch_count rabbitmq +oslo_messaging_rabbit/notification_persistence rabbitmq +oslo_messaging_rabbit/notification_retry_delay rabbitmq +oslo_messaging_rabbit/pool_max_overflow rabbitmq +oslo_messaging_rabbit/pool_max_size rabbitmq +oslo_messaging_rabbit/pool_recycle rabbitmq +oslo_messaging_rabbit/pool_stale rabbitmq +oslo_messaging_rabbit/pool_timeout rabbitmq oslo_messaging_rabbit/rabbit_ha_queues rabbitmq oslo_messaging_rabbit/rabbit_host rabbitmq oslo_messaging_rabbit/rabbit_hosts rabbitmq +oslo_messaging_rabbit/rabbit_interval_max rabbitmq oslo_messaging_rabbit/rabbit_login_method rabbitmq oslo_messaging_rabbit/rabbit_max_retries rabbitmq oslo_messaging_rabbit/rabbit_password rabbitmq oslo_messaging_rabbit/rabbit_port rabbitmq +oslo_messaging_rabbit/rabbit_qos_prefetch_count rabbitmq oslo_messaging_rabbit/rabbit_retry_backoff rabbitmq oslo_messaging_rabbit/rabbit_retry_interval rabbitmq +oslo_messaging_rabbit/rabbit_transient_queues_ttl rabbitmq oslo_messaging_rabbit/rabbit_use_ssl rabbitmq oslo_messaging_rabbit/rabbit_userid rabbitmq oslo_messaging_rabbit/rabbit_virtual_host rabbitmq -oslo_messaging_rabbit/send_single_reply rabbitmq +oslo_messaging_rabbit/rpc_listener_prefetch_count rabbitmq +oslo_messaging_rabbit/rpc_queue_expiration rabbitmq +oslo_messaging_rabbit/rpc_reply_exchange rabbitmq +oslo_messaging_rabbit/rpc_reply_listener_prefetch_count rabbitmq +oslo_messaging_rabbit/rpc_reply_retry_attempts rabbitmq +oslo_messaging_rabbit/rpc_reply_retry_delay rabbitmq +oslo_messaging_rabbit/rpc_retry_delay rabbitmq +oslo_messaging_rabbit/socket_timeout rabbitmq +oslo_messaging_rabbit/ssl rabbitmq +oslo_messaging_rabbit/ssl_options rabbitmq +oslo_messaging_rabbit/tcp_user_timeout rabbitmq oslo_middleware/max_request_body_size api oslo_middleware/secure_proxy_ssl_header api oslo_policy/policy_default_rule policy @@ -329,6 +358,7 @@ pxe/instance_master_path pxe pxe/ip_version pxe pxe/ipxe_boot_script pxe pxe/ipxe_enabled pxe +pxe/ipxe_timeout pxe pxe/pxe_append_params pxe pxe/pxe_bootfile_name pxe pxe/pxe_config_template pxe diff --git a/tools/autogenerate-config-flagmappings/keystone.flagmappings b/tools/autogenerate-config-flagmappings/keystone.flagmappings index bf4a9dafa7..18f97d4ad2 100644 --- a/tools/autogenerate-config-flagmappings/keystone.flagmappings +++ b/tools/autogenerate-config-flagmappings/keystone.flagmappings @@ -8,7 +8,7 @@ default_publisher_id amqp domain_id_immutable api executor_thread_pool_size common fatal_deprecations logging -host redis +insecure_debug logging instance_format logging instance_uuid_format logging list_limit api @@ -16,7 +16,6 @@ log_config_append logging log_date_format logging log_dir logging log_file logging -log_format logging logging_context_format_string logging logging_debug_format_suffix logging logging_default_format_string logging @@ -28,12 +27,8 @@ max_token_size api member_role_id api member_role_name api memcached_servers common -notification_driver amqp notification_format amqp -notification_topics amqp -notification_transport_url amqp -password redis -port redis +notification_opt_out amqp public_endpoint api publish_errors logging pydev_debug_host debug @@ -43,7 +38,6 @@ rpc_cast_timeout rpc rpc_conn_pool_size rpc rpc_poll_timeout rpc rpc_response_timeout rpc -rpc_zmq_all_req_rep zeromq rpc_zmq_bind_address zeromq rpc_zmq_bind_port_retries zeromq rpc_zmq_concurrency zeromq @@ -59,13 +53,14 @@ standard_threads debug strict_password_check api syslog_log_facility logging transport_url amqp +use_pub_sub zeromq use_stderr logging use_syslog logging -use_syslog_rfc_format logging verbose logging watch_log_file logging -zmq_use_broker zeromq +zmq_target_expire zeromq assignment/driver assignment +assignment/prohibited_implied_role assignment audit/namespace debug auth/external auth auth/methods auth @@ -171,10 +166,10 @@ keystone_authtoken/admin_token auth_token keystone_authtoken/admin_user auth_token keystone_authtoken/auth_admin_prefix auth_token keystone_authtoken/auth_host auth_token -keystone_authtoken/auth_plugin auth_token keystone_authtoken/auth_port auth_token keystone_authtoken/auth_protocol auth_token keystone_authtoken/auth_section auth_token +keystone_authtoken/auth_type auth_token keystone_authtoken/auth_uri auth_token keystone_authtoken/auth_version auth_token keystone_authtoken/cache auth_token @@ -223,6 +218,7 @@ ldap/group_desc_attribute ldap ldap/group_filter ldap ldap/group_id_attribute ldap ldap/group_member_attribute ldap +ldap/group_members_are_ids ldap ldap/group_name_attribute ldap ldap/group_objectclass ldap ldap/group_tree_dn ldap @@ -233,35 +229,7 @@ ldap/pool_connection_timeout ldap ldap/pool_retry_delay ldap ldap/pool_retry_max ldap ldap/pool_size ldap -ldap/project_additional_attribute_mapping ldap -ldap/project_allow_create ldap -ldap/project_allow_delete ldap -ldap/project_allow_update ldap -ldap/project_attribute_ignore ldap -ldap/project_desc_attribute ldap -ldap/project_domain_id_attribute ldap -ldap/project_enabled_attribute ldap -ldap/project_enabled_emulation ldap -ldap/project_enabled_emulation_dn ldap -ldap/project_enabled_emulation_use_group_config ldap -ldap/project_filter ldap -ldap/project_id_attribute ldap -ldap/project_member_attribute ldap -ldap/project_name_attribute ldap -ldap/project_objectclass ldap -ldap/project_tree_dn ldap ldap/query_scope ldap -ldap/role_additional_attribute_mapping ldap -ldap/role_allow_create ldap -ldap/role_allow_delete ldap -ldap/role_allow_update ldap -ldap/role_attribute_ignore ldap -ldap/role_filter ldap -ldap/role_id_attribute ldap -ldap/role_member_attribute ldap -ldap/role_name_attribute ldap -ldap/role_objectclass ldap -ldap/role_tree_dn ldap ldap/suffix ldap ldap/tls_cacertdir ldap ldap/tls_cacertfile ldap @@ -278,6 +246,7 @@ ldap/user_allow_delete ldap ldap/user_allow_update ldap ldap/user_attribute_ignore ldap ldap/user_default_project_id_attribute ldap +ldap/user_description_attribute ldap ldap/user_enabled_attribute ldap ldap/user_enabled_default ldap ldap/user_enabled_emulation ldap @@ -292,9 +261,14 @@ ldap/user_name_attribute ldap ldap/user_objectclass ldap ldap/user_pass_attribute ldap ldap/user_tree_dn ldap +matchmaker_redis/check_timeout redis matchmaker_redis/host redis matchmaker_redis/password redis matchmaker_redis/port redis +matchmaker_redis/sentinel_group_name redis +matchmaker_redis/sentinel_hosts redis +matchmaker_redis/socket_timeout redis +matchmaker_redis/wait_timeout redis memcache/dead_retry cache memcache/pool_connection_get_timeout cache memcache/pool_maxsize cache @@ -323,44 +297,64 @@ oslo_messaging_amqp/ssl_key_file rpc oslo_messaging_amqp/ssl_key_password rpc oslo_messaging_amqp/trace rpc oslo_messaging_amqp/username rpc -oslo_messaging_qpid/amqp_auto_delete qpid -oslo_messaging_qpid/amqp_durable_queues qpid -oslo_messaging_qpid/qpid_heartbeat qpid -oslo_messaging_qpid/qpid_hostname qpid -oslo_messaging_qpid/qpid_hosts qpid -oslo_messaging_qpid/qpid_password qpid -oslo_messaging_qpid/qpid_port qpid -oslo_messaging_qpid/qpid_protocol qpid -oslo_messaging_qpid/qpid_receiver_capacity qpid -oslo_messaging_qpid/qpid_sasl_mechanisms qpid -oslo_messaging_qpid/qpid_tcp_nodelay qpid -oslo_messaging_qpid/qpid_topology_version qpid -oslo_messaging_qpid/qpid_username qpid -oslo_messaging_qpid/send_single_reply qpid +oslo_messaging_notifications/driver rpc +oslo_messaging_notifications/topics rpc +oslo_messaging_notifications/transport_url rpc oslo_messaging_rabbit/amqp_auto_delete rabbitmq oslo_messaging_rabbit/amqp_durable_queues rabbitmq +oslo_messaging_rabbit/channel_max rabbitmq +oslo_messaging_rabbit/default_notification_exchange rabbitmq +oslo_messaging_rabbit/default_notification_retry_attempts rabbitmq +oslo_messaging_rabbit/default_rpc_exchange rabbitmq +oslo_messaging_rabbit/default_rpc_retry_attempts rabbitmq oslo_messaging_rabbit/fake_rabbit rabbitmq +oslo_messaging_rabbit/frame_max rabbitmq +oslo_messaging_rabbit/heartbeat_interval rabbitmq oslo_messaging_rabbit/heartbeat_rate rabbitmq oslo_messaging_rabbit/heartbeat_timeout_threshold rabbitmq +oslo_messaging_rabbit/host_connection_reconnect_delay rabbitmq +oslo_messaging_rabbit/kombu_compression rabbitmq +oslo_messaging_rabbit/kombu_failover_strategy rabbitmq +oslo_messaging_rabbit/kombu_missing_consumer_retry_timeout rabbitmq oslo_messaging_rabbit/kombu_reconnect_delay rabbitmq -oslo_messaging_rabbit/kombu_reconnect_timeout rabbitmq oslo_messaging_rabbit/kombu_ssl_ca_certs rabbitmq oslo_messaging_rabbit/kombu_ssl_certfile rabbitmq oslo_messaging_rabbit/kombu_ssl_keyfile rabbitmq oslo_messaging_rabbit/kombu_ssl_version rabbitmq +oslo_messaging_rabbit/notification_listener_prefetch_count rabbitmq +oslo_messaging_rabbit/notification_persistence rabbitmq +oslo_messaging_rabbit/notification_retry_delay rabbitmq +oslo_messaging_rabbit/pool_max_overflow rabbitmq +oslo_messaging_rabbit/pool_max_size rabbitmq +oslo_messaging_rabbit/pool_recycle rabbitmq +oslo_messaging_rabbit/pool_stale rabbitmq +oslo_messaging_rabbit/pool_timeout rabbitmq oslo_messaging_rabbit/rabbit_ha_queues rabbitmq oslo_messaging_rabbit/rabbit_host rabbitmq oslo_messaging_rabbit/rabbit_hosts rabbitmq +oslo_messaging_rabbit/rabbit_interval_max rabbitmq oslo_messaging_rabbit/rabbit_login_method rabbitmq oslo_messaging_rabbit/rabbit_max_retries rabbitmq oslo_messaging_rabbit/rabbit_password rabbitmq oslo_messaging_rabbit/rabbit_port rabbitmq +oslo_messaging_rabbit/rabbit_qos_prefetch_count rabbitmq oslo_messaging_rabbit/rabbit_retry_backoff rabbitmq oslo_messaging_rabbit/rabbit_retry_interval rabbitmq +oslo_messaging_rabbit/rabbit_transient_queues_ttl rabbitmq oslo_messaging_rabbit/rabbit_use_ssl rabbitmq oslo_messaging_rabbit/rabbit_userid rabbitmq oslo_messaging_rabbit/rabbit_virtual_host rabbitmq -oslo_messaging_rabbit/send_single_reply rabbitmq +oslo_messaging_rabbit/rpc_listener_prefetch_count rabbitmq +oslo_messaging_rabbit/rpc_queue_expiration rabbitmq +oslo_messaging_rabbit/rpc_reply_exchange rabbitmq +oslo_messaging_rabbit/rpc_reply_listener_prefetch_count rabbitmq +oslo_messaging_rabbit/rpc_reply_retry_attempts rabbitmq +oslo_messaging_rabbit/rpc_reply_retry_delay rabbitmq +oslo_messaging_rabbit/rpc_retry_delay rabbitmq +oslo_messaging_rabbit/socket_timeout rabbitmq +oslo_messaging_rabbit/ssl rabbitmq +oslo_messaging_rabbit/ssl_options rabbitmq +oslo_messaging_rabbit/tcp_user_timeout rabbitmq oslo_middleware/max_request_body_size api oslo_middleware/secure_proxy_ssl_header api oslo_policy/policy_default_rule policy @@ -369,10 +363,14 @@ oslo_policy/policy_file policy paste_deploy/config_file api policy/driver policy policy/list_limit policy +resource/admin_project_domain_name api +resource/admin_project_name api resource/cache_time api resource/caching api +resource/domain_name_url_safe api resource/driver api resource/list_limit api +resource/project_name_url_safe api revoke/cache_time revoke revoke/caching revoke revoke/driver revoke @@ -399,6 +397,7 @@ saml/idp_sso_endpoint saml saml/keyfile saml saml/relay_state_prefix saml saml/xmlsec1_binary saml +shadow_users/driver api signing/ca_certs ca signing/ca_key ca signing/cert_subject ca @@ -418,6 +417,7 @@ token/driver token token/enforce_token_bind token token/expiration token token/hash_algorithm token +token/infer_roles token token/provider token token/revoke_by_id token tokenless_auth/issuer_attribute tokenless diff --git a/tools/autogenerate-config-flagmappings/manila.flagmappings b/tools/autogenerate-config-flagmappings/manila.flagmappings index 0f3f49cacc..922a5ca708 100644 --- a/tools/autogenerate-config-flagmappings/manila.flagmappings +++ b/tools/autogenerate-config-flagmappings/manila.flagmappings @@ -1,9 +1,16 @@ +admin_network_config_group api +admin_network_id api +admin_subnet_id api api_paste_config api api_rate_limit api auth_strategy auth automatic_share_server_cleanup share backlog share capacity_weight_multiplier scheduler +cephfs_auth_id cephfs +cephfs_cluster_name cephfs +cephfs_conf_path cephfs +cephfs_enable_snapshots cephfs cinder_admin_auth_url generic cinder_admin_password generic cinder_admin_tenant_name generic @@ -18,6 +25,11 @@ client_socket_timeout common compute_api_class common connect_share_server_to_tenant_network generic control_exchange amqp +data_access_wait_access_rules_timeout common +data_manager common +data_node_access_cert common +data_node_access_ip common +data_topic common db_backend database db_driver database debug logging @@ -27,7 +39,7 @@ delete_share_server_with_last_share share driver_handles_share_servers share generic emc_nas_login emc emc_nas_password emc -emc_nas_pool_name emc +emc_nas_pool_names emc emc_nas_root_dir emc emc_nas_server emc emc_nas_server_container emc @@ -78,18 +90,24 @@ hdfs_ssh_name hdfs hdfs_ssh_port hdfs hdfs_ssh_private_key hdfs hdfs_ssh_pw hdfs +hds_hnas_driver_helper hnas hook_drivers share host common hpe3par_api_url hpe3par +hpe3par_cifs_admin_access_domain hpe3par +hpe3par_cifs_admin_access_password hpe3par +hpe3par_cifs_admin_access_username hpe3par hpe3par_debug hpe3par hpe3par_fpg hpe3par hpe3par_fstore_per_share hpe3par hpe3par_password hpe3par +hpe3par_require_cifs_ip hpe3par hpe3par_san_ip hpe3par hpe3par_san_login hpe3par hpe3par_san_password hpe3par hpe3par_san_ssh_port hpe3par hpe3par_share_ip_address hpe3par +hpe3par_share_mount_path hpe3par hpe3par_username hpe3par instance_format logging instance_uuid_format logging @@ -99,12 +117,16 @@ log_config_append logging log_date_format logging log_dir logging log_file logging -log_format logging logging_context_format_string logging logging_debug_format_suffix logging logging_default_format_string logging logging_exception_prefix logging logging_user_identity_format logging +lvm_share_export_ip lvm +lvm_share_export_root lvm +lvm_share_helpers lvm +lvm_share_mirrors lvm +lvm_share_volume_group lvm manila_huawei_conf_file huawei manila_service_keypair_name generic max_age quota @@ -117,11 +139,8 @@ max_time_to_create_volume generic max_time_to_extend_volume generic memcached_servers common migration_create_delete_share_timeout share -migration_data_copy_node_ip share migration_ignore_files share -migration_mounting_backend_ip share -migration_protocol_mount_command share -migration_readonly_support share +migration_readonly_rules_support share migration_tmp_location share migration_wait_access_rules_timeout share monkey_patch common @@ -136,15 +155,14 @@ netapp_root_volume netapp netapp_root_volume_aggregate netapp netapp_server_hostname netapp netapp_server_port netapp +netapp_snapmirror_quiesce_timeout netapp netapp_storage_family netapp netapp_trace_flags netapp netapp_transport_type netapp netapp_volume_name_template netapp +netapp_volume_snapshot_reserve_percent netapp netapp_vserver_name_template netapp network_config_group share -notification_driver amqp -notification_topics amqp -notification_transport_url amqp nova_admin_auth_url compute nova_admin_password compute nova_admin_tenant_name compute @@ -164,14 +182,12 @@ osapi_share_listen api osapi_share_listen_port api osapi_share_workers api ovs_integration_bridge generic -password redis path_to_private_key generic path_to_public_key generic periodic_fuzzy_delay common periodic_hooks_interval common periodic_interval common pool_weight_multiplier scheduler -port redis publish_errors logging quobyte_api_ca quobyte quobyte_api_password quobyte @@ -187,6 +203,8 @@ quota_share_networks quota quota_shares quota quota_snapshot_gigabytes quota quota_snapshots quota +replica_state_update_interval common +replication_domain common report_interval common reservation_expire quota reserved_share_percentage common @@ -197,7 +215,6 @@ rpc_cast_timeout rpc rpc_conn_pool_size rpc rpc_poll_timeout rpc rpc_response_timeout rpc -rpc_zmq_all_req_rep zeromq rpc_zmq_bind_address zeromq rpc_zmq_bind_port_retries zeromq rpc_zmq_concurrency zeromq @@ -234,9 +251,11 @@ share_api_class api share_helpers generic share_manager share share_mount_path generic +share_mount_template generic share_name_template share share_snapshot_name_template share share_topic rpc +share_unmount_template generic share_usage_audit_period share share_volume_fstype generic smb_template_config_path common @@ -261,16 +280,20 @@ tcp_keepalive common tcp_keepalive_count common tcp_keepalive_interval common tcp_keepidle common +tegile_default_project tegile +tegile_nas_login tegile +tegile_nas_password tegile +tegile_nas_server tegile tenant_net_name_or_ip generic transport_url amqp unmanage_remove_access_rules share until_refresh common unused_share_server_cleanup_interval share use_forwarded_for common +use_pub_sub zeromq use_scheduler_creating_share_from_snapshot share use_stderr logging use_syslog logging -use_syslog_rfc_format logging verbose logging volume_api_class api volume_name_template api generic @@ -284,6 +307,18 @@ winrm_retry_count winrm winrm_retry_interval winrm winrm_use_cert_based_auth winrm wsgi_keep_alive common +zfs_dataset_creation_options zfs +zfs_dataset_name_prefix zfs +zfs_dataset_snapshot_name_prefix zfs +zfs_replica_snapshot_prefix zfs +zfs_service_ip zfs +zfs_share_export_ip zfs +zfs_share_helpers zfs +zfs_ssh_private_key_path zfs +zfs_ssh_user_password zfs +zfs_ssh_username zfs +zfs_use_ssh zfs +zfs_zpool_list zfs zfssa_auth_password zfssa zfssa_auth_user zfssa zfssa_data_ip zfssa @@ -298,7 +333,7 @@ zfssa_nas_vscan zfssa zfssa_pool zfssa zfssa_project zfssa zfssa_rest_timeout zfssa -zmq_use_broker zeromq +zmq_target_expire zeromq cors/allow_credentials cors cors/allow_headers cors cors/allow_methods cors @@ -380,9 +415,14 @@ keystone_authtoken/region_name auth_token keystone_authtoken/revocation_cache_time auth_token keystone_authtoken/signing_dir auth_token keystone_authtoken/token_cache_time auth_token +matchmaker_redis/check_timeout redis matchmaker_redis/host redis matchmaker_redis/password redis matchmaker_redis/port redis +matchmaker_redis/sentinel_group_name redis +matchmaker_redis/sentinel_hosts redis +matchmaker_redis/socket_timeout redis +matchmaker_redis/wait_timeout redis oslo_concurrency/disable_process_locking rpc oslo_concurrency/lock_path rpc oslo_messaging_amqp/allow_insecure_clients rpc @@ -401,44 +441,64 @@ oslo_messaging_amqp/ssl_key_file rpc oslo_messaging_amqp/ssl_key_password rpc oslo_messaging_amqp/trace rpc oslo_messaging_amqp/username rpc -oslo_messaging_qpid/amqp_auto_delete qpid -oslo_messaging_qpid/amqp_durable_queues qpid -oslo_messaging_qpid/qpid_heartbeat qpid -oslo_messaging_qpid/qpid_hostname qpid -oslo_messaging_qpid/qpid_hosts qpid -oslo_messaging_qpid/qpid_password qpid -oslo_messaging_qpid/qpid_port qpid -oslo_messaging_qpid/qpid_protocol qpid -oslo_messaging_qpid/qpid_receiver_capacity qpid -oslo_messaging_qpid/qpid_sasl_mechanisms qpid -oslo_messaging_qpid/qpid_tcp_nodelay qpid -oslo_messaging_qpid/qpid_topology_version qpid -oslo_messaging_qpid/qpid_username qpid -oslo_messaging_qpid/send_single_reply qpid +oslo_messaging_notifications/driver rpc +oslo_messaging_notifications/topics rpc +oslo_messaging_notifications/transport_url rpc oslo_messaging_rabbit/amqp_auto_delete rabbitmq oslo_messaging_rabbit/amqp_durable_queues rabbitmq +oslo_messaging_rabbit/channel_max rabbitmq +oslo_messaging_rabbit/default_notification_exchange rabbitmq +oslo_messaging_rabbit/default_notification_retry_attempts rabbitmq +oslo_messaging_rabbit/default_rpc_exchange rabbitmq +oslo_messaging_rabbit/default_rpc_retry_attempts rabbitmq oslo_messaging_rabbit/fake_rabbit rabbitmq +oslo_messaging_rabbit/frame_max rabbitmq +oslo_messaging_rabbit/heartbeat_interval rabbitmq oslo_messaging_rabbit/heartbeat_rate rabbitmq oslo_messaging_rabbit/heartbeat_timeout_threshold rabbitmq +oslo_messaging_rabbit/host_connection_reconnect_delay rabbitmq +oslo_messaging_rabbit/kombu_compression rabbitmq +oslo_messaging_rabbit/kombu_failover_strategy rabbitmq +oslo_messaging_rabbit/kombu_missing_consumer_retry_timeout rabbitmq oslo_messaging_rabbit/kombu_reconnect_delay rabbitmq -oslo_messaging_rabbit/kombu_reconnect_timeout rabbitmq oslo_messaging_rabbit/kombu_ssl_ca_certs rabbitmq oslo_messaging_rabbit/kombu_ssl_certfile rabbitmq oslo_messaging_rabbit/kombu_ssl_keyfile rabbitmq oslo_messaging_rabbit/kombu_ssl_version rabbitmq +oslo_messaging_rabbit/notification_listener_prefetch_count rabbitmq +oslo_messaging_rabbit/notification_persistence rabbitmq +oslo_messaging_rabbit/notification_retry_delay rabbitmq +oslo_messaging_rabbit/pool_max_overflow rabbitmq +oslo_messaging_rabbit/pool_max_size rabbitmq +oslo_messaging_rabbit/pool_recycle rabbitmq +oslo_messaging_rabbit/pool_stale rabbitmq +oslo_messaging_rabbit/pool_timeout rabbitmq oslo_messaging_rabbit/rabbit_ha_queues rabbitmq oslo_messaging_rabbit/rabbit_host rabbitmq oslo_messaging_rabbit/rabbit_hosts rabbitmq +oslo_messaging_rabbit/rabbit_interval_max rabbitmq oslo_messaging_rabbit/rabbit_login_method rabbitmq oslo_messaging_rabbit/rabbit_max_retries rabbitmq oslo_messaging_rabbit/rabbit_password rabbitmq oslo_messaging_rabbit/rabbit_port rabbitmq +oslo_messaging_rabbit/rabbit_qos_prefetch_count rabbitmq oslo_messaging_rabbit/rabbit_retry_backoff rabbitmq oslo_messaging_rabbit/rabbit_retry_interval rabbitmq +oslo_messaging_rabbit/rabbit_transient_queues_ttl rabbitmq oslo_messaging_rabbit/rabbit_use_ssl rabbitmq oslo_messaging_rabbit/rabbit_userid rabbitmq oslo_messaging_rabbit/rabbit_virtual_host rabbitmq -oslo_messaging_rabbit/send_single_reply rabbitmq +oslo_messaging_rabbit/rpc_listener_prefetch_count rabbitmq +oslo_messaging_rabbit/rpc_queue_expiration rabbitmq +oslo_messaging_rabbit/rpc_reply_exchange rabbitmq +oslo_messaging_rabbit/rpc_reply_listener_prefetch_count rabbitmq +oslo_messaging_rabbit/rpc_reply_retry_attempts rabbitmq +oslo_messaging_rabbit/rpc_reply_retry_delay rabbitmq +oslo_messaging_rabbit/rpc_retry_delay rabbitmq +oslo_messaging_rabbit/socket_timeout rabbitmq +oslo_messaging_rabbit/ssl rabbitmq +oslo_messaging_rabbit/ssl_options rabbitmq +oslo_messaging_rabbit/tcp_user_timeout rabbitmq oslo_middleware/max_request_body_size api oslo_middleware/secure_proxy_ssl_header api oslo_policy/policy_default_rule api diff --git a/tools/autogenerate-config-flagmappings/manila.headers b/tools/autogenerate-config-flagmappings/manila.headers index d85323bb5c..aa1ff4643f 100644 --- a/tools/autogenerate-config-flagmappings/manila.headers +++ b/tools/autogenerate-config-flagmappings/manila.headers @@ -3,6 +3,7 @@ api API auth Authorization auth_token Authorization Token ca Certificate Authority +cephfs CephFS Driver common Common compute Compute cors CORS @@ -16,6 +17,7 @@ hdfs HDFS Share Driver hds_hnas HDS NAS Share Driver hpe3par HPE 3PAR Share Driver huawei Huawei Share Driver +lvm LVM Share Driver logging Logging netapp NetApp Share Drivers qpid QPID @@ -27,6 +29,8 @@ rpc RPC san SAN scheduler Scheduler share Share +tegile Tegile Share Driver winrm WinRM zeromq ZeroMQ +zfs ZFS Share Driver zfssa ZFSSA Share Driver diff --git a/tools/autogenerate-config-flagmappings/neutron.flagmappings b/tools/autogenerate-config-flagmappings/neutron.flagmappings index e49093af33..b6525ec8f0 100644 --- a/tools/autogenerate-config-flagmappings/neutron.flagmappings +++ b/tools/autogenerate-config-flagmappings/neutron.flagmappings @@ -57,6 +57,7 @@ fatal_deprecations logging force_gateway_on_subnet common force_metadata dhcp_agent gateway_external_network_id l3_agent +global_physnet_mtu common ha_confs_path l3_agent ha_vrrp_advert_int l3_agent ha_vrrp_auth_password l3_agent @@ -199,6 +200,8 @@ AGENT/tunnel_types openvswitch_agent AGENT/use_helper_for_ns_read l3_agent AGENT/veth_mtu openvswitch_agent AGENT/vxlan_udp_port openvswitch_agent +BGP/bgp_router_id bgp +BGP/bgp_speaker_driver bgp LINUX_BRIDGE/bridge_mappings linuxbridge_agent LINUX_BRIDGE/physical_interface_mappings linuxbridge_agent OVS/bridge_mappings openvswitch_agent @@ -217,6 +220,8 @@ OVS/tun_peer_patch_port openvswitch_agent OVS/tunnel_bridge openvswitch_agent OVS/use_veth_interconnection openvswitch_agent OVS/vhostuser_socket_dir openvswitch_agent +QOS/kernel_hz qos +QOS/tbf_latency qos QUOTAS/default_quota quotas QUOTAS/quota_driver quotas QUOTAS/quota_firewall quotas @@ -244,6 +249,7 @@ SECURITYGROUP/enable_security_group securitygroups SECURITYGROUP/firewall_driver securitygroups SRIOV_NIC/exclude_devices sriov SRIOV_NIC/physical_device_mappings sriov +VXLAN/arp_responder linuxbridge_agent VXLAN/enable_vxlan linuxbridge_agent VXLAN/l2_population linuxbridge_agent VXLAN/local_ip linuxbridge_agent @@ -299,10 +305,8 @@ designate/ptr_zone_email designate designate/url designate fwaas/driver nec fwaas/enabled fwaas -haproxy/interface_driver lbaas_services haproxy/jinja_config_template lbaas_services haproxy/loadbalancer_state_path lbaas_agent -haproxy/periodic_interval lbaas_services haproxy/send_gratuitous_arp lbaas_agent haproxy/user_group lbaas_agent ipsec/config_base_dir vpnaas_ipsec @@ -347,6 +351,7 @@ keystone_authtoken/revocation_cache_time auth_token keystone_authtoken/signing_dir auth_token keystone_authtoken/token_cache_time auth_token l2pop/agent_boot_time ml2_l2pop +macvtap/physical_interface_mappings linuxbridge_agent matchmaker_redis/check_timeout redis matchmaker_redis/host redis matchmaker_redis/password redis @@ -360,7 +365,6 @@ ml2/external_network_type ml2 ml2/mechanism_drivers ml2 ml2/path_mtu ml2 ml2/physical_network_mtus ml2 -ml2/segment_mtu ml2 ml2/tenant_network_types ml2 ml2/type_drivers ml2 ml2_sriov/supported_pci_vendor_devs ml2_sriov @@ -415,14 +419,22 @@ oslo_messaging_amqp/ssl_key_file rpc oslo_messaging_amqp/ssl_key_password rpc oslo_messaging_amqp/trace rpc oslo_messaging_amqp/username rpc -oslo_messaging_notifications/driver amqp -oslo_messaging_notifications/topics amqp -oslo_messaging_notifications/transport_url amqp +oslo_messaging_notifications/driver rpc +oslo_messaging_notifications/topics rpc +oslo_messaging_notifications/transport_url rpc oslo_messaging_rabbit/amqp_auto_delete rabbitmq oslo_messaging_rabbit/amqp_durable_queues rabbitmq +oslo_messaging_rabbit/channel_max rabbitmq +oslo_messaging_rabbit/default_notification_exchange rabbitmq +oslo_messaging_rabbit/default_notification_retry_attempts rabbitmq +oslo_messaging_rabbit/default_rpc_exchange rabbitmq +oslo_messaging_rabbit/default_rpc_retry_attempts rabbitmq oslo_messaging_rabbit/fake_rabbit rabbitmq +oslo_messaging_rabbit/frame_max rabbitmq +oslo_messaging_rabbit/heartbeat_interval rabbitmq oslo_messaging_rabbit/heartbeat_rate rabbitmq oslo_messaging_rabbit/heartbeat_timeout_threshold rabbitmq +oslo_messaging_rabbit/host_connection_reconnect_delay rabbitmq oslo_messaging_rabbit/kombu_compression rabbitmq oslo_messaging_rabbit/kombu_failover_strategy rabbitmq oslo_messaging_rabbit/kombu_missing_consumer_retry_timeout rabbitmq @@ -431,6 +443,14 @@ oslo_messaging_rabbit/kombu_ssl_ca_certs rabbitmq oslo_messaging_rabbit/kombu_ssl_certfile rabbitmq oslo_messaging_rabbit/kombu_ssl_keyfile rabbitmq oslo_messaging_rabbit/kombu_ssl_version rabbitmq +oslo_messaging_rabbit/notification_listener_prefetch_count rabbitmq +oslo_messaging_rabbit/notification_persistence rabbitmq +oslo_messaging_rabbit/notification_retry_delay rabbitmq +oslo_messaging_rabbit/pool_max_overflow rabbitmq +oslo_messaging_rabbit/pool_max_size rabbitmq +oslo_messaging_rabbit/pool_recycle rabbitmq +oslo_messaging_rabbit/pool_stale rabbitmq +oslo_messaging_rabbit/pool_timeout rabbitmq oslo_messaging_rabbit/rabbit_ha_queues rabbitmq oslo_messaging_rabbit/rabbit_host rabbitmq oslo_messaging_rabbit/rabbit_hosts rabbitmq @@ -446,6 +466,17 @@ oslo_messaging_rabbit/rabbit_transient_queues_ttl rabbitmq oslo_messaging_rabbit/rabbit_use_ssl rabbitmq oslo_messaging_rabbit/rabbit_userid rabbitmq oslo_messaging_rabbit/rabbit_virtual_host rabbitmq +oslo_messaging_rabbit/rpc_listener_prefetch_count rabbitmq +oslo_messaging_rabbit/rpc_queue_expiration rabbitmq +oslo_messaging_rabbit/rpc_reply_exchange rabbitmq +oslo_messaging_rabbit/rpc_reply_listener_prefetch_count rabbitmq +oslo_messaging_rabbit/rpc_reply_retry_attempts rabbitmq +oslo_messaging_rabbit/rpc_reply_retry_delay rabbitmq +oslo_messaging_rabbit/rpc_retry_delay rabbitmq +oslo_messaging_rabbit/socket_timeout rabbitmq +oslo_messaging_rabbit/ssl rabbitmq +oslo_messaging_rabbit/ssl_options rabbitmq +oslo_messaging_rabbit/tcp_user_timeout rabbitmq oslo_middleware/max_request_body_size api oslo_middleware/secure_proxy_ssl_header api oslo_policy/policy_default_rule api diff --git a/tools/autogenerate-config-flagmappings/neutron.headers b/tools/autogenerate-config-flagmappings/neutron.headers index a56ba6b135..7d3a08e2c2 100644 --- a/tools/autogenerate-config-flagmappings/neutron.headers +++ b/tools/autogenerate-config-flagmappings/neutron.headers @@ -1,4 +1,5 @@ -bagpipe BaGpipe BGP +bagpipe BaGpipe BGP +bgp BGP bigswitch BigSwitch brocade Brocade brocade_vyatta_l3 Brocade Vyatta L3 plug-in @@ -56,12 +57,13 @@ nova nova nsx VMware NSX nuage Nuage nvsd NVSD driver -onos Open Networking Operating System (ONOS) +onos Open Networking Operating System (ONOS) opencontrail OpenContrail openvswitch_agent Open vSwitch agent -ovn Virtual Network for Open vSwitch +ovn Virtual Network for Open vSwitch pd_linux_agent IPv6 Prefix Delegation driver plumgrid PLUMgrid +qos QoS quotas quotas ryu RYU sdnve SDN-VE diff --git a/tools/autogenerate-config-flagmappings/nova.flagmappings b/tools/autogenerate-config-flagmappings/nova.flagmappings index 27b20532df..e097413811 100644 --- a/tools/autogenerate-config-flagmappings/nova.flagmappings +++ b/tools/autogenerate-config-flagmappings/nova.flagmappings @@ -316,6 +316,7 @@ use_cow_images hypervisor use_forwarded_for api use_ipv6 ipv6 use_network_dns_servers network +use_neutron network use_neutron_default_nets network use_project_ca ca use_pub_sub zeromq @@ -323,7 +324,6 @@ use_rootwrap_daemon common use_single_default_gateway network use_stderr logging use_syslog logging -use_syslog_rfc_format logging user_cert_subject ca vcpu_pin_set hypervisor vendordata_driver metadata @@ -406,6 +406,8 @@ cells/scheduler_retries scheduler cells/scheduler_retry_delay scheduler cells/scheduler_weight_classes scheduler cells/topic cells +certificates/barbican_auth barbican +certificates/cert_manager_type barbican cinder/cafile volumes cinder/catalog_info volumes cinder/certfile volumes @@ -634,6 +636,7 @@ osapi_v21/extensions_whitelist apiv21 osapi_v21/project_id_regex apiv21 oslo_concurrency/disable_process_locking rpc oslo_concurrency/lock_path rpc +oslo_messaging/event_stream_topic rpc oslo_messaging_amqp/allow_insecure_clients rpc oslo_messaging_amqp/broadcast_prefix rpc oslo_messaging_amqp/container_name rpc @@ -650,14 +653,22 @@ oslo_messaging_amqp/ssl_key_file rpc oslo_messaging_amqp/ssl_key_password rpc oslo_messaging_amqp/trace rpc oslo_messaging_amqp/username rpc -oslo_messaging_notifications/driver amqp -oslo_messaging_notifications/topics amqp -oslo_messaging_notifications/transport_url amqp +oslo_messaging_notifications/driver rpc +oslo_messaging_notifications/topics rpc +oslo_messaging_notifications/transport_url rpc oslo_messaging_rabbit/amqp_auto_delete rabbitmq oslo_messaging_rabbit/amqp_durable_queues rabbitmq +oslo_messaging_rabbit/channel_max rabbitmq +oslo_messaging_rabbit/default_notification_exchange rabbitmq +oslo_messaging_rabbit/default_notification_retry_attempts rabbitmq +oslo_messaging_rabbit/default_rpc_exchange rabbitmq +oslo_messaging_rabbit/default_rpc_retry_attempts rabbitmq oslo_messaging_rabbit/fake_rabbit rabbitmq +oslo_messaging_rabbit/frame_max rabbitmq +oslo_messaging_rabbit/heartbeat_interval rabbitmq oslo_messaging_rabbit/heartbeat_rate rabbitmq oslo_messaging_rabbit/heartbeat_timeout_threshold rabbitmq +oslo_messaging_rabbit/host_connection_reconnect_delay rabbitmq oslo_messaging_rabbit/kombu_compression rabbitmq oslo_messaging_rabbit/kombu_failover_strategy rabbitmq oslo_messaging_rabbit/kombu_missing_consumer_retry_timeout rabbitmq @@ -666,6 +677,14 @@ oslo_messaging_rabbit/kombu_ssl_ca_certs rabbitmq oslo_messaging_rabbit/kombu_ssl_certfile rabbitmq oslo_messaging_rabbit/kombu_ssl_keyfile rabbitmq oslo_messaging_rabbit/kombu_ssl_version rabbitmq +oslo_messaging_rabbit/notification_listener_prefetch_count rabbitmq +oslo_messaging_rabbit/notification_persistence rabbitmq +oslo_messaging_rabbit/notification_retry_delay rabbitmq +oslo_messaging_rabbit/pool_max_overflow rabbitmq +oslo_messaging_rabbit/pool_max_size rabbitmq +oslo_messaging_rabbit/pool_recycle rabbitmq +oslo_messaging_rabbit/pool_stale rabbitmq +oslo_messaging_rabbit/pool_timeout rabbitmq oslo_messaging_rabbit/rabbit_ha_queues rabbitmq oslo_messaging_rabbit/rabbit_host rabbitmq oslo_messaging_rabbit/rabbit_hosts rabbitmq @@ -681,6 +700,17 @@ oslo_messaging_rabbit/rabbit_transient_queues_ttl rabbitmq oslo_messaging_rabbit/rabbit_use_ssl rabbitmq oslo_messaging_rabbit/rabbit_userid rabbitmq oslo_messaging_rabbit/rabbit_virtual_host rabbitmq +oslo_messaging_rabbit/rpc_listener_prefetch_count rabbitmq +oslo_messaging_rabbit/rpc_queue_expiration rabbitmq +oslo_messaging_rabbit/rpc_reply_exchange rabbitmq +oslo_messaging_rabbit/rpc_reply_listener_prefetch_count rabbitmq +oslo_messaging_rabbit/rpc_reply_retry_attempts rabbitmq +oslo_messaging_rabbit/rpc_reply_retry_delay rabbitmq +oslo_messaging_rabbit/rpc_retry_delay rabbitmq +oslo_messaging_rabbit/socket_timeout rabbitmq +oslo_messaging_rabbit/ssl rabbitmq +oslo_messaging_rabbit/ssl_options rabbitmq +oslo_messaging_rabbit/tcp_user_timeout rabbitmq oslo_middleware/max_request_body_size api oslo_middleware/secure_proxy_ssl_header api oslo_policy/policy_default_rule policy @@ -696,6 +726,16 @@ serial_console/port_range serial_console serial_console/proxyclient_address serial_console serial_console/serialproxy_host serial_console serial_console/serialproxy_port serial_console +service_auth/admin_password api +service_auth/admin_project_domain api +service_auth/admin_tenant_name api +service_auth/admin_user api +service_auth/admin_user_domain api +service_auth/auth_url api +service_auth/auth_version api +service_auth/endpoint_type api +service_auth/region api +service_auth/service_name api spice/agent_enabled spice spice/enabled spice spice/html5proxy_base_url spice @@ -721,6 +761,10 @@ upgrade_levels/consoleauth upgrade_levels upgrade_levels/intercell upgrade_levels upgrade_levels/network upgrade_levels upgrade_levels/scheduler upgrade_levels +vArmour/director varmour +vArmour/director_port varmour +vArmour/password varmour +vArmour/username varmour vmware/api_retry_count vmware vmware/ca_file vmware vmware/cache_prefix vmware diff --git a/tools/autogenerate-config-flagmappings/nova.headers b/tools/autogenerate-config-flagmappings/nova.headers index 6c24813597..f3f6e7a7fb 100644 --- a/tools/autogenerate-config-flagmappings/nova.headers +++ b/tools/autogenerate-config-flagmappings/nova.headers @@ -22,6 +22,7 @@ serial_console serial console spice SPICE trustedcomputing trusted computing upgrade_levels upgrade levels +varmour vArmour vnc VNC volumes volumes xen Xen diff --git a/tools/autogenerate-config-flagmappings/sahara.flagmappings b/tools/autogenerate-config-flagmappings/sahara.flagmappings index 81e3e495f5..250b2a58bb 100644 --- a/tools/autogenerate-config-flagmappings/sahara.flagmappings +++ b/tools/autogenerate-config-flagmappings/sahara.flagmappings @@ -2,10 +2,10 @@ admin_project_domain_name common admin_user_domain_name common api_workers common cleanup_time_for_incomplete_clusters common -cluster_operation_trust_expiration_hours common cluster_remote_threshold common compute_topology_file common control_exchange amqp +coordinator_heartbeat_interval common db_driver database debug logging default_log_levels logging @@ -13,12 +13,12 @@ default_ntp_server common disable_event_log common enable_data_locality common enable_hypervisor_awareness common -enable_notifications common executor_thread_pool_size common fatal_deprecations logging global_remote_threshold common +hash_ring_replicas_count common +heat_enable_wait_condition common heat_stack_tags common -host redis infrastructure_engine common instance_format logging instance_uuid_format logging @@ -29,7 +29,6 @@ log_config_append logging log_date_format logging log_dir logging log_file logging -log_format logging logging_context_format_string logging logging_debug_format_suffix logging logging_default_format_string logging @@ -38,18 +37,13 @@ logging_user_identity_format logging memcached_servers common min_transient_cluster_active_time common node_domain common -notification_driver amqp -notification_level amqp -notification_publisher_id amqp -notification_topics amqp -notification_transport_url amqp os_region_name common -password redis +periodic_coordinator_backend_url common periodic_enable common periodic_fuzzy_delay common periodic_interval_max common +periodic_workers_number common plugins common -port redis proxy_command common proxy_user_domain_name domain proxy_user_role_names domain @@ -61,7 +55,6 @@ rpc_cast_timeout rpc rpc_conn_pool_size rpc rpc_poll_timeout rpc rpc_response_timeout rpc -rpc_zmq_all_req_rep zeromq rpc_zmq_bind_address zeromq rpc_zmq_bind_port_retries zeromq rpc_zmq_concurrency zeromq @@ -78,23 +71,29 @@ ssh_timeout_interactive ssh swift_topology_file common syslog_log_facility logging transport_url amqp +use_barbican_key_manager common use_domain_for_proxy_users domain -use_external_key_manager common use_floating_ips common use_identity_api_v3 common use_namespaces common use_neutron common +use_pub_sub zeromq use_rootwrap common use_stderr logging use_syslog logging -use_syslog_rfc_format logging verbose logging watch_log_file logging -zmq_use_broker zeromq +zmq_target_expire zeromq +castellan/barbican_api_endpoint common +castellan/barbican_api_version common +certificates/barbican_auth common +certificates/cert_manager_type common cinder/api_insecure clients cinder/api_version clients cinder/ca_file clients cinder/endpoint_type clients +cluster_verifications/verification_enable common +cluster_verifications/verification_periodic_interval common conductor/use_local common cors/allow_credentials cors cors/allow_headers cors @@ -140,10 +139,10 @@ keystone_authtoken/admin_token auth_token keystone_authtoken/admin_user auth_token keystone_authtoken/auth_admin_prefix auth_token keystone_authtoken/auth_host auth_token -keystone_authtoken/auth_plugin auth_token keystone_authtoken/auth_port auth_token keystone_authtoken/auth_protocol auth_token keystone_authtoken/auth_section auth_token +keystone_authtoken/auth_type auth_token keystone_authtoken/auth_uri auth_token keystone_authtoken/auth_version auth_token keystone_authtoken/cache auth_token @@ -175,9 +174,14 @@ keystone_authtoken/token_cache_time auth_token manila/api_insecure clients manila/api_version clients manila/ca_file clients +matchmaker_redis/check_timeout redis matchmaker_redis/host redis matchmaker_redis/password redis matchmaker_redis/port redis +matchmaker_redis/sentinel_group_name redis +matchmaker_redis/sentinel_hosts redis +matchmaker_redis/socket_timeout redis +matchmaker_redis/wait_timeout redis neutron/api_insecure clients neutron/ca_file clients neutron/endpoint_type clients @@ -188,6 +192,7 @@ object_store_access/public_identity_ca_file object_store_access object_store_access/public_object_store_ca_file object_store_access oslo_concurrency/disable_process_locking rpc oslo_concurrency/lock_path rpc +oslo_messaging/event_stream_topic rpc oslo_messaging_amqp/allow_insecure_clients rpc oslo_messaging_amqp/broadcast_prefix rpc oslo_messaging_amqp/container_name rpc @@ -204,44 +209,67 @@ oslo_messaging_amqp/ssl_key_file rpc oslo_messaging_amqp/ssl_key_password rpc oslo_messaging_amqp/trace rpc oslo_messaging_amqp/username rpc -oslo_messaging_qpid/amqp_auto_delete qpid -oslo_messaging_qpid/amqp_durable_queues qpid -oslo_messaging_qpid/qpid_heartbeat qpid -oslo_messaging_qpid/qpid_hostname qpid -oslo_messaging_qpid/qpid_hosts qpid -oslo_messaging_qpid/qpid_password qpid -oslo_messaging_qpid/qpid_port qpid -oslo_messaging_qpid/qpid_protocol qpid -oslo_messaging_qpid/qpid_receiver_capacity qpid -oslo_messaging_qpid/qpid_sasl_mechanisms qpid -oslo_messaging_qpid/qpid_tcp_nodelay qpid -oslo_messaging_qpid/qpid_topology_version qpid -oslo_messaging_qpid/qpid_username qpid -oslo_messaging_qpid/send_single_reply qpid +oslo_messaging_notifications/driver rpc +oslo_messaging_notifications/enable rpc +oslo_messaging_notifications/level rpc +oslo_messaging_notifications/publisher_id rpc +oslo_messaging_notifications/topics rpc +oslo_messaging_notifications/transport_url rpc oslo_messaging_rabbit/amqp_auto_delete rabbitmq oslo_messaging_rabbit/amqp_durable_queues rabbitmq +oslo_messaging_rabbit/channel_max rabbitmq +oslo_messaging_rabbit/default_notification_exchange rabbitmq +oslo_messaging_rabbit/default_notification_retry_attempts rabbitmq +oslo_messaging_rabbit/default_rpc_exchange rabbitmq +oslo_messaging_rabbit/default_rpc_retry_attempts rabbitmq oslo_messaging_rabbit/fake_rabbit rabbitmq +oslo_messaging_rabbit/frame_max rabbitmq +oslo_messaging_rabbit/heartbeat_interval rabbitmq oslo_messaging_rabbit/heartbeat_rate rabbitmq oslo_messaging_rabbit/heartbeat_timeout_threshold rabbitmq +oslo_messaging_rabbit/host_connection_reconnect_delay rabbitmq +oslo_messaging_rabbit/kombu_compression rabbitmq +oslo_messaging_rabbit/kombu_failover_strategy rabbitmq +oslo_messaging_rabbit/kombu_missing_consumer_retry_timeout rabbitmq oslo_messaging_rabbit/kombu_reconnect_delay rabbitmq -oslo_messaging_rabbit/kombu_reconnect_timeout rabbitmq oslo_messaging_rabbit/kombu_ssl_ca_certs rabbitmq oslo_messaging_rabbit/kombu_ssl_certfile rabbitmq oslo_messaging_rabbit/kombu_ssl_keyfile rabbitmq oslo_messaging_rabbit/kombu_ssl_version rabbitmq +oslo_messaging_rabbit/notification_listener_prefetch_count rabbitmq +oslo_messaging_rabbit/notification_persistence rabbitmq +oslo_messaging_rabbit/notification_retry_delay rabbitmq +oslo_messaging_rabbit/pool_max_overflow rabbitmq +oslo_messaging_rabbit/pool_max_size rabbitmq +oslo_messaging_rabbit/pool_recycle rabbitmq +oslo_messaging_rabbit/pool_stale rabbitmq +oslo_messaging_rabbit/pool_timeout rabbitmq oslo_messaging_rabbit/rabbit_ha_queues rabbitmq oslo_messaging_rabbit/rabbit_host rabbitmq oslo_messaging_rabbit/rabbit_hosts rabbitmq +oslo_messaging_rabbit/rabbit_interval_max rabbitmq oslo_messaging_rabbit/rabbit_login_method rabbitmq oslo_messaging_rabbit/rabbit_max_retries rabbitmq oslo_messaging_rabbit/rabbit_password rabbitmq oslo_messaging_rabbit/rabbit_port rabbitmq +oslo_messaging_rabbit/rabbit_qos_prefetch_count rabbitmq oslo_messaging_rabbit/rabbit_retry_backoff rabbitmq oslo_messaging_rabbit/rabbit_retry_interval rabbitmq +oslo_messaging_rabbit/rabbit_transient_queues_ttl rabbitmq oslo_messaging_rabbit/rabbit_use_ssl rabbitmq oslo_messaging_rabbit/rabbit_userid rabbitmq oslo_messaging_rabbit/rabbit_virtual_host rabbitmq -oslo_messaging_rabbit/send_single_reply rabbitmq +oslo_messaging_rabbit/rpc_listener_prefetch_count rabbitmq +oslo_messaging_rabbit/rpc_queue_expiration rabbitmq +oslo_messaging_rabbit/rpc_reply_exchange rabbitmq +oslo_messaging_rabbit/rpc_reply_listener_prefetch_count rabbitmq +oslo_messaging_rabbit/rpc_reply_retry_attempts rabbitmq +oslo_messaging_rabbit/rpc_reply_retry_delay rabbitmq +oslo_messaging_rabbit/rpc_retry_delay rabbitmq +oslo_messaging_rabbit/socket_timeout rabbitmq +oslo_messaging_rabbit/ssl rabbitmq +oslo_messaging_rabbit/ssl_options rabbitmq +oslo_messaging_rabbit/tcp_user_timeout rabbitmq oslo_middleware/max_request_body_size api oslo_middleware/secure_proxy_ssl_header api oslo_policy/policy_default_rule policy @@ -249,13 +277,24 @@ oslo_policy/policy_dirs policy oslo_policy/policy_file policy retries/retries_number api retries/retry_after api +service_auth/admin_password api +service_auth/admin_project_domain api +service_auth/admin_tenant_name api +service_auth/admin_user api +service_auth/admin_user_domain api +service_auth/auth_url api +service_auth/auth_version api +service_auth/endpoint_type api +service_auth/region api +service_auth/service_name api swift/api_insecure clients swift/ca_file clients swift/endpoint_type clients -timeouts/await_attach_volumes timeouts -timeouts/await_for_instances_active timeouts timeouts/delete_instances_timeout timeouts timeouts/detach_volume_timeout timeouts timeouts/ips_assign_timeout timeouts -timeouts/volume_available_timeout timeouts timeouts/wait_until_accessible timeouts +vArmour/director varmour +vArmour/director_port varmour +vArmour/password varmour +vArmour/username varmour diff --git a/tools/autogenerate-config-flagmappings/sahara.headers b/tools/autogenerate-config-flagmappings/sahara.headers index e65654571c..8cda3e9124 100644 --- a/tools/autogenerate-config-flagmappings/sahara.headers +++ b/tools/autogenerate-config-flagmappings/sahara.headers @@ -1,3 +1,4 @@ domain domain object_store_access Auth options for Swift access for VM ssh SSH +varmour vArmour diff --git a/tools/autogenerate-config-flagmappings/trove.flagmappings b/tools/autogenerate-config-flagmappings/trove.flagmappings index 093fef1785..7d27653e5a 100644 --- a/tools/autogenerate-config-flagmappings/trove.flagmappings +++ b/tools/autogenerate-config-flagmappings/trove.flagmappings @@ -66,6 +66,9 @@ format_options logging guest_config guestagent guest_id guestagent guest_info guestagent +guest_log_container_name guestagent +guest_log_expiry guestagent +guest_log_limit guestagent heat_endpoint_type heat heat_service_type heat heat_time_out heat @@ -86,7 +89,6 @@ log_config_append logging log_date_format logging log_dir logging log_file logging -log_format logging logging_context_format_string logging logging_debug_format_suffix logging logging_default_format_string logging @@ -98,16 +100,16 @@ max_header_line api max_instances_per_tenant quota max_volumes_per_tenant quota memcached_servers common +module_aes_cbc_key common +module_types common +modules_page_size common mount_options guestagent network_driver network network_label_regex logging neutron_endpoint_type network neutron_service_type network neutron_url network -notification_driver amqp notification_service_id amqp -notification_topics amqp -notification_transport_url amqp nova_client_version compute nova_compute_endpoint_type compute nova_compute_service_type compute @@ -118,8 +120,6 @@ nova_proxy_admin_tenant_name nova nova_proxy_admin_user nova num_tries rpc os_region_name api -password redis -port redis publish_errors logging pybasedir common pydev_debug debug @@ -127,6 +127,7 @@ pydev_debug_host debug pydev_debug_port debug pydev_path common quota_driver quota +quota_notification_interval common reboot_time_out taskmanager region api remote_cinder_client clients @@ -147,7 +148,6 @@ rpc_cast_timeout rpc rpc_conn_pool_size rpc rpc_poll_timeout rpc rpc_response_timeout rpc -rpc_zmq_all_req_rep zeromq rpc_zmq_bind_address zeromq rpc_zmq_bind_port_retries zeromq rpc_zmq_concurrency zeromq @@ -187,9 +187,9 @@ usage_timeout common use_heat taskmanager use_nova_server_config_drive taskmanager use_nova_server_volume taskmanager +use_pub_sub zeromq use_stderr logging use_syslog logging -use_syslog_rfc_format logging users_page_size api verbose logging verify_swift_checksum_on_restore taskmanager @@ -197,18 +197,27 @@ volume_format_timeout volume volume_fstype volume volume_time_out volume watch_log_file logging -zmq_use_broker zeromq +zmq_target_expire zeromq +cassandra/api_strategy db_cassandra cassandra/backup_incremental_strategy db_cassandra cassandra/backup_namespace db_cassandra cassandra/backup_strategy db_cassandra +cassandra/cluster_support db_cassandra cassandra/device_path db_cassandra +cassandra/guest_log_exposed_logs db_cassandra +cassandra/guestagent_strategy db_cassandra +cassandra/ignore_dbs db_cassandra +cassandra/ignore_users db_cassandra cassandra/mount_point db_cassandra cassandra/replication_strategy db_cassandra cassandra/restore_namespace db_cassandra cassandra/root_controller db_cassandra +cassandra/taskmanager_strategy db_cassandra cassandra/tcp_ports db_cassandra cassandra/udp_ports db_cassandra cassandra/volume_support db_cassandra +certificates/barbican_auth common +certificates/cert_manager_type common cors/allow_credentials cors cors/allow_headers cors cors/allow_methods cors @@ -225,6 +234,7 @@ couchbase/backup_incremental_strategy db_couchbase couchbase/backup_namespace db_couchbase couchbase/backup_strategy db_couchbase couchbase/device_path db_couchbase +couchbase/guest_log_exposed_logs db_couchbase couchbase/mount_point db_couchbase couchbase/replication_strategy db_couchbase couchbase/restore_namespace db_couchbase @@ -233,25 +243,47 @@ couchbase/root_on_create db_couchbase couchbase/tcp_ports db_couchbase couchbase/udp_ports db_couchbase couchbase/volume_support db_couchbase -couchdb/backup_incremental_strategy db_couchbase -couchdb/backup_namespace db_couchbase -couchdb/backup_strategy db_couchbase -couchdb/device_path db_couchbase -couchdb/mount_point db_couchbase -couchdb/replication_strategy db_couchbase -couchdb/restore_namespace db_couchbase -couchdb/root_controller db_couchbase -couchdb/root_on_create db_couchbase -couchdb/tcp_ports db_couchbase -couchdb/udp_ports db_couchbase +couchdb/backup_incremental_strategy db_couchdb +couchdb/backup_namespace db_couchdb +couchdb/backup_strategy db_couchdb +couchdb/device_path db_couchdb +couchdb/guest_log_exposed_logs db_couchdb +couchdb/ignore_dbs db_couchdb +couchdb/ignore_users db_couchdb +couchdb/mount_point db_couchdb +couchdb/replication_strategy db_couchdb +couchdb/restore_namespace db_couchdb +couchdb/root_controller db_couchdb +couchdb/root_on_create db_couchdb +couchdb/tcp_ports db_couchdb +couchdb/udp_ports db_couchdb couchdb/volume_support db_couchbase +database/backend database database/connection database +database/connection_debug database +database/connection_trace database +database/db_inc_retry_interval database +database/db_max_retries database +database/db_max_retry_interval database +database/db_retry_interval database database/idle_timeout database +database/max_overflow database +database/max_pool_size database +database/max_retries database +database/min_pool_size database +database/mysql_sql_mode database +database/pool_timeout database database/query_log database +database/retry_interval database +database/slave_connection database +database/sqlite_db database +database/sqlite_synchronous database +database/use_db_reconnect database db2/backup_incremental_strategy db_db2 db2/backup_namespace db_db2 db2/backup_strategy db_db2 db2/device_path db_db2 +db2/guest_log_exposed_logs db_db2 db2/ignore_users db_db2 db2/mount_point db_db2 db2/replication_strategy db_db2 @@ -267,10 +299,10 @@ keystone_authtoken/admin_token auth_token keystone_authtoken/admin_user auth_token keystone_authtoken/auth_admin_prefix auth_token keystone_authtoken/auth_host auth_token -keystone_authtoken/auth_plugin auth_token keystone_authtoken/auth_port auth_token keystone_authtoken/auth_protocol auth_token keystone_authtoken/auth_section auth_token +keystone_authtoken/auth_type auth_token keystone_authtoken/auth_uri auth_token keystone_authtoken/auth_version auth_token keystone_authtoken/cache auth_token @@ -299,33 +331,47 @@ keystone_authtoken/region_name auth_token keystone_authtoken/revocation_cache_time auth_token keystone_authtoken/signing_dir auth_token keystone_authtoken/token_cache_time auth_token +mariadb/api_strategy db_mariadb mariadb/backup_incremental_strategy db_mariadb mariadb/backup_namespace db_mariadb mariadb/backup_strategy db_mariadb +mariadb/cluster_support db_mariadb mariadb/device_path db_mariadb +mariadb/guest_log_exposed_logs db_mariadb +mariadb/guest_log_long_query_time db_mariadb +mariadb/guestagent_strategy db_mariadb mariadb/ignore_dbs db_mariadb mariadb/ignore_users db_mariadb +mariadb/min_cluster_member_count db_mariadb mariadb/mount_point db_mariadb mariadb/replication_namespace db_mariadb mariadb/replication_strategy db_mariadb mariadb/restore_namespace db_mariadb mariadb/root_controller db_mariadb mariadb/root_on_create db_mariadb +mariadb/taskmanager_strategy db_mariadb mariadb/tcp_ports db_mariadb mariadb/udp_ports db_mariadb mariadb/usage_timeout db_mariadb mariadb/volume_support db_mariadb +matchmaker_redis/check_timeout redis matchmaker_redis/host redis matchmaker_redis/password redis matchmaker_redis/port redis +matchmaker_redis/sentinel_group_name redis +matchmaker_redis/sentinel_hosts redis +matchmaker_redis/socket_timeout redis +matchmaker_redis/wait_timeout redis mongodb/add_members_timeout db_mongodb mongodb/api_strategy db_mongodb mongodb/backup_incremental_strategy db_mongodb mongodb/backup_namespace db_mongodb mongodb/backup_strategy db_mongodb +mongodb/cluster_secure db_mongodb mongodb/cluster_support db_mongodb mongodb/configsvr_port db_mongodb mongodb/device_path db_mongodb +mongodb/guest_log_exposed_logs db_mongodb mongodb/guestagent_strategy db_mongodb mongodb/ignore_dbs db_mongodb mongodb/ignore_users db_mongodb @@ -344,6 +390,8 @@ mysql/backup_incremental_strategy db_mysql mysql/backup_namespace db_mysql mysql/backup_strategy db_mysql mysql/device_path db_mysql +mysql/guest_log_exposed_logs db_mysql +mysql/guest_log_long_query_time db_mysql mysql/ignore_dbs db_mysql mysql/ignore_users db_mysql mysql/mount_point db_mysql @@ -358,6 +406,7 @@ mysql/usage_timeout db_mysql mysql/volume_support db_mysql oslo_concurrency/disable_process_locking rpc oslo_concurrency/lock_path rpc +oslo_messaging/event_stream_topic rpc oslo_messaging_amqp/allow_insecure_clients rpc oslo_messaging_amqp/broadcast_prefix rpc oslo_messaging_amqp/container_name rpc @@ -374,50 +423,72 @@ oslo_messaging_amqp/ssl_key_file rpc oslo_messaging_amqp/ssl_key_password rpc oslo_messaging_amqp/trace rpc oslo_messaging_amqp/username rpc -oslo_messaging_qpid/amqp_auto_delete qpid -oslo_messaging_qpid/amqp_durable_queues qpid -oslo_messaging_qpid/qpid_heartbeat qpid -oslo_messaging_qpid/qpid_hostname qpid -oslo_messaging_qpid/qpid_hosts qpid -oslo_messaging_qpid/qpid_password qpid -oslo_messaging_qpid/qpid_port qpid -oslo_messaging_qpid/qpid_protocol qpid -oslo_messaging_qpid/qpid_receiver_capacity qpid -oslo_messaging_qpid/qpid_sasl_mechanisms qpid -oslo_messaging_qpid/qpid_tcp_nodelay qpid -oslo_messaging_qpid/qpid_topology_version qpid -oslo_messaging_qpid/qpid_username qpid -oslo_messaging_qpid/send_single_reply qpid +oslo_messaging_notifications/driver rpc +oslo_messaging_notifications/topics rpc +oslo_messaging_notifications/transport_url rpc oslo_messaging_rabbit/amqp_auto_delete rabbitmq oslo_messaging_rabbit/amqp_durable_queues rabbitmq +oslo_messaging_rabbit/channel_max rabbitmq +oslo_messaging_rabbit/default_notification_exchange rabbitmq +oslo_messaging_rabbit/default_notification_retry_attempts rabbitmq +oslo_messaging_rabbit/default_rpc_exchange rabbitmq +oslo_messaging_rabbit/default_rpc_retry_attempts rabbitmq oslo_messaging_rabbit/fake_rabbit rabbitmq +oslo_messaging_rabbit/frame_max rabbitmq +oslo_messaging_rabbit/heartbeat_interval rabbitmq oslo_messaging_rabbit/heartbeat_rate rabbitmq oslo_messaging_rabbit/heartbeat_timeout_threshold rabbitmq +oslo_messaging_rabbit/host_connection_reconnect_delay rabbitmq +oslo_messaging_rabbit/kombu_compression rabbitmq +oslo_messaging_rabbit/kombu_failover_strategy rabbitmq +oslo_messaging_rabbit/kombu_missing_consumer_retry_timeout rabbitmq oslo_messaging_rabbit/kombu_reconnect_delay rabbitmq -oslo_messaging_rabbit/kombu_reconnect_timeout rabbitmq oslo_messaging_rabbit/kombu_ssl_ca_certs rabbitmq oslo_messaging_rabbit/kombu_ssl_certfile rabbitmq oslo_messaging_rabbit/kombu_ssl_keyfile rabbitmq oslo_messaging_rabbit/kombu_ssl_version rabbitmq +oslo_messaging_rabbit/notification_listener_prefetch_count rabbitmq +oslo_messaging_rabbit/notification_persistence rabbitmq +oslo_messaging_rabbit/notification_retry_delay rabbitmq +oslo_messaging_rabbit/pool_max_overflow rabbitmq +oslo_messaging_rabbit/pool_max_size rabbitmq +oslo_messaging_rabbit/pool_recycle rabbitmq +oslo_messaging_rabbit/pool_stale rabbitmq +oslo_messaging_rabbit/pool_timeout rabbitmq oslo_messaging_rabbit/rabbit_ha_queues rabbitmq oslo_messaging_rabbit/rabbit_host rabbitmq oslo_messaging_rabbit/rabbit_hosts rabbitmq +oslo_messaging_rabbit/rabbit_interval_max rabbitmq oslo_messaging_rabbit/rabbit_login_method rabbitmq oslo_messaging_rabbit/rabbit_max_retries rabbitmq oslo_messaging_rabbit/rabbit_password rabbitmq oslo_messaging_rabbit/rabbit_port rabbitmq +oslo_messaging_rabbit/rabbit_qos_prefetch_count rabbitmq oslo_messaging_rabbit/rabbit_retry_backoff rabbitmq oslo_messaging_rabbit/rabbit_retry_interval rabbitmq +oslo_messaging_rabbit/rabbit_transient_queues_ttl rabbitmq oslo_messaging_rabbit/rabbit_use_ssl rabbitmq oslo_messaging_rabbit/rabbit_userid rabbitmq oslo_messaging_rabbit/rabbit_virtual_host rabbitmq -oslo_messaging_rabbit/send_single_reply rabbitmq +oslo_messaging_rabbit/rpc_listener_prefetch_count rabbitmq +oslo_messaging_rabbit/rpc_queue_expiration rabbitmq +oslo_messaging_rabbit/rpc_reply_exchange rabbitmq +oslo_messaging_rabbit/rpc_reply_listener_prefetch_count rabbitmq +oslo_messaging_rabbit/rpc_reply_retry_attempts rabbitmq +oslo_messaging_rabbit/rpc_reply_retry_delay rabbitmq +oslo_messaging_rabbit/rpc_retry_delay rabbitmq +oslo_messaging_rabbit/socket_timeout rabbitmq +oslo_messaging_rabbit/ssl rabbitmq +oslo_messaging_rabbit/ssl_options rabbitmq +oslo_messaging_rabbit/tcp_user_timeout rabbitmq oslo_middleware/max_request_body_size api oslo_middleware/secure_proxy_ssl_header api percona/backup_incremental_strategy db_percona percona/backup_namespace db_percona percona/backup_strategy db_percona percona/device_path db_percona +percona/guest_log_exposed_logs db_percona +percona/guest_log_long_query_time db_percona percona/ignore_dbs db_percona percona/ignore_users db_percona percona/mount_point db_percona @@ -436,9 +507,12 @@ postgresql/backup_incremental_strategy db_postgresql postgresql/backup_namespace db_postgresql postgresql/backup_strategy db_postgresql postgresql/device_path db_postgresql +postgresql/guest_log_exposed_logs db_postgresql +postgresql/guest_log_long_query_time db_postgresql postgresql/ignore_dbs db_postgresql postgresql/ignore_users db_postgresql postgresql/mount_point db_postgresql +postgresql/postgresql_port db_postgresql postgresql/restore_namespace db_postgresql postgresql/root_controller db_postgresql postgresql/root_on_create db_postgresql @@ -446,6 +520,7 @@ postgresql/tcp_ports db_postgresql postgresql/udp_ports db_postgresql postgresql/volume_support db_postgresql profiler/enabled debug +profiler/hmac_keys debug profiler/trace_sqlalchemy debug pxc/api_strategy db_pxc pxc/backup_incremental_strategy db_pxc @@ -453,6 +528,8 @@ pxc/backup_namespace db_pxc pxc/backup_strategy db_pxc pxc/cluster_support db_pxc pxc/device_path db_pxc +pxc/guest_log_exposed_logs db_pxc +pxc/guest_log_long_query_time db_pxc pxc/guestagent_strategy db_pxc pxc/ignore_dbs db_pxc pxc/ignore_users db_pxc @@ -475,6 +552,7 @@ redis/backup_namespace db_redis redis/backup_strategy db_redis redis/cluster_support db_redis redis/device_path db_redis +redis/guest_log_exposed_logs db_redis redis/guestagent_strategy db_redis redis/mount_point db_redis redis/replication_namespace db_redis @@ -485,9 +563,23 @@ redis/taskmanager_strategy db_redis redis/tcp_ports db_redis redis/udp_ports db_redis redis/volume_support db_redis +service_auth/admin_password common +service_auth/admin_project_domain common +service_auth/admin_tenant_name common +service_auth/admin_user common +service_auth/admin_user_domain common +service_auth/auth_url common +service_auth/auth_version common +service_auth/endpoint_type common +service_auth/region common +service_auth/service_name common upgrade_levels/conductor upgrades upgrade_levels/guestagent upgrades upgrade_levels/taskmanager upgrades +vArmour/director varmour +vArmour/director_port varmour +vArmour/password varmour +vArmour/username varmour vertica/api_strategy db_vertica vertica/backup_incremental_strategy db_vertica vertica/backup_namespace db_vertica @@ -495,7 +587,9 @@ vertica/backup_strategy db_vertica vertica/cluster_member_count db_vertica vertica/cluster_support db_vertica vertica/device_path db_vertica +vertica/guest_log_exposed_logs db_vertica vertica/guestagent_strategy db_vertica +vertica/min_ksafety db_vertica vertica/mount_point db_vertica vertica/readahead_size db_vertica vertica/replication_strategy db_vertica diff --git a/tools/autogenerate-config-flagmappings/trove.headers b/tools/autogenerate-config-flagmappings/trove.headers index d1cce57aca..ea9d97cbfe 100644 --- a/tools/autogenerate-config-flagmappings/trove.headers +++ b/tools/autogenerate-config-flagmappings/trove.headers @@ -16,4 +16,5 @@ guestagent guest agent heat Orchestration module nova nova taskmanager taskmanager +varmour vArmour volume volume diff --git a/tools/autogenerate-config-flagmappings/zaqar.flagmappings b/tools/autogenerate-config-flagmappings/zaqar.flagmappings index 460ac9d373..adc3275d85 100644 --- a/tools/autogenerate-config-flagmappings/zaqar.flagmappings +++ b/tools/autogenerate-config-flagmappings/zaqar.flagmappings @@ -10,19 +10,18 @@ log_config_append logging log_date_format logging log_dir logging log_file logging -log_format logging logging_context_format_string logging logging_debug_format_suffix logging logging_default_format_string logging logging_exception_prefix logging logging_user_identity_format logging +memcached_servers cache pooling pooling publish_errors logging syslog_log_facility logging unreliable api use_stderr logging use_syslog logging -use_syslog_rfc_format logging verbose logging watch_log_file logging cache/backend cache @@ -127,6 +126,7 @@ storage/subscription_pipeline storage transport/default_claim_grace transport transport/default_claim_ttl transport transport/default_message_ttl transport +transport/default_subscription_ttl transport transport/max_claim_grace transport transport/max_claim_ttl transport transport/max_message_ttl transport