openstack/openstack-manuals
Code Issues Proposed changes
6475c37330
openstack-manuals/doc/config-reference/conf-changes/manila.xml
Andreas Jaeger ab261dbc0c Config Reference: Update changes for Liberty 
Regenerate all changes file with changes between kilo and Liberty.

Change-Id: I80d8f1b2170aa1c85e352c3572bf106d50c3f7dc
2015-10-14 14:20:07 +02:00

436 lines
18 KiB
XML
Raw Blame History

<?xml version='1.0' encoding='UTF-8'?>
<section xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="manila-conf-changes-liberty">
<!-- Warning: Do not edit this file. It is automatically generated and your changes will be overwritten. The tool to do so lives in the openstack-doc-tools repository. -->
<title>New, updated, and deprecated options in Liberty for Shared File Systems service</title>
<table>
<caption>New options</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<td>Option = default value</td>
<td>(Type) Help string</td>
</tr>
</thead>
<tr>
<td>[DEFAULT] client_socket_timeout = 900</td>
<td>(IntOpt) Timeout for client connections socket operations. If an incoming connection is idle for this number of seconds it will be closed. A value of '0' means wait forever.</td>
</tr>
<tr>
<td>[DEFAULT] emc_nas_root_dir = None</td>
<td>(StrOpt) The root directory where shares will be located.</td>
</tr>
<tr>
<td>[DEFAULT] enable_periodic_hooks = False</td>
<td>(BoolOpt) Whether to enable periodic hooks or not.</td>
</tr>
<tr>
<td>[DEFAULT] enable_post_hooks = False</td>
<td>(BoolOpt) Whether to enable post hooks or not.</td>
</tr>
<tr>
<td>[DEFAULT] enable_pre_hooks = False</td>
<td>(BoolOpt) Whether to enable pre hooks or not.</td>
</tr>
<tr>
<td>[DEFAULT] executor_thread_pool_size = 64</td>
<td>(IntOpt) Size of executor thread pool.</td>
</tr>
<tr>
<td>[DEFAULT] glusterfs_share_layout = None</td>
<td>(StrOpt) Specifies GlusterFS share layout, that is, the method of associating backing GlusterFS resources to shares.</td>
</tr>
<tr>
<td>[DEFAULT] hds_hnas_cluster_admin_ip0 = None</td>
<td>(StrOpt) The IP of the clusters admin node. Only set in HNAS multinode clusters.</td>
</tr>
<tr>
<td>[DEFAULT] hds_hnas_evs_id = None</td>
<td>(StrOpt) Specify which EVS this backend is assigned to.</td>
</tr>
<tr>
<td>[DEFAULT] hds_hnas_evs_ip = None</td>
<td>(StrOpt) Specify IP for mounting shares.</td>
</tr>
<tr>
<td>[DEFAULT] hds_hnas_file_system_name = None</td>
<td>(StrOpt) Specify file-system name for creating shares.</td>
</tr>
<tr>
<td>[DEFAULT] hds_hnas_ip = None</td>
<td>(StrOpt) HNAS management interface IP for communication between Manila controller and HNAS.</td>
</tr>
<tr>
<td>[DEFAULT] hds_hnas_password = None</td>
<td>(StrOpt) HNAS user password. Required only if private key is not provided.</td>
</tr>
<tr>
<td>[DEFAULT] hds_hnas_ssh_private_key = None</td>
<td>(StrOpt) RSA/DSA private key value used to connect into HNAS. Required only if password is not provided.</td>
</tr>
<tr>
<td>[DEFAULT] hds_hnas_stalled_job_timeout = 30</td>
<td>(IntOpt) The time (in seconds) to wait for stalled HNAS jobs before aborting.</td>
</tr>
<tr>
<td>[DEFAULT] hds_hnas_user = None</td>
<td>(StrOpt) HNAS username Base64 String in order to perform tasks such as create file-systems and network interfaces.</td>
</tr>
<tr>
<td>[DEFAULT] hook_drivers = </td>
<td>(ListOpt) Driver(s) to perform some additional actions before and after share driver actions and on a periodic basis. Default is [].</td>
</tr>
<tr>
<td>[DEFAULT] max_over_subscription_ratio = 20.0</td>
<td>(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.</td>
</tr>
<tr>
<td>[DEFAULT] max_time_to_extend_volume = 180</td>
<td>(IntOpt) Maximum time to wait for extending cinder volume.</td>
</tr>
<tr>
<td>[DEFAULT] migration_create_delete_share_timeout = 300</td>
<td>(IntOpt) Timeout for creating and deleting share instances when performing share migration (seconds).</td>
</tr>
<tr>
<td>[DEFAULT] migration_data_copy_node_ip = None</td>
<td>(StrOpt) The IP of the node responsible for copying data during migration, such as the data copy service node, reachable by the backend.</td>
</tr>
<tr>
<td>[DEFAULT] migration_ignore_files = lost+found</td>
<td>(ListOpt) List of files and folders to be ignored when migrating shares. Items should be names (not including any path).</td>
</tr>
<tr>
<td>[DEFAULT] migration_mounting_backend_ip = None</td>
<td>(StrOpt) Backend IP in admin network to use for mounting shares during migration.</td>
</tr>
<tr>
<td>[DEFAULT] migration_protocol_mount_command = None</td>
<td>(StrOpt) The command for mounting shares for this backend. Must specifythe executable and all necessary parameters for the protocol supported. It is advisable to separate protocols per backend.</td>
</tr>
<tr>
<td>[DEFAULT] migration_readonly_support = True</td>
<td>(BoolOpt) Specify whether read only access mode is supported in thisbackend.</td>
</tr>
<tr>
<td>[DEFAULT] migration_tmp_location = /tmp/</td>
<td>(StrOpt) Temporary path to create and mount shares during migration.</td>
</tr>
<tr>
<td>[DEFAULT] migration_wait_access_rules_timeout = 90</td>
<td>(IntOpt) Time to wait for access rules to be allowed/denied on backends when migrating shares using generic approach (seconds).</td>
</tr>
<tr>
<td>[DEFAULT] nova_api_microversion = 2.10</td>
<td>(StrOpt) Version of Nova API to be used.</td>
</tr>
<tr>
<td>[DEFAULT] osapi_share_workers = 1</td>
<td>(IntOpt) Number of workers for OpenStack Share API service.</td>
</tr>
<tr>
<td>[DEFAULT] password = </td>
<td>(StrOpt) Password for Redis server (optional).</td>
</tr>
<tr>
<td>[DEFAULT] periodic_hooks_interval = 300.0</td>
<td>(FloatOpt) Interval in seconds between execution of periodic hooks. Used when option 'enable_periodic_hooks' is set to True. Default is 300.</td>
</tr>
<tr>
<td>[DEFAULT] pool_weight_multiplier = 1.0</td>
<td>(FloatOpt) Multiplier used for weighing pools which have existing share servers. Negative numbers mean to spread vs stack.</td>
</tr>
<tr>
<td>[DEFAULT] port = 6379</td>
<td>(IntOpt) Use this port to connect to redis host.</td>
</tr>
<tr>
<td>[DEFAULT] rpc_conn_pool_size = 30</td>
<td>(IntOpt) Size of RPC connection pool.</td>
</tr>
<tr>
<td>[DEFAULT] rpc_poll_timeout = 1</td>
<td>(IntOpt) The default number of seconds that poll should wait. Poll raises timeout exception when timeout expired.</td>
</tr>
<tr>
<td>[DEFAULT] rpc_zmq_all_req_rep = True</td>
<td>(BoolOpt) Use REQ/REP pattern for all methods CALL/CAST/FANOUT.</td>
</tr>
<tr>
<td>[DEFAULT] rpc_zmq_concurrency = eventlet</td>
<td>(StrOpt) Type of concurrency used. Either "native" or "eventlet"</td>
</tr>
<tr>
<td>[DEFAULT] suppress_post_hooks_errors = False</td>
<td>(BoolOpt) Whether to suppress post hook errors (allow driver's results to pass through) or not.</td>
</tr>
<tr>
<td>[DEFAULT] suppress_pre_hooks_errors = False</td>
<td>(BoolOpt) Whether to suppress pre hook errors (allow driver perform actions) or not.</td>
</tr>
<tr>
<td>[DEFAULT] watch_log_file = False</td>
<td>(BoolOpt) (Optional) Uses logging handler designed to watch file system. When log file is moved or removed this handler will open a new log file with specified path instantaneously. It makes sense only if log-file option is specified and Linux platform is used. This option is ignored if log_config_append is set.</td>
</tr>
<tr>
<td>[DEFAULT] winrm_cert_key_pem_path = ~/.ssl/key.pem</td>
<td>(StrOpt) Path to the x509 certificate key.</td>
</tr>
<tr>
<td>[DEFAULT] winrm_cert_pem_path = ~/.ssl/cert.pem</td>
<td>(StrOpt) Path to the x509 certificate used for accessing the serviceinstance.</td>
</tr>
<tr>
<td>[DEFAULT] winrm_conn_timeout = 60</td>
<td>(IntOpt) WinRM connection timeout.</td>
</tr>
<tr>
<td>[DEFAULT] winrm_operation_timeout = 60</td>
<td>(IntOpt) WinRM operation timeout.</td>
</tr>
<tr>
<td>[DEFAULT] winrm_retry_count = 3</td>
<td>(IntOpt) WinRM retry count.</td>
</tr>
<tr>
<td>[DEFAULT] winrm_retry_interval = 5</td>
<td>(IntOpt) WinRM retry interval in seconds</td>
</tr>
<tr>
<td>[DEFAULT] winrm_use_cert_based_auth = False</td>
<td>(BoolOpt) Use x509 certificates in order to authenticate to theservice instance.</td>
</tr>
<tr>
<td>[DEFAULT] wsgi_keep_alive = True</td>
<td>(BoolOpt) If False, closes the client socket connection explicitly. Setting it to True to maintain backward compatibility. Recommended setting is set it to False.</td>
</tr>
<tr>
<td>[DEFAULT] zmq_use_broker = True</td>
<td>(BoolOpt) Shows whether zmq-messaging uses broker or not.</td>
</tr>
<tr>
<td>[cors] allow_credentials = True</td>
<td>(BoolOpt) Indicate that the actual request can include user credentials</td>
</tr>
<tr>
<td>[cors] allow_headers = Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma</td>
<td>(ListOpt) Indicate which header field names may be used during the actual request.</td>
</tr>
<tr>
<td>[cors] allow_methods = GET, POST, PUT, DELETE, OPTIONS</td>
<td>(ListOpt) Indicate which methods can be used during the actual request.</td>
</tr>
<tr>
<td>[cors] allowed_origin = None</td>
<td>(StrOpt) Indicate whether this resource may be shared with the domain received in the requests "origin" header.</td>
</tr>
<tr>
<td>[cors] expose_headers = Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma</td>
<td>(ListOpt) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers.</td>
</tr>
<tr>
<td>[cors] max_age = 3600</td>
<td>(IntOpt) Maximum cache age of CORS preflight requests.</td>
</tr>
<tr>
<td>[cors.subdomain] allow_credentials = True</td>
<td>(BoolOpt) Indicate that the actual request can include user credentials</td>
</tr>
<tr>
<td>[cors.subdomain] allow_headers = Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma</td>
<td>(ListOpt) Indicate which header field names may be used during the actual request.</td>
</tr>
<tr>
<td>[cors.subdomain] allow_methods = GET, POST, PUT, DELETE, OPTIONS</td>
<td>(ListOpt) Indicate which methods can be used during the actual request.</td>
</tr>
<tr>
<td>[cors.subdomain] allowed_origin = None</td>
<td>(StrOpt) Indicate whether this resource may be shared with the domain received in the requests "origin" header.</td>
</tr>
<tr>
<td>[cors.subdomain] expose_headers = Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma</td>
<td>(ListOpt) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers.</td>
</tr>
<tr>
<td>[cors.subdomain] max_age = 3600</td>
<td>(IntOpt) Maximum cache age of CORS preflight requests.</td>
</tr>
<tr>
<td>[keystone_authtoken] region_name = None</td>
<td>(StrOpt) The region in which the identity server can be found.</td>
</tr>
<tr>
<td>[oslo_messaging_amqp] password = </td>
<td>(StrOpt) Password for message broker authentication</td>
</tr>
<tr>
<td>[oslo_messaging_amqp] sasl_config_dir = </td>
<td>(StrOpt) Path to directory that contains the SASL configuration</td>
</tr>
<tr>
<td>[oslo_messaging_amqp] sasl_config_name = </td>
<td>(StrOpt) Name of configuration file (without .conf suffix)</td>
</tr>
<tr>
<td>[oslo_messaging_amqp] sasl_mechanisms = </td>
<td>(StrOpt) Space separated list of acceptable SASL mechanisms</td>
</tr>
<tr>
<td>[oslo_messaging_amqp] username = </td>
<td>(StrOpt) User name for message broker authentication</td>
</tr>
<tr>
<td>[oslo_messaging_qpid] send_single_reply = False</td>
<td>(BoolOpt) Send a single AMQP reply to call message. The current behaviour since oslo-incubator is to send two AMQP replies - first one with the payload, a second one to ensure the other have finish to send the payload. We are going to remove it in the N release, but we must keep backward compatible at the same time. This option provides such compatibility - it defaults to False in Liberty and can be turned on for early adopters with a new installations or for testing. Please note, that this option will be removed in the Mitaka release.</td>
</tr>
<tr>
<td>[oslo_messaging_rabbit] kombu_reconnect_timeout = 60</td>
<td>(IntOpt) How long to wait before considering a reconnect attempt to have failed. This value should not be longer than rpc_response_timeout.</td>
</tr>
<tr>
<td>[oslo_messaging_rabbit] send_single_reply = False</td>
<td>(BoolOpt) Send a single AMQP reply to call message. The current behaviour since oslo-incubator is to send two AMQP replies - first one with the payload, a second one to ensure the other have finish to send the payload. We are going to remove it in the N release, but we must keep backward compatible at the same time. This option provides such compatibility - it defaults to False in Liberty and can be turned on for early adopters with a new installations or for testing. Please note, that this option will be removed in the Mitaka release.</td>
</tr>
<tr>
<td>[oslo_middleware] max_request_body_size = 114688</td>
<td>(IntOpt) The maximum body size for each request, in bytes.</td>
</tr>
<tr>
<td>[oslo_middleware] secure_proxy_ssl_header = X-Forwarded-Proto</td>
<td>(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.</td>
</tr>
<tr>
<td>[oslo_policy] policy_default_rule = default</td>
<td>(StrOpt) Default rule. Enforced when a requested rule is not found.</td>
</tr>
<tr>
<td>[oslo_policy] policy_dirs = ['policy.d']</td>
<td>(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.</td>
</tr>
<tr>
<td>[oslo_policy] policy_file = policy.json</td>
<td>(StrOpt) The JSON file that defines policies.</td>
</tr>
</table>
<table>
<caption>New default values</caption>
<col width="33%"/>
<col width="33%"/>
<col width="33%"/>
<thead>
<tr>
<td>Option</td>
<td>Previous default value</td>
<td>New default value</td>
</tr>
</thead>
<tr>
<td>[DEFAULT] default_log_levels</td>
<td>amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, oslo.messaging=INFO, iso8601=WARN, requests.packages.urllib3.connectionpool=WARN, urllib3.connectionpool=WARN, websocket=WARN, keystonemiddleware=WARN, routes.middleware=WARN, stevedore=WARN</td>
<td>amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, oslo.messaging=INFO, iso8601=WARN, requests.packages.urllib3.connectionpool=WARN, urllib3.connectionpool=WARN, websocket=WARN, requests.packages.urllib3.util.retry=WARN, urllib3.util.retry=WARN, keystonemiddleware=WARN, routes.middleware=WARN, stevedore=WARN, taskflow=WARN</td>
</tr>
<tr>
<td>[DEFAULT] enable_v1_api</td>
<td>True</td>
<td>False</td>
</tr>
<tr>
<td>[DEFAULT] enable_v2_api</td>
<td>True</td>
<td>False</td>
</tr>
<tr>
<td>[DEFAULT] logging_exception_prefix</td>
<td>%(asctime)s.%(msecs)03d %(process)d TRACE %(name)s %(instance)s</td>
<td>%(asctime)s.%(msecs)03d %(process)d ERROR %(name)s %(instance)s</td>
</tr>
<tr>
<td>[DEFAULT] osapi_share_listen</td>
<td>0.0.0.0</td>
<td>::</td>
</tr>
<tr>
<td>[DEFAULT] rpc_zmq_matchmaker</td>
<td>local</td>
<td>redis</td>
</tr>
<tr>
<td>[DEFAULT] scheduler_default_filters</td>
<td>AvailabilityZoneFilter, CapacityFilter, CapabilitiesFilter</td>
<td>AvailabilityZoneFilter, CapacityFilter, CapabilitiesFilter, ConsistencyGroupFilter</td>
</tr>
<tr>
<td>[DEFAULT] use_syslog_rfc_format</td>
<td>False</td>
<td>True</td>
</tr>
<tr>
<td>[DEFAULT] verbose</td>
<td>False</td>
<td>True</td>
</tr>
<tr>
<td>[matchmaker_redis] password</td>
<td>None</td>
<td></td>
</tr>
<tr>
<td>[oslo_messaging_rabbit] heartbeat_timeout_threshold</td>
<td>0</td>
<td>60</td>
</tr>
</table>
<table>
<caption>Deprecated options</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<td>Deprecated option</td>
<td>New Option</td>
</tr>
</thead>
<tr>
<td>[DEFAULT] glusterfs_native_server_password</td>
<td>[DEFAULT] glusterfs_server_password</td>
</tr>
<tr>
<td>[DEFAULT] sql_max_retries</td>
<td>[database] max_retries</td>
</tr>
<tr>
<td>[DEFAULT] sql_retry_interval</td>
<td>[database] retry_interval</td>
</tr>
<tr>
<td>[DEFAULT] use_syslog</td>
<td>None</td>
</tr>
<tr>
<td>[DEFAULT] osapi_max_request_body_size</td>
<td>[oslo_middleware] max_request_body_size</td>
</tr>
<tr>
<td>[DEFAULT] glusterfs_native_path_to_private_key</td>
<td>[DEFAULT] glusterfs_path_to_private_key</td>
</tr>
<tr>
<td>[DEFAULT] sql_idle_timeout</td>
<td>[database] idle_timeout</td>
</tr>
<tr>
<td>[DEFAULT] rpc_thread_pool_size</td>
<td>[DEFAULT] executor_thread_pool_size</td>
</tr>
<tr>
<td>[DEFAULT] db_backend</td>
<td>[database] backend</td>
</tr>
<tr>
<td>[DEFAULT] log_format</td>
<td>None</td>
</tr>
</table>
</section>
View Git Blame Copy Permalink