diff --git a/doc/config-ref-rst/source/tables/aodh-api.rst b/doc/config-ref-rst/source/tables/aodh-api.rst index b20dbfa09c..82bfa6b2ad 100644 --- a/doc/config-ref-rst/source/tables/aodh-api.rst +++ b/doc/config-ref-rst/source/tables/aodh-api.rst @@ -29,6 +29,6 @@ * - **[oslo_middleware]** - * - ``max_request_body_size`` = ``114688`` - - (IntOpt) The maximum body size for each request, in bytes. + - (IntOpt) 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. diff --git a/doc/config-ref-rst/source/tables/aodh-auth_token.rst b/doc/config-ref-rst/source/tables/aodh-auth_token.rst index 4b6a5e709d..ce2894aeff 100644 --- a/doc/config-ref-rst/source/tables/aodh-auth_token.rst +++ b/doc/config-ref-rst/source/tables/aodh-auth_token.rst @@ -79,7 +79,7 @@ * - ``memcache_secret_key`` = ``None`` - (StrOpt) (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. + - (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. * - ``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. * - ``memcached_servers`` = ``None`` diff --git a/doc/config-ref-rst/source/tables/aodh-logging.rst b/doc/config-ref-rst/source/tables/aodh-logging.rst index bbe00ece82..3e600d567e 100644 --- a/doc/config-ref-rst/source/tables/aodh-logging.rst +++ b/doc/config-ref-rst/source/tables/aodh-logging.rst @@ -35,7 +35,7 @@ * - ``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. * - ``log_format`` = ``None`` - - (StrOpt) DEPRECATED. A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. This option is deprecated. Please use logging_context_format_string and logging_default_format_string instead. This option is ignored if log_config_append is set. + - (StrOpt) DEPRECATED. A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. This option is deprecated. Please use logging_context_format_string and logging_default_format_string instead. 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. * - ``logging_debug_format_suffix`` = ``%(funcName)s %(pathname)s:%(lineno)d`` diff --git a/doc/config-ref-rst/source/tables/aodh-policy.rst b/doc/config-ref-rst/source/tables/aodh-policy.rst index 3839d589e6..973d09a166 100644 --- a/doc/config-ref-rst/source/tables/aodh-policy.rst +++ b/doc/config-ref-rst/source/tables/aodh-policy.rst @@ -19,6 +19,6 @@ * - ``policy_default_rule`` = ``default`` - (StrOpt) 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. + - (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. * - ``policy_file`` = ``policy.json`` - (StrOpt) The JSON file that defines policies. diff --git a/doc/config-ref-rst/source/tables/aodh-qpid.rst b/doc/config-ref-rst/source/tables/aodh-qpid.rst index 4eae7fdadc..c2f7d80b61 100644 --- a/doc/config-ref-rst/source/tables/aodh-qpid.rst +++ b/doc/config-ref-rst/source/tables/aodh-qpid.rst @@ -39,7 +39,7 @@ * - ``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. + - (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`` diff --git a/doc/config-ref-rst/source/tables/ceilometer-api.rst b/doc/config-ref-rst/source/tables/ceilometer-api.rst index 2d75dc410f..f32bdc4962 100644 --- a/doc/config-ref-rst/source/tables/ceilometer-api.rst +++ b/doc/config-ref-rst/source/tables/ceilometer-api.rst @@ -55,6 +55,6 @@ * - **[oslo_middleware]** - * - ``max_request_body_size`` = ``114688`` - - (IntOpt) The maximum body size for each request, in bytes. + - (IntOpt) 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. diff --git a/doc/config-ref-rst/source/tables/ceilometer-auth_token.rst b/doc/config-ref-rst/source/tables/ceilometer-auth_token.rst index 0b9f5f4166..d914b6d5be 100644 --- a/doc/config-ref-rst/source/tables/ceilometer-auth_token.rst +++ b/doc/config-ref-rst/source/tables/ceilometer-auth_token.rst @@ -79,7 +79,7 @@ * - ``memcache_secret_key`` = ``None`` - (StrOpt) (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. + - (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. * - ``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. * - ``region_name`` = ``None`` diff --git a/doc/config-ref-rst/source/tables/ceilometer-logging.rst b/doc/config-ref-rst/source/tables/ceilometer-logging.rst index bbe00ece82..3e600d567e 100644 --- a/doc/config-ref-rst/source/tables/ceilometer-logging.rst +++ b/doc/config-ref-rst/source/tables/ceilometer-logging.rst @@ -35,7 +35,7 @@ * - ``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. * - ``log_format`` = ``None`` - - (StrOpt) DEPRECATED. A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. This option is deprecated. Please use logging_context_format_string and logging_default_format_string instead. This option is ignored if log_config_append is set. + - (StrOpt) DEPRECATED. A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. This option is deprecated. Please use logging_context_format_string and logging_default_format_string instead. 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. * - ``logging_debug_format_suffix`` = ``%(funcName)s %(pathname)s:%(lineno)d`` diff --git a/doc/config-ref-rst/source/tables/ceilometer-policy.rst b/doc/config-ref-rst/source/tables/ceilometer-policy.rst index 3839d589e6..973d09a166 100644 --- a/doc/config-ref-rst/source/tables/ceilometer-policy.rst +++ b/doc/config-ref-rst/source/tables/ceilometer-policy.rst @@ -19,6 +19,6 @@ * - ``policy_default_rule`` = ``default`` - (StrOpt) 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. + - (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. * - ``policy_file`` = ``policy.json`` - (StrOpt) The JSON file that defines policies. diff --git a/doc/config-ref-rst/source/tables/ceilometer-qpid.rst b/doc/config-ref-rst/source/tables/ceilometer-qpid.rst index 4eae7fdadc..c2f7d80b61 100644 --- a/doc/config-ref-rst/source/tables/ceilometer-qpid.rst +++ b/doc/config-ref-rst/source/tables/ceilometer-qpid.rst @@ -39,7 +39,7 @@ * - ``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. + - (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`` diff --git a/doc/config-ref-rst/source/tables/ceilometer-rpc.rst b/doc/config-ref-rst/source/tables/ceilometer-rpc.rst index a5abf261f4..0e9c0e1859 100644 --- a/doc/config-ref-rst/source/tables/ceilometer-rpc.rst +++ b/doc/config-ref-rst/source/tables/ceilometer-rpc.rst @@ -35,7 +35,7 @@ * - ``disable_process_locking`` = ``False`` - (BoolOpt) 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. + - (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. * - **[oslo_messaging_amqp]** - * - ``allow_insecure_clients`` = ``False`` diff --git a/doc/config-ref-rst/source/tables/cinder-api.rst b/doc/config-ref-rst/source/tables/cinder-api.rst index 0c5f60204a..a420b0bcda 100644 --- a/doc/config-ref-rst/source/tables/cinder-api.rst +++ b/doc/config-ref-rst/source/tables/cinder-api.rst @@ -79,7 +79,7 @@ * - **[oslo_middleware]** - * - ``max_request_body_size`` = ``114688`` - - (IntOpt) The maximum body size for each request, in bytes. + - (IntOpt) 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. * - **[oslo_policy]** @@ -87,7 +87,7 @@ * - ``policy_default_rule`` = ``default`` - (StrOpt) 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. + - (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. * - ``policy_file`` = ``policy.json`` - (StrOpt) The JSON file that defines policies. * - **[oslo_versionedobjects]** diff --git a/doc/config-ref-rst/source/tables/cinder-auth_token.rst b/doc/config-ref-rst/source/tables/cinder-auth_token.rst index 0b9f5f4166..d914b6d5be 100644 --- a/doc/config-ref-rst/source/tables/cinder-auth_token.rst +++ b/doc/config-ref-rst/source/tables/cinder-auth_token.rst @@ -79,7 +79,7 @@ * - ``memcache_secret_key`` = ``None`` - (StrOpt) (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. + - (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. * - ``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. * - ``region_name`` = ``None`` diff --git a/doc/config-ref-rst/source/tables/cinder-common.rst b/doc/config-ref-rst/source/tables/cinder-common.rst index 3a8859bfe1..9d954336a8 100644 --- a/doc/config-ref-rst/source/tables/cinder-common.rst +++ b/doc/config-ref-rst/source/tables/cinder-common.rst @@ -53,7 +53,7 @@ * - ``executor_thread_pool_size`` = ``64`` - (IntOpt) 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. + - (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`` = `` `` @@ -87,7 +87,7 @@ * - ``replication_api_class`` = ``cinder.replication.api.API`` - (StrOpt) 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 = device_target_id:,managed_backend_name:,key1:value1,key2:value2... + - (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 = device_target_id:,managed_backend_name:,key1:value1,key2:value2... * - ``report_interval`` = ``10`` - (IntOpt) Interval, in seconds, between nodes reporting state to datastore * - ``request_timeout`` = ``300`` @@ -103,7 +103,7 @@ * - ``sqlite_clean_db`` = ``clean.sqlite`` - (StrOpt) File name of clean sqlite db * - ``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 + - (StrOpt) 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. * - ``state_path`` = ``/var/lib/cinder`` @@ -111,7 +111,7 @@ * - ``storage_availability_zone`` = ``nova`` - (StrOpt) 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 + - (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 * - ``tcp_keepalive`` = ``True`` - (BoolOpt) Sets the value of TCP_KEEPALIVE (True/False) for each server socket. * - ``tcp_keepalive_count`` = ``None`` diff --git a/doc/config-ref-rst/source/tables/cinder-drbd.rst b/doc/config-ref-rst/source/tables/cinder-drbd.rst index 4b2fd9c5cd..df97722427 100644 --- a/doc/config-ref-rst/source/tables/cinder-drbd.rst +++ b/doc/config-ref-rst/source/tables/cinder-drbd.rst @@ -17,10 +17,6 @@ * - **[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. + - (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. * - ``drbdmanage_redundancy`` = ``1`` - (StrOpt) Number of nodes that should replicate the data. diff --git a/doc/config-ref-rst/source/tables/cinder-hpe3par.rst b/doc/config-ref-rst/source/tables/cinder-hpe3par.rst index cb5498a75e..ee27ec1462 100644 --- a/doc/config-ref-rst/source/tables/cinder-hpe3par.rst +++ b/doc/config-ref-rst/source/tables/cinder-hpe3par.rst @@ -31,8 +31,8 @@ * - ``hpe3par_password`` = `` `` - (StrOpt) 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 + - (StrOpt) 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. + - (StrOpt) 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 diff --git a/doc/config-ref-rst/source/tables/cinder-hplefthand.rst b/doc/config-ref-rst/source/tables/cinder-hpelefthand.rst similarity index 55% rename from doc/config-ref-rst/source/tables/cinder-hplefthand.rst rename to doc/config-ref-rst/source/tables/cinder-hpelefthand.rst index d8a8fe7bbc..af933d8eb3 100644 --- a/doc/config-ref-rst/source/tables/cinder-hplefthand.rst +++ b/doc/config-ref-rst/source/tables/cinder-hpelefthand.rst @@ -8,7 +8,7 @@ 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 LeftHand/StoreVirtual driver configuration options +.. list-table:: Description of HPE LeftHand/StoreVirtual driver configuration options :header-rows: 1 :class: config-ref-table @@ -16,15 +16,15 @@ - Description * - **[DEFAULT]** - - * - ``hplefthand_api_url`` = ``None`` - - (StrOpt) HP LeftHand WSAPI Server Url like https://:8081/lhos - * - ``hplefthand_clustername`` = ``None`` - - (StrOpt) HP LeftHand cluster name - * - ``hplefthand_debug`` = ``False`` + * - ``hpelefthand_api_url`` = ``None`` + - (StrOpt) HPE LeftHand WSAPI Server Url like https://:8081/lhos + * - ``hpelefthand_clustername`` = ``None`` + - (StrOpt) HPE LeftHand cluster name + * - ``hpelefthand_debug`` = ``False`` - (BoolOpt) Enable HTTP debugging to LeftHand - * - ``hplefthand_iscsi_chap_enabled`` = ``False`` + * - ``hpelefthand_iscsi_chap_enabled`` = ``False`` - (BoolOpt) Configure CHAP authentication for iSCSI connections (Default: Disabled) - * - ``hplefthand_password`` = ``None`` - - (StrOpt) HP LeftHand Super user password - * - ``hplefthand_username`` = ``None`` - - (StrOpt) HP LeftHand Super user username + * - ``hpelefthand_password`` = ``None`` + - (StrOpt) HPE LeftHand Super user password + * - ``hpelefthand_username`` = ``None`` + - (StrOpt) HPE LeftHand Super user username diff --git a/doc/config-ref-rst/source/tables/cinder-ibmnas.rst b/doc/config-ref-rst/source/tables/cinder-ibmnas.rst index b7b930f1d8..9b31b53d56 100644 --- a/doc/config-ref-rst/source/tables/cinder-ibmnas.rst +++ b/doc/config-ref-rst/source/tables/cinder-ibmnas.rst @@ -33,6 +33,6 @@ * - ``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`` = `` `` - - (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 . + - (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. diff --git a/doc/config-ref-rst/source/tables/cinder-images.rst b/doc/config-ref-rst/source/tables/cinder-images.rst index e4073e5433..5e6bf9c95b 100644 --- a/doc/config-ref-rst/source/tables/cinder-images.rst +++ b/doc/config-ref-rst/source/tables/cinder-images.rst @@ -17,7 +17,7 @@ * - **[DEFAULT]** - * - ``allowed_direct_url_schemes`` = `` `` - - (ListOpt) A list of url schemes that can be downloaded directly via the direct_url. Currently supported schemes: [file]. + - (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 * - ``glance_api_servers`` = ``$glance_host:$glance_port`` diff --git a/doc/config-ref-rst/source/tables/cinder-logging.rst b/doc/config-ref-rst/source/tables/cinder-logging.rst index c0d7d4df0a..f5c5bdecbd 100644 --- a/doc/config-ref-rst/source/tables/cinder-logging.rst +++ b/doc/config-ref-rst/source/tables/cinder-logging.rst @@ -37,7 +37,7 @@ * - ``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. * - ``log_format`` = ``None`` - - (StrOpt) DEPRECATED. A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. This option is deprecated. Please use logging_context_format_string and logging_default_format_string instead. This option is ignored if log_config_append is set. + - (StrOpt) DEPRECATED. A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. This option is deprecated. Please use logging_context_format_string and logging_default_format_string instead. 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. * - ``logging_debug_format_suffix`` = ``%(funcName)s %(pathname)s:%(lineno)d`` diff --git a/doc/config-ref-rst/source/tables/cinder-netapp_7mode_iscsi.rst b/doc/config-ref-rst/source/tables/cinder-netapp_7mode_iscsi.rst index d51a3547dd..5c9f6bcbd1 100644 --- a/doc/config-ref-rst/source/tables/cinder-netapp_7mode_iscsi.rst +++ b/doc/config-ref-rst/source/tables/cinder-netapp_7mode_iscsi.rst @@ -19,7 +19,7 @@ * - ``netapp_login`` = ``None`` - (StrOpt) 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. + - (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. * - ``netapp_password`` = ``None`` - (StrOpt) Password for the administrative user account specified in the netapp_login option. * - ``netapp_pool_name_search_pattern`` = ``(.+)`` @@ -29,7 +29,7 @@ * - ``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. * - ``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. + - (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. * - ``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. * - ``netapp_storage_protocol`` = ``None`` diff --git a/doc/config-ref-rst/source/tables/cinder-netapp_7mode_nfs.rst b/doc/config-ref-rst/source/tables/cinder-netapp_7mode_nfs.rst index e398024966..92655b0342 100644 --- a/doc/config-ref-rst/source/tables/cinder-netapp_7mode_nfs.rst +++ b/doc/config-ref-rst/source/tables/cinder-netapp_7mode_nfs.rst @@ -21,7 +21,7 @@ * - ``netapp_login`` = ``None`` - (StrOpt) 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. + - (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. * - ``netapp_password`` = ``None`` - (StrOpt) Password for the administrative user account specified in the netapp_login option. * - ``netapp_pool_name_search_pattern`` = ``(.+)`` diff --git a/doc/config-ref-rst/source/tables/cinder-netapp_cdot_iscsi.rst b/doc/config-ref-rst/source/tables/cinder-netapp_cdot_iscsi.rst index 83ca282a22..6bb9705d4f 100644 --- a/doc/config-ref-rst/source/tables/cinder-netapp_cdot_iscsi.rst +++ b/doc/config-ref-rst/source/tables/cinder-netapp_cdot_iscsi.rst @@ -23,7 +23,7 @@ * - ``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. * - ``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. + - (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. * - ``netapp_password`` = ``None`` - (StrOpt) Password for the administrative user account specified in the netapp_login option. * - ``netapp_pool_name_search_pattern`` = ``(.+)`` @@ -33,7 +33,7 @@ * - ``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. * - ``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. + - (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. * - ``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. * - ``netapp_storage_protocol`` = ``None`` diff --git a/doc/config-ref-rst/source/tables/cinder-netapp_cdot_nfs.rst b/doc/config-ref-rst/source/tables/cinder-netapp_cdot_nfs.rst index 41e86868be..b0fedd169d 100644 --- a/doc/config-ref-rst/source/tables/cinder-netapp_cdot_nfs.rst +++ b/doc/config-ref-rst/source/tables/cinder-netapp_cdot_nfs.rst @@ -29,7 +29,7 @@ * - ``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. * - ``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. + - (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. * - ``netapp_password`` = ``None`` - (StrOpt) Password for the administrative user account specified in the netapp_login option. * - ``netapp_pool_name_search_pattern`` = ``(.+)`` diff --git a/doc/config-ref-rst/source/tables/cinder-netapp_eseries_iscsi.rst b/doc/config-ref-rst/source/tables/cinder-netapp_eseries_iscsi.rst index f1f432557a..568e5778ea 100644 --- a/doc/config-ref-rst/source/tables/cinder-netapp_eseries_iscsi.rst +++ b/doc/config-ref-rst/source/tables/cinder-netapp_eseries_iscsi.rst @@ -25,7 +25,7 @@ * - ``netapp_login`` = ``None`` - (StrOpt) 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. + - (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. * - ``netapp_password`` = ``None`` - (StrOpt) Password for the administrative user account specified in the netapp_login option. * - ``netapp_pool_name_search_pattern`` = ``(.+)`` diff --git a/doc/config-ref-rst/source/tables/cinder-qpid.rst b/doc/config-ref-rst/source/tables/cinder-qpid.rst index 4eae7fdadc..c2f7d80b61 100644 --- a/doc/config-ref-rst/source/tables/cinder-qpid.rst +++ b/doc/config-ref-rst/source/tables/cinder-qpid.rst @@ -39,7 +39,7 @@ * - ``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. + - (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`` diff --git a/doc/config-ref-rst/source/tables/cinder-rpc.rst b/doc/config-ref-rst/source/tables/cinder-rpc.rst index 56a7891f5f..410c841738 100644 --- a/doc/config-ref-rst/source/tables/cinder-rpc.rst +++ b/doc/config-ref-rst/source/tables/cinder-rpc.rst @@ -33,7 +33,7 @@ * - ``disable_process_locking`` = ``False`` - (BoolOpt) 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. + - (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. * - **[oslo_messaging_amqp]** - * - ``allow_insecure_clients`` = ``False`` diff --git a/doc/config-ref-rst/source/tables/cinder-smbfs.rst b/doc/config-ref-rst/source/tables/cinder-smbfs.rst index 5b5ad20048..9d7dcb1ce7 100644 --- a/doc/config-ref-rst/source/tables/cinder-smbfs.rst +++ b/doc/config-ref-rst/source/tables/cinder-smbfs.rst @@ -25,7 +25,7 @@ * - ``smbfs_mount_point_base`` = ``$state_path/mnt`` - (StrOpt) 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. + - (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. * - ``smbfs_shares_config`` = ``/etc/cinder/smbfs_shares`` - (StrOpt) File with the list of available smbfs shares. * - ``smbfs_sparsed_volumes`` = ``True`` diff --git a/doc/config-ref-rst/source/tables/cinder-solidfire.rst b/doc/config-ref-rst/source/tables/cinder-solidfire.rst index 13d0011793..1703e1faa3 100644 --- a/doc/config-ref-rst/source/tables/cinder-solidfire.rst +++ b/doc/config-ref-rst/source/tables/cinder-solidfire.rst @@ -17,7 +17,7 @@ * - **[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. + - (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. * - ``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. * - ``sf_allow_tenant_qos`` = ``False`` @@ -26,11 +26,13 @@ - (PortOpt) 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; + * - ``sf_enable_vag`` = ``False`` + - (BoolOpt) 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. + - (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. * - ``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. * - ``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). * - ``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-'. + - (StrOpt) 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-ref-rst/source/tables/cinder-storage_ceph.rst b/doc/config-ref-rst/source/tables/cinder-storage_ceph.rst index 832e70fe6e..cc3f7f31bd 100644 --- a/doc/config-ref-rst/source/tables/cinder-storage_ceph.rst +++ b/doc/config-ref-rst/source/tables/cinder-storage_ceph.rst @@ -39,4 +39,4 @@ * - ``rbd_user`` = ``None`` - (StrOpt) 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. + - (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. diff --git a/doc/config-ref-rst/source/tables/cinder-storage_gpfs.rst b/doc/config-ref-rst/source/tables/cinder-storage_gpfs.rst index 35d6e34057..e5933edc67 100644 --- a/doc/config-ref-rst/source/tables/cinder-storage_gpfs.rst +++ b/doc/config-ref-rst/source/tables/cinder-storage_gpfs.rst @@ -17,11 +17,11 @@ * - **[DEFAULT]** - * - ``gpfs_images_dir`` = ``None`` - - (StrOpt) Specifies the path of the Image service repository in GPFS. Leave undefined if not storing images in GPFS. + - (StrOpt) 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. + - (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. * - ``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. + - (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. * - ``gpfs_mount_point_base`` = ``None`` - (StrOpt) Specifies the path of the GPFS directory where Block Storage volume and snapshot files are stored. * - ``gpfs_sparse_volumes`` = ``True`` diff --git a/doc/config-ref-rst/source/tables/cinder-storage_nfs.rst b/doc/config-ref-rst/source/tables/cinder-storage_nfs.rst index d8a82f6932..c16fd2c102 100644 --- a/doc/config-ref-rst/source/tables/cinder-storage_nfs.rst +++ b/doc/config-ref-rst/source/tables/cinder-storage_nfs.rst @@ -17,13 +17,13 @@ * - **[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. + - (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. * - ``nfs_mount_options`` = ``None`` - (StrOpt) 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. + - (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. * - ``nfs_shares_config`` = ``/etc/cinder/nfs_shares`` - (StrOpt) File with the list of available NFS shares * - ``nfs_sparsed_volumes`` = ``True`` diff --git a/doc/config-ref-rst/source/tables/glance-api.rst b/doc/config-ref-rst/source/tables/glance-api.rst index 67e0f8ec62..9eb81a160f 100644 --- a/doc/config-ref-rst/source/tables/glance-api.rst +++ b/doc/config-ref-rst/source/tables/glance-api.rst @@ -47,7 +47,7 @@ * - ``max_request_id_length`` = ``64`` - (IntOpt) 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. + - (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. * - ``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. * - ``send_identity_headers`` = ``False`` @@ -55,7 +55,7 @@ * - ``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. * - ``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. + - (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. * - ``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. * - **[glance_store]** @@ -69,7 +69,7 @@ * - **[oslo_middleware]** - * - ``max_request_body_size`` = ``114688`` - - (IntOpt) The maximum body size for each request, in bytes. + - (IntOpt) 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. * - **[paste_deploy]** diff --git a/doc/config-ref-rst/source/tables/glance-auth_token.rst b/doc/config-ref-rst/source/tables/glance-auth_token.rst index 0b9f5f4166..d914b6d5be 100644 --- a/doc/config-ref-rst/source/tables/glance-auth_token.rst +++ b/doc/config-ref-rst/source/tables/glance-auth_token.rst @@ -79,7 +79,7 @@ * - ``memcache_secret_key`` = ``None`` - (StrOpt) (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. + - (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. * - ``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. * - ``region_name`` = ``None`` diff --git a/doc/config-ref-rst/source/tables/glance-common.rst b/doc/config-ref-rst/source/tables/glance-common.rst index c098c20426..a462e435fc 100644 --- a/doc/config-ref-rst/source/tables/glance-common.rst +++ b/doc/config-ref-rst/source/tables/glance-common.rst @@ -23,7 +23,7 @@ * - ``backlog`` = ``4096`` - (IntOpt) 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. + - (StrOpt) Address to bind the server. Useful when selecting a particular network interface. * - ``bind_port`` = ``None`` - (PortOpt) The port on which the server will listen. * - ``data_api`` = ``glance.db.sqlalchemy.api`` diff --git a/doc/config-ref-rst/source/tables/glance-filesystem.rst b/doc/config-ref-rst/source/tables/glance-filesystem.rst index f145d6c660..0c30d91290 100644 --- a/doc/config-ref-rst/source/tables/glance-filesystem.rst +++ b/doc/config-ref-rst/source/tables/glance-filesystem.rst @@ -23,4 +23,4 @@ * - ``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. * - ``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'. + - (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'. diff --git a/doc/config-ref-rst/source/tables/glance-logging.rst b/doc/config-ref-rst/source/tables/glance-logging.rst index bbe00ece82..3e600d567e 100644 --- a/doc/config-ref-rst/source/tables/glance-logging.rst +++ b/doc/config-ref-rst/source/tables/glance-logging.rst @@ -35,7 +35,7 @@ * - ``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. * - ``log_format`` = ``None`` - - (StrOpt) DEPRECATED. A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. This option is deprecated. Please use logging_context_format_string and logging_default_format_string instead. This option is ignored if log_config_append is set. + - (StrOpt) DEPRECATED. A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. This option is deprecated. Please use logging_context_format_string and logging_default_format_string instead. 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. * - ``logging_debug_format_suffix`` = ``%(funcName)s %(pathname)s:%(lineno)d`` diff --git a/doc/config-ref-rst/source/tables/glance-policy.rst b/doc/config-ref-rst/source/tables/glance-policy.rst index 3839d589e6..973d09a166 100644 --- a/doc/config-ref-rst/source/tables/glance-policy.rst +++ b/doc/config-ref-rst/source/tables/glance-policy.rst @@ -19,6 +19,6 @@ * - ``policy_default_rule`` = ``default`` - (StrOpt) 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. + - (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. * - ``policy_file`` = ``policy.json`` - (StrOpt) The JSON file that defines policies. diff --git a/doc/config-ref-rst/source/tables/glance-qpid.rst b/doc/config-ref-rst/source/tables/glance-qpid.rst index 4eae7fdadc..c2f7d80b61 100644 --- a/doc/config-ref-rst/source/tables/glance-qpid.rst +++ b/doc/config-ref-rst/source/tables/glance-qpid.rst @@ -39,7 +39,7 @@ * - ``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. + - (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`` diff --git a/doc/config-ref-rst/source/tables/glance-rbd.rst b/doc/config-ref-rst/source/tables/glance-rbd.rst index 17443b19bb..08eadfa500 100644 --- a/doc/config-ref-rst/source/tables/glance-rbd.rst +++ b/doc/config-ref-rst/source/tables/glance-rbd.rst @@ -22,7 +22,7 @@ - (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 * - ``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. - * - ``rbd_store_pool`` = ``images`` + * - ``rbd_store_pool`` = ``localhost`` - (StrOpt) 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) diff --git a/doc/config-ref-rst/source/tables/glance-registry.rst b/doc/config-ref-rst/source/tables/glance-registry.rst index 6c7ec5c0eb..6c8e480618 100644 --- a/doc/config-ref-rst/source/tables/glance-registry.rst +++ b/doc/config-ref-rst/source/tables/glance-registry.rst @@ -37,7 +37,7 @@ * - ``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 * - ``registry_client_protocol`` = ``http`` - - (StrOpt) The protocol to use for communication with the registry server. Either http or https. + - (StrOpt) 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. * - ``registry_host`` = ``0.0.0.0`` diff --git a/doc/config-ref-rst/source/tables/glance-rpc.rst b/doc/config-ref-rst/source/tables/glance-rpc.rst index 90ffc38044..ca96e7bcb4 100644 --- a/doc/config-ref-rst/source/tables/glance-rpc.rst +++ b/doc/config-ref-rst/source/tables/glance-rpc.rst @@ -33,7 +33,7 @@ * - ``disable_process_locking`` = ``False`` - (BoolOpt) 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. + - (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. * - **[oslo_messaging_amqp]** - * - ``allow_insecure_clients`` = ``False`` diff --git a/doc/config-ref-rst/source/tables/heat-api.rst b/doc/config-ref-rst/source/tables/heat-api.rst index 1542c4b9fb..ae927cebea 100644 --- a/doc/config-ref-rst/source/tables/heat-api.rst +++ b/doc/config-ref-rst/source/tables/heat-api.rst @@ -95,13 +95,13 @@ * - ``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). * - ``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. + - (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`` = ``4`` - (IntOpt) Number of workers for Heat service. * - **[oslo_middleware]** - * - ``max_request_body_size`` = ``114688`` - - (IntOpt) The maximum body size for each request, in bytes. + - (IntOpt) 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. * - **[oslo_policy]** @@ -109,7 +109,7 @@ * - ``policy_default_rule`` = ``default`` - (StrOpt) 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. + - (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. * - ``policy_file`` = ``policy.json`` - (StrOpt) The JSON file that defines policies. * - **[oslo_versionedobjects]** diff --git a/doc/config-ref-rst/source/tables/heat-auth_token.rst b/doc/config-ref-rst/source/tables/heat-auth_token.rst index 4b6a5e709d..ce2894aeff 100644 --- a/doc/config-ref-rst/source/tables/heat-auth_token.rst +++ b/doc/config-ref-rst/source/tables/heat-auth_token.rst @@ -79,7 +79,7 @@ * - ``memcache_secret_key`` = ``None`` - (StrOpt) (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. + - (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. * - ``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. * - ``memcached_servers`` = ``None`` diff --git a/doc/config-ref-rst/source/tables/heat-cfn_api.rst b/doc/config-ref-rst/source/tables/heat-cfn_api.rst index c0f946ffb8..d3aa50738a 100644 --- a/doc/config-ref-rst/source/tables/heat-cfn_api.rst +++ b/doc/config-ref-rst/source/tables/heat-cfn_api.rst @@ -35,6 +35,6 @@ * - ``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). * - ``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. + - (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. diff --git a/doc/config-ref-rst/source/tables/heat-cloudwatch_api.rst b/doc/config-ref-rst/source/tables/heat-cloudwatch_api.rst index 4b7754f222..5a06dc4910 100644 --- a/doc/config-ref-rst/source/tables/heat-cloudwatch_api.rst +++ b/doc/config-ref-rst/source/tables/heat-cloudwatch_api.rst @@ -35,6 +35,6 @@ * - ``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.) * - ``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. + - (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. diff --git a/doc/config-ref-rst/source/tables/heat-common.rst b/doc/config-ref-rst/source/tables/heat-common.rst index 02b9ecaaf4..debf2a122c 100644 --- a/doc/config-ref-rst/source/tables/heat-common.rst +++ b/doc/config-ref-rst/source/tables/heat-common.rst @@ -51,13 +51,13 @@ * - **[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. + - (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. * - ``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: ":". * - ``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. * - ``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. + - (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. * - ``enabled`` = ``False`` - (BoolOpt) Global toggle for caching. * - ``expiration_time`` = ``600`` diff --git a/doc/config-ref-rst/source/tables/heat-logging.rst b/doc/config-ref-rst/source/tables/heat-logging.rst index 4acc74cfcc..fa14587627 100644 --- a/doc/config-ref-rst/source/tables/heat-logging.rst +++ b/doc/config-ref-rst/source/tables/heat-logging.rst @@ -35,7 +35,7 @@ * - ``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. * - ``log_format`` = ``None`` - - (StrOpt) DEPRECATED. A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. This option is deprecated. Please use logging_context_format_string and logging_default_format_string instead. This option is ignored if log_config_append is set. + - (StrOpt) DEPRECATED. A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. This option is deprecated. Please use logging_context_format_string and logging_default_format_string instead. 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. * - ``logging_debug_format_suffix`` = ``%(funcName)s %(pathname)s:%(lineno)d`` diff --git a/doc/config-ref-rst/source/tables/heat-qpid.rst b/doc/config-ref-rst/source/tables/heat-qpid.rst index 4eae7fdadc..c2f7d80b61 100644 --- a/doc/config-ref-rst/source/tables/heat-qpid.rst +++ b/doc/config-ref-rst/source/tables/heat-qpid.rst @@ -39,7 +39,7 @@ * - ``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. + - (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`` diff --git a/doc/config-ref-rst/source/tables/heat-rpc.rst b/doc/config-ref-rst/source/tables/heat-rpc.rst index 313af4ab4d..0fd232df15 100644 --- a/doc/config-ref-rst/source/tables/heat-rpc.rst +++ b/doc/config-ref-rst/source/tables/heat-rpc.rst @@ -33,7 +33,7 @@ * - ``disable_process_locking`` = ``False`` - (BoolOpt) 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. + - (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. * - **[oslo_messaging_amqp]** - * - ``allow_insecure_clients`` = ``False`` diff --git a/doc/config-ref-rst/source/tables/heat-testing.rst b/doc/config-ref-rst/source/tables/heat-testing.rst index 4748d221d0..3d1020b33b 100644 --- a/doc/config-ref-rst/source/tables/heat-testing.rst +++ b/doc/config-ref-rst/source/tables/heat-testing.rst @@ -16,6 +16,8 @@ - Description * - **[profiler]** - + * - ``hmac_keys`` = ``SECRET_KEY`` + - (StrOpt) Secret key to use to sign tracing messages. * - ``profiler_enabled`` = ``False`` - (BoolOpt) If False fully disable profiling feature. * - ``trace_sqlalchemy`` = ``False`` diff --git a/doc/config-ref-rst/source/tables/ironic-api.rst b/doc/config-ref-rst/source/tables/ironic-api.rst index 8a55004d5b..7e0e64ab12 100644 --- a/doc/config-ref-rst/source/tables/ironic-api.rst +++ b/doc/config-ref-rst/source/tables/ironic-api.rst @@ -16,6 +16,8 @@ - Description * - **[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. * - ``host_ip`` = ``0.0.0.0`` - (StrOpt) The IP address on which ironic-api listens. * - ``max_limit`` = ``1000`` @@ -55,7 +57,7 @@ * - **[oslo_middleware]** - * - ``max_request_body_size`` = ``114688`` - - (IntOpt) The maximum body size for each request, in bytes. + - (IntOpt) 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. * - **[oslo_versionedobjects]** diff --git a/doc/config-ref-rst/source/tables/ironic-auth_token.rst b/doc/config-ref-rst/source/tables/ironic-auth_token.rst index 4b6a5e709d..ce2894aeff 100644 --- a/doc/config-ref-rst/source/tables/ironic-auth_token.rst +++ b/doc/config-ref-rst/source/tables/ironic-auth_token.rst @@ -79,7 +79,7 @@ * - ``memcache_secret_key`` = ``None`` - (StrOpt) (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. + - (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. * - ``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. * - ``memcached_servers`` = ``None`` diff --git a/doc/config-ref-rst/source/tables/ironic-common.rst b/doc/config-ref-rst/source/tables/ironic-common.rst index b36acf3236..4192eac06c 100644 --- a/doc/config-ref-rst/source/tables/ironic-common.rst +++ b/doc/config-ref-rst/source/tables/ironic-common.rst @@ -34,8 +34,8 @@ - (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. * - ``hash_ring_reset_interval`` = ``180`` - (IntOpt) Interval (in seconds) between hash ring resets. - * - ``host`` = ``shock.local.net`` - - (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. + * - ``host`` = ``sd-52009.dedibox.fr`` + - (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. * - ``isolinux_bin`` = ``/usr/lib/syslinux/isolinux.bin`` - (StrOpt) Path to isolinux binary file. * - ``isolinux_config_template`` = ``$pybasedir/common/isolinux_config.template`` diff --git a/doc/config-ref-rst/source/tables/ironic-glance.rst b/doc/config-ref-rst/source/tables/ironic-glance.rst index 6583aa5ff3..95b7b782e4 100644 --- a/doc/config-ref-rst/source/tables/ironic-glance.rst +++ b/doc/config-ref-rst/source/tables/ironic-glance.rst @@ -17,7 +17,7 @@ * - **[glance]** - * - ``allowed_direct_url_schemes`` = `` `` - - (ListOpt) A list of URL schemes that can be downloaded directly via the direct_url. Currently supported schemes: [file]. + - (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. * - ``glance_api_insecure`` = ``False`` diff --git a/doc/config-ref-rst/source/tables/ironic-logging.rst b/doc/config-ref-rst/source/tables/ironic-logging.rst index 0ef7dd239a..27b15e6caf 100644 --- a/doc/config-ref-rst/source/tables/ironic-logging.rst +++ b/doc/config-ref-rst/source/tables/ironic-logging.rst @@ -35,7 +35,7 @@ * - ``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. * - ``log_format`` = ``None`` - - (StrOpt) DEPRECATED. A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. This option is deprecated. Please use logging_context_format_string and logging_default_format_string instead. This option is ignored if log_config_append is set. + - (StrOpt) DEPRECATED. A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. This option is deprecated. Please use logging_context_format_string and logging_default_format_string instead. 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. * - ``logging_debug_format_suffix`` = ``%(funcName)s %(pathname)s:%(lineno)d`` diff --git a/doc/config-ref-rst/source/tables/ironic-policy.rst b/doc/config-ref-rst/source/tables/ironic-policy.rst index 3839d589e6..973d09a166 100644 --- a/doc/config-ref-rst/source/tables/ironic-policy.rst +++ b/doc/config-ref-rst/source/tables/ironic-policy.rst @@ -19,6 +19,6 @@ * - ``policy_default_rule`` = ``default`` - (StrOpt) 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. + - (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. * - ``policy_file`` = ``policy.json`` - (StrOpt) The JSON file that defines policies. diff --git a/doc/config-ref-rst/source/tables/ironic-qpid.rst b/doc/config-ref-rst/source/tables/ironic-qpid.rst index 4eae7fdadc..c2f7d80b61 100644 --- a/doc/config-ref-rst/source/tables/ironic-qpid.rst +++ b/doc/config-ref-rst/source/tables/ironic-qpid.rst @@ -39,7 +39,7 @@ * - ``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. + - (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`` diff --git a/doc/config-ref-rst/source/tables/ironic-rpc.rst b/doc/config-ref-rst/source/tables/ironic-rpc.rst index df8cf63e62..a122aa0edb 100644 --- a/doc/config-ref-rst/source/tables/ironic-rpc.rst +++ b/doc/config-ref-rst/source/tables/ironic-rpc.rst @@ -31,7 +31,7 @@ * - ``disable_process_locking`` = ``False`` - (BoolOpt) 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. + - (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. * - **[oslo_messaging_amqp]** - * - ``allow_insecure_clients`` = ``False`` diff --git a/doc/config-ref-rst/source/tables/keystone-api.rst b/doc/config-ref-rst/source/tables/keystone-api.rst index 2c9b96c049..7032bf3f92 100644 --- a/doc/config-ref-rst/source/tables/keystone-api.rst +++ b/doc/config-ref-rst/source/tables/keystone-api.rst @@ -77,7 +77,7 @@ * - **[oslo_middleware]** - * - ``max_request_body_size`` = ``114688`` - - (IntOpt) The maximum body size for each request, in bytes. + - (IntOpt) 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. * - **[paste_deploy]** diff --git a/doc/config-ref-rst/source/tables/keystone-auth_token.rst b/doc/config-ref-rst/source/tables/keystone-auth_token.rst index 0b9f5f4166..d914b6d5be 100644 --- a/doc/config-ref-rst/source/tables/keystone-auth_token.rst +++ b/doc/config-ref-rst/source/tables/keystone-auth_token.rst @@ -79,7 +79,7 @@ * - ``memcache_secret_key`` = ``None`` - (StrOpt) (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. + - (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. * - ``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. * - ``region_name`` = ``None`` diff --git a/doc/config-ref-rst/source/tables/keystone-cache.rst b/doc/config-ref-rst/source/tables/keystone-cache.rst index 5e2707fd3f..82dde86f51 100644 --- a/doc/config-ref-rst/source/tables/keystone-cache.rst +++ b/doc/config-ref-rst/source/tables/keystone-cache.rst @@ -17,13 +17,13 @@ * - **[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. + - (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. * - ``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: ":". * - ``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. * - ``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. + - (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. * - ``enabled`` = ``False`` - (BoolOpt) Global toggle for caching. * - ``expiration_time`` = ``600`` diff --git a/doc/config-ref-rst/source/tables/keystone-common.rst b/doc/config-ref-rst/source/tables/keystone-common.rst index c8f2713ed2..b13bcd8b67 100644 --- a/doc/config-ref-rst/source/tables/keystone-common.rst +++ b/doc/config-ref-rst/source/tables/keystone-common.rst @@ -29,4 +29,4 @@ * - ``disable_process_locking`` = ``False`` - (BoolOpt) 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. + - (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. diff --git a/doc/config-ref-rst/source/tables/keystone-logging.rst b/doc/config-ref-rst/source/tables/keystone-logging.rst index bbe00ece82..3e600d567e 100644 --- a/doc/config-ref-rst/source/tables/keystone-logging.rst +++ b/doc/config-ref-rst/source/tables/keystone-logging.rst @@ -35,7 +35,7 @@ * - ``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. * - ``log_format`` = ``None`` - - (StrOpt) DEPRECATED. A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. This option is deprecated. Please use logging_context_format_string and logging_default_format_string instead. This option is ignored if log_config_append is set. + - (StrOpt) DEPRECATED. A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. This option is deprecated. Please use logging_context_format_string and logging_default_format_string instead. 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. * - ``logging_debug_format_suffix`` = ``%(funcName)s %(pathname)s:%(lineno)d`` diff --git a/doc/config-ref-rst/source/tables/keystone-policy.rst b/doc/config-ref-rst/source/tables/keystone-policy.rst index de8b81be56..b1b09e6d36 100644 --- a/doc/config-ref-rst/source/tables/keystone-policy.rst +++ b/doc/config-ref-rst/source/tables/keystone-policy.rst @@ -19,7 +19,7 @@ * - ``policy_default_rule`` = ``default`` - (StrOpt) 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. + - (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. * - ``policy_file`` = ``policy.json`` - (StrOpt) The JSON file that defines policies. * - **[policy]** diff --git a/doc/config-ref-rst/source/tables/keystone-qpid.rst b/doc/config-ref-rst/source/tables/keystone-qpid.rst index 4eae7fdadc..c2f7d80b61 100644 --- a/doc/config-ref-rst/source/tables/keystone-qpid.rst +++ b/doc/config-ref-rst/source/tables/keystone-qpid.rst @@ -39,7 +39,7 @@ * - ``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. + - (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`` diff --git a/doc/config-ref-rst/source/tables/manila-api.rst b/doc/config-ref-rst/source/tables/manila-api.rst index a8321168e8..4886a942aa 100644 --- a/doc/config-ref-rst/source/tables/manila-api.rst +++ b/doc/config-ref-rst/source/tables/manila-api.rst @@ -51,7 +51,7 @@ * - **[oslo_middleware]** - * - ``max_request_body_size`` = ``114688`` - - (IntOpt) The maximum body size for each request, in bytes. + - (IntOpt) 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. * - **[oslo_policy]** @@ -59,6 +59,6 @@ * - ``policy_default_rule`` = ``default`` - (StrOpt) 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. + - (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. * - ``policy_file`` = ``policy.json`` - (StrOpt) The JSON file that defines policies. diff --git a/doc/config-ref-rst/source/tables/manila-auth_token.rst b/doc/config-ref-rst/source/tables/manila-auth_token.rst index 4e878e4390..17fd7f073b 100644 --- a/doc/config-ref-rst/source/tables/manila-auth_token.rst +++ b/doc/config-ref-rst/source/tables/manila-auth_token.rst @@ -79,7 +79,7 @@ * - ``memcache_secret_key`` = ``None`` - (StrOpt) (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. + - (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. * - ``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. * - ``memcached_servers`` = ``None`` diff --git a/doc/config-ref-rst/source/tables/manila-common.rst b/doc/config-ref-rst/source/tables/manila-common.rst index 5429991ac3..b72997e772 100644 --- a/doc/config-ref-rst/source/tables/manila-common.rst +++ b/doc/config-ref-rst/source/tables/manila-common.rst @@ -23,7 +23,7 @@ * - ``enable_new_services`` = ``True`` - (BoolOpt) 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. + - (StrOpt) 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. * - ``memcached_servers`` = ``None`` diff --git a/doc/config-ref-rst/source/tables/manila-ganesha.rst b/doc/config-ref-rst/source/tables/manila-ganesha.rst index 5e38c1e7f6..3ab84a6b47 100644 --- a/doc/config-ref-rst/source/tables/manila-ganesha.rst +++ b/doc/config-ref-rst/source/tables/manila-ganesha.rst @@ -27,6 +27,6 @@ * - ``ganesha_export_template_dir`` = ``/etc/manila/ganesha-export-templ.d`` - (StrOpt) 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.) + - (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.) * - ``ganesha_service_name`` = ``ganesha.nfsd`` - (StrOpt) Name of the ganesha nfs service. diff --git a/doc/config-ref-rst/source/tables/manila-hpe3par.rst b/doc/config-ref-rst/source/tables/manila-hpe3par.rst new file mode 100644 index 0000000000..992466d8fc --- /dev/null +++ b/doc/config-ref-rst/source/tables/manila-hpe3par.rst @@ -0,0 +1,40 @@ +.. + 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 hpe3par configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``hpe3par_api_url`` = `` `` + - (StrOpt) 3PAR WSAPI Server Url like https://<3par ip>:8080/api/v1 + * - ``hpe3par_debug`` = ``False`` + - (BoolOpt) Enable HTTP debugging to 3PAR + * - ``hpe3par_fpg`` = ``OpenStack`` + - (StrOpt) The File Provisioning Group (FPG) to use + * - ``hpe3par_fstore_per_share`` = ``False`` + - (BoolOpt) Use one filestore per share + * - ``hpe3par_password`` = `` `` + - (StrOpt) 3PAR password for the user specified in hpe3par_username + * - ``hpe3par_san_ip`` = `` `` + - (StrOpt) IP address of SAN controller + * - ``hpe3par_san_login`` = `` `` + - (StrOpt) Username for SAN controller + * - ``hpe3par_san_password`` = `` `` + - (StrOpt) Password for SAN controller + * - ``hpe3par_san_ssh_port`` = ``22`` + - (PortOpt) SSH port to use with SAN + * - ``hpe3par_share_ip_address`` = `` `` + - (StrOpt) The IP address for shares not using a share server + * - ``hpe3par_username`` = `` `` + - (StrOpt) 3PAR username with the 'edit' role diff --git a/doc/config-ref-rst/source/tables/manila-logging.rst b/doc/config-ref-rst/source/tables/manila-logging.rst index f091c4bf5d..fc3f76d2d5 100644 --- a/doc/config-ref-rst/source/tables/manila-logging.rst +++ b/doc/config-ref-rst/source/tables/manila-logging.rst @@ -37,7 +37,7 @@ * - ``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. * - ``log_format`` = ``None`` - - (StrOpt) DEPRECATED. A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. This option is deprecated. Please use logging_context_format_string and logging_default_format_string instead. This option is ignored if log_config_append is set. + - (StrOpt) DEPRECATED. A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. This option is deprecated. Please use logging_context_format_string and logging_default_format_string instead. 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. * - ``logging_debug_format_suffix`` = ``%(funcName)s %(pathname)s:%(lineno)d`` diff --git a/doc/config-ref-rst/source/tables/manila-netapp.rst b/doc/config-ref-rst/source/tables/manila-netapp.rst index 6b5a025a20..9510f388f5 100644 --- a/doc/config-ref-rst/source/tables/manila-netapp.rst +++ b/doc/config-ref-rst/source/tables/manila-netapp.rst @@ -37,7 +37,7 @@ * - ``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. * - ``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. + - (StrOpt) 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. * - ``netapp_volume_name_template`` = ``share_%(share_id)s`` diff --git a/doc/config-ref-rst/source/tables/manila-qpid.rst b/doc/config-ref-rst/source/tables/manila-qpid.rst index 813257e8b8..ae394294eb 100644 --- a/doc/config-ref-rst/source/tables/manila-qpid.rst +++ b/doc/config-ref-rst/source/tables/manila-qpid.rst @@ -39,7 +39,7 @@ * - ``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. + - (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`` diff --git a/doc/config-ref-rst/source/tables/manila-rpc.rst b/doc/config-ref-rst/source/tables/manila-rpc.rst index 26f91e91d8..9fa9572c1c 100644 --- a/doc/config-ref-rst/source/tables/manila-rpc.rst +++ b/doc/config-ref-rst/source/tables/manila-rpc.rst @@ -33,7 +33,7 @@ * - ``disable_process_locking`` = ``False`` - (BoolOpt) 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. + - (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. * - **[oslo_messaging_amqp]** - * - ``allow_insecure_clients`` = ``False`` diff --git a/doc/config-ref-rst/source/tables/manila-share.rst b/doc/config-ref-rst/source/tables/manila-share.rst index 096fdab072..78abe1a636 100644 --- a/doc/config-ref-rst/source/tables/manila-share.rst +++ b/doc/config-ref-rst/source/tables/manila-share.rst @@ -121,7 +121,7 @@ * - ``share_snapshot_name_template`` = ``share-snapshot-%s`` - (StrOpt) 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. + - (StrOpt) Time period to generate share usages for. Time period must be hour, day, month or year. * - ``share_volume_fstype`` = ``ext4`` - (StrOpt) Filesystem type of the share volume. * - ``smb_template_config_path`` = ``$state_path/smb.conf`` diff --git a/doc/config-ref-rst/source/tables/nova-api.rst b/doc/config-ref-rst/source/tables/nova-api.rst index 13b951ca53..aefcbfd93a 100644 --- a/doc/config-ref-rst/source/tables/nova-api.rst +++ b/doc/config-ref-rst/source/tables/nova-api.rst @@ -33,7 +33,7 @@ * - ``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). * - ``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. + - (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. * - ``non_inheritable_image_properties`` = ``cache_in_nova, bittorrent`` - (ListOpt) These are image properties which a snapshot should not inherit from an instance * - ``null_kernel`` = ``nokernel`` @@ -71,7 +71,7 @@ * - **[oslo_middleware]** - * - ``max_request_body_size`` = ``114688`` - - (IntOpt) The maximum body size for each request, in bytes. + - (IntOpt) 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. * - **[oslo_versionedobjects]** diff --git a/doc/config-ref-rst/source/tables/nova-auth_token.rst b/doc/config-ref-rst/source/tables/nova-auth_token.rst index 0b9f5f4166..d914b6d5be 100644 --- a/doc/config-ref-rst/source/tables/nova-auth_token.rst +++ b/doc/config-ref-rst/source/tables/nova-auth_token.rst @@ -79,7 +79,7 @@ * - ``memcache_secret_key`` = ``None`` - (StrOpt) (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. + - (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. * - ``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. * - ``region_name`` = ``None`` diff --git a/doc/config-ref-rst/source/tables/nova-authentication.rst b/doc/config-ref-rst/source/tables/nova-authentication.rst index f81d4c920f..8233d65cc0 100644 --- a/doc/config-ref-rst/source/tables/nova-authentication.rst +++ b/doc/config-ref-rst/source/tables/nova-authentication.rst @@ -17,6 +17,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. + - (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. diff --git a/doc/config-ref-rst/source/tables/nova-cells.rst b/doc/config-ref-rst/source/tables/nova-cells.rst index 3fdbc80990..86bf6ce0a4 100644 --- a/doc/config-ref-rst/source/tables/nova-cells.rst +++ b/doc/config-ref-rst/source/tables/nova-cells.rst @@ -23,7 +23,7 @@ * - ``cell_type`` = ``compute`` - (StrOpt) Type of cell * - ``cells_config`` = ``None`` - - (StrOpt) Configuration file from which to read cells configuration. If given, overrides reading cells from the database. + - (StrOpt) Configuration file from which to read cells configuration. If given, overrides reading cells from the database. * - ``db_check_interval`` = ``60`` - (IntOpt) Interval, in seconds, for getting fresh cell information from the database. * - ``driver`` = ``nova.cells.rpc_driver.CellsRPCDriver`` @@ -33,7 +33,7 @@ * - ``instance_update_num_instances`` = ``1`` - (IntOpt) Number of instances to update per periodic task run * - ``instance_update_sync_database_limit`` = ``100`` - - (IntOpt) 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 + - (IntOpt) 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 * - ``instance_updated_at_threshold`` = ``3600`` - (IntOpt) Number of seconds after an instance was updated or deleted to continue to update cells * - ``manager`` = ``nova.cells.manager.CellsManager`` diff --git a/doc/config-ref-rst/source/tables/nova-common.rst b/doc/config-ref-rst/source/tables/nova-common.rst index 83f9b9a384..ffe3bf973b 100644 --- a/doc/config-ref-rst/source/tables/nova-common.rst +++ b/doc/config-ref-rst/source/tables/nova-common.rst @@ -27,7 +27,7 @@ * - ``executor_thread_pool_size`` = ``64`` - (IntOpt) 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 + - (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 * - ``memcached_servers`` = ``None`` - (ListOpt) Memcached servers or None for in process cache. * - ``my_ip`` = ``10.0.0.1`` @@ -35,7 +35,7 @@ * - ``notify_api_faults`` = ``False`` - (BoolOpt) 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. + - (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. * - ``pybasedir`` = ``/usr/lib/python/site-packages/nova`` - (StrOpt) Directory where the nova python module is installed * - ``report_interval`` = ``10`` @@ -59,7 +59,7 @@ * - ``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 * - ``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 + - (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 * - ``disable_rootwrap`` = ``False`` - (BoolOpt) 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`` diff --git a/doc/config-ref-rst/source/tables/nova-compute.rst b/doc/config-ref-rst/source/tables/nova-compute.rst index 2e361404f0..df5d13e79e 100644 --- a/doc/config-ref-rst/source/tables/nova-compute.rst +++ b/doc/config-ref-rst/source/tables/nova-compute.rst @@ -51,7 +51,7 @@ * - ``instance_usage_audit`` = ``False`` - (BoolOpt) 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 + - (StrOpt) 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 * - ``max_concurrent_builds`` = ``10`` diff --git a/doc/config-ref-rst/source/tables/nova-glance.rst b/doc/config-ref-rst/source/tables/nova-glance.rst index 7953e386a3..0865c20a1d 100644 --- a/doc/config-ref-rst/source/tables/nova-glance.rst +++ b/doc/config-ref-rst/source/tables/nova-glance.rst @@ -21,7 +21,7 @@ * - **[glance]** - * - ``allowed_direct_url_schemes`` = `` `` - - (ListOpt) A list of url scheme that can be downloaded directly via the direct_url. Currently supported schemes: [file]. + - (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 * - ``api_servers`` = ``None`` diff --git a/doc/config-ref-rst/source/tables/nova-hyperv.rst b/doc/config-ref-rst/source/tables/nova-hyperv.rst index 33f34b8216..030ab3bf62 100644 --- a/doc/config-ref-rst/source/tables/nova-hyperv.rst +++ b/doc/config-ref-rst/source/tables/nova-hyperv.rst @@ -20,8 +20,6 @@ - (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 * - ``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 - * - ``force_hyperv_utils_v1`` = ``False`` - - (BoolOpt) Force V1 WMI utility classes * - ``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 * - ``limit_cpu_features`` = ``False`` diff --git a/doc/config-ref-rst/source/tables/nova-logging.rst b/doc/config-ref-rst/source/tables/nova-logging.rst index 51be390135..addde54cef 100644 --- a/doc/config-ref-rst/source/tables/nova-logging.rst +++ b/doc/config-ref-rst/source/tables/nova-logging.rst @@ -37,7 +37,7 @@ * - ``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. * - ``log_format`` = ``None`` - - (StrOpt) DEPRECATED. A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. This option is deprecated. Please use logging_context_format_string and logging_default_format_string instead. This option is ignored if log_config_append is set. + - (StrOpt) DEPRECATED. A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. This option is deprecated. Please use logging_context_format_string and logging_default_format_string instead. 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. * - ``logging_debug_format_suffix`` = ``%(funcName)s %(pathname)s:%(lineno)d`` diff --git a/doc/config-ref-rst/source/tables/nova-pci.rst b/doc/config-ref-rst/source/tables/nova-pci.rst index d698c06fa3..a6074f76a4 100644 --- a/doc/config-ref-rst/source/tables/nova-pci.rst +++ b/doc/config-ref-rst/source/tables/nova-pci.rst @@ -17,6 +17,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": "ACCEL" } defines an alias for the Intel QuickAssist card. (multi valued) + - (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": "ACCEL" } defines an alias for the Intel QuickAssist card. (multi valued) * - ``pci_passthrough_whitelist`` = ``[]`` - - (MultiStrOpt) White list of PCI devices available to VMs. For example: pci_passthrough_whitelist = [{"vendor_id": "8086", "product_id": "0443"}] + - (MultiStrOpt) White list of PCI devices available to VMs. For example: pci_passthrough_whitelist = [{"vendor_id": "8086", "product_id": "0443"}] diff --git a/doc/config-ref-rst/source/tables/nova-policy.rst b/doc/config-ref-rst/source/tables/nova-policy.rst index 95bcc5d752..6e97dfa85d 100644 --- a/doc/config-ref-rst/source/tables/nova-policy.rst +++ b/doc/config-ref-rst/source/tables/nova-policy.rst @@ -33,7 +33,7 @@ * - ``policy_default_rule`` = ``default`` - (StrOpt) 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. + - (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. * - ``policy_file`` = ``policy.json`` - (StrOpt) The JSON file that defines policies. * - ``reservation_expire`` = ``86400`` diff --git a/doc/config-ref-rst/source/tables/nova-qpid.rst b/doc/config-ref-rst/source/tables/nova-qpid.rst index 4eae7fdadc..c2f7d80b61 100644 --- a/doc/config-ref-rst/source/tables/nova-qpid.rst +++ b/doc/config-ref-rst/source/tables/nova-qpid.rst @@ -39,7 +39,7 @@ * - ``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. + - (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`` diff --git a/doc/config-ref-rst/source/tables/nova-rpc.rst b/doc/config-ref-rst/source/tables/nova-rpc.rst index 96100de759..fea7179f53 100644 --- a/doc/config-ref-rst/source/tables/nova-rpc.rst +++ b/doc/config-ref-rst/source/tables/nova-rpc.rst @@ -29,13 +29,13 @@ * - **[cells]** - * - ``rpc_driver_queue_base`` = ``cells.intercell`` - - (StrOpt) Base queue name to use when communicating between cells. Various topics by message type will be appended to this. + - (StrOpt) Base queue name to use when communicating between cells. Various topics by message type will be appended to this. * - **[oslo_concurrency]** - * - ``disable_process_locking`` = ``False`` - (BoolOpt) 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. + - (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. * - **[oslo_messaging_amqp]** - * - ``allow_insecure_clients`` = ``False`` diff --git a/doc/config-ref-rst/source/tables/nova-scheduler.rst b/doc/config-ref-rst/source/tables/nova-scheduler.rst index 3e7b7de5c9..d927b323fd 100644 --- a/doc/config-ref-rst/source/tables/nova-scheduler.rst +++ b/doc/config-ref-rst/source/tables/nova-scheduler.rst @@ -39,7 +39,7 @@ * - ``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 * - ``ram_weight_multiplier`` = ``1.0`` - - (FloatOpt) Multiplier used for weighing ram. Negative numbers mean to stack vs spread. + - (FloatOpt) Multiplier used for weighing ram. Negative numbers mean to stack vs spread. * - ``reserved_host_disk_mb`` = ``0`` - (IntOpt) Amount of disk in MB to reserve for the host * - ``reserved_host_memory_mb`` = ``512`` @@ -47,7 +47,7 @@ * - ``restrict_isolated_hosts_to_isolated_images`` = ``True`` - (BoolOpt) Whether to force isolated hosts to run only isolated images * - ``scheduler_available_filters`` = ``['nova.scheduler.filters.all_filters']`` - - (MultiStrOpt) Filter classes available to the scheduler which may be specified more than once. An entry of "nova.scheduler.filters.all_filters" maps to all filters included with nova. + - (MultiStrOpt) Filter classes available to the scheduler which may be specified more than once. An entry of "nova.scheduler.filters.all_filters" maps to all filters included with nova. * - ``scheduler_default_filters`` = ``RetryFilter, AvailabilityZoneFilter, RamFilter, DiskFilter, ComputeFilter, ComputeCapabilitiesFilter, ImagePropertiesFilter, ServerGroupAntiAffinityFilter, ServerGroupAffinityFilter`` - (ListOpt) Which filter class names to use for filtering hosts when not specified in the request. * - ``scheduler_driver`` = ``nova.scheduler.filter_scheduler.FilterScheduler`` @@ -77,15 +77,15 @@ * - **[cells]** - * - ``ram_weight_multiplier`` = ``10.0`` - - (FloatOpt) Multiplier used for weighing ram. Negative numbers mean to stack vs spread. + - (FloatOpt) Multiplier used for weighing ram. Negative numbers mean to stack vs spread. * - ``scheduler_filter_classes`` = ``nova.cells.filters.all_filters`` - - (ListOpt) Filter classes the cells scheduler should use. An entry of "nova.cells.filters.all_filters" maps to all cells filters included with nova. + - (ListOpt) Filter classes the cells scheduler should use. An entry of "nova.cells.filters.all_filters" maps to all cells filters included with nova. * - ``scheduler_retries`` = ``10`` - (IntOpt) How many retries when no cells are available. * - ``scheduler_retry_delay`` = ``2`` - (IntOpt) How often to retry in seconds when no cells are available. * - ``scheduler_weight_classes`` = ``nova.cells.weights.all_weighers`` - - (ListOpt) Weigher classes the cells scheduler should use. An entry of "nova.cells.weights.all_weighers" maps to all cell weighers included with nova. + - (ListOpt) Weigher classes the cells scheduler should use. An entry of "nova.cells.weights.all_weighers" maps to all cell weighers included with nova. * - **[metrics]** - * - ``required`` = ``True`` diff --git a/doc/config-ref-rst/source/tables/nova-xen.rst b/doc/config-ref-rst/source/tables/nova-xen.rst index dc9425ba1b..20cbec9bce 100644 --- a/doc/config-ref-rst/source/tables/nova-xen.rst +++ b/doc/config-ref-rst/source/tables/nova-xen.rst @@ -53,7 +53,7 @@ * - ``connection_password`` = ``None`` - (StrOpt) 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 + - (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 * - ``connection_username`` = ``root`` - (StrOpt) Username for connection to XenServer/Xen Cloud Platform. Used only if compute_driver=xenapi.XenAPIDriver * - ``default_os_type`` = ``linux`` diff --git a/doc/config-ref-rst/source/tables/sahara-api.rst b/doc/config-ref-rst/source/tables/sahara-api.rst index 69f4cbd725..07d9095d95 100644 --- a/doc/config-ref-rst/source/tables/sahara-api.rst +++ b/doc/config-ref-rst/source/tables/sahara-api.rst @@ -17,7 +17,7 @@ * - **[oslo_middleware]** - * - ``max_request_body_size`` = ``114688`` - - (IntOpt) The maximum body size for each request, in bytes. + - (IntOpt) 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. * - **[retries]** diff --git a/doc/config-ref-rst/source/tables/sahara-auth_token.rst b/doc/config-ref-rst/source/tables/sahara-auth_token.rst index 0b9f5f4166..d914b6d5be 100644 --- a/doc/config-ref-rst/source/tables/sahara-auth_token.rst +++ b/doc/config-ref-rst/source/tables/sahara-auth_token.rst @@ -79,7 +79,7 @@ * - ``memcache_secret_key`` = ``None`` - (StrOpt) (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. + - (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. * - ``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. * - ``region_name`` = ``None`` diff --git a/doc/config-ref-rst/source/tables/sahara-common.rst b/doc/config-ref-rst/source/tables/sahara-common.rst index 31a78cf35f..5dfef775ca 100644 --- a/doc/config-ref-rst/source/tables/sahara-common.rst +++ b/doc/config-ref-rst/source/tables/sahara-common.rst @@ -75,7 +75,7 @@ * - ``remote`` = ``ssh`` - (StrOpt) 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 + - (StrOpt) 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`` diff --git a/doc/config-ref-rst/source/tables/sahara-logging.rst b/doc/config-ref-rst/source/tables/sahara-logging.rst index 025a24ebde..8984f80dfd 100644 --- a/doc/config-ref-rst/source/tables/sahara-logging.rst +++ b/doc/config-ref-rst/source/tables/sahara-logging.rst @@ -35,7 +35,7 @@ * - ``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. * - ``log_format`` = ``None`` - - (StrOpt) DEPRECATED. A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. This option is deprecated. Please use logging_context_format_string and logging_default_format_string instead. This option is ignored if log_config_append is set. + - (StrOpt) DEPRECATED. A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. This option is deprecated. Please use logging_context_format_string and logging_default_format_string instead. 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. * - ``logging_debug_format_suffix`` = ``%(funcName)s %(pathname)s:%(lineno)d`` diff --git a/doc/config-ref-rst/source/tables/sahara-policy.rst b/doc/config-ref-rst/source/tables/sahara-policy.rst index 3839d589e6..973d09a166 100644 --- a/doc/config-ref-rst/source/tables/sahara-policy.rst +++ b/doc/config-ref-rst/source/tables/sahara-policy.rst @@ -19,6 +19,6 @@ * - ``policy_default_rule`` = ``default`` - (StrOpt) 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. + - (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. * - ``policy_file`` = ``policy.json`` - (StrOpt) The JSON file that defines policies. diff --git a/doc/config-ref-rst/source/tables/sahara-qpid.rst b/doc/config-ref-rst/source/tables/sahara-qpid.rst index 4eae7fdadc..c2f7d80b61 100644 --- a/doc/config-ref-rst/source/tables/sahara-qpid.rst +++ b/doc/config-ref-rst/source/tables/sahara-qpid.rst @@ -39,7 +39,7 @@ * - ``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. + - (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`` diff --git a/doc/config-ref-rst/source/tables/sahara-rpc.rst b/doc/config-ref-rst/source/tables/sahara-rpc.rst index df8cf63e62..a122aa0edb 100644 --- a/doc/config-ref-rst/source/tables/sahara-rpc.rst +++ b/doc/config-ref-rst/source/tables/sahara-rpc.rst @@ -31,7 +31,7 @@ * - ``disable_process_locking`` = ``False`` - (BoolOpt) 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. + - (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. * - **[oslo_messaging_amqp]** - * - ``allow_insecure_clients`` = ``False`` diff --git a/doc/config-ref-rst/source/tables/trove-api.rst b/doc/config-ref-rst/source/tables/trove-api.rst index 266add8dec..d6bb12cec9 100644 --- a/doc/config-ref-rst/source/tables/trove-api.rst +++ b/doc/config-ref-rst/source/tables/trove-api.rst @@ -69,6 +69,6 @@ * - **[oslo_middleware]** - * - ``max_request_body_size`` = ``114688`` - - (IntOpt) The maximum body size for each request, in bytes. + - (IntOpt) 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. diff --git a/doc/config-ref-rst/source/tables/trove-auth_token.rst b/doc/config-ref-rst/source/tables/trove-auth_token.rst index 0b9f5f4166..d914b6d5be 100644 --- a/doc/config-ref-rst/source/tables/trove-auth_token.rst +++ b/doc/config-ref-rst/source/tables/trove-auth_token.rst @@ -79,7 +79,7 @@ * - ``memcache_secret_key`` = ``None`` - (StrOpt) (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. + - (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. * - ``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. * - ``region_name`` = ``None`` diff --git a/doc/config-ref-rst/source/tables/trove-guestagent.rst b/doc/config-ref-rst/source/tables/trove-guestagent.rst index 41b4459d5a..67e9a49369 100644 --- a/doc/config-ref-rst/source/tables/trove-guestagent.rst +++ b/doc/config-ref-rst/source/tables/trove-guestagent.rst @@ -31,7 +31,7 @@ * - ``guest_id`` = ``None`` - (StrOpt) 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 + - (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 * - ``mount_options`` = ``defaults,noatime`` - (StrOpt) Options to use when mounting a volume. * - ``storage_namespace`` = ``trove.guestagent.strategies.storage.swift`` diff --git a/doc/config-ref-rst/source/tables/trove-logging.rst b/doc/config-ref-rst/source/tables/trove-logging.rst index 41d00a6a1d..227c00b142 100644 --- a/doc/config-ref-rst/source/tables/trove-logging.rst +++ b/doc/config-ref-rst/source/tables/trove-logging.rst @@ -37,7 +37,7 @@ * - ``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. * - ``log_format`` = ``None`` - - (StrOpt) DEPRECATED. A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. This option is deprecated. Please use logging_context_format_string and logging_default_format_string instead. This option is ignored if log_config_append is set. + - (StrOpt) DEPRECATED. A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. This option is deprecated. Please use logging_context_format_string and logging_default_format_string instead. 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. * - ``logging_debug_format_suffix`` = ``%(funcName)s %(pathname)s:%(lineno)d`` diff --git a/doc/config-ref-rst/source/tables/trove-qpid.rst b/doc/config-ref-rst/source/tables/trove-qpid.rst index 4eae7fdadc..c2f7d80b61 100644 --- a/doc/config-ref-rst/source/tables/trove-qpid.rst +++ b/doc/config-ref-rst/source/tables/trove-qpid.rst @@ -39,7 +39,7 @@ * - ``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. + - (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`` diff --git a/doc/config-ref-rst/source/tables/trove-rpc.rst b/doc/config-ref-rst/source/tables/trove-rpc.rst index 943219566e..5538d1e539 100644 --- a/doc/config-ref-rst/source/tables/trove-rpc.rst +++ b/doc/config-ref-rst/source/tables/trove-rpc.rst @@ -35,7 +35,7 @@ * - ``disable_process_locking`` = ``False`` - (BoolOpt) 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. + - (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. * - **[oslo_messaging_amqp]** - * - ``allow_insecure_clients`` = ``False`` diff --git a/tools/autogenerate-config-flagmappings/cinder.flagmappings b/tools/autogenerate-config-flagmappings/cinder.flagmappings index 85208d8a0b..33fbb75a68 100644 --- a/tools/autogenerate-config-flagmappings/cinder.flagmappings +++ b/tools/autogenerate-config-flagmappings/cinder.flagmappings @@ -456,6 +456,7 @@ sf_allow_template_caching solidfire sf_allow_tenant_qos solidfire sf_api_port solidfire sf_emulate_512 solidfire +sf_enable_vag solidfire sf_enable_volume_mapping solidfire sf_svip solidfire sf_template_account_name solidfire diff --git a/tools/autogenerate-config-flagmappings/heat.flagmappings b/tools/autogenerate-config-flagmappings/heat.flagmappings index 76b2f90bd5..6bb5a20e52 100644 --- a/tools/autogenerate-config-flagmappings/heat.flagmappings +++ b/tools/autogenerate-config-flagmappings/heat.flagmappings @@ -337,6 +337,7 @@ oslo_policy/policy_file api oslo_versionedobjects/fatal_exception_format_errors api paste_deploy/api_paste_config api paste_deploy/flavor api +profiler/hmac_keys testing profiler/profiler_enabled testing profiler/trace_sqlalchemy testing revision/heat_revision common diff --git a/tools/autogenerate-config-flagmappings/ironic.flagmappings b/tools/autogenerate-config-flagmappings/ironic.flagmappings index 498656dae1..9e72cfee27 100644 --- a/tools/autogenerate-config-flagmappings/ironic.flagmappings +++ b/tools/autogenerate-config-flagmappings/ironic.flagmappings @@ -77,6 +77,7 @@ agent/post_deploy_get_power_state_retry_interval agent amt/action_wait amt amt/max_attempts amt amt/protocol amt +api/api_workers api api/host_ip api api/max_limit api api/port api diff --git a/tools/autogenerate-config-flagmappings/manila.flagmappings b/tools/autogenerate-config-flagmappings/manila.flagmappings index 438fc7565e..32b240a741 100644 --- a/tools/autogenerate-config-flagmappings/manila.flagmappings +++ b/tools/autogenerate-config-flagmappings/manila.flagmappings @@ -89,17 +89,17 @@ hds_hnas_stalled_job_timeout hds_hnas hds_hnas_user hds_hnas hook_drivers share host common -hp3par_api_url hp3par -hp3par_debug hp3par -hp3par_fpg hp3par -hp3par_fstore_per_share hp3par -hp3par_password hp3par -hp3par_san_ip hp3par -hp3par_san_login hp3par -hp3par_san_password hp3par -hp3par_san_ssh_port hp3par -hp3par_share_ip_address hp3par -hp3par_username hp3par +hpe3par_api_url hpe3par +hpe3par_debug hpe3par +hpe3par_fpg hpe3par +hpe3par_fstore_per_share hpe3par +hpe3par_password hpe3par +hpe3par_san_ip hpe3par +hpe3par_san_login hpe3par +hpe3par_san_password hpe3par +hpe3par_san_ssh_port hpe3par +hpe3par_share_ip_address hpe3par +hpe3par_username hpe3par instance_format logging instance_uuid_format logging interface_driver share diff --git a/tools/autogenerate-config-flagmappings/nova.flagmappings b/tools/autogenerate-config-flagmappings/nova.flagmappings index bf85bca04d..890f4d7fe7 100644 --- a/tools/autogenerate-config-flagmappings/nova.flagmappings +++ b/tools/autogenerate-config-flagmappings/nova.flagmappings @@ -484,7 +484,6 @@ hyperv/config_drive_cdrom configdrive hyperv/config_drive_inject_password configdrive hyperv/dynamic_memory_ratio hyperv hyperv/enable_instance_metrics_collection hyperv -hyperv/force_hyperv_utils_v1 hyperv hyperv/force_volumeutils_v1 volumes hyperv/instances_path_share hyperv hyperv/limit_cpu_features hyperv