RST tables: workaround problem with empty values

See https://review.openstack.org/#/c/246766/ for the os-doc-tools patch.

Without a workaround of this type, sphinx generates warnings (and errors
in our setup) because of lines not ending as expected.

Change-Id: Ica62ee532745aa21774460b30bea2c4c603388cd
This commit is contained in:
Gauvain Pocentek 2015-11-18 07:34:14 +01:00
parent 89acc8152c
commit c79f39591b
136 changed files with 365 additions and 365 deletions

View File

@ -32,7 +32,7 @@
- (StrOpt) The user project name
* - ``os_region_name`` = ``None``
- (StrOpt) Region name to use for OpenStack service endpoints.
* - ``os_tenant_id`` = ````
* - ``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.

View File

@ -24,7 +24,7 @@
- (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.
* - ``admin_user`` = ``None``
- (StrOpt) Service username.
* - ``auth_admin_prefix`` = ````
* - ``auth_admin_prefix`` = `` ``
- (StrOpt) 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.

View File

@ -36,7 +36,7 @@
- (ListOpt) Memcached servers or None for in process cache.
* - ``notifier_rpc_topic`` = ``alarm_notifier``
- (StrOpt) The topic that aodh uses for alarm notifier messages.
* - ``password`` = ````
* - ``password`` = `` ``
- (StrOpt) Password for Redis server (optional).
* - ``port`` = ``6379``
- (IntOpt) Use this port to connect to redis host.
@ -44,9 +44,9 @@
- (IntOpt) Maximum number of alarms defined for a project.
* - ``record_history`` = ``True``
- (BoolOpt) Record alarm change events.
* - ``rest_notifier_certificate_file`` = ````
* - ``rest_notifier_certificate_file`` = `` ``
- (StrOpt) SSL Client certificate for REST notifier.
* - ``rest_notifier_certificate_key`` = ````
* - ``rest_notifier_certificate_key`` = `` ``
- (StrOpt) SSL Client private key for REST notifier.
* - ``rest_notifier_max_retries`` = ``0``
- (IntOpt) Number of retries for REST notifier

View File

@ -26,7 +26,7 @@
- (StrOpt) Qpid broker hostname.
* - ``qpid_hosts`` = ``$qpid_hostname:$qpid_port``
- (ListOpt) Qpid HA cluster host:port pairs.
* - ``qpid_password`` = ````
* - ``qpid_password`` = `` ``
- (StrOpt) Password for Qpid connection.
* - ``qpid_port`` = ``5672``
- (IntOpt) Qpid broker port.
@ -34,13 +34,13 @@
- (StrOpt) Transport to use, either 'tcp' or 'ssl'.
* - ``qpid_receiver_capacity`` = ``1``
- (IntOpt) The number of prefetched messages held by receiver.
* - ``qpid_sasl_mechanisms`` = ````
* - ``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`` = ````
* - ``qpid_username`` = `` ``
- (StrOpt) Username for Qpid connection.
* - ``send_single_reply`` = ``False``
- (BoolOpt) Send a single AMQP reply to call message. The current behaviour since oslo-incubator is to send two AMQP replies - first one with the payload, a second one to ensure the other have finish to send the payload. We are going to remove it in the N release, but we must keep backward compatible at the same time. This option provides such compatibility - it defaults to False in Liberty and can be turned on for early adopters with a new installations or for testing. Please note, that this option will be removed in the Mitaka release.

View File

@ -30,13 +30,13 @@
- (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.
* - ``kombu_ssl_ca_certs`` = ````
* - ``kombu_ssl_ca_certs`` = `` ``
- (StrOpt) SSL certification authority file (valid only if SSL enabled).
* - ``kombu_ssl_certfile`` = ````
* - ``kombu_ssl_certfile`` = `` ``
- (StrOpt) SSL cert file (valid only if SSL enabled).
* - ``kombu_ssl_keyfile`` = ````
* - ``kombu_ssl_keyfile`` = `` ``
- (StrOpt) SSL key file (valid only if SSL enabled).
* - ``kombu_ssl_version`` = ````
* - ``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.
* - ``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.

View File

@ -18,7 +18,7 @@
-
* - ``host`` = ``127.0.0.1``
- (StrOpt) Host to locate redis.
* - ``password`` = ````
* - ``password`` = `` ``
- (StrOpt) Password for Redis server (optional).
* - ``port`` = ``6379``
- (IntOpt) Use this port to connect to redis host.

View File

@ -38,25 +38,25 @@
- (StrOpt) address prefix when sending to any server in group
* - ``idle_timeout`` = ``0``
- (IntOpt) Timeout for inactive connections (in seconds)
* - ``password`` = ````
* - ``password`` = `` ``
- (StrOpt) Password for message broker authentication
* - ``sasl_config_dir`` = ````
* - ``sasl_config_dir`` = `` ``
- (StrOpt) Path to directory that contains the SASL configuration
* - ``sasl_config_name`` = ````
* - ``sasl_config_name`` = `` ``
- (StrOpt) Name of configuration file (without .conf suffix)
* - ``sasl_mechanisms`` = ````
* - ``sasl_mechanisms`` = `` ``
- (StrOpt) Space separated list of acceptable SASL mechanisms
* - ``server_request_prefix`` = ``exclusive``
- (StrOpt) address prefix used when sending to a specific server
* - ``ssl_ca_file`` = ````
* - ``ssl_ca_file`` = `` ``
- (StrOpt) CA certificate PEM file to verify server certificate
* - ``ssl_cert_file`` = ````
* - ``ssl_cert_file`` = `` ``
- (StrOpt) Identifying certificate PEM file to present to clients
* - ``ssl_key_file`` = ````
* - ``ssl_key_file`` = `` ``
- (StrOpt) Private key PEM file used to sign cert_file certificate
* - ``ssl_key_password`` = ``None``
- (StrOpt) Password for decrypting ssl_key_file (if encrypted)
* - ``trace`` = ``False``
- (BoolOpt) Debug: dump AMQP frames to stdout
* - ``username`` = ````
* - ``username`` = `` ``
- (StrOpt) User name for message broker authentication

View File

@ -26,9 +26,9 @@
- (IntOpt) Maximum number of alarms defined for a project.
* - ``record_history`` = ``True``
- (BoolOpt) Record alarm change events.
* - ``rest_notifier_certificate_file`` = ````
* - ``rest_notifier_certificate_file`` = `` ``
- (StrOpt) SSL Client certificate for REST notifier.
* - ``rest_notifier_certificate_key`` = ````
* - ``rest_notifier_certificate_key`` = `` ``
- (StrOpt) SSL Client private key for REST notifier.
* - ``rest_notifier_max_retries`` = ``0``
- (IntOpt) Number of retries for REST notifier

View File

@ -28,7 +28,7 @@
- (BoolOpt) Refresh Event Pipeline configuration on-the-fly.
* - ``refresh_pipeline_cfg`` = ``False``
- (BoolOpt) Refresh Pipeline configuration on-the-fly.
* - ``reserved_metadata_keys`` = ````
* - ``reserved_metadata_keys`` = `` ``
- (ListOpt) 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.

View File

@ -28,7 +28,7 @@
- (StrOpt) Password to use for OpenStack service access.
* - ``os_region_name`` = ``None``
- (StrOpt) Region name to use for OpenStack service endpoints.
* - ``os_tenant_id`` = ````
* - ``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.

View File

@ -24,7 +24,7 @@
- (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.
* - ``admin_user`` = ``None``
- (StrOpt) Service username.
* - ``auth_admin_prefix`` = ````
* - ``auth_admin_prefix`` = `` ``
- (StrOpt) 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.

View File

@ -20,7 +20,7 @@
- (BoolOpt) The flag that indicates if only cadf message should be posted. If false, all meters will be posted. This is deprecated in favor of keystonemiddleware's audit middleware functionality
* - ``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.
* - ``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
* - ``timeout`` = ``5``
- (IntOpt) The max time in seconds to wait for a request to timeout.

View File

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

View File

@ -26,7 +26,7 @@
- (StrOpt) Qpid broker hostname.
* - ``qpid_hosts`` = ``$qpid_hostname:$qpid_port``
- (ListOpt) Qpid HA cluster host:port pairs.
* - ``qpid_password`` = ````
* - ``qpid_password`` = `` ``
- (StrOpt) Password for Qpid connection.
* - ``qpid_port`` = ``5672``
- (IntOpt) Qpid broker port.
@ -34,13 +34,13 @@
- (StrOpt) Transport to use, either 'tcp' or 'ssl'.
* - ``qpid_receiver_capacity`` = ``1``
- (IntOpt) The number of prefetched messages held by receiver.
* - ``qpid_sasl_mechanisms`` = ````
* - ``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`` = ````
* - ``qpid_username`` = `` ``
- (StrOpt) Username for Qpid connection.
* - ``send_single_reply`` = ``False``
- (BoolOpt) Send a single AMQP reply to call message. The current behaviour since oslo-incubator is to send two AMQP replies - first one with the payload, a second one to ensure the other have finish to send the payload. We are going to remove it in the N release, but we must keep backward compatible at the same time. This option provides such compatibility - it defaults to False in Liberty and can be turned on for early adopters with a new installations or for testing. Please note, that this option will be removed in the Mitaka release.

View File

@ -30,13 +30,13 @@
- (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.
* - ``kombu_ssl_ca_certs`` = ````
* - ``kombu_ssl_ca_certs`` = `` ``
- (StrOpt) SSL certification authority file (valid only if SSL enabled).
* - ``kombu_ssl_certfile`` = ````
* - ``kombu_ssl_certfile`` = `` ``
- (StrOpt) SSL cert file (valid only if SSL enabled).
* - ``kombu_ssl_keyfile`` = ````
* - ``kombu_ssl_keyfile`` = `` ``
- (StrOpt) SSL key file (valid only if SSL enabled).
* - ``kombu_ssl_version`` = ````
* - ``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.
* - ``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.

View File

@ -16,7 +16,7 @@
- Description
* - **[DEFAULT]**
-
* - ``password`` = ````
* - ``password`` = `` ``
- (StrOpt) Password for Redis server (optional).
* - ``port`` = ``6379``
- (IntOpt) Use this port to connect to redis host.
@ -24,7 +24,7 @@
-
* - ``host`` = ``127.0.0.1``
- (StrOpt) Host to locate redis.
* - ``password`` = ````
* - ``password`` = `` ``
- (StrOpt) Password for Redis server (optional).
* - ``port`` = ``6379``
- (IntOpt) Use this port to connect to redis host.

View File

@ -48,27 +48,27 @@
- (StrOpt) address prefix when sending to any server in group
* - ``idle_timeout`` = ``0``
- (IntOpt) Timeout for inactive connections (in seconds)
* - ``password`` = ````
* - ``password`` = `` ``
- (StrOpt) Password for message broker authentication
* - ``sasl_config_dir`` = ````
* - ``sasl_config_dir`` = `` ``
- (StrOpt) Path to directory that contains the SASL configuration
* - ``sasl_config_name`` = ````
* - ``sasl_config_name`` = `` ``
- (StrOpt) Name of configuration file (without .conf suffix)
* - ``sasl_mechanisms`` = ````
* - ``sasl_mechanisms`` = `` ``
- (StrOpt) Space separated list of acceptable SASL mechanisms
* - ``server_request_prefix`` = ``exclusive``
- (StrOpt) address prefix used when sending to a specific server
* - ``ssl_ca_file`` = ````
* - ``ssl_ca_file`` = `` ``
- (StrOpt) CA certificate PEM file to verify server certificate
* - ``ssl_cert_file`` = ````
* - ``ssl_cert_file`` = `` ``
- (StrOpt) Identifying certificate PEM file to present to clients
* - ``ssl_key_file`` = ````
* - ``ssl_key_file`` = `` ``
- (StrOpt) Private key PEM file used to sign cert_file certificate
* - ``ssl_key_password`` = ``None``
- (StrOpt) Password for decrypting ssl_key_file (if encrypted)
* - ``trace`` = ``False``
- (BoolOpt) Debug: dump AMQP frames to stdout
* - ``username`` = ````
* - ``username`` = `` ``
- (StrOpt) User name for message broker authentication
* - **[publisher]**
-

View File

@ -20,13 +20,13 @@
- (IntOpt) 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.
* - ``host_ip`` = ````
* - ``host_ip`` = `` ``
- (StrOpt) IP address of the VMware vSphere host.
* - ``host_password`` = ````
* - ``host_password`` = `` ``
- (StrOpt) Password of VMware vSphere.
* - ``host_port`` = ``443``
- (PortOpt) Port of the VMware vSphere host.
* - ``host_username`` = ````
* - ``host_username`` = `` ``
- (StrOpt) 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.

View File

@ -34,7 +34,7 @@
- (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.
* - ``ignore_pool_full_threshold`` = ``False``
- (BoolOpt) Force LUN creation even if the full threshold of pool is reached.
* - ``management_ips`` = ````
* - ``management_ips`` = `` ``
- (StrOpt) List of Management IP addresses (separated by commas)
* - ``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).
@ -44,7 +44,7 @@
- (IntOpt) 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
* - ``osapi_volume_ext_list`` = ````
* - ``osapi_volume_ext_list`` = `` ``
- (ListOpt) 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
@ -54,7 +54,7 @@
- (PortOpt) 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`` = ````
* - ``password`` = `` ``
- (StrOpt) Password for Redis server (optional).
* - ``per_volume_size_limit`` = ``-1``
- (IntOpt) Max size allowed per volume, in gigabytes

View File

@ -24,7 +24,7 @@
- (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.
* - ``admin_user`` = ``None``
- (StrOpt) Service username.
* - ``auth_admin_prefix`` = ````
* - ``auth_admin_prefix`` = `` ``
- (StrOpt) 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.

View File

@ -16,5 +16,5 @@
- Description
* - **[DEFAULT]**
-
* - ``available_devices`` = ````
* - ``available_devices`` = `` ``
- (ListOpt) List of all available devices

View File

@ -18,9 +18,9 @@
-
* - ``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.
* - ``chap_password`` = ````
* - ``chap_password`` = `` ``
- (StrOpt) Password for specified CHAP account name.
* - ``chap_username`` = ````
* - ``chap_username`` = `` ``
- (StrOpt) CHAP user name.
* - ``chiscsi_conf`` = ``/etc/chelsio-iscsi/chiscsi.conf``
- (StrOpt) Chiscsi (CXT) global defaults configuration file
@ -56,7 +56,7 @@
- (StrOpt) 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
* - ``iscsi_secondary_ip_addresses`` = ````
* - ``iscsi_secondary_ip_addresses`` = `` ``
- (ListOpt) 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.
@ -64,7 +64,7 @@
- (ListOpt) Memcached servers or None for in process cache.
* - ``monkey_patch`` = ``False``
- (BoolOpt) Enable monkey patching
* - ``monkey_patch_modules`` = ````
* - ``monkey_patch_modules`` = `` ``
- (ListOpt) List of modules/decorators to monkey patch
* - ``my_ip`` = ``10.0.0.1``
- (StrOpt) IP address of this host

View File

@ -22,7 +22,7 @@
- (StrOpt) Pool or Vdisk name to use for volume creation.
* - ``dothill_backend_type`` = ``virtual``
- (StrOpt) linear (for Vdisk) or virtual (for Pool).
* - ``dothill_iscsi_ips`` = ````
* - ``dothill_iscsi_ips`` = `` ``
- (ListOpt) List of comma-separated target iSCSI IP addresses.
* - ``dothill_verify_certificate`` = ``False``
- (BoolOpt) Whether to verify DotHill array SSL certificate.

View File

@ -30,11 +30,11 @@
- (BoolOpt) 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.
* - ``iscsi_initiators`` = ````
* - ``iscsi_initiators`` = `` ``
- (StrOpt) 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.
* - ``naviseccli_path`` = ````
* - ``naviseccli_path`` = `` ``
- (StrOpt) Naviseccli Path.
* - ``storage_vnx_authentication_type`` = ``global``
- (StrOpt) VNX authentication scope type.
@ -46,5 +46,5 @@
- (IntOpt) Number of retries in case array is busy
* - ``xtremio_array_busy_retry_interval`` = ``5``
- (IntOpt) Interval between retries in case array is busy
* - ``xtremio_cluster_name`` = ````
* - ``xtremio_cluster_name`` = `` ``
- (StrOpt) XMS cluster id in multi-cluster environment

View File

@ -16,23 +16,23 @@
- Description
* - **[DEFAULT]**
-
* - ``hpe3par_api_url`` = ````
* - ``hpe3par_api_url`` = `` ``
- (StrOpt) 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
* - ``hpe3par_cpg_snap`` = ````
* - ``hpe3par_cpg_snap`` = `` ``
- (StrOpt) The CPG to use for Snapshots for volumes. If empty the userCPG will be used.
* - ``hpe3par_debug`` = ``False``
- (BoolOpt) Enable HTTP debugging to 3PAR
* - ``hpe3par_iscsi_chap_enabled`` = ``False``
- (BoolOpt) Enable CHAP authentication for iSCSI connections.
* - ``hpe3par_iscsi_ips`` = ````
* - ``hpe3par_iscsi_ips`` = `` ``
- (ListOpt) List of target iSCSI addresses to use.
* - ``hpe3par_password`` = ````
* - ``hpe3par_password`` = `` ``
- (StrOpt) 3PAR password for the user specified in hpe3par_username
* - ``hpe3par_snapshot_expiration`` = ````
* - ``hpe3par_snapshot_expiration`` = `` ``
- (StrOpt) The time in hours when a snapshot expires and is deleted. This must be larger than expiration
* - ``hpe3par_snapshot_retention`` = ````
* - ``hpe3par_snapshot_retention`` = `` ``
- (StrOpt) The time in hours to retain a snapshot. You can't delete it before this expires.
* - ``hpe3par_username`` = ````
* - ``hpe3par_username`` = `` ``
- (StrOpt) 3PAR username with the 'edit' role

View File

@ -22,7 +22,7 @@
- (StrOpt) Pool or Vdisk name to use for volume creation.
* - ``hpmsa_backend_type`` = ``virtual``
- (StrOpt) linear (for Vdisk) or virtual (for Pool).
* - ``hpmsa_iscsi_ips`` = ````
* - ``hpmsa_iscsi_ips`` = `` ``
- (ListOpt) List of comma-separated target iSCSI IP addresses.
* - ``hpmsa_verify_certificate`` = ``False``
- (BoolOpt) Whether to verify HPMSA array SSL certificate.

View File

@ -18,21 +18,21 @@
-
* - ``ibmnas_platform_type`` = ``v7ku``
- (StrOpt) IBMNAS platform type to be used as backend storage; valid values are - v7ku : for using IBM Storwize V7000 Unified, sonas : for using IBM Scale Out NAS, gpfs-nas : for using NFS based IBM GPFS deployments.
* - ``nas_ip`` = ````
* - ``nas_ip`` = `` ``
- (StrOpt) IP address or Hostname of NAS system.
* - ``nas_login`` = ``admin``
- (StrOpt) 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.
* - ``nas_password`` = ````
* - ``nas_password`` = `` ``
- (StrOpt) Password to connect to NAS system.
* - ``nas_private_key`` = ````
* - ``nas_private_key`` = `` ``
- (StrOpt) 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.
* - ``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.
* - ``nas_share_path`` = ````
* - ``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 .
* - ``nas_ssh_port`` = ``22``
- (PortOpt) SSH port to use to connect to NAS system.

View File

@ -16,7 +16,7 @@
- Description
* - **[DEFAULT]**
-
* - ``allowed_direct_url_schemes`` = ````
* - ``allowed_direct_url_schemes`` = `` ``
- (ListOpt) 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

View File

@ -22,7 +22,7 @@
- (StrOpt) 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.
* - ``infortrend_pools_name`` = ````
* - ``infortrend_pools_name`` = `` ``
- (StrOpt) 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.

View File

@ -22,7 +22,7 @@
- (StrOpt) Pool or Vdisk name to use for volume creation.
* - ``lenovo_backend_type`` = ``virtual``
- (StrOpt) linear (for VDisk) or virtual (for Pool).
* - ``lenovo_iscsi_ips`` = ````
* - ``lenovo_iscsi_ips`` = `` ``
- (ListOpt) List of comma-separated target iSCSI IP addresses.
* - ``lenovo_verify_certificate`` = ``False``
- (BoolOpt) Whether to verify Lenovo array SSL certificate.

View File

@ -16,17 +16,17 @@
- Description
* - **[DEFAULT]**
-
* - ``dpl_pool`` = ````
* - ``dpl_pool`` = `` ``
- (StrOpt) DPL pool uuid in which DPL volumes are stored.
* - ``dpl_port`` = ``8357``
- (PortOpt) DPL port number.
* - ``iscsi_port`` = ``3260``
- (PortOpt) The port that the iSCSI daemon is listening on
* - ``san_ip`` = ````
* - ``san_ip`` = `` ``
- (StrOpt) IP address of SAN controller
* - ``san_login`` = ``admin``
- (StrOpt) Username for SAN controller
* - ``san_password`` = ````
* - ``san_password`` = `` ``
- (StrOpt) Password for SAN controller
* - ``san_thin_provision`` = ``True``
- (BoolOpt) Use thin provisioning for SAN volumes?

View File

@ -26,7 +26,7 @@
- (StrOpt) Qpid broker hostname.
* - ``qpid_hosts`` = ``$qpid_hostname:$qpid_port``
- (ListOpt) Qpid HA cluster host:port pairs.
* - ``qpid_password`` = ````
* - ``qpid_password`` = `` ``
- (StrOpt) Password for Qpid connection.
* - ``qpid_port`` = ``5672``
- (IntOpt) Qpid broker port.
@ -34,13 +34,13 @@
- (StrOpt) Transport to use, either 'tcp' or 'ssl'.
* - ``qpid_receiver_capacity`` = ``1``
- (IntOpt) The number of prefetched messages held by receiver.
* - ``qpid_sasl_mechanisms`` = ````
* - ``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`` = ````
* - ``qpid_username`` = `` ``
- (StrOpt) Username for Qpid connection.
* - ``send_single_reply`` = ``False``
- (BoolOpt) Send a single AMQP reply to call message. The current behaviour since oslo-incubator is to send two AMQP replies - first one with the payload, a second one to ensure the other have finish to send the payload. We are going to remove it in the N release, but we must keep backward compatible at the same time. This option provides such compatibility - it defaults to False in Liberty and can be turned on for early adopters with a new installations or for testing. Please note, that this option will be removed in the Mitaka release.

View File

@ -30,13 +30,13 @@
- (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.
* - ``kombu_ssl_ca_certs`` = ````
* - ``kombu_ssl_ca_certs`` = `` ``
- (StrOpt) SSL certification authority file (valid only if SSL enabled).
* - ``kombu_ssl_certfile`` = ````
* - ``kombu_ssl_certfile`` = `` ``
- (StrOpt) SSL cert file (valid only if SSL enabled).
* - ``kombu_ssl_keyfile`` = ````
* - ``kombu_ssl_keyfile`` = `` ``
- (StrOpt) SSL key file (valid only if SSL enabled).
* - ``kombu_ssl_version`` = ````
* - ``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.
* - ``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.

View File

@ -18,7 +18,7 @@
-
* - ``host`` = ``127.0.0.1``
- (StrOpt) Host to locate redis.
* - ``password`` = ````
* - ``password`` = `` ``
- (StrOpt) Password for Redis server (optional).
* - ``port`` = ``6379``
- (IntOpt) Use this port to connect to redis host.

View File

@ -46,25 +46,25 @@
- (StrOpt) address prefix when sending to any server in group
* - ``idle_timeout`` = ``0``
- (IntOpt) Timeout for inactive connections (in seconds)
* - ``password`` = ````
* - ``password`` = `` ``
- (StrOpt) Password for message broker authentication
* - ``sasl_config_dir`` = ````
* - ``sasl_config_dir`` = `` ``
- (StrOpt) Path to directory that contains the SASL configuration
* - ``sasl_config_name`` = ````
* - ``sasl_config_name`` = `` ``
- (StrOpt) Name of configuration file (without .conf suffix)
* - ``sasl_mechanisms`` = ````
* - ``sasl_mechanisms`` = `` ``
- (StrOpt) Space separated list of acceptable SASL mechanisms
* - ``server_request_prefix`` = ``exclusive``
- (StrOpt) address prefix used when sending to a specific server
* - ``ssl_ca_file`` = ````
* - ``ssl_ca_file`` = `` ``
- (StrOpt) CA certificate PEM file to verify server certificate
* - ``ssl_cert_file`` = ````
* - ``ssl_cert_file`` = `` ``
- (StrOpt) Identifying certificate PEM file to present to clients
* - ``ssl_key_file`` = ````
* - ``ssl_key_file`` = `` ``
- (StrOpt) Private key PEM file used to sign cert_file certificate
* - ``ssl_key_password`` = ``None``
- (StrOpt) Password for decrypting ssl_key_file (if encrypted)
* - ``trace`` = ``False``
- (BoolOpt) Debug: dump AMQP frames to stdout
* - ``username`` = ````
* - ``username`` = `` ``
- (StrOpt) User name for message broker authentication

View File

@ -16,17 +16,17 @@
- Description
* - **[DEFAULT]**
-
* - ``san_clustername`` = ````
* - ``san_clustername`` = `` ``
- (StrOpt) Cluster name to use for creating volumes
* - ``san_ip`` = ````
* - ``san_ip`` = `` ``
- (StrOpt) 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
* - ``san_login`` = ``admin``
- (StrOpt) Username for SAN controller
* - ``san_password`` = ````
* - ``san_password`` = `` ``
- (StrOpt) Password for SAN controller
* - ``san_private_key`` = ````
* - ``san_private_key`` = `` ``
- (StrOpt) Filename of private key to use for SSH authentication
* - ``san_secondary_ip`` = ``None``
- (StrOpt) VNX secondary SP IP Address.

View File

@ -28,7 +28,7 @@
- (StrOpt) Default scheduler driver to use
* - ``scheduler_host_manager`` = ``cinder.scheduler.host_manager.HostManager``
- (StrOpt) The scheduler host manager class to use
* - ``scheduler_json_config_location`` = ````
* - ``scheduler_json_config_location`` = `` ``
- (StrOpt) Absolute path to scheduler configuration JSON file.
* - ``scheduler_manager`` = ``cinder.scheduler.manager.SchedulerManager``
- (StrOpt) Full class name for the Manager for scheduler

View File

@ -32,7 +32,7 @@
- (PortOpt) 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".
* - ``iscsi_target_flags`` = ````
* - ``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.
* - ``iscsi_target_prefix`` = ``iqn.2010-10.org.openstack:``
- (StrOpt) Prefix for iSCSI volumes

View File

@ -22,7 +22,7 @@
- (IntOpt) Interval value (in seconds) between connection retries to ceph cluster.
* - ``rados_connection_retries`` = ``3``
- (IntOpt) Number of retries if connection to ceph cluster failed.
* - ``rbd_ceph_conf`` = ````
* - ``rbd_ceph_conf`` = `` ``
- (StrOpt) Path to the ceph configuration file
* - ``rbd_cluster_name`` = ``ceph``
- (StrOpt) The name of ceph cluster

View File

@ -16,13 +16,13 @@
- Description
* - **[DEFAULT]**
-
* - ``san_clustername`` = ````
* - ``san_clustername`` = `` ``
- (StrOpt) Cluster name to use for creating volumes
* - ``san_ip`` = ````
* - ``san_ip`` = `` ``
- (StrOpt) IP address of SAN controller
* - ``san_login`` = ``admin``
- (StrOpt) Username for SAN controller
* - ``san_password`` = ````
* - ``san_password`` = `` ``
- (StrOpt) Password for SAN controller
* - ``xiv_chap`` = ``disabled``
- (StrOpt) CHAP authentication mode, effective only for iscsi (disabled|enabled)

View File

@ -16,15 +16,15 @@
- Description
* - **[DEFAULT]**
-
* - ``zfssa_initiator`` = ````
* - ``zfssa_initiator`` = `` ``
- (StrOpt) iSCSI initiator IQNs. (comma separated)
* - ``zfssa_initiator_config`` = ````
* - ``zfssa_initiator_config`` = `` ``
- (StrOpt) iSCSI initiators configuration.
* - ``zfssa_initiator_group`` = ````
* - ``zfssa_initiator_group`` = `` ``
- (StrOpt) iSCSI initiator group.
* - ``zfssa_initiator_password`` = ````
* - ``zfssa_initiator_password`` = `` ``
- (StrOpt) Secret of the iSCSI initiator CHAP user.
* - ``zfssa_initiator_user`` = ````
* - ``zfssa_initiator_user`` = `` ``
- (StrOpt) iSCSI initiator CHAP user (name).
* - ``zfssa_lun_compression`` = ``off``
- (StrOpt) Data compression.
@ -38,7 +38,7 @@
- (StrOpt) Storage pool name.
* - ``zfssa_project`` = ``None``
- (StrOpt) Project name.
* - ``zfssa_replication_ip`` = ````
* - ``zfssa_replication_ip`` = `` ``
- (StrOpt) IP address used for replication data. (maybe the same as data ip)
* - ``zfssa_rest_timeout`` = ``None``
- (IntOpt) REST connection timeout. (seconds)
@ -46,9 +46,9 @@
- (StrOpt) iSCSI target group name.
* - ``zfssa_target_interfaces`` = ``None``
- (StrOpt) Network interfaces of iSCSI targets. (comma separated)
* - ``zfssa_target_password`` = ````
* - ``zfssa_target_password`` = `` ``
- (StrOpt) Secret of the iSCSI target CHAP user.
* - ``zfssa_target_portal`` = ``None``
- (StrOpt) iSCSI target portal (Data-IP:Port, w.x.y.z:3260).
* - ``zfssa_target_user`` = ````
* - ``zfssa_target_user`` = `` ``
- (StrOpt) iSCSI target CHAP user (name).

View File

@ -26,9 +26,9 @@
- (BoolOpt) Flag to enable local caching: True, False.
* - ``zfssa_https_port`` = ``443``
- (StrOpt) HTTPS port number
* - ``zfssa_nfs_mount_options`` = ````
* - ``zfssa_nfs_mount_options`` = `` ``
- (StrOpt) Options to be passed while mounting share over nfs
* - ``zfssa_nfs_pool`` = ````
* - ``zfssa_nfs_pool`` = `` ``
- (StrOpt) Storage pool name.
* - ``zfssa_nfs_project`` = ``NFSProject``
- (StrOpt) Project name.

View File

@ -16,13 +16,13 @@
- Description
* - **[BRCD_FABRIC_EXAMPLE]**
-
* - ``fc_fabric_address`` = ````
* - ``fc_fabric_address`` = `` ``
- (StrOpt) Management IP of fabric
* - ``fc_fabric_password`` = ````
* - ``fc_fabric_password`` = `` ``
- (StrOpt) Password for user
* - ``fc_fabric_port`` = ``22``
- (PortOpt) Connecting port
* - ``fc_fabric_user`` = ````
* - ``fc_fabric_user`` = `` ``
- (StrOpt) Fabric user ID
* - ``principal_switch_wwn`` = ``None``
- (StrOpt) Principal switch WWN of the fabric

View File

@ -16,13 +16,13 @@
- Description
* - **[CISCO_FABRIC_EXAMPLE]**
-
* - ``cisco_fc_fabric_address`` = ````
* - ``cisco_fc_fabric_address`` = `` ``
- (StrOpt) Management IP of fabric
* - ``cisco_fc_fabric_password`` = ````
* - ``cisco_fc_fabric_password`` = `` ``
- (StrOpt) Password for user
* - ``cisco_fc_fabric_port`` = ``22``
- (PortOpt) Connecting port
* - ``cisco_fc_fabric_user`` = ````
* - ``cisco_fc_fabric_user`` = `` ``
- (StrOpt) Fabric user ID
* - ``cisco_zone_activate`` = ``True``
- (BoolOpt) overridden zoning activation state

View File

@ -20,7 +20,7 @@
- (StrOpt) 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.
* - ``disabled_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.
* - ``notification_driver`` = ``[]``
- (MultiStrOpt) The Drivers(s) to handle sending notifications. Possible values are messaging, messagingv2, routing, log, test, noop

View File

@ -20,7 +20,7 @@
- (StrOpt) 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.
* - ``available_plugins`` = ````
* - ``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.
* - ``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.
@ -80,5 +80,5 @@
- (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"
* - **[store_type_location_strategy]**
-
* - ``store_type_preference`` = ````
* - ``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.

View File

@ -24,7 +24,7 @@
- (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.
* - ``admin_user`` = ``None``
- (StrOpt) Service username.
* - ``auth_admin_prefix`` = ````
* - ``auth_admin_prefix`` = `` ``
- (StrOpt) 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.

View File

@ -26,7 +26,7 @@
- (StrOpt) Qpid broker hostname.
* - ``qpid_hosts`` = ``$qpid_hostname:$qpid_port``
- (ListOpt) Qpid HA cluster host:port pairs.
* - ``qpid_password`` = ````
* - ``qpid_password`` = `` ``
- (StrOpt) Password for Qpid connection.
* - ``qpid_port`` = ``5672``
- (IntOpt) Qpid broker port.
@ -34,13 +34,13 @@
- (StrOpt) Transport to use, either 'tcp' or 'ssl'.
* - ``qpid_receiver_capacity`` = ``1``
- (IntOpt) The number of prefetched messages held by receiver.
* - ``qpid_sasl_mechanisms`` = ````
* - ``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`` = ````
* - ``qpid_username`` = `` ``
- (StrOpt) Username for Qpid connection.
* - ``send_single_reply`` = ``False``
- (BoolOpt) Send a single AMQP reply to call message. The current behaviour since oslo-incubator is to send two AMQP replies - first one with the payload, a second one to ensure the other have finish to send the payload. We are going to remove it in the N release, but we must keep backward compatible at the same time. This option provides such compatibility - it defaults to False in Liberty and can be turned on for early adopters with a new installations or for testing. Please note, that this option will be removed in the Mitaka release.

View File

@ -30,13 +30,13 @@
- (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.
* - ``kombu_ssl_ca_certs`` = ````
* - ``kombu_ssl_ca_certs`` = `` ``
- (StrOpt) SSL certification authority file (valid only if SSL enabled).
* - ``kombu_ssl_certfile`` = ````
* - ``kombu_ssl_certfile`` = `` ``
- (StrOpt) SSL cert file (valid only if SSL enabled).
* - ``kombu_ssl_keyfile`` = ````
* - ``kombu_ssl_keyfile`` = `` ``
- (StrOpt) SSL key file (valid only if SSL enabled).
* - ``kombu_ssl_version`` = ````
* - ``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.
* - ``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.

View File

@ -18,7 +18,7 @@
-
* - ``host`` = ``127.0.0.1``
- (StrOpt) Host to locate redis.
* - ``password`` = ````
* - ``password`` = `` ``
- (StrOpt) Password for Redis server (optional).
* - ``port`` = ``6379``
- (IntOpt) Use this port to connect to redis host.
@ -26,7 +26,7 @@
-
* - ``host`` = ``127.0.0.1``
- (StrOpt) Host to locate redis.
* - ``password`` = ````
* - ``password`` = `` ``
- (StrOpt) Password for Redis server (optional).
* - ``port`` = ``6379``
- (IntOpt) Use this port to connect to redis host.

View File

@ -24,11 +24,11 @@
- (StrOpt) Command to be given to replicator
* - ``dontreplicate`` = ``created_at date deleted_at location updated_at``
- (StrOpt) List of fields to not replicate.
* - ``mastertoken`` = ````
* - ``mastertoken`` = `` ``
- (StrOpt) 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.
* - ``slavetoken`` = ````
* - ``slavetoken`` = `` ``
- (StrOpt) Pass in your authentication token if you have one. This is the token used for the slave.
* - ``token`` = ````
* - ``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.

View File

@ -46,25 +46,25 @@
- (StrOpt) address prefix when sending to any server in group
* - ``idle_timeout`` = ``0``
- (IntOpt) Timeout for inactive connections (in seconds)
* - ``password`` = ````
* - ``password`` = `` ``
- (StrOpt) Password for message broker authentication
* - ``sasl_config_dir`` = ````
* - ``sasl_config_dir`` = `` ``
- (StrOpt) Path to directory that contains the SASL configuration
* - ``sasl_config_name`` = ````
* - ``sasl_config_name`` = `` ``
- (StrOpt) Name of configuration file (without .conf suffix)
* - ``sasl_mechanisms`` = ````
* - ``sasl_mechanisms`` = `` ``
- (StrOpt) Space separated list of acceptable SASL mechanisms
* - ``server_request_prefix`` = ``exclusive``
- (StrOpt) address prefix used when sending to a specific server
* - ``ssl_ca_file`` = ````
* - ``ssl_ca_file`` = `` ``
- (StrOpt) CA certificate PEM file to verify server certificate
* - ``ssl_cert_file`` = ````
* - ``ssl_cert_file`` = `` ``
- (StrOpt) Identifying certificate PEM file to present to clients
* - ``ssl_key_file`` = ````
* - ``ssl_key_file`` = `` ``
- (StrOpt) Private key PEM file used to sign cert_file certificate
* - ``ssl_key_password`` = ``None``
- (StrOpt) Password for decrypting ssl_key_file (if encrypted)
* - ``trace`` = ``False``
- (BoolOpt) Debug: dump AMQP frames to stdout
* - ``username`` = ````
* - ``username`` = `` ``
- (StrOpt) User name for message broker authentication

View File

@ -30,7 +30,7 @@
-
* - ``default_swift_reference`` = ``ref1``
- (StrOpt) The reference to the default swift account/backing store parameters to use for adding new images.
* - ``swift_store_admin_tenants`` = ````
* - ``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.
* - ``swift_store_auth_address`` = ``None``
- (StrOpt) The address where the Swift authentication service is listening. (deprecated - use "auth_address" in swift_store_config_file)

View File

@ -24,13 +24,13 @@
- (BoolOpt) 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`` = ````
* - ``heat_metadata_server_url`` = `` ``
- (StrOpt) URL of the Heat metadata server.
* - ``heat_stack_user_role`` = ``heat_stack_user``
- (StrOpt) Keystone role for heat template-defined users.
* - ``heat_waitcondition_server_url`` = ``None``
- (StrOpt) URL of the Heat waitcondition server.
* - ``heat_watch_server_url`` = ````
* - ``heat_watch_server_url`` = `` ``
- (StrOpt) 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).
@ -50,17 +50,17 @@
- (StrOpt) 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.
* - ``trusts_delegated_roles`` = ````
* - ``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.
* - **[auth_password]**
-
* - ``allowed_auth_uris`` = ````
* - ``allowed_auth_uris`` = `` ``
- (ListOpt) 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.
* - **[ec2authtoken]**
-
* - ``allowed_auth_uris`` = ````
* - ``allowed_auth_uris`` = `` ``
- (ListOpt) 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.

View File

@ -24,7 +24,7 @@
- (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.
* - ``admin_user`` = ``None``
- (StrOpt) Service username.
* - ``auth_admin_prefix`` = ````
* - ``auth_admin_prefix`` = `` ``
- (StrOpt) 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.

View File

@ -26,5 +26,5 @@
- (BoolOpt) If set, then the server's certificate will not be verified.
* - ``key_file`` = ``None``
- (StrOpt) Optional PEM-formatted file that contains the private key.
* - ``url`` = ````
* - ``url`` = `` ``
- (StrOpt) Optional heat url in format like http://0.0.0.0:8004/v1/%(tenant_id)s.

View File

@ -16,7 +16,7 @@
- Description
* - **[clients_keystone]**
-
* - ``auth_uri`` = ````
* - ``auth_uri`` = `` ``
- (StrOpt) 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.

View File

@ -18,7 +18,7 @@
-
* - ``enable_cloud_watch_lite`` = ``False``
- (BoolOpt) Enable the legacy OS::Heat::CWLiteAlarm resource.
* - ``heat_watch_server_url`` = ````
* - ``heat_watch_server_url`` = `` ``
- (StrOpt) URL of the Heat CloudWatch server.
* - **[heat_api_cloudwatch]**
-

View File

@ -38,7 +38,7 @@
- (StrOpt) Fully qualified class name to use as a keystone backend.
* - ``memcached_servers`` = ``None``
- (ListOpt) Memcached servers or None for in process cache.
* - ``password`` = ````
* - ``password`` = `` ``
- (StrOpt) Password for Redis server (optional).
* - ``periodic_interval`` = ``60``
- (IntOpt) Seconds between running periodic tasks.
@ -74,7 +74,7 @@
- (ListOpt) 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).
* - ``proxies`` = ````
* - ``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.
* - **[constraint_validation_cache]**
-

View File

@ -16,5 +16,5 @@
- Description
* - **[DEFAULT]**
-
* - ``heat_metadata_server_url`` = ````
* - ``heat_metadata_server_url`` = `` ``
- (StrOpt) URL of the Heat metadata server.

View File

@ -26,7 +26,7 @@
- (StrOpt) Qpid broker hostname.
* - ``qpid_hosts`` = ``$qpid_hostname:$qpid_port``
- (ListOpt) Qpid HA cluster host:port pairs.
* - ``qpid_password`` = ````
* - ``qpid_password`` = `` ``
- (StrOpt) Password for Qpid connection.
* - ``qpid_port`` = ``5672``
- (IntOpt) Qpid broker port.
@ -34,13 +34,13 @@
- (StrOpt) Transport to use, either 'tcp' or 'ssl'.
* - ``qpid_receiver_capacity`` = ``1``
- (IntOpt) The number of prefetched messages held by receiver.
* - ``qpid_sasl_mechanisms`` = ````
* - ``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`` = ````
* - ``qpid_username`` = `` ``
- (StrOpt) Username for Qpid connection.
* - ``send_single_reply`` = ``False``
- (BoolOpt) Send a single AMQP reply to call message. The current behaviour since oslo-incubator is to send two AMQP replies - first one with the payload, a second one to ensure the other have finish to send the payload. We are going to remove it in the N release, but we must keep backward compatible at the same time. This option provides such compatibility - it defaults to False in Liberty and can be turned on for early adopters with a new installations or for testing. Please note, that this option will be removed in the Mitaka release.

View File

@ -30,13 +30,13 @@
- (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.
* - ``kombu_ssl_ca_certs`` = ````
* - ``kombu_ssl_ca_certs`` = `` ``
- (StrOpt) SSL certification authority file (valid only if SSL enabled).
* - ``kombu_ssl_certfile`` = ````
* - ``kombu_ssl_certfile`` = `` ``
- (StrOpt) SSL cert file (valid only if SSL enabled).
* - ``kombu_ssl_keyfile`` = ````
* - ``kombu_ssl_keyfile`` = `` ``
- (StrOpt) SSL key file (valid only if SSL enabled).
* - ``kombu_ssl_version`` = ````
* - ``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.
* - ``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.

View File

@ -18,7 +18,7 @@
-
* - ``host`` = ``127.0.0.1``
- (StrOpt) Host to locate redis.
* - ``password`` = ````
* - ``password`` = `` ``
- (StrOpt) Password for Redis server (optional).
* - ``port`` = ``6379``
- (IntOpt) Use this port to connect to redis host.

View File

@ -46,25 +46,25 @@
- (StrOpt) address prefix when sending to any server in group
* - ``idle_timeout`` = ``0``
- (IntOpt) Timeout for inactive connections (in seconds)
* - ``password`` = ````
* - ``password`` = `` ``
- (StrOpt) Password for message broker authentication
* - ``sasl_config_dir`` = ````
* - ``sasl_config_dir`` = `` ``
- (StrOpt) Path to directory that contains the SASL configuration
* - ``sasl_config_name`` = ````
* - ``sasl_config_name`` = `` ``
- (StrOpt) Name of configuration file (without .conf suffix)
* - ``sasl_mechanisms`` = ````
* - ``sasl_mechanisms`` = `` ``
- (StrOpt) Space separated list of acceptable SASL mechanisms
* - ``server_request_prefix`` = ``exclusive``
- (StrOpt) address prefix used when sending to a specific server
* - ``ssl_ca_file`` = ````
* - ``ssl_ca_file`` = `` ``
- (StrOpt) CA certificate PEM file to verify server certificate
* - ``ssl_cert_file`` = ````
* - ``ssl_cert_file`` = `` ``
- (StrOpt) Identifying certificate PEM file to present to clients
* - ``ssl_key_file`` = ````
* - ``ssl_key_file`` = `` ``
- (StrOpt) Private key PEM file used to sign cert_file certificate
* - ``ssl_key_password`` = ``None``
- (StrOpt) Password for decrypting ssl_key_file (if encrypted)
* - ``trace`` = ``False``
- (BoolOpt) Debug: dump AMQP frames to stdout
* - ``username`` = ````
* - ``username`` = `` ``
- (StrOpt) User name for message broker authentication

View File

@ -24,7 +24,7 @@
- (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.
* - ``admin_user`` = ``None``
- (StrOpt) Service username.
* - ``auth_admin_prefix`` = ````
* - ``auth_admin_prefix`` = `` ``
- (StrOpt) 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.

View File

@ -16,7 +16,7 @@
- Description
* - **[glance]**
-
* - ``allowed_direct_url_schemes`` = ````
* - ``allowed_direct_url_schemes`` = `` ``
- (ListOpt) 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.

View File

@ -30,7 +30,7 @@
- (StrOpt) Ironic conductor node's "NFS" or "CIFS" root path
* - ``remote_image_share_type`` = ``CIFS``
- (StrOpt) Share type of virtual media, either "NFS" or "CIFS"
* - ``remote_image_user_domain`` = ````
* - ``remote_image_user_domain`` = `` ``
- (StrOpt) Domain name of remote_image_user_name
* - ``remote_image_user_name`` = ``None``
- (StrOpt) User name of remote_image_server

View File

@ -26,7 +26,7 @@
- (StrOpt) Qpid broker hostname.
* - ``qpid_hosts`` = ``$qpid_hostname:$qpid_port``
- (ListOpt) Qpid HA cluster host:port pairs.
* - ``qpid_password`` = ````
* - ``qpid_password`` = `` ``
- (StrOpt) Password for Qpid connection.
* - ``qpid_port`` = ``5672``
- (IntOpt) Qpid broker port.
@ -34,13 +34,13 @@
- (StrOpt) Transport to use, either 'tcp' or 'ssl'.
* - ``qpid_receiver_capacity`` = ``1``
- (IntOpt) The number of prefetched messages held by receiver.
* - ``qpid_sasl_mechanisms`` = ````
* - ``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`` = ````
* - ``qpid_username`` = `` ``
- (StrOpt) Username for Qpid connection.
* - ``send_single_reply`` = ``False``
- (BoolOpt) Send a single AMQP reply to call message. The current behaviour since oslo-incubator is to send two AMQP replies - first one with the payload, a second one to ensure the other have finish to send the payload. We are going to remove it in the N release, but we must keep backward compatible at the same time. This option provides such compatibility - it defaults to False in Liberty and can be turned on for early adopters with a new installations or for testing. Please note, that this option will be removed in the Mitaka release.

View File

@ -30,13 +30,13 @@
- (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.
* - ``kombu_ssl_ca_certs`` = ````
* - ``kombu_ssl_ca_certs`` = `` ``
- (StrOpt) SSL certification authority file (valid only if SSL enabled).
* - ``kombu_ssl_certfile`` = ````
* - ``kombu_ssl_certfile`` = `` ``
- (StrOpt) SSL cert file (valid only if SSL enabled).
* - ``kombu_ssl_keyfile`` = ````
* - ``kombu_ssl_keyfile`` = `` ``
- (StrOpt) SSL key file (valid only if SSL enabled).
* - ``kombu_ssl_version`` = ````
* - ``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.
* - ``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.

View File

@ -16,7 +16,7 @@
- Description
* - **[DEFAULT]**
-
* - ``password`` = ````
* - ``password`` = `` ``
- (StrOpt) Password for Redis server (optional).
* - ``port`` = ``6379``
- (IntOpt) Use this port to connect to redis host.
@ -24,7 +24,7 @@
-
* - ``host`` = ``127.0.0.1``
- (StrOpt) Host to locate redis.
* - ``password`` = ````
* - ``password`` = `` ``
- (StrOpt) Password for Redis server (optional).
* - ``port`` = ``6379``
- (IntOpt) Use this port to connect to redis host.

View File

@ -44,25 +44,25 @@
- (StrOpt) address prefix when sending to any server in group
* - ``idle_timeout`` = ``0``
- (IntOpt) Timeout for inactive connections (in seconds)
* - ``password`` = ````
* - ``password`` = `` ``
- (StrOpt) Password for message broker authentication
* - ``sasl_config_dir`` = ````
* - ``sasl_config_dir`` = `` ``
- (StrOpt) Path to directory that contains the SASL configuration
* - ``sasl_config_name`` = ````
* - ``sasl_config_name`` = `` ``
- (StrOpt) Name of configuration file (without .conf suffix)
* - ``sasl_mechanisms`` = ````
* - ``sasl_mechanisms`` = `` ``
- (StrOpt) Space separated list of acceptable SASL mechanisms
* - ``server_request_prefix`` = ``exclusive``
- (StrOpt) address prefix used when sending to a specific server
* - ``ssl_ca_file`` = ````
* - ``ssl_ca_file`` = `` ``
- (StrOpt) CA certificate PEM file to verify server certificate
* - ``ssl_cert_file`` = ````
* - ``ssl_cert_file`` = `` ``
- (StrOpt) Identifying certificate PEM file to present to clients
* - ``ssl_key_file`` = ````
* - ``ssl_key_file`` = `` ``
- (StrOpt) Private key PEM file used to sign cert_file certificate
* - ``ssl_key_password`` = ``None``
- (StrOpt) Password for decrypting ssl_key_file (if encrypted)
* - ``trace`` = ``False``
- (BoolOpt) Debug: dump AMQP frames to stdout
* - ``username`` = ````
* - ``username`` = `` ``
- (StrOpt) User name for message broker authentication

View File

@ -24,7 +24,7 @@
- (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.
* - ``admin_user`` = ``None``
- (StrOpt) Service username.
* - ``auth_admin_prefix`` = ````
* - ``auth_admin_prefix`` = `` ``
- (StrOpt) 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.

View File

@ -40,7 +40,7 @@
- (ListOpt) 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).
* - ``proxies`` = ````
* - ``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.
* - **[memcache]**
-

View File

@ -16,7 +16,7 @@
- Description
* - **[federation]**
-
* - ``assertion_prefix`` = ````
* - ``assertion_prefix`` = `` ``
- (StrOpt) 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.

View File

@ -16,7 +16,7 @@
- Description
* - **[kvs]**
-
* - ``backends`` = ````
* - ``backends`` = `` ``
- (ListOpt) 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.

View File

@ -30,7 +30,7 @@
- (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.
* - ``dumb_member`` = ``cn=dumb,dc=nonexistent``
- (StrOpt) DN of the "dummy member" to use when "use_dumb_member" is enabled.
* - ``group_additional_attribute_mapping`` = ````
* - ``group_additional_attribute_mapping`` = `` ``
- (ListOpt) Additional attribute mappings for groups. Attribute mapping format is <ldap_attr>:<user_attr>, 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.
@ -38,7 +38,7 @@
- (BoolOpt) Allow group deletion in LDAP backend.
* - ``group_allow_update`` = ``True``
- (BoolOpt) Allow group update in LDAP backend.
* - ``group_attribute_ignore`` = ````
* - ``group_attribute_ignore`` = `` ``
- (ListOpt) List of attributes stripped off the group on update.
* - ``group_desc_attribute`` = ``description``
- (StrOpt) LDAP attribute mapped to group description.
@ -68,7 +68,7 @@
- (IntOpt) Maximum count of reconnect trials.
* - ``pool_size`` = ``10``
- (IntOpt) Connection pool size.
* - ``project_additional_attribute_mapping`` = ````
* - ``project_additional_attribute_mapping`` = `` ``
- (ListOpt) Additional attribute mappings for projects. Attribute mapping format is <ldap_attr>:<user_attr>, 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.
@ -76,7 +76,7 @@
- (BoolOpt) Allow project deletion in LDAP backend.
* - ``project_allow_update`` = ``True``
- (BoolOpt) Allow project update in LDAP backend.
* - ``project_attribute_ignore`` = ````
* - ``project_attribute_ignore`` = `` ``
- (ListOpt) List of attributes stripped off the project on update.
* - ``project_desc_attribute`` = ``description``
- (StrOpt) LDAP attribute mapped to project description.
@ -104,7 +104,7 @@
- (StrOpt) Search base for projects. Defaults to the suffix value.
* - ``query_scope`` = ``one``
- (StrOpt) The LDAP scope for queries, "one" represents oneLevel/singleLevel and "sub" represents subtree/wholeSubtree options.
* - ``role_additional_attribute_mapping`` = ````
* - ``role_additional_attribute_mapping`` = `` ``
- (ListOpt) Additional attribute mappings for roles. Attribute mapping format is <ldap_attr>:<user_attr>, 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.
@ -112,7 +112,7 @@
- (BoolOpt) Allow role deletion in LDAP backend.
* - ``role_allow_update`` = ``True``
- (BoolOpt) Allow role update in LDAP backend.
* - ``role_attribute_ignore`` = ````
* - ``role_attribute_ignore`` = `` ``
- (ListOpt) List of attributes stripped off the role on update.
* - ``role_filter`` = ``None``
- (StrOpt) LDAP search filter for roles.
@ -146,7 +146,7 @@
- (BoolOpt) Enable TLS for communicating with LDAP servers.
* - ``user`` = ``None``
- (StrOpt) User BindDN to query the LDAP server.
* - ``user_additional_attribute_mapping`` = ````
* - ``user_additional_attribute_mapping`` = `` ``
- (ListOpt) List of additional LDAP attributes used for mapping additional attribute mappings for users. Attribute mapping format is <ldap_attr>:<user_attr>, 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.

View File

@ -26,7 +26,7 @@
- (StrOpt) Qpid broker hostname.
* - ``qpid_hosts`` = ``$qpid_hostname:$qpid_port``
- (ListOpt) Qpid HA cluster host:port pairs.
* - ``qpid_password`` = ````
* - ``qpid_password`` = `` ``
- (StrOpt) Password for Qpid connection.
* - ``qpid_port`` = ``5672``
- (IntOpt) Qpid broker port.
@ -34,13 +34,13 @@
- (StrOpt) Transport to use, either 'tcp' or 'ssl'.
* - ``qpid_receiver_capacity`` = ``1``
- (IntOpt) The number of prefetched messages held by receiver.
* - ``qpid_sasl_mechanisms`` = ````
* - ``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`` = ````
* - ``qpid_username`` = `` ``
- (StrOpt) Username for Qpid connection.
* - ``send_single_reply`` = ``False``
- (BoolOpt) Send a single AMQP reply to call message. The current behaviour since oslo-incubator is to send two AMQP replies - first one with the payload, a second one to ensure the other have finish to send the payload. We are going to remove it in the N release, but we must keep backward compatible at the same time. This option provides such compatibility - it defaults to False in Liberty and can be turned on for early adopters with a new installations or for testing. Please note, that this option will be removed in the Mitaka release.

View File

@ -30,13 +30,13 @@
- (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.
* - ``kombu_ssl_ca_certs`` = ````
* - ``kombu_ssl_ca_certs`` = `` ``
- (StrOpt) SSL certification authority file (valid only if SSL enabled).
* - ``kombu_ssl_certfile`` = ````
* - ``kombu_ssl_certfile`` = `` ``
- (StrOpt) SSL cert file (valid only if SSL enabled).
* - ``kombu_ssl_keyfile`` = ````
* - ``kombu_ssl_keyfile`` = `` ``
- (StrOpt) SSL key file (valid only if SSL enabled).
* - ``kombu_ssl_version`` = ````
* - ``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.
* - ``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.

View File

@ -18,7 +18,7 @@
-
* - ``host`` = ``127.0.0.1``
- (StrOpt) Host to locate redis.
* - ``password`` = ````
* - ``password`` = `` ``
- (StrOpt) Password for Redis server (optional).
* - ``port`` = ``6379``
- (IntOpt) Use this port to connect to redis host.
@ -26,7 +26,7 @@
-
* - ``host`` = ``127.0.0.1``
- (StrOpt) Host to locate redis.
* - ``password`` = ````
* - ``password`` = `` ``
- (StrOpt) Password for Redis server (optional).
* - ``port`` = ``6379``
- (IntOpt) Use this port to connect to redis host.

View File

@ -38,25 +38,25 @@
- (StrOpt) address prefix when sending to any server in group
* - ``idle_timeout`` = ``0``
- (IntOpt) Timeout for inactive connections (in seconds)
* - ``password`` = ````
* - ``password`` = `` ``
- (StrOpt) Password for message broker authentication
* - ``sasl_config_dir`` = ````
* - ``sasl_config_dir`` = `` ``
- (StrOpt) Path to directory that contains the SASL configuration
* - ``sasl_config_name`` = ````
* - ``sasl_config_name`` = `` ``
- (StrOpt) Name of configuration file (without .conf suffix)
* - ``sasl_mechanisms`` = ````
* - ``sasl_mechanisms`` = `` ``
- (StrOpt) Space separated list of acceptable SASL mechanisms
* - ``server_request_prefix`` = ``exclusive``
- (StrOpt) address prefix used when sending to a specific server
* - ``ssl_ca_file`` = ````
* - ``ssl_ca_file`` = `` ``
- (StrOpt) CA certificate PEM file to verify server certificate
* - ``ssl_cert_file`` = ````
* - ``ssl_cert_file`` = `` ``
- (StrOpt) Identifying certificate PEM file to present to clients
* - ``ssl_key_file`` = ````
* - ``ssl_key_file`` = `` ``
- (StrOpt) Private key PEM file used to sign cert_file certificate
* - ``ssl_key_password`` = ``None``
- (StrOpt) Password for decrypting ssl_key_file (if encrypted)
* - ``trace`` = ``False``
- (BoolOpt) Debug: dump AMQP frames to stdout
* - ``username`` = ````
* - ``username`` = `` ``
- (StrOpt) User name for message broker authentication

View File

@ -18,7 +18,7 @@
-
* - ``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.
* - ``bind`` = ````
* - ``bind`` = `` ``
- (ListOpt) 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.

View File

@ -30,7 +30,7 @@
- (IntOpt) 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
* - ``osapi_share_ext_list`` = ````
* - ``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.

View File

@ -24,7 +24,7 @@
- (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.
* - ``admin_user`` = ``None``
- (StrOpt) Service username.
* - ``auth_admin_prefix`` = ````
* - ``auth_admin_prefix`` = `` ``
- (StrOpt) 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.

View File

@ -30,7 +30,7 @@
- (ListOpt) Memcached servers or None for in process cache.
* - ``monkey_patch`` = ``False``
- (BoolOpt) Whether to log monkey patching.
* - ``monkey_patch_modules`` = ````
* - ``monkey_patch_modules`` = `` ``
- (ListOpt) List of modules or decorators to monkey patch.
* - ``my_ip`` = ``10.0.0.1``
- (StrOpt) IP address of this host.

View File

@ -30,7 +30,7 @@
- (StrOpt) 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.
* - ``glusterfs_servers`` = ````
* - ``glusterfs_servers`` = `` ``
- (ListOpt) List of GlusterFS servers that can be used to create shares. Each GlusterFS server should be of the form [remoteuser@]<volserver>, 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.

View File

@ -16,7 +16,7 @@
- Description
* - **[DEFAULT]**
-
* - ``hp3par_api_url`` = ````
* - ``hp3par_api_url`` = `` ``
- (StrOpt) 3PAR WSAPI Server Url like https://<3par ip>:8080/api/v1
* - ``hp3par_debug`` = ``False``
- (BoolOpt) Enable HTTP debugging to 3PAR
@ -24,17 +24,17 @@
- (StrOpt) The File Provisioning Group (FPG) to use
* - ``hp3par_fstore_per_share`` = ``False``
- (BoolOpt) Use one filestore per share
* - ``hp3par_password`` = ````
* - ``hp3par_password`` = `` ``
- (StrOpt) 3PAR password for the user specified in hp3par_username
* - ``hp3par_san_ip`` = ````
* - ``hp3par_san_ip`` = `` ``
- (StrOpt) IP address of SAN controller
* - ``hp3par_san_login`` = ````
* - ``hp3par_san_login`` = `` ``
- (StrOpt) Username for SAN controller
* - ``hp3par_san_password`` = ````
* - ``hp3par_san_password`` = `` ``
- (StrOpt) Password for SAN controller
* - ``hp3par_san_ssh_port`` = ``22``
- (PortOpt) SSH port to use with SAN
* - ``hp3par_share_ip_address`` = ````
* - ``hp3par_share_ip_address`` = `` ``
- (StrOpt) The IP address for shares not using a share server
* - ``hp3par_username`` = ````
* - ``hp3par_username`` = `` ``
- (StrOpt) 3PAR username with the 'edit' role

View File

@ -26,7 +26,7 @@
- (StrOpt) Qpid broker hostname.
* - ``qpid_hosts`` = ``$qpid_hostname:$qpid_port``
- (ListOpt) Qpid HA cluster host:port pairs.
* - ``qpid_password`` = ````
* - ``qpid_password`` = `` ``
- (StrOpt) Password for Qpid connection.
* - ``qpid_port`` = ``5672``
- (IntOpt) Qpid broker port.
@ -34,13 +34,13 @@
- (StrOpt) Transport to use, either 'tcp' or 'ssl'.
* - ``qpid_receiver_capacity`` = ``1``
- (IntOpt) The number of prefetched messages held by receiver.
* - ``qpid_sasl_mechanisms`` = ````
* - ``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`` = ````
* - ``qpid_username`` = `` ``
- (StrOpt) Username for Qpid connection.
* - ``send_single_reply`` = ``False``
- (BoolOpt) Send a single AMQP reply to call message. The current behaviour since oslo-incubator is to send two AMQP replies - first one with the payload, a second one to ensure the other have finish to send the payload. We are going to remove it in the N release, but we must keep backward compatible at the same time. This option provides such compatibility - it defaults to False in Liberty and can be turned on for early adopters with a new installations or for testing. Please note, that this option will be removed in the Mitaka release.

View File

@ -30,13 +30,13 @@
- (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.
* - ``kombu_ssl_ca_certs`` = ````
* - ``kombu_ssl_ca_certs`` = `` ``
- (StrOpt) SSL certification authority file (valid only if SSL enabled).
* - ``kombu_ssl_certfile`` = ````
* - ``kombu_ssl_certfile`` = `` ``
- (StrOpt) SSL cert file (valid only if SSL enabled).
* - ``kombu_ssl_keyfile`` = ````
* - ``kombu_ssl_keyfile`` = `` ``
- (StrOpt) SSL key file (valid only if SSL enabled).
* - ``kombu_ssl_version`` = ````
* - ``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.
* - ``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.

View File

@ -16,7 +16,7 @@
- Description
* - **[DEFAULT]**
-
* - ``password`` = ````
* - ``password`` = `` ``
- (StrOpt) Password for Redis server (optional).
* - ``port`` = ``6379``
- (IntOpt) Use this port to connect to redis host.
@ -24,7 +24,7 @@
-
* - ``host`` = ``127.0.0.1``
- (StrOpt) Host to locate redis.
* - ``password`` = ````
* - ``password`` = `` ``
- (StrOpt) Password for Redis server (optional).
* - ``port`` = ``6379``
- (IntOpt) Use this port to connect to redis host.

View File

@ -46,25 +46,25 @@
- (StrOpt) address prefix when sending to any server in group
* - ``idle_timeout`` = ``0``
- (IntOpt) Timeout for inactive connections (in seconds)
* - ``password`` = ````
* - ``password`` = `` ``
- (StrOpt) Password for message broker authentication
* - ``sasl_config_dir`` = ````
* - ``sasl_config_dir`` = `` ``
- (StrOpt) Path to directory that contains the SASL configuration
* - ``sasl_config_name`` = ````
* - ``sasl_config_name`` = `` ``
- (StrOpt) Name of configuration file (without .conf suffix)
* - ``sasl_mechanisms`` = ````
* - ``sasl_mechanisms`` = `` ``
- (StrOpt) Space separated list of acceptable SASL mechanisms
* - ``server_request_prefix`` = ``exclusive``
- (StrOpt) address prefix used when sending to a specific server
* - ``ssl_ca_file`` = ````
* - ``ssl_ca_file`` = `` ``
- (StrOpt) CA certificate PEM file to verify server certificate
* - ``ssl_cert_file`` = ````
* - ``ssl_cert_file`` = `` ``
- (StrOpt) Identifying certificate PEM file to present to clients
* - ``ssl_key_file`` = ````
* - ``ssl_key_file`` = `` ``
- (StrOpt) Private key PEM file used to sign cert_file certificate
* - ``ssl_key_password`` = ``None``
- (StrOpt) Password for decrypting ssl_key_file (if encrypted)
* - ``trace`` = ``False``
- (BoolOpt) Debug: dump AMQP frames to stdout
* - ``username`` = ````
* - ``username`` = `` ``
- (StrOpt) User name for message broker authentication

View File

@ -28,7 +28,7 @@
- (StrOpt) Default scheduler driver to use.
* - ``scheduler_host_manager`` = ``manila.scheduler.host_manager.HostManager``
- (StrOpt) The scheduler host manager class to use.
* - ``scheduler_json_config_location`` = ````
* - ``scheduler_json_config_location`` = `` ``
- (StrOpt) Absolute path to scheduler configuration JSON file.
* - ``scheduler_manager`` = ``manila.scheduler.manager.SchedulerManager``
- (StrOpt) Full class name for the scheduler manager.

View File

@ -40,7 +40,7 @@
- (ListOpt) Specify list of protocols to be allowed for share creation. Available values are '('NFS', 'CIFS', 'GLUSTERFS', 'HDFS')'
* - ``executor_thread_pool_size`` = ``64``
- (IntOpt) Size of executor thread pool.
* - ``hook_drivers`` = ````
* - ``hook_drivers`` = `` ``
- (ListOpt) Driver(s) to perform some additional actions before and after share driver actions and on a periodic basis. Default is [].
* - ``interface_driver`` = ``manila.network.linux.interface.OVSInterfaceDriver``
- (StrOpt) Vif driver. Used only with Neutron.

View File

@ -30,7 +30,7 @@
- (StrOpt) Data compression-off, lzjb, gzip-2, gzip, gzip-9.
* - ``zfssa_nas_logbias`` = ``latency``
- (StrOpt) Controls behavior when servicing synchronous writes.
* - ``zfssa_nas_mountpoint`` = ````
* - ``zfssa_nas_mountpoint`` = `` ``
- (StrOpt) Location of project in ZFS/SA.
* - ``zfssa_nas_quota_snap`` = ``true``
- (StrOpt) Controls whether a share quota includes snapshot.

View File

@ -26,7 +26,7 @@
- (BoolOpt) Services to be added to the available pool on create
* - ``enabled_apis`` = ``ec2, osapi_compute, metadata``
- (ListOpt) A list of APIs to enable by default
* - ``enabled_ssl_apis`` = ````
* - ``enabled_ssl_apis`` = `` ``
- (ListOpt) A list of APIs with enabled SSL
* - ``instance_name_template`` = ``instance-%08x``
- (StrOpt) Template string to be used to generate instance names
@ -38,7 +38,7 @@
- (ListOpt) 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
* - ``osapi_compute_ext_list`` = ````
* - ``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.
* - ``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.

View File

@ -18,7 +18,7 @@
-
* - ``enabled`` = ``True``
- (BoolOpt) DEPRECATED: Whether the V2.1 API is enabled or not. This option will be removed in the near future.
* - ``extensions_blacklist`` = ````
* - ``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.
* - ``extensions_whitelist`` = ````
* - ``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.

View File

@ -24,7 +24,7 @@
- (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.
* - ``admin_user`` = ``None``
- (StrOpt) Service username.
* - ``auth_admin_prefix`` = ````
* - ``auth_admin_prefix`` = `` ``
- (StrOpt) 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.

View File

@ -22,9 +22,9 @@
- (StrOpt) Driver to use for controlling virtualization. Options include: libvirt.LibvirtDriver, xenapi.XenAPIDriver, fake.FakeDriver, ironic.IronicDriver, vmwareapi.VMwareVCDriver, hyperv.HyperVDriver
* - ``compute_manager`` = ``nova.compute.manager.ComputeManager``
- (StrOpt) Full class name for the Manager for compute
* - ``compute_monitors`` = ````
* - ``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"]
* - ``compute_resources`` = ````
* - ``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.
* - ``compute_stats_class`` = ``nova.compute.stats.Stats``
- (StrOpt) Class that will manage stats for the local compute host

View File

@ -16,7 +16,7 @@
- Description
* - **[DEFAULT]**
-
* - ``console_allowed_origins`` = ````
* - ``console_allowed_origins`` = `` ``
- (ListOpt) Allowed Origin header hostnames for access to console proxy servers
* - ``console_public_hostname`` = ``localhost``
- (StrOpt) Publicly visible name for this console host

View File

@ -48,5 +48,5 @@
- (IntOpt) Number of minutes to lockout if triggered.
* - ``lockout_window`` = ``15``
- (IntOpt) Number of minutes for lockout window.
* - ``region_list`` = ````
* - ``region_list`` = `` ``
- (ListOpt) List of region=fqdn pairs separated by commas

View File

@ -20,7 +20,7 @@
- (StrOpt) Base URL that will be presented to users in links to glance resources
* - **[glance]**
-
* - ``allowed_direct_url_schemes`` = ````
* - ``allowed_direct_url_schemes`` = `` ``
- (ListOpt) 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
@ -36,5 +36,5 @@
- (StrOpt) Default protocol to use when connecting to glance. Set to https for SSL.
* - **[image_file_url]**
-
* - ``filesystems`` = ````
* - ``filesystems`` = `` ``
- (ListOpt) List of file systems that are configured in this file in the image_file_url:<list entry name> sections

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