openstack/openstack-manuals
Code Issues Proposed changes

Merge "Add Shared File Systems (manila) to Config Ref"

Browse Source
This commit is contained in:
Jenkins 2015-09-24 16:50:38 +00:00 committed by Gerrit Code Review
commit f61efea1eb
52 changed files with 7713 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1895
doc/common/samples/manila.conf.sample Normal file
View File

File diff suppressed because it is too large Load Diff

38
doc/common/tables/manila-amqp.xml Normal file
View File

@ -0,0 +1,38 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_manila_amqp">
<caption>Description of AMQP configuration options</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td><option>control_exchange</option> = <replaceable>openstack</replaceable></td>
<td>(StrOpt) The default exchange under which topics are scoped. May be overridden by an exchange name specified in the transport_url option.</td>
</tr>
<tr>
<td><option>notification_driver</option> = <replaceable>[]</replaceable></td>
<td>(MultiStrOpt) The Drivers(s) to handle sending notifications. Possible values are messaging, messagingv2, routing, log, test, noop</td>
</tr>
<tr>
<td><option>notification_topics</option> = <replaceable>notifications</replaceable></td>
<td>(ListOpt) AMQP topic used for OpenStack notifications.</td>
</tr>
<tr>
<td><option>transport_url</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) A URL representing the messaging driver to use and its full configuration. If not set, we fall back to the rpc_backend option and driver specific configuration.</td>
</tr>
</tbody>
</table>
</para>

112
doc/common/tables/manila-api.xml Normal file
View File

@ -0,0 +1,112 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_manila_api">
<caption>Description of API configuration options</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td><option>api_paste_config</option> = <replaceable>api-paste.ini</replaceable></td>
<td>(StrOpt) File name for the paste.deploy config for manila-api.</td>
</tr>
<tr>
<td><option>api_rate_limit</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Whether to rate limit the API.</td>
</tr>
<tr>
<td><option>enable_v1_api</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Deploy v1 of the Manila API. This option is deprecated, is not used, and will be removed in a future release.</td>
</tr>
<tr>
<td><option>enable_v2_api</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Deploy v2 of the Manila API. This option is deprecated, is not used, and will be removed in a future release.</td>
</tr>
<tr>
<td><option>max_header_line</option> = <replaceable>16384</replaceable></td>
<td>(IntOpt) Maximum line size of message headers to be accepted. Option max_header_line may need to be increased when using large tokens (typically those generated by the Keystone v3 API with big service catalogs).</td>
</tr>
<tr>
<td><option>osapi_max_limit</option> = <replaceable>1000</replaceable></td>
<td>(IntOpt) The maximum number of items returned in a single response from a collection resource.</td>
</tr>
<tr>
<td><option>osapi_share_base_URL</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Base URL to be presented to users in links to the Share API</td>
</tr>
<tr>
<td><option>osapi_share_ext_list</option> = <replaceable></replaceable></td>
<td>(ListOpt) Specify list of extensions to load when using osapi_share_extension option with manila.api.contrib.select_extensions.</td>
</tr>
<tr>
<td><option>osapi_share_extension</option> = <replaceable>['manila.api.contrib.standard_extensions']</replaceable></td>
<td>(MultiStrOpt) The osapi share extension to load.</td>
</tr>
<tr>
<td><option>osapi_share_listen</option> = <replaceable>::</replaceable></td>
<td>(StrOpt) IP address for OpenStack Share API to listen on.</td>
</tr>
<tr>
<td><option>osapi_share_listen_port</option> = <replaceable>8786</replaceable></td>
<td>(IntOpt) Port for OpenStack Share API to listen on.</td>
</tr>
<tr>
<td><option>osapi_share_workers</option> = <replaceable>1</replaceable></td>
<td>(IntOpt) Number of workers for OpenStack Share API service.</td>
</tr>
<tr>
<td><option>share_api_class</option> = <replaceable>manila.share.api.API</replaceable></td>
<td>(StrOpt) The full class name of the share API class to use.</td>
</tr>
<tr>
<td><option>volume_api_class</option> = <replaceable>manila.volume.cinder.API</replaceable></td>
<td>(StrOpt) The full class name of the Volume API class to use.</td>
</tr>
<tr>
<td><option>volume_name_template</option> = <replaceable>manila-share-%s</replaceable></td>
<td>(StrOpt) Volume name template.</td>
</tr>
<tr>
<td><option>volume_snapshot_name_template</option> = <replaceable>manila-snapshot-%s</replaceable></td>
<td>(StrOpt) Volume snapshot name template.</td>
</tr>
<tr>
<th colspan="2">[oslo_middleware]</th>
</tr>
<tr>
<td><option>max_request_body_size</option> = <replaceable>114688</replaceable></td>
<td>(IntOpt) The maximum body size for each request, in bytes.</td>
</tr>
<tr>
<td><option>secure_proxy_ssl_header</option> = <replaceable>X-Forwarded-Proto</replaceable></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>
<th colspan="2">[oslo_policy]</th>
</tr>
<tr>
<td><option>policy_default_rule</option> = <replaceable>default</replaceable></td>
<td>(StrOpt) Default rule. Enforced when a requested rule is not found.</td>
</tr>
<tr>
<td><option>policy_dirs</option> = <replaceable>['policy.d']</replaceable></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><option>policy_file</option> = <replaceable>policy.json</replaceable></td>
<td>(StrOpt) The JSON file that defines policies.</td>
</tr>
</tbody>
</table>
</para>

26
doc/common/tables/manila-auth.xml Normal file
View File

@ -0,0 +1,26 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_manila_auth">
<caption>Description of Authorization configuration options</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td><option>auth_strategy</option> = <replaceable>keystone</replaceable></td>
<td>(StrOpt) The strategy to use for auth. Supports noauth, keystone, and deprecated.</td>
</tr>
</tbody>
</table>
</para>

174
doc/common/tables/manila-auth_token.xml Normal file
View File

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

34
doc/common/tables/manila-ca.xml Normal file
View File

@ -0,0 +1,34 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_manila_ca">
<caption>Description of Certificate Authority configuration options</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td><option>ssl_ca_file</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) CA certificate file to use to verify connecting clients.</td>
</tr>
<tr>
<td><option>ssl_cert_file</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Certificate file to use when starting the server securely.</td>
</tr>
<tr>
<td><option>ssl_key_file</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Private key file to use when starting the server securely.</td>
</tr>
</tbody>
</table>
</para>

150
doc/common/tables/manila-common.xml Normal file
View File

@ -0,0 +1,150 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_manila_common">
<caption>Description of Common configuration options</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td><option>client_socket_timeout</option> = <replaceable>900</replaceable></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><option>compute_api_class</option> = <replaceable>manila.compute.nova.API</replaceable></td>
<td>(StrOpt) The full class name of the Compute API class to use.</td>
</tr>
<tr>
<td><option>enable_new_services</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Services to be added to the available pool on create.</td>
</tr>
<tr>
<td><option>host</option> = <replaceable>localhost</replaceable></td>
<td>(StrOpt) Name of this node. This can be an opaque identifier. It is not necessarily a hostname, FQDN, or IP address.</td>
</tr>
<tr>
<td><option>max_over_subscription_ratio</option> = <replaceable>20.0</replaceable></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><option>memcached_servers</option> = <replaceable>None</replaceable></td>
<td>(ListOpt) Memcached servers or None for in process cache.</td>
</tr>
<tr>
<td><option>monkey_patch</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Whether to log monkey patching.</td>
</tr>
<tr>
<td><option>monkey_patch_modules</option> = <replaceable></replaceable></td>
<td>(ListOpt) List of modules or decorators to monkey patch.</td>
</tr>
<tr>
<td><option>my_ip</option> = <replaceable>10.0.0.1</replaceable></td>
<td>(StrOpt) IP address of this host.</td>
</tr>
<tr>
<td><option>num_shell_tries</option> = <replaceable>3</replaceable></td>
<td>(IntOpt) Number of times to attempt to run flakey shell commands.</td>
</tr>
<tr>
<td><option>periodic_fuzzy_delay</option> = <replaceable>60</replaceable></td>
<td>(IntOpt) Range of seconds to randomly delay when starting the periodic task scheduler to reduce stampeding. (Disable by setting to 0)</td>
</tr>
<tr>
<td><option>periodic_hooks_interval</option> = <replaceable>300.0</replaceable></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><option>periodic_interval</option> = <replaceable>60</replaceable></td>
<td>(IntOpt) Seconds between running periodic tasks.</td>
</tr>
<tr>
<td><option>report_interval</option> = <replaceable>10</replaceable></td>
<td>(IntOpt) Seconds between nodes reporting state to datastore.</td>
</tr>
<tr>
<td><option>reserved_share_percentage</option> = <replaceable>0</replaceable></td>
<td>(IntOpt) The percentage of backend capacity reserved.</td>
</tr>
<tr>
<td><option>rootwrap_config</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Path to the rootwrap configuration file to use for running commands as root.</td>
</tr>
<tr>
<td><option>service_down_time</option> = <replaceable>60</replaceable></td>
<td>(IntOpt) Maximum time since last check-in for up service.</td>
</tr>
<tr>
<td><option>sql_idle_timeout</option> = <replaceable>3600</replaceable></td>
<td>(IntOpt) Timeout before idle SQL connections are reaped.</td>
</tr>
<tr>
<td><option>sql_max_retries</option> = <replaceable>10</replaceable></td>
<td>(IntOpt) Maximum database connection retries during startup. (setting -1 implies an infinite retry count).</td>
</tr>
<tr>
<td><option>sql_retry_interval</option> = <replaceable>10</replaceable></td>
<td>(IntOpt) Interval between retries of opening a SQL connection.</td>
</tr>
<tr>
<td><option>sqlite_clean_db</option> = <replaceable>clean.sqlite</replaceable></td>
<td>(StrOpt) File name of clean sqlite database.</td>
</tr>
<tr>
<td><option>sqlite_db</option> = <replaceable>manila.sqlite</replaceable></td>
<td>(StrOpt) The filename to use with sqlite.</td>
</tr>
<tr>
<td><option>sqlite_synchronous</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) If passed, use synchronous mode for sqlite.</td>
</tr>
<tr>
<td><option>state_path</option> = <replaceable>/var/lib/manila</replaceable></td>
<td>(StrOpt) Top-level directory for maintaining manila's state.</td>
</tr>
<tr>
<td><option>storage_availability_zone</option> = <replaceable>nova</replaceable></td>
<td>(StrOpt) Availability zone of this node.</td>
</tr>
<tr>
<td><option>tcp_keepalive</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Sets the value of TCP_KEEPALIVE (True/False) for each server socket.</td>
</tr>
<tr>
<td><option>tcp_keepalive_count</option> = <replaceable>None</replaceable></td>
<td>(IntOpt) Sets the value of TCP_KEEPCNT for each server socket. Not supported on OS X.</td>
</tr>
<tr>
<td><option>tcp_keepalive_interval</option> = <replaceable>None</replaceable></td>
<td>(IntOpt) Sets the value of TCP_KEEPINTVL in seconds for each server socket. Not supported on OS X.</td>
</tr>
<tr>
<td><option>tcp_keepidle</option> = <replaceable>600</replaceable></td>
<td>(IntOpt) Sets the value of TCP_KEEPIDLE in seconds for each server socket. Not supported on OS X.</td>
</tr>
<tr>
<td><option>until_refresh</option> = <replaceable>0</replaceable></td>
<td>(IntOpt) Count of reservations until usage is refreshed.</td>
</tr>
<tr>
<td><option>use_forwarded_for</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Treat X-Forwarded-For as the canonical remote address. Only enable this if you have a sanitizing proxy.</td>
</tr>
<tr>
<td><option>wsgi_keep_alive</option> = <replaceable>True</replaceable></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>
</tbody>
</table>
</para>

62
doc/common/tables/manila-compute.xml Normal file
View File

@ -0,0 +1,62 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_manila_compute">
<caption>Description of Compute configuration options</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td><option>nova_admin_auth_url</option> = <replaceable>http://localhost:5000/v2.0</replaceable></td>
<td>(StrOpt) Identity service URL.</td>
</tr>
<tr>
<td><option>nova_admin_password</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Nova admin password.</td>
</tr>
<tr>
<td><option>nova_admin_tenant_name</option> = <replaceable>service</replaceable></td>
<td>(StrOpt) Nova admin tenant name.</td>
</tr>
<tr>
<td><option>nova_admin_username</option> = <replaceable>nova</replaceable></td>
<td>(StrOpt) Nova admin username.</td>
</tr>
<tr>
<td><option>nova_api_insecure</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Allow to perform insecure SSL requests to nova.</td>
</tr>
<tr>
<td><option>nova_api_microversion</option> = <replaceable>2.10</replaceable></td>
<td>(StrOpt) Version of Nova API to be used.</td>
</tr>
<tr>
<td><option>nova_ca_certificates_file</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Location of CA certificates file to use for nova client requests.</td>
</tr>
<tr>
<td><option>nova_catalog_admin_info</option> = <replaceable>compute:nova:adminURL</replaceable></td>
<td>(StrOpt) Same as nova_catalog_info, but for admin endpoint.</td>
</tr>
<tr>
<td><option>nova_catalog_info</option> = <replaceable>compute:nova:publicURL</replaceable></td>
<td>(StrOpt) Info to match when looking for nova in the service catalog. Format is separated values of the form: &lt;service_type&gt;:&lt;service_name&gt;:&lt;endpoint_type&gt;</td>
</tr>
<tr>
<td><option>os_region_name</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Region name of this node.</td>
</tr>
</tbody>
</table>
</para>

73
doc/common/tables/manila-cors.xml Normal file
View File

@ -0,0 +1,73 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_manila_cors">
<caption>Description of CORS configuration options</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[cors]</th>
</tr>
<tr>
<td><option>allow_credentials</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Indicate that the actual request can include user credentials</td>
</tr>
<tr>
<td><option>allow_headers</option> = <replaceable>Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma</replaceable></td>
<td>(ListOpt) Indicate which header field names may be used during the actual request.</td>
</tr>
<tr>
<td><option>allow_methods</option> = <replaceable>GET, POST, PUT, DELETE, OPTIONS</replaceable></td>
<td>(ListOpt) Indicate which methods can be used during the actual request.</td>
</tr>
<tr>
<td><option>allowed_origin</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Indicate whether this resource may be shared with the domain received in the requests "origin" header.</td>
</tr>
<tr>
<td><option>expose_headers</option> = <replaceable>Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma</replaceable></td>
<td>(ListOpt) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers.</td>
</tr>
<tr>
<td><option>max_age</option> = <replaceable>3600</replaceable></td>
<td>(IntOpt) Maximum cache age of CORS preflight requests.</td>
</tr>
<tr>
<th colspan="2">[cors.subdomain]</th>
</tr>
<tr>
<td><option>allow_credentials</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Indicate that the actual request can include user credentials</td>
</tr>
<tr>
<td><option>allow_headers</option> = <replaceable>Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma</replaceable></td>
<td>(ListOpt) Indicate which header field names may be used during the actual request.</td>
</tr>
<tr>
<td><option>allow_methods</option> = <replaceable>GET, POST, PUT, DELETE, OPTIONS</replaceable></td>
<td>(ListOpt) Indicate which methods can be used during the actual request.</td>
</tr>
<tr>
<td><option>allowed_origin</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Indicate whether this resource may be shared with the domain received in the requests "origin" header.</td>
</tr>
<tr>
<td><option>expose_headers</option> = <replaceable>Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma</replaceable></td>
<td>(ListOpt) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers.</td>
</tr>
<tr>
<td><option>max_age</option> = <replaceable>3600</replaceable></td>
<td>(IntOpt) Maximum cache age of CORS preflight requests.</td>
</tr>
</tbody>
</table>
</para>

113
doc/common/tables/manila-database.xml Normal file
View File

@ -0,0 +1,113 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_manila_database">
<caption>Description of Database configuration options</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td><option>db_backend</option> = <replaceable>sqlalchemy</replaceable></td>
<td>(StrOpt) The backend to use for database.</td>
</tr>
<tr>
<td><option>db_driver</option> = <replaceable>manila.db</replaceable></td>
<td>(StrOpt) Driver to use for database access.</td>
</tr>
<tr>
<th colspan="2">[database]</th>
</tr>
<tr>
<td><option>backend</option> = <replaceable>sqlalchemy</replaceable></td>
<td>(StrOpt) The back end to use for the database.</td>
</tr>
<tr>
<td><option>connection</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) The SQLAlchemy connection string to use to connect to the database.</td>
</tr>
<tr>
<td><option>connection_debug</option> = <replaceable>0</replaceable></td>
<td>(IntOpt) Verbosity of SQL debugging information: 0=None, 100=Everything.</td>
</tr>
<tr>
<td><option>connection_trace</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Add Python stack traces to SQL as comment strings.</td>
</tr>
<tr>
<td><option>db_inc_retry_interval</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) If True, increases the interval between retries of a database operation up to db_max_retry_interval.</td>
</tr>
<tr>
<td><option>db_max_retries</option> = <replaceable>20</replaceable></td>
<td>(IntOpt) Maximum retries in case of connection error or deadlock error before error is raised. Set to -1 to specify an infinite retry count.</td>
</tr>
<tr>
<td><option>db_max_retry_interval</option> = <replaceable>10</replaceable></td>
<td>(IntOpt) If db_inc_retry_interval is set, the maximum seconds between retries of a database operation.</td>
</tr>
<tr>
<td><option>db_retry_interval</option> = <replaceable>1</replaceable></td>
<td>(IntOpt) Seconds between retries of a database transaction.</td>
</tr>
<tr>
<td><option>idle_timeout</option> = <replaceable>3600</replaceable></td>
<td>(IntOpt) Timeout before idle SQL connections are reaped.</td>
</tr>
<tr>
<td><option>max_overflow</option> = <replaceable>None</replaceable></td>
<td>(IntOpt) If set, use this value for max_overflow with SQLAlchemy.</td>
</tr>
<tr>
<td><option>max_pool_size</option> = <replaceable>None</replaceable></td>
<td>(IntOpt) Maximum number of SQL connections to keep open in a pool.</td>
</tr>
<tr>
<td><option>max_retries</option> = <replaceable>10</replaceable></td>
<td>(IntOpt) Maximum number of database connection retries during startup. Set to -1 to specify an infinite retry count.</td>
</tr>
<tr>
<td><option>min_pool_size</option> = <replaceable>1</replaceable></td>
<td>(IntOpt) Minimum number of SQL connections to keep open in a pool.</td>
</tr>
<tr>
<td><option>mysql_sql_mode</option> = <replaceable>TRADITIONAL</replaceable></td>
<td>(StrOpt) The SQL mode to be used for MySQL sessions. This option, including the default, overrides any server-set SQL mode. To use whatever SQL mode is set by the server configuration, set this to no value. Example: mysql_sql_mode=</td>
</tr>
<tr>
<td><option>pool_timeout</option> = <replaceable>None</replaceable></td>
<td>(IntOpt) If set, use this value for pool_timeout with SQLAlchemy.</td>
</tr>
<tr>
<td><option>retry_interval</option> = <replaceable>10</replaceable></td>
<td>(IntOpt) Interval between retries of opening a SQL connection.</td>
</tr>
<tr>
<td><option>slave_connection</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) The SQLAlchemy connection string to use to connect to the slave database.</td>
</tr>
<tr>
<td><option>sqlite_db</option> = <replaceable>oslo.sqlite</replaceable></td>
<td>(StrOpt) The file name to use with SQLite.</td>
</tr>
<tr>
<td><option>sqlite_synchronous</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) If True, SQLite uses synchronous mode.</td>
</tr>
<tr>
<td><option>use_db_reconnect</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Enable the experimental use of database reconnect on connection lost.</td>
</tr>
</tbody>
</table>
</para>

58
doc/common/tables/manila-emc.xml Normal file
View File

@ -0,0 +1,58 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_manila_emc">
<caption>Description of EMC Share Drivers configuration options</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td><option>emc_nas_login</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) User name for the EMC server.</td>
</tr>
<tr>
<td><option>emc_nas_password</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Password for the EMC server.</td>
</tr>
<tr>
<td><option>emc_nas_pool_name</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) EMC pool name.</td>
</tr>
<tr>
<td><option>emc_nas_root_dir</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) The root directory where shares will be located.</td>
</tr>
<tr>
<td><option>emc_nas_server</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) EMC server hostname or IP address.</td>
</tr>
<tr>
<td><option>emc_nas_server_container</option> = <replaceable>server_2</replaceable></td>
<td>(StrOpt) Container of share servers.</td>
</tr>
<tr>
<td><option>emc_nas_server_port</option> = <replaceable>8080</replaceable></td>
<td>(IntOpt) Port number for the EMC server.</td>
</tr>
<tr>
<td><option>emc_nas_server_secure</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Use secure connection to server.</td>
</tr>
<tr>
<td><option>emc_share_backend</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Share backend.</td>
</tr>
</tbody>
</table>
</para>

46
doc/common/tables/manila-ganesha.xml Normal file
View File

@ -0,0 +1,46 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_manila_ganesha">
<caption>Description of Ganesha configuration options</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td><option>ganesha_config_dir</option> = <replaceable>/etc/ganesha</replaceable></td>
<td>(StrOpt) Directory where Ganesha config files are stored.</td>
</tr>
<tr>
<td><option>ganesha_config_path</option> = <replaceable>$ganesha_config_dir/ganesha.conf</replaceable></td>
<td>(StrOpt) Path to main Ganesha config file.</td>
</tr>
<tr>
<td><option>ganesha_db_path</option> = <replaceable>$state_path/manila-ganesha.db</replaceable></td>
<td>(StrOpt) Location of Ganesha database file. (Ganesha module only.)</td>
</tr>
<tr>
<td><option>ganesha_export_dir</option> = <replaceable>$ganesha_config_dir/export.d</replaceable></td>
<td>(StrOpt) Path to directory containing Ganesha export configuration. (Ganesha module only.)</td>
</tr>
<tr>
<td><option>ganesha_export_template_dir</option> = <replaceable>/etc/manila/ganesha-export-templ.d</replaceable></td>
<td>(StrOpt) Path to directory containing Ganesha export block templates. (Ganesha module only.)</td>
</tr>
<tr>
<td><option>ganesha_service_name</option> = <replaceable>ganesha.nfsd</replaceable></td>
<td>(StrOpt) Name of the ganesha nfs service.</td>
</tr>
</tbody>
</table>
</para>

74
doc/common/tables/manila-glusterfs.xml Normal file
View File

@ -0,0 +1,74 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_manila_glusterfs">
<caption>Description of GlusterFS Share Drivers configuration options</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td><option>glusterfs_ganesha_server_ip</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Remote Ganesha server node's IP address.</td>
</tr>
<tr>
<td><option>glusterfs_ganesha_server_password</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Remote Ganesha server node's login password. This is not required if 'glusterfs_path_to_private_key' is configured.</td>
</tr>
<tr>
<td><option>glusterfs_ganesha_server_username</option> = <replaceable>root</replaceable></td>
<td>(StrOpt) Remote Ganesha server node's username.</td>
</tr>
<tr>
<td><option>glusterfs_mount_point_base</option> = <replaceable>$state_path/mnt</replaceable></td>
<td>(StrOpt) Base directory containing mount points for Gluster volumes.</td>
</tr>
<tr>
<td><option>glusterfs_native_path_to_private_key</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Path of Manila host's private SSH key file.</td>
</tr>
<tr>
<td><option>glusterfs_native_server_password</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Remote GlusterFS server node's login password. This is not required if 'glusterfs_native_path_to_private_key' is configured.</td>
</tr>
<tr>
<td><option>glusterfs_nfs_server_type</option> = <replaceable>Gluster</replaceable></td>
<td>(StrOpt) Type of NFS server that mediate access to the Gluster volumes (Gluster or Ganesha).</td>
</tr>
<tr>
<td><option>glusterfs_path_to_private_key</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Path of Manila host's private SSH key file.</td>
</tr>
<tr>
<td><option>glusterfs_server_password</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Remote GlusterFS server node's login password. This is not required if 'glusterfs_path_to_private_key' is configured.</td>
</tr>
<tr>
<td><option>glusterfs_servers</option> = <replaceable></replaceable></td>
<td>(ListOpt) List of GlusterFS servers that can be used to create shares. Each GlusterFS server should be of the form [remoteuser@]&lt;volserver&gt;, and they are assumed to belong to distinct Gluster clusters.</td>
</tr>
<tr>
<td><option>glusterfs_share_layout</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Specifies GlusterFS share layout, that is, the method of associating backing GlusterFS resources to shares.</td>
</tr>
<tr>
<td><option>glusterfs_target</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Specifies the GlusterFS volume to be mounted on the Manila host. It is of the form [remoteuser@]&lt;volserver&gt;:&lt;volid&gt;.</td>
</tr>
<tr>
<td><option>glusterfs_volume_pattern</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Regular expression template used to filter GlusterFS volumes for share creation. The regex template can optionally (ie. with support of the GlusterFS backend) contain the #{size} parameter which matches an integer (sequence of digits) in which case the value shall be interpreted as size of the volume in GB. Examples: "manila-share-volume-\d+$", "manila-share-volume-#{size}G-\d+$"; with matching volume names, respectively: "manila-share-volume-12", "manila-share-volume-3G-13". In latter example, the number that matches "#{size}", that is, 3, is an indication that the size of volume is 3G.</td>
</tr>
</tbody>
</table>
</para>

46
doc/common/tables/manila-hdfs.xml Normal file
View File

@ -0,0 +1,46 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_manila_hdfs">
<caption>Description of HDFS Share Driver configuration options</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td><option>hdfs_namenode_ip</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) The IP of the HDFS namenode.</td>
</tr>
<tr>
<td><option>hdfs_namenode_port</option> = <replaceable>9000</replaceable></td>
<td>(IntOpt) The port of HDFS namenode service.</td>
</tr>
<tr>
<td><option>hdfs_ssh_name</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) HDFS namenode ssh login name.</td>
</tr>
<tr>
<td><option>hdfs_ssh_port</option> = <replaceable>22</replaceable></td>
<td>(IntOpt) HDFS namenode SSH port.</td>
</tr>
<tr>
<td><option>hdfs_ssh_private_key</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Path to HDFS namenode SSH private key for login.</td>
</tr>
<tr>
<td><option>hdfs_ssh_pw</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) HDFS namenode SSH login password, This parameter is not necessary, if 'hdfs_ssh_private_key' is configured.</td>
</tr>
</tbody>
</table>
</para>

58
doc/common/tables/manila-hds_hnas.xml Normal file
View File

@ -0,0 +1,58 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_manila_hds_hnas">
<caption>Description of HDS NAS Share Driver configuration options</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td><option>hds_hnas_cluster_admin_ip0</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) The IP of the clusters admin node. Only set in HNAS multinode clusters.</td>
</tr>
<tr>
<td><option>hds_hnas_evs_id</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Specify which EVS this backend is assigned to.</td>
</tr>
<tr>
<td><option>hds_hnas_evs_ip</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Specify IP for mounting shares.</td>
</tr>
<tr>
<td><option>hds_hnas_file_system_name</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Specify file-system name for creating shares.</td>
</tr>
<tr>
<td><option>hds_hnas_ip</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) HNAS management interface IP for communication between Manila controller and HNAS.</td>
</tr>
<tr>
<td><option>hds_hnas_password</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) HNAS user password. Required only if private key is not provided.</td>
</tr>
<tr>
<td><option>hds_hnas_ssh_private_key</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) RSA/DSA private key value used to connect into HNAS. Required only if password is not provided.</td>
</tr>
<tr>
<td><option>hds_hnas_stalled_job_timeout</option> = <replaceable>30</replaceable></td>
<td>(IntOpt) The time (in seconds) to wait for stalled HNAS jobs before aborting.</td>
</tr>
<tr>
<td><option>hds_hnas_user</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) HNAS username Base64 String in order to perform tasks such as create file-systems and network interfaces.</td>
</tr>
</tbody>
</table>
</para>

66
doc/common/tables/manila-hp3par.xml Normal file
View File

@ -0,0 +1,66 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_manila_hp3par">
<caption>Description of HP 3PAR Share Driver configuration options</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td><option>hp3par_api_url</option> = <replaceable></replaceable></td>
<td>(StrOpt) 3PAR WSAPI Server Url like https://&lt;3par ip&gt;:8080/api/v1</td>
</tr>
<tr>
<td><option>hp3par_debug</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Enable HTTP debugging to 3PAR</td>
</tr>
<tr>
<td><option>hp3par_fpg</option> = <replaceable>OpenStack</replaceable></td>
<td>(StrOpt) The File Provisioning Group (FPG) to use</td>
</tr>
<tr>
<td><option>hp3par_fstore_per_share</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Use one filestore per share</td>
</tr>
<tr>
<td><option>hp3par_password</option> = <replaceable></replaceable></td>
<td>(StrOpt) 3PAR password for the user specified in hp3par_username</td>
</tr>
<tr>
<td><option>hp3par_san_ip</option> = <replaceable></replaceable></td>
<td>(StrOpt) IP address of SAN controller</td>
</tr>
<tr>
<td><option>hp3par_san_login</option> = <replaceable></replaceable></td>
<td>(StrOpt) Username for SAN controller</td>
</tr>
<tr>
<td><option>hp3par_san_password</option> = <replaceable></replaceable></td>
<td>(StrOpt) Password for SAN controller</td>
</tr>
<tr>
<td><option>hp3par_san_ssh_port</option> = <replaceable>22</replaceable></td>
<td>(IntOpt) SSH port to use with SAN</td>
</tr>
<tr>
<td><option>hp3par_share_ip_address</option> = <replaceable></replaceable></td>
<td>(StrOpt) The IP address for shares not using a share server</td>
</tr>
<tr>
<td><option>hp3par_username</option> = <replaceable></replaceable></td>
<td>(StrOpt) 3PAR username with the 'edit' role</td>
</tr>
</tbody>
</table>
</para>

26
doc/common/tables/manila-huawei.xml Normal file
View File

@ -0,0 +1,26 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_manila_huawei">
<caption>Description of Huawei Share Driver configuration options</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td><option>manila_huawei_conf_file</option> = <replaceable>/etc/manila/manila_huawei_conf.xml</replaceable></td>
<td>(StrOpt) The configuration file for the Manila Huawei driver.</td>
</tr>
</tbody>
</table>
</para>

106
doc/common/tables/manila-logging.xml Normal file
View File

@ -0,0 +1,106 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_manila_logging">
<caption>Description of Logging configuration options</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td><option>debug</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Print debugging output (set logging level to DEBUG instead of default INFO level).</td>
</tr>
<tr>
<td><option>default_log_levels</option> = <replaceable>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</replaceable></td>
<td>(ListOpt) List of logger=LEVEL pairs.</td>
</tr>
<tr>
<td><option>fatal_deprecations</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Enables or disables fatal status of deprecations.</td>
</tr>
<tr>
<td><option>fatal_exception_format_errors</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Whether to make exception message format errors fatal.</td>
</tr>
<tr>
<td><option>instance_format</option> = <replaceable>"[instance: %(uuid)s] "</replaceable></td>
<td>(StrOpt) The format for an instance that is passed with the log message.</td>
</tr>
<tr>
<td><option>instance_uuid_format</option> = <replaceable>"[instance: %(uuid)s] "</replaceable></td>
<td>(StrOpt) The format for an instance UUID that is passed with the log message.</td>
</tr>
<tr>
<td><option>log_config_append</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) The name of a logging configuration file. This file is appended to any existing logging configuration files. For details about logging configuration files, see the Python logging module documentation.</td>
</tr>
<tr>
<td><option>log_date_format</option> = <replaceable>%Y-%m-%d %H:%M:%S</replaceable></td>
<td>(StrOpt) Format string for %%(asctime)s in log records. Default: %(default)s .</td>
</tr>
<tr>
<td><option>log_dir</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) (Optional) The base directory used for relative --log-file paths.</td>
</tr>
<tr>
<td><option>log_file</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) (Optional) Name of log file to output to. If no default is set, logging will go to stdout.</td>
</tr>
<tr>
<td><option>log_format</option> = <replaceable>None</replaceable></td>
<td>(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.</td>
</tr>
<tr>
<td><option>logging_context_format_string</option> = <replaceable>%(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s</replaceable></td>
<td>(StrOpt) Format string to use for log messages with context.</td>
</tr>
<tr>
<td><option>logging_debug_format_suffix</option> = <replaceable>%(funcName)s %(pathname)s:%(lineno)d</replaceable></td>
<td>(StrOpt) Data to append to log format when level is DEBUG.</td>
</tr>
<tr>
<td><option>logging_default_format_string</option> = <replaceable>%(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s</replaceable></td>
<td>(StrOpt) Format string to use for log messages without context.</td>
</tr>
<tr>
<td><option>logging_exception_prefix</option> = <replaceable>%(asctime)s.%(msecs)03d %(process)d ERROR %(name)s %(instance)s</replaceable></td>
<td>(StrOpt) Prefix each line of exception output with this format.</td>
</tr>
<tr>
<td><option>publish_errors</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Enables or disables publication of error events.</td>
</tr>
<tr>
<td><option>syslog_log_facility</option> = <replaceable>LOG_USER</replaceable></td>
<td>(StrOpt) Syslog facility to receive log lines.</td>
</tr>
<tr>
<td><option>use_stderr</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Log output to standard error.</td>
</tr>
<tr>
<td><option>use_syslog</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED and will be changed later to honor RFC5424.</td>
</tr>
<tr>
<td><option>use_syslog_rfc_format</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) (Optional) Enables or disables syslog rfc5424 format for logging. If enabled, prefixes the MSG part of the syslog message with APP-NAME (RFC5424). The format without the APP-NAME is deprecated in Kilo, and will be removed in Mitaka, along with this option.</td>
</tr>
<tr>
<td><option>verbose</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) If set to false, will disable INFO logging level, making WARNING the default.</td>
</tr>
</tbody>
</table>
</para>

78
doc/common/tables/manila-netapp.xml Normal file
View File

@ -0,0 +1,78 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_manila_netapp">
<caption>Description of NetApp Share Drivers configuration options</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td><option>netapp_aggregate_name_search_pattern</option> = <replaceable>(.*)</replaceable></td>
<td>(StrOpt) Pattern for searching available aggregates for provisioning.</td>
</tr>
<tr>
<td><option>netapp_lif_name_template</option> = <replaceable>os_%(net_allocation_id)s</replaceable></td>
<td>(StrOpt) Logical interface (LIF) name template</td>
</tr>
<tr>
<td><option>netapp_login</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Administrative user account name used to access the storage system.</td>
</tr>
<tr>
<td><option>netapp_password</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Password for the administrative user account specified in the netapp_login option.</td>
</tr>
<tr>
<td><option>netapp_port_name_search_pattern</option> = <replaceable>(.*)</replaceable></td>
<td>(StrOpt) Pattern for overriding the selection of network ports on which to create Vserver LIFs.</td>
</tr>
<tr>
<td><option>netapp_root_volume</option> = <replaceable>root</replaceable></td>
<td>(StrOpt) Root volume name.</td>
</tr>
<tr>
<td><option>netapp_root_volume_aggregate</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Name of aggregate to create Vserver root volumes on. This option only applies when the option driver_handles_share_servers is set to True.</td>
</tr>
<tr>
<td><option>netapp_server_hostname</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) The hostname (or IP address) for the storage system.</td>
</tr>
<tr>
<td><option>netapp_server_port</option> = <replaceable>None</replaceable></td>
<td>(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.</td>
</tr>
<tr>
<td><option>netapp_storage_family</option> = <replaceable>ontap_cluster</replaceable></td>
<td>(StrOpt) The storage family type used on the storage system; valid values include ontap_cluster for using clustered Data ONTAP.</td>
</tr>
<tr>
<td><option>netapp_trace_flags</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Comma-separated list of options that control which trace info is written to the debug logs. Values include method and api.</td>
</tr>
<tr>
<td><option>netapp_transport_type</option> = <replaceable>http</replaceable></td>
<td>(StrOpt) The transport protocol used when communicating with the storage system or proxy server. Valid values are http or https.</td>
</tr>
<tr>
<td><option>netapp_volume_name_template</option> = <replaceable>share_%(share_id)s</replaceable></td>
<td>(StrOpt) NetApp volume name template.</td>
</tr>
<tr>
<td><option>netapp_vserver_name_template</option> = <replaceable>os_%s</replaceable></td>
<td>(StrOpt) Name template to use for new Vserver.</td>
</tr>
</tbody>
</table>
</para>

78
doc/common/tables/manila-qpid.xml Normal file
View File

@ -0,0 +1,78 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_manila_qpid">
<caption>Description of QPID configuration options</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[oslo_messaging_qpid]</th>
</tr>
<tr>
<td><option>amqp_auto_delete</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Auto-delete queues in AMQP.</td>
</tr>
<tr>
<td><option>amqp_durable_queues</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Use durable queues in AMQP.</td>
</tr>
<tr>
<td><option>qpid_heartbeat</option> = <replaceable>60</replaceable></td>
<td>(IntOpt) Seconds between connection keepalive heartbeats.</td>
</tr>
<tr>
<td><option>qpid_hostname</option> = <replaceable>localhost</replaceable></td>
<td>(StrOpt) Qpid broker hostname.</td>
</tr>
<tr>
<td><option>qpid_hosts</option> = <replaceable>$qpid_hostname:$qpid_port</replaceable></td>
<td>(ListOpt) Qpid HA cluster host:port pairs.</td>
</tr>
<tr>
<td><option>qpid_password</option> = <replaceable></replaceable></td>
<td>(StrOpt) Password for Qpid connection.</td>
</tr>
<tr>
<td><option>qpid_port</option> = <replaceable>5672</replaceable></td>
<td>(IntOpt) Qpid broker port.</td>
</tr>
<tr>
<td><option>qpid_protocol</option> = <replaceable>tcp</replaceable></td>
<td>(StrOpt) Transport to use, either 'tcp' or 'ssl'.</td>
</tr>
<tr>
<td><option>qpid_receiver_capacity</option> = <replaceable>1</replaceable></td>
<td>(IntOpt) The number of prefetched messages held by receiver.</td>
</tr>
<tr>
<td><option>qpid_sasl_mechanisms</option> = <replaceable></replaceable></td>
<td>(StrOpt) Space separated list of SASL mechanisms to use for auth.</td>
</tr>
<tr>
<td><option>qpid_tcp_nodelay</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Whether to disable the Nagle algorithm.</td>
</tr>
<tr>
<td><option>qpid_topology_version</option> = <replaceable>1</replaceable></td>
<td>(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.</td>
</tr>
<tr>
<td><option>qpid_username</option> = <replaceable></replaceable></td>
<td>(StrOpt) Username for Qpid connection.</td>
</tr>
<tr>
<td><option>send_single_reply</option> = <replaceable>False</replaceable></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>
</tbody>
</table>
</para>

54
doc/common/tables/manila-quobyte.xml Normal file
View File

@ -0,0 +1,54 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_manila_quobyte">
<caption>Description of Quobyte Share Driver configuration options</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td><option>quobyte_api_ca</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) The X.509 CA file to verify the server cert.</td>
</tr>
<tr>
<td><option>quobyte_api_password</option> = <replaceable>quobyte</replaceable></td>
<td>(StrOpt) Password for Quobyte API server</td>
</tr>
<tr>
<td><option>quobyte_api_url</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) URL of the Quobyte API server (http or https)</td>
</tr>
<tr>
<td><option>quobyte_api_username</option> = <replaceable>admin</replaceable></td>
<td>(StrOpt) Username for Quobyte API server.</td>
</tr>
<tr>
<td><option>quobyte_default_volume_group</option> = <replaceable>root</replaceable></td>
<td>(StrOpt) Default owning group for new volumes.</td>
</tr>
<tr>
<td><option>quobyte_default_volume_user</option> = <replaceable>root</replaceable></td>
<td>(StrOpt) Default owning user for new volumes.</td>
</tr>
<tr>
<td><option>quobyte_delete_shares</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Actually deletes shares (vs. unexport)</td>
</tr>
<tr>
<td><option>quobyte_volume_configuration</option> = <replaceable>BASE</replaceable></td>
<td>(StrOpt) Name of volume configuration used for new shares.</td>
</tr>
</tbody>
</table>
</para>

54
doc/common/tables/manila-quota.xml Normal file
View File

@ -0,0 +1,54 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_manila_quota">
<caption>Description of Quota configuration options</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td><option>max_age</option> = <replaceable>0</replaceable></td>
<td>(IntOpt) Number of seconds between subsequent usage refreshes.</td>
</tr>
<tr>
<td><option>quota_driver</option> = <replaceable>manila.quota.DbQuotaDriver</replaceable></td>
<td>(StrOpt) Default driver to use for quota checks.</td>
</tr>
<tr>
<td><option>quota_gigabytes</option> = <replaceable>1000</replaceable></td>
<td>(IntOpt) Number of share gigabytes allowed per project.</td>
</tr>
<tr>
<td><option>quota_share_networks</option> = <replaceable>10</replaceable></td>
<td>(IntOpt) Number of share-networks allowed per project.</td>
</tr>
<tr>
<td><option>quota_shares</option> = <replaceable>50</replaceable></td>
<td>(IntOpt) Number of shares allowed per project.</td>
</tr>
<tr>
<td><option>quota_snapshot_gigabytes</option> = <replaceable>1000</replaceable></td>
<td>(IntOpt) Number of snapshot gigabytes allowed per project.</td>
</tr>
<tr>
<td><option>quota_snapshots</option> = <replaceable>50</replaceable></td>
<td>(IntOpt) Number of share snapshots allowed per project.</td>
</tr>
<tr>
<td><option>reservation_expire</option> = <replaceable>86400</replaceable></td>
<td>(IntOpt) Number of seconds until a reservation expires.</td>
</tr>
</tbody>
</table>
</para>

118
doc/common/tables/manila-rabbitmq.xml Normal file
View File

@ -0,0 +1,118 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_manila_rabbitmq">
<caption>Description of RabbitMQ configuration options</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[oslo_messaging_rabbit]</th>
</tr>
<tr>
<td><option>amqp_auto_delete</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Auto-delete queues in AMQP.</td>
</tr>
<tr>
<td><option>amqp_durable_queues</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Use durable queues in AMQP.</td>
</tr>
<tr>
<td><option>fake_rabbit</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Deprecated, use rpc_backend=kombu+memory or rpc_backend=fake</td>
</tr>
<tr>
<td><option>heartbeat_rate</option> = <replaceable>2</replaceable></td>
<td>(IntOpt) How often times during the heartbeat_timeout_threshold we check the heartbeat.</td>
</tr>
<tr>
<td><option>heartbeat_timeout_threshold</option> = <replaceable>60</replaceable></td>
<td>(IntOpt) Number of seconds after which the Rabbit broker is considered down if heartbeat's keep-alive fails (0 disable the heartbeat). EXPERIMENTAL</td>
</tr>
<tr>
<td><option>kombu_reconnect_delay</option> = <replaceable>1.0</replaceable></td>
<td>(FloatOpt) How long to wait before reconnecting in response to an AMQP consumer cancel notification.</td>
</tr>
<tr>
<td><option>kombu_reconnect_timeout</option> = <replaceable>60</replaceable></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><option>kombu_ssl_ca_certs</option> = <replaceable></replaceable></td>
<td>(StrOpt) SSL certification authority file (valid only if SSL enabled).</td>
</tr>
<tr>
<td><option>kombu_ssl_certfile</option> = <replaceable></replaceable></td>
<td>(StrOpt) SSL cert file (valid only if SSL enabled).</td>
</tr>
<tr>
<td><option>kombu_ssl_keyfile</option> = <replaceable></replaceable></td>
<td>(StrOpt) SSL key file (valid only if SSL enabled).</td>
</tr>
<tr>
<td><option>kombu_ssl_version</option> = <replaceable></replaceable></td>
<td>(StrOpt) SSL version to use (valid only if SSL enabled). Valid values are TLSv1 and SSLv23. SSLv2, SSLv3, TLSv1_1, and TLSv1_2 may be available on some distributions.</td>
</tr>
<tr>
<td><option>rabbit_ha_queues</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Use HA queues in RabbitMQ (x-ha-policy: all). If you change this option, you must wipe the RabbitMQ database.</td>
</tr>
<tr>
<td><option>rabbit_host</option> = <replaceable>localhost</replaceable></td>
<td>(StrOpt) The RabbitMQ broker address where a single node is used.</td>
</tr>
<tr>
<td><option>rabbit_hosts</option> = <replaceable>$rabbit_host:$rabbit_port</replaceable></td>
<td>(ListOpt) RabbitMQ HA cluster host:port pairs.</td>
</tr>
<tr>
<td><option>rabbit_login_method</option> = <replaceable>AMQPLAIN</replaceable></td>
<td>(StrOpt) The RabbitMQ login method.</td>
</tr>
<tr>
<td><option>rabbit_max_retries</option> = <replaceable>0</replaceable></td>
<td>(IntOpt) Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry count).</td>
</tr>
<tr>
<td><option>rabbit_password</option> = <replaceable>guest</replaceable></td>
<td>(StrOpt) The RabbitMQ password.</td>
</tr>
<tr>
<td><option>rabbit_port</option> = <replaceable>5672</replaceable></td>
<td>(IntOpt) The RabbitMQ broker port where a single node is used.</td>
</tr>
<tr>
<td><option>rabbit_retry_backoff</option> = <replaceable>2</replaceable></td>
<td>(IntOpt) How long to backoff for between retries when connecting to RabbitMQ.</td>
</tr>
<tr>
<td><option>rabbit_retry_interval</option> = <replaceable>1</replaceable></td>
<td>(IntOpt) How frequently to retry connecting with RabbitMQ.</td>
</tr>
<tr>
<td><option>rabbit_use_ssl</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Connect over SSL for RabbitMQ.</td>
</tr>
<tr>
<td><option>rabbit_userid</option> = <replaceable>guest</replaceable></td>
<td>(StrOpt) The RabbitMQ userid.</td>
</tr>
<tr>
<td><option>rabbit_virtual_host</option> = <replaceable>/</replaceable></td>
<td>(StrOpt) The RabbitMQ virtual host.</td>
</tr>
<tr>
<td><option>send_single_reply</option> = <replaceable>False</replaceable></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>
</tbody>
</table>
</para>

41
doc/common/tables/manila-redis.xml Normal file
View File

@ -0,0 +1,41 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_manila_redis">
<caption>Description of Redis configuration options</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[matchmaker_redis]</th>
</tr>
<tr>
<td><option>host</option> = <replaceable>127.0.0.1</replaceable></td>
<td>(StrOpt) Host to locate redis.</td>
</tr>
<tr>
<td><option>password</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Password for Redis server (optional).</td>
</tr>
<tr>
<td><option>port</option> = <replaceable>6379</replaceable></td>
<td>(IntOpt) Use this port to connect to redis host.</td>
</tr>
<tr>
<th colspan="2">[matchmaker_ring]</th>
</tr>
<tr>
<td><option>ringfile</option> = <replaceable>/etc/oslo/matchmaker_ring.json</replaceable></td>
<td>(StrOpt) Matchmaker ring file (JSON).</td>
</tr>
</tbody>
</table>
</para>

108
doc/common/tables/manila-rpc.xml Normal file
View File

@ -0,0 +1,108 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_manila_rpc">
<caption>Description of RPC configuration options</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td><option>matchmaker_heartbeat_freq</option> = <replaceable>300</replaceable></td>
<td>(IntOpt) Heartbeat frequency.</td>
</tr>
<tr>
<td><option>matchmaker_heartbeat_ttl</option> = <replaceable>600</replaceable></td>
<td>(IntOpt) Heartbeat time-to-live.</td>
</tr>
<tr>
<td><option>rpc_backend</option> = <replaceable>rabbit</replaceable></td>
<td>(StrOpt) The messaging driver to use, defaults to rabbit. Other drivers include qpid and zmq.</td>
</tr>
<tr>
<td><option>rpc_cast_timeout</option> = <replaceable>30</replaceable></td>
<td>(IntOpt) Seconds to wait before a cast expires (TTL). Only supported by impl_zmq.</td>
</tr>
<tr>
<td><option>rpc_conn_pool_size</option> = <replaceable>30</replaceable></td>
<td>(IntOpt) Size of RPC connection pool.</td>
</tr>
<tr>
<td><option>rpc_response_timeout</option> = <replaceable>60</replaceable></td>
<td>(IntOpt) Seconds to wait for a response from a call.</td>
</tr>
<tr>
<td><option>share_topic</option> = <replaceable>manila-share</replaceable></td>
<td>(StrOpt) The topic share nodes listen on.</td>
</tr>
<tr>
<th colspan="2">[oslo_concurrency]</th>
</tr>
<tr>
<td><option>disable_process_locking</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Enables or disables inter-process locks.</td>
</tr>
<tr>
<td><option>lock_path</option> = <replaceable>None</replaceable></td>
<td>(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.</td>
</tr>
<tr>
<th colspan="2">[oslo_messaging_amqp]</th>
</tr>
<tr>
<td><option>allow_insecure_clients</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Accept clients using either SSL or plain TCP</td>
</tr>
<tr>
<td><option>broadcast_prefix</option> = <replaceable>broadcast</replaceable></td>
<td>(StrOpt) address prefix used when broadcasting to all servers</td>
</tr>
<tr>
<td><option>container_name</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Name for the AMQP container</td>
</tr>
<tr>
<td><option>group_request_prefix</option> = <replaceable>unicast</replaceable></td>
<td>(StrOpt) address prefix when sending to any server in group</td>
</tr>
<tr>
<td><option>idle_timeout</option> = <replaceable>0</replaceable></td>
<td>(IntOpt) Timeout for inactive connections (in seconds)</td>
</tr>
<tr>
<td><option>server_request_prefix</option> = <replaceable>exclusive</replaceable></td>
<td>(StrOpt) address prefix used when sending to a specific server</td>
</tr>
<tr>
<td><option>ssl_ca_file</option> = <replaceable></replaceable></td>
<td>(StrOpt) CA certificate PEM file to verify server certificate</td>
</tr>
<tr>
<td><option>ssl_cert_file</option> = <replaceable></replaceable></td>
<td>(StrOpt) Identifying certificate PEM file to present to clients</td>
</tr>
<tr>
<td><option>ssl_key_file</option> = <replaceable></replaceable></td>
<td>(StrOpt) Private key PEM file used to sign cert_file certificate</td>
</tr>
<tr>
<td><option>ssl_key_password</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Password for decrypting ssl_key_file (if encrypted)</td>
</tr>
<tr>
<td><option>trace</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Debug: dump AMQP frames to stdout</td>
</tr>
</tbody>
</table>
</para>

34
doc/common/tables/manila-san.xml Normal file
View File

@ -0,0 +1,34 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_manila_san">
<caption>Description of SAN configuration options</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td><option>ssh_conn_timeout</option> = <replaceable>60</replaceable></td>
<td>(IntOpt) Backend server SSH connection timeout.</td>
</tr>
<tr>
<td><option>ssh_max_pool_conn</option> = <replaceable>10</replaceable></td>
<td>(IntOpt) Maximum number of connections in the SSH pool.</td>
</tr>
<tr>
<td><option>ssh_min_pool_conn</option> = <replaceable>1</replaceable></td>
<td>(IntOpt) Minimum number of connections in the SSH pool.</td>
</tr>
</tbody>
</table>
</para>

62
doc/common/tables/manila-scheduler.xml Normal file
View File

@ -0,0 +1,62 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_manila_scheduler">
<caption>Description of Scheduler configuration options</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td><option>capacity_weight_multiplier</option> = <replaceable>1.0</replaceable></td>
<td>(FloatOpt) Multiplier used for weighing share capacity. Negative numbers mean to stack vs spread.</td>
</tr>
<tr>
<td><option>pool_weight_multiplier</option> = <replaceable>1.0</replaceable></td>
<td>(FloatOpt) Multiplier used for weighing pools which have existing share servers. Negative numbers mean to spread vs stack.</td>
</tr>
<tr>
<td><option>scheduler_default_filters</option> = <replaceable>AvailabilityZoneFilter, CapacityFilter, CapabilitiesFilter, ConsistencyGroupFilter</replaceable></td>
<td>(ListOpt) Which filter class names to use for filtering hosts when not specified in the request.</td>
</tr>
<tr>
<td><option>scheduler_default_weighers</option> = <replaceable>CapacityWeigher</replaceable></td>
<td>(ListOpt) Which weigher class names to use for weighing hosts.</td>
</tr>
<tr>
<td><option>scheduler_driver</option> = <replaceable>manila.scheduler.filter_scheduler.FilterScheduler</replaceable></td>
<td>(StrOpt) Default scheduler driver to use.</td>
</tr>
<tr>
<td><option>scheduler_host_manager</option> = <replaceable>manila.scheduler.host_manager.HostManager</replaceable></td>
<td>(StrOpt) The scheduler host manager class to use.</td>
</tr>
<tr>
<td><option>scheduler_json_config_location</option> = <replaceable></replaceable></td>
<td>(StrOpt) Absolute path to scheduler configuration JSON file.</td>
</tr>
<tr>
<td><option>scheduler_manager</option> = <replaceable>manila.scheduler.manager.SchedulerManager</replaceable></td>
<td>(StrOpt) Full class name for the scheduler manager.</td>
</tr>
<tr>
<td><option>scheduler_max_attempts</option> = <replaceable>3</replaceable></td>
<td>(IntOpt) Maximum number of attempts to schedule a share.</td>
</tr>
<tr>
<td><option>scheduler_topic</option> = <replaceable>manila-scheduler</replaceable></td>
<td>(StrOpt) The topic scheduler nodes listen on.</td>
</tr>
</tbody>
</table>
</para>

266
doc/common/tables/manila-share.xml Normal file
View File

@ -0,0 +1,266 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_manila_share">
<caption>Description of Share configuration options</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td><option>automatic_share_server_cleanup</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) If set to True, then Manila will delete all share servers which were unused more than specified time .If set to False - automatic deletion of share servers will be disabled.</td>
</tr>
<tr>
<td><option>backlog</option> = <replaceable>4096</replaceable></td>
<td>(IntOpt) Number of backlog requests to configure the socket with.</td>
</tr>
<tr>
<td><option>connect_share_server_to_tenant_network</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Attach share server directly to share network. Used only with Neutron.</td>
</tr>
<tr>
<td><option>default_share_type</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Default share type to use.</td>
</tr>
<tr>
<td><option>delete_share_server_with_last_share</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Whether share servers will be deleted on deletion of the last share.</td>
</tr>
<tr>
<td><option>driver_handles_share_servers</option> = <replaceable>None</replaceable></td>
<td>(BoolOpt) There are two possible approaches for share drivers in Manila. First is when share driver is able to handle share-servers and second when not. Drivers can support either both or only one of these approaches. So, set this opt to True if share driver is able to handle share servers and it is desired mode else set False. It is set to None by default to make this choice intentional.</td>
</tr>
<tr>
<td><option>enable_periodic_hooks</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Whether to enable periodic hooks or not.</td>
</tr>
<tr>
<td><option>enable_post_hooks</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Whether to enable post hooks or not.</td>
</tr>
<tr>
<td><option>enable_pre_hooks</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Whether to enable pre hooks or not.</td>
</tr>
<tr>
<td><option>enabled_share_backends</option> = <replaceable>None</replaceable></td>
<td>(ListOpt) A list of share backend names to use. These backend names should be backed by a unique [CONFIG] group with its options.</td>
</tr>
<tr>
<td><option>enabled_share_protocols</option> = <replaceable>NFS, CIFS</replaceable></td>
<td>(ListOpt) Specify list of protocols to be allowed for share creation. Available values are '('NFS', 'CIFS', 'GLUSTERFS', 'HDFS')'</td>
</tr>
<tr>
<td><option>executor_thread_pool_size</option> = <replaceable>64</replaceable></td>
<td>(IntOpt) Size of executor thread pool.</td>
</tr>
<tr>
<td><option>hook_drivers</option> = <replaceable></replaceable></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><option>interface_driver</option> = <replaceable>manila.network.linux.interface.OVSInterfaceDriver</replaceable></td>
<td>(StrOpt) Vif driver. Used only with Neutron.</td>
</tr>
<tr>
<td><option>manila_service_keypair_name</option> = <replaceable>manila-service</replaceable></td>
<td>(StrOpt) Keypair name that will be created and used for service instances.</td>
</tr>
<tr>
<td><option>max_time_to_attach</option> = <replaceable>120</replaceable></td>
<td>(IntOpt) Maximum time to wait for attaching cinder volume.</td>
</tr>
<tr>
<td><option>max_time_to_build_instance</option> = <replaceable>300</replaceable></td>
<td>(IntOpt) Maximum time in seconds to wait for creating service instance.</td>
</tr>
<tr>
<td><option>max_time_to_create_volume</option> = <replaceable>180</replaceable></td>
<td>(IntOpt) Maximum time to wait for creating cinder volume.</td>
</tr>
<tr>
<td><option>max_time_to_extend_volume</option> = <replaceable>180</replaceable></td>
<td>(IntOpt) Maximum time to wait for extending cinder volume.</td>
</tr>
<tr>
<td><option>migration_create_delete_share_timeout</option> = <replaceable>300</replaceable></td>
<td>(IntOpt) Timeout for creating and deleting share instances when performing share migration (seconds).</td>
</tr>
<tr>
<td><option>migration_data_copy_node_ip</option> = <replaceable>None</replaceable></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><option>migration_ignore_files</option> = <replaceable>lost+found</replaceable></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><option>migration_mounting_backend_ip</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Backend IP in admin network to use for mounting shares during migration.</td>
</tr>
<tr>
<td><option>migration_protocol_mount_command</option> = <replaceable>None</replaceable></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><option>migration_readonly_support</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Specify whether read only access mode is supported in thisbackend.</td>
</tr>
<tr>
<td><option>migration_tmp_location</option> = <replaceable>/tmp/</replaceable></td>
<td>(StrOpt) Temporary path to create and mount shares during migration.</td>
</tr>
<tr>
<td><option>migration_wait_access_rules_timeout</option> = <replaceable>90</replaceable></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><option>network_config_group</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Name of the configuration group in the Manila conf file to look for network config options.If not set, the share backend's config group will be used.If an option is not found within provided group, then'DEFAULT' group will be used for search of option.</td>
</tr>
<tr>
<td><option>ovs_integration_bridge</option> = <replaceable>br-int</replaceable></td>
<td>(StrOpt) Name of Open vSwitch bridge to use.</td>
</tr>
<tr>
<td><option>path_to_private_key</option> = <replaceable>~/.ssh/id_rsa</replaceable></td>
<td>(StrOpt) Path to host's private key.</td>
</tr>
<tr>
<td><option>path_to_public_key</option> = <replaceable>~/.ssh/id_rsa.pub</replaceable></td>
<td>(StrOpt) Path to hosts public key.</td>
</tr>
<tr>
<td><option>root_helper</option> = <replaceable>sudo</replaceable></td>
<td>(StrOpt) Deprecated: command to use for running commands as root.</td>
</tr>
<tr>
<td><option>service_image_name</option> = <replaceable>manila-service-image</replaceable></td>
<td>(StrOpt) Name of image in Glance, that will be used for service instance creation.</td>
</tr>
<tr>
<td><option>service_instance_flavor_id</option> = <replaceable>100</replaceable></td>
<td>(IntOpt) ID of flavor, that will be used for service instance creation.</td>
</tr>
<tr>
<td><option>service_instance_name_or_id</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Name or ID of service instance in Nova to use for share exports. Used only when share servers handling is disabled.</td>
</tr>
<tr>
<td><option>service_instance_name_template</option> = <replaceable>manila_service_instance_%s</replaceable></td>
<td>(StrOpt) Name of service instance.</td>
</tr>
<tr>
<td><option>service_instance_network_helper_type</option> = <replaceable>neutron</replaceable></td>
<td>(StrOpt) Allowed values are ['nova', 'neutron'].</td>
</tr>
<tr>
<td><option>service_instance_password</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Password for service instance user.</td>
</tr>
<tr>
<td><option>service_instance_security_group</option> = <replaceable>manila-service</replaceable></td>
<td>(StrOpt) Security group name, that will be used for service instance creation.</td>
</tr>
<tr>
<td><option>service_instance_smb_config_path</option> = <replaceable>$share_mount_path/smb.conf</replaceable></td>
<td>(StrOpt) Path to SMB config in service instance.</td>
</tr>
<tr>
<td><option>service_instance_user</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) User in service instance that will be used for authentication.</td>
</tr>
<tr>
<td><option>service_net_name_or_ip</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Can be either name of network that is used by service instance within Nova to get IP address or IP address itself for managing shares there. Used only when share servers handling is disabled.</td>
</tr>
<tr>
<td><option>service_network_cidr</option> = <replaceable>10.254.0.0/16</replaceable></td>
<td>(StrOpt) CIDR of manila service network. Used only with Neutron.</td>
</tr>
<tr>
<td><option>service_network_division_mask</option> = <replaceable>28</replaceable></td>
<td>(IntOpt) This mask is used for dividing service network into subnets, IP capacity of subnet with this mask directly defines possible amount of created service VMs per tenant's subnet. Used only with Neutron.</td>
</tr>
<tr>
<td><option>service_network_name</option> = <replaceable>manila_service_network</replaceable></td>
<td>(StrOpt) Name of manila service network. Used only with Neutron.</td>
</tr>
<tr>
<td><option>share_backend_name</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) The backend name for a given driver implementation.</td>
</tr>
<tr>
<td><option>share_driver</option> = <replaceable>manila.share.drivers.generic.GenericShareDriver</replaceable></td>
<td>(StrOpt) Driver to use for share creation.</td>
</tr>
<tr>
<td><option>share_helpers</option> = <replaceable>CIFS=manila.share.drivers.generic.CIFSHelper, NFS=manila.share.drivers.generic.NFSHelper</replaceable></td>
<td>(ListOpt) Specify list of share export helpers.</td>
</tr>
<tr>
<td><option>share_manager</option> = <replaceable>manila.share.manager.ShareManager</replaceable></td>
<td>(StrOpt) Full class name for the share manager.</td>
</tr>
<tr>
<td><option>share_mount_path</option> = <replaceable>/shares</replaceable></td>
<td>(StrOpt) Parent path in service instance where shares will be mounted.</td>
</tr>
<tr>
<td><option>share_name_template</option> = <replaceable>share-%s</replaceable></td>
<td>(StrOpt) Template string to be used to generate share names.</td>
</tr>
<tr>
<td><option>share_snapshot_name_template</option> = <replaceable>share-snapshot-%s</replaceable></td>
<td>(StrOpt) Template string to be used to generate share snapshot names.</td>
</tr>
<tr>
<td><option>share_usage_audit_period</option> = <replaceable>month</replaceable></td>
<td>(StrOpt) Time period to generate share usages for. Time period must be hour, day, month or year.</td>
</tr>
<tr>
<td><option>share_volume_fstype</option> = <replaceable>ext4</replaceable></td>
<td>(StrOpt) Filesystem type of the share volume.</td>
</tr>
<tr>
<td><option>smb_template_config_path</option> = <replaceable>$state_path/smb.conf</replaceable></td>
<td>(StrOpt) Path to smb config.</td>
</tr>
<tr>
<td><option>suppress_post_hooks_errors</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Whether to suppress post hook errors (allow driver's results to pass through) or not.</td>
</tr>
<tr>
<td><option>suppress_pre_hooks_errors</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Whether to suppress pre hook errors (allow driver perform actions) or not.</td>
</tr>
<tr>
<td><option>tenant_net_name_or_ip</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Can be either name of network that is used by service instance within Nova to get IP address or IP address itself for exporting shares. Used only when share servers handling is disabled.</td>
</tr>
<tr>
<td><option>unmanage_remove_access_rules</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) If set to True, then manila will deny access and remove all access rules on share unmanage.If set to False - nothing will be changed.</td>
</tr>
<tr>
<td><option>unused_share_server_cleanup_interval</option> = <replaceable>10</replaceable></td>
<td>(IntOpt) Unallocated share servers reclamation time interval (minutes). Minimum value is 10 minutes, maximum is 60 minutes. The reclamation function is run every 10 minutes and delete share servers which were unused more than unused_share_server_cleanup_interval option defines. This value reflects the shortest time Manila will wait for a share server to go unutilized before deleting it.</td>
</tr>
<tr>
<td><option>use_scheduler_creating_share_from_snapshot</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) If set to False, then share creation from snapshot will be performed on the same host. If set to True, then scheduling step will be used.</td>
</tr>
</tbody>
</table>
</para>

66
doc/common/tables/manila-storage.xml Normal file
View File

@ -0,0 +1,66 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_manila_storage">
<caption>Description of Storage configuration options</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td><option>cinder_admin_auth_url</option> = <replaceable>http://localhost:5000/v2.0</replaceable></td>
<td>(StrOpt) Identity service URL.</td>
</tr>
<tr>
<td><option>cinder_admin_password</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Cinder admin password.</td>
</tr>
<tr>
<td><option>cinder_admin_tenant_name</option> = <replaceable>service</replaceable></td>
<td>(StrOpt) Cinder admin tenant name.</td>
</tr>
<tr>
<td><option>cinder_admin_username</option> = <replaceable>cinder</replaceable></td>
<td>(StrOpt) Cinder admin username.</td>
</tr>
<tr>
<td><option>cinder_api_insecure</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Allow to perform insecure SSL requests to cinder.</td>
</tr>
<tr>
<td><option>cinder_ca_certificates_file</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Location of CA certificates file to use for cinder client requests.</td>
</tr>
<tr>
<td><option>cinder_catalog_info</option> = <replaceable>volume:cinder:publicURL</replaceable></td>
<td>(StrOpt) Info to match when looking for cinder in the service catalog. Format is separated values of the form: &lt;service_type&gt;:&lt;service_name&gt;:&lt;endpoint_type&gt;</td>
</tr>
<tr>
<td><option>cinder_cross_az_attach</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Allow attaching between instances and volumes in different availability zones.</td>
</tr>
<tr>
<td><option>cinder_http_retries</option> = <replaceable>3</replaceable></td>
<td>(IntOpt) Number of cinderclient retries on failed HTTP calls.</td>
</tr>
<tr>
<td><option>cinder_volume_type</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Name or id of cinder volume type which will be used for all volumes created by driver.</td>
</tr>
<tr>
<td><option>max_gigabytes</option> = <replaceable>10000</replaceable></td>
<td>(IntOpt) Maximum number of volume gigabytes to allow per host.</td>
</tr>
</tbody>
</table>
</para>

50
doc/common/tables/manila-winrm.xml Normal file
View File

@ -0,0 +1,50 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_manila_winrm">
<caption>Description of WinRM configuration options</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td><option>winrm_cert_key_pem_path</option> = <replaceable>~/.ssl/key.pem</replaceable></td>
<td>(StrOpt) Path to the x509 certificate key.</td>
</tr>
<tr>
<td><option>winrm_cert_pem_path</option> = <replaceable>~/.ssl/cert.pem</replaceable></td>
<td>(StrOpt) Path to the x509 certificate used for accessing the serviceinstance.</td>
</tr>
<tr>
<td><option>winrm_conn_timeout</option> = <replaceable>60</replaceable></td>
<td>(IntOpt) WinRM connection timeout.</td>
</tr>
<tr>
<td><option>winrm_operation_timeout</option> = <replaceable>60</replaceable></td>
<td>(IntOpt) WinRM operation timeout.</td>
</tr>
<tr>
<td><option>winrm_retry_count</option> = <replaceable>3</replaceable></td>
<td>(IntOpt) WinRM retry count.</td>
</tr>
<tr>
<td><option>winrm_retry_interval</option> = <replaceable>5</replaceable></td>
<td>(IntOpt) WinRM retry interval in seconds</td>
</tr>
<tr>
<td><option>winrm_use_cert_based_auth</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Use x509 certificates in order to authenticate to theservice instance.</td>
</tr>
</tbody>
</table>
</para>

50
doc/common/tables/manila-zeromq.xml Normal file
View File

@ -0,0 +1,50 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_manila_zeromq">
<caption>Description of ZeroMQ configuration options</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td><option>rpc_zmq_bind_address</option> = <replaceable>*</replaceable></td>
<td>(StrOpt) ZeroMQ bind address. Should be a wildcard (*), an ethernet interface, or IP. The "host" option should point or resolve to this address.</td>
</tr>
<tr>
<td><option>rpc_zmq_contexts</option> = <replaceable>1</replaceable></td>
<td>(IntOpt) Number of ZeroMQ contexts, defaults to 1.</td>
</tr>
<tr>
<td><option>rpc_zmq_host</option> = <replaceable>localhost</replaceable></td>
<td>(StrOpt) Name of this node. Must be a valid hostname, FQDN, or IP address. Must match "host" option, if running Nova.</td>
</tr>
<tr>
<td><option>rpc_zmq_ipc_dir</option> = <replaceable>/var/run/openstack</replaceable></td>
<td>(StrOpt) Directory for holding IPC sockets.</td>
</tr>
<tr>
<td><option>rpc_zmq_matchmaker</option> = <replaceable>local</replaceable></td>
<td>(StrOpt) MatchMaker driver.</td>
</tr>
<tr>
<td><option>rpc_zmq_port</option> = <replaceable>9501</replaceable></td>
<td>(IntOpt) ZeroMQ receiver listening port.</td>
</tr>
<tr>
<td><option>rpc_zmq_topic_backlog</option> = <replaceable>None</replaceable></td>
<td>(IntOpt) Maximum number of ingress messages to locally buffer per topic. Default is unlimited.</td>
</tr>
</tbody>
</table>
</para>

78
doc/common/tables/manila-zfssa.xml Normal file
View File

@ -0,0 +1,78 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_manila_zfssa">
<caption>Description of ZFSSA Share Driver configuration options</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td><option>zfssa_auth_password</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) ZFSSA management authorized userpassword.</td>
</tr>
<tr>
<td><option>zfssa_auth_user</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) ZFSSA management authorized username.</td>
</tr>
<tr>
<td><option>zfssa_data_ip</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) IP address for data.</td>
</tr>
<tr>
<td><option>zfssa_host</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) ZFSSA management IP address.</td>
</tr>
<tr>
<td><option>zfssa_nas_checksum</option> = <replaceable>fletcher4</replaceable></td>
<td>(StrOpt) Controls checksum used for data blocks.</td>
</tr>
<tr>
<td><option>zfssa_nas_compression</option> = <replaceable>off</replaceable></td>
<td>(StrOpt) Data compression-off, lzjb, gzip-2, gzip, gzip-9.</td>
</tr>
<tr>
<td><option>zfssa_nas_logbias</option> = <replaceable>latency</replaceable></td>
<td>(StrOpt) Controls behavior when servicing synchronous writes.</td>
</tr>
<tr>
<td><option>zfssa_nas_mountpoint</option> = <replaceable></replaceable></td>
<td>(StrOpt) Location of project in ZFS/SA.</td>
</tr>
<tr>
<td><option>zfssa_nas_quota_snap</option> = <replaceable>true</replaceable></td>
<td>(StrOpt) Controls whether a share quota includes snapshot.</td>
</tr>
<tr>
<td><option>zfssa_nas_rstchown</option> = <replaceable>true</replaceable></td>
<td>(StrOpt) Controls whether file ownership can be changed.</td>
</tr>
<tr>
<td><option>zfssa_nas_vscan</option> = <replaceable>false</replaceable></td>
<td>(StrOpt) Controls whether the share is scanned for viruses.</td>
</tr>
<tr>
<td><option>zfssa_pool</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) ZFSSA storage pool name.</td>
</tr>
<tr>
<td><option>zfssa_project</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) ZFSSA project name.</td>
</tr>
<tr>
<td><option>zfssa_rest_timeout</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) REST connection timeout (in seconds).</td>
</tr>
</tbody>
</table>
</para>

2
doc/config-reference/bk-config-ref.xml
View File

@ -145,6 +145,8 @@
<xi:include href="ch_baremetalconfigure.xml"/>
<!-- Block Storage -->
<xi:include href="ch_blockstorageconfigure.xml"/>
<!-- Shared File Systems -->
<xi:include href="ch_sharedfilesystemsconfigure.xml"/>
<!-- Compute -->
<xi:include href="ch_computeconfigure.xml"/>
<!-- Dashboard -->

16
doc/config-reference/ch_sharedfilesystemsconfigure.xml Normal file
View File

@ -0,0 +1,16 @@
<?xml version="1.0" encoding="UTF-8"?>
<chapter xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink"
version="5.0"
xml:id="ch_configuring-openstack-shared-file-systems">
<title>Shared File Systems</title>
<para>The Shared File Systems service works with many different
drivers that you can configure by using these instructions.</para>
<xi:include href="shared-file-systems/section_shared-file-systems-overview.xml"/>
<xi:include href="shared-file-systems/section_share-drivers.xml"/>
<xi:include href="shared-file-systems/section_manila-log-files.xml"/>
<xi:include href="shared-file-systems/section_manila-sample-configuration-files.xml" />
<xi:include href="shared-file-systems/section_manila-misc.xml"/>
<xi:include href="conf-changes/manila.xml"/>
</chapter>

63
doc/config-reference/conf-changes/manila.xml Normal file
View File

@ -0,0 +1,63 @@
<?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</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] TODO:</td>
<td>This needs to be generated.</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] auth_strategy</td>
<td>noauth</td>
<td>keystone</td>
</tr>
<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, requests.packages.urllib3.util.retry=WARN, urllib3.util.retry=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] 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>
</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] TODO</td>
<td>This table needs to be generated.</td>
</tr>
</table>
</section>

137
doc/config-reference/shared-file-systems/drivers/emc-isilon-driver.xml Normal file
View File

@ -0,0 +1,137 @@
<section xml:id="isilon-driver" xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0">
<title>EMC Isilon driver</title>
<para>
The EMC Shared File Systems driver framework (EMCShareDriver)
utilizes EMC
storage products to provide shared file systems to OpenStack. The EMC
driver is a plug-in based driver which is designed to use
different plug-ins to manage different EMC storage products.
</para>
<para>
The Isilon driver is a plug-in for the EMC framework which allows
the Shared File Systems service to interface with an Isilon back end to
provide a shared filesystem. The EMC driver framework with the
Isilon plug-in is referred to as the &quot;Isilon Driver&quot; in
this document.
</para>
<para>
This Isilon Driver interfaces with an Isilon cluster via the REST
Isilon Platform API (PAPI) and the RESTful Access to Namespace API
(RAN).
</para>
<simplesect>
<title>Requirements</title>
<itemizedlist>
<listitem>
<para>
Isilon cluster running OneFS 7.2 or higher
</para>
</listitem>
</itemizedlist>
</simplesect>
<simplesect>
<title>Supported operations</title>
<para>
The following operations will be supported on an Isilon cluster:
</para>
<itemizedlist>
<listitem>
<para>
Create CIFS/NFS share.
</para>
</listitem>
<listitem>
<para>
Delete CIFS/NFS share.
</para>
</listitem>
<listitem>
<para>
Allow CIFS/NFS share access.
</para>
<itemizedlist>
<listitem>
<para>
Only IP access type is supported for NFS and CIFS.
</para>
</listitem>
</itemizedlist>
<para>
* Only RW access is supported.
</para>
</listitem>
<listitem>
<para>
Deny CIFS/NFS share access
</para>
</listitem>
<listitem>
<para>
Create snapshot
</para>
</listitem>
<listitem>
<para>
Delete snapshot
</para>
</listitem>
<listitem>
<para>
Create share from snapshot
</para>
</listitem>
</itemizedlist>
</simplesect>
<simplesect>
<title>Backend configuration</title>
<para>
The following parameters need to be configured in the Shared
File Systems service configuration file for the Isilon driver:
</para>
<blockquote>
<para>
share_driver = manila.share.drivers.emc.driver.EMCShareDriver
emc_share_backend = isilon emc_nas_server = &lt;IP address of
Isilon cluster&gt; emc_nas_login = &lt;username&gt;
emc_nas_password = &lt;password&gt; isilon_share_root_dir =
&lt;directory on Isilon where shares will be created&gt;
</para>
</blockquote>
<para>
Restart of manila-share service is needed for the configuration
changes to take effect.
</para>
</simplesect>
<simplesect>
<title>Restrictions</title>
<para>
The Isilon driver has the following restrictions:
</para>
<itemizedlist>
<listitem>
<para>
Only IP access type is supported for NFS and CIFS.
</para>
</listitem>
<listitem>
<para>
Only FLAT network is supported.
</para>
</listitem>
<listitem>
<para>
Quotas are not yet supported.
</para>
</listitem>
</itemizedlist>
</simplesect>
<simplesect>
<title>Driver configuration options</title>
<para>
Configuration options specific to this driver are documented here:
<xref linkend="config_table_manila_emc"/>.
</para>
</simplesect>
</section>

466
doc/config-reference/shared-file-systems/drivers/emc-vnx-driver.xml Normal file
View File

@ -0,0 +1,466 @@
<section xml:id="vnx-driver" xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0">
<title>EMC VNX driver</title>
<para>
EMC Shared File Systems service driver framework (EMCShareDriver)
utilizes the EMC storage products to provide the shared file systems
to OpenStack. The EMC driver is a plug-in based driver which is designed
to use different plug-ins to manage different EMC storage products.
</para>
<para>
VNX plug-in is the plug-in which manages the VNX to provide shared
filesystems. EMC driver framework with VNX plug-in is referred to as
VNX driver in this document.
</para>
<para>
This driver performs the operations on VNX by XMLAPI and the File
command line. Each back end manages one Data Mover of VNX. Multiple
Shared File Systems service back ends need to be configured to manage
multiple Data Movers.
</para>
<simplesect>
<title>Requirements</title>
<itemizedlist>
<listitem>
<para>
VNX OE for File version 7.1 or higher
</para>
</listitem>
<listitem>
<para>
VNX Unified, File only, or Gateway system with single storage
back end
</para>
</listitem>
<listitem>
<para>
The following licenses should be activated on VNX for File:
</para>
<itemizedlist>
<listitem>
<para>
CIFS
</para>
</listitem>
<listitem>
<para>
NFS
</para>
</listitem>
<listitem>
<para>
SnapSure (for snapshot)
</para>
</listitem>
<listitem>
<para>
ReplicationV2 (for create share from snapshot)
</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
</simplesect>
<simplesect>
<title>Supported operations</title>
<para>
The following operations will be supported on VNX array:
</para>
<itemizedlist>
<listitem>
<para>
Create CIFS/NFS share.
</para>
</listitem>
<listitem>
<para>
Delete CIFS/NFS share.
</para>
</listitem>
<listitem>
<para>
Allow CIFS/NFS share access.
</para>
<itemizedlist>
<listitem>
<para>
Only IP access type is supported for NFS.
</para>
</listitem>
</itemizedlist>
<para>
* Only user access type is supported for CIFS.
</para>
</listitem>
<listitem>
<para>
Deny CIFS/NFS share access.
</para>
</listitem>
<listitem>
<para>
Create snapshot.
</para>
</listitem>
<listitem>
<para>
Delete snapshot.
</para>
</listitem>
<listitem>
<para>
Create share from snapshot.
</para>
</listitem>
</itemizedlist>
<para>
While the generic driver creates shared filesystems based on
cinder volumes attached to nova VMs, the VNX driver performs
similar operations using the Data Movers on the array.
</para>
</simplesect>
<simplesect>
<title>Pre-configurations on VNX</title>
<orderedlist numeration="arabic">
<listitem>
<para>
Enable Unicode on Data Mover.
</para>
</listitem>
</orderedlist>
<para>
VNX driver requires that the Unicode is enabled on Data Mover.
</para>
<caution><para>
CAUTION: After enabling Unicode, you cannot disable it. If there
are some filesystems created before Unicode is enabled on the VNX,
consult the storage administrator before enabling Unicode.
</para></caution>
<para>
To check the Unicode status on Data Mover, use the following VNX
File command on VNX control station:
</para>
<blockquote>
<para>
server_cifs &lt;mover_name&gt; | head where: mover_name =
&lt;name of the Data Mover&gt;
</para>
</blockquote>
<para>
Check the value of I18N mode field. UNICODE mode is shown as
I18N mode =
UNICODE
</para>
<para>
To enable the Unicode for Data Mover:
</para>
<blockquote>
<para>
uc_config -on -mover &lt;mover_name&gt; where: mover_name =
&lt;name of the Data Mover&gt;
</para>
</blockquote>
<para>
Refer to the document
Using International Character Sets on VNX for File on [EMC support
site](<link xlink:href="http://support.emc.com">http://support.emc.com</link>)
for more information.
</para>
<orderedlist numeration="arabic">
<listitem override="2">
<para>
Enable CIFS service on Data Mover.
</para>
</listitem>
</orderedlist>
<para>
Ensure the CIFS service is enabled on the Data Mover which is
going to be managed by VNX driver.
</para>
<para>
To start the CIFS service, use the following command:
</para>
<blockquote>
<para>
server_setup &lt;mover_name&gt; -Protocol cifs -option start
[=&lt;n&gt;] where: &lt;mover_name&gt; = &lt;name of the Data
Mover&gt; [=&lt;n&gt;] = &lt;number of threads for CIFS
users&gt;
</para>
</blockquote>
<note><para>
Note: If there is 1 GB of memory on the Data Mover, the default is
96 threads; however, if there is over 1 GB of memory, the default
number of threads is 256.
</para></note>
<para>
To check the CIFS service status, use this command:
</para>
<blockquote>
<para>
server_cifs &lt;mover_name&gt; | head where: &lt;mover_name&gt;
= &lt;name of the Data Mover&gt;
</para>
</blockquote>
<para>
The command output will show the number of CIFS threads started.
</para>
<orderedlist numeration="arabic">
<listitem override="3">
<para>
NTP settings on Data Mover.
</para>
</listitem>
</orderedlist>
<para>
VNX driver only supports CIFS share creation with share network
which has an Active Directory security-service associated.
</para>
<para>
Creating CIFS share requires that the time on the Data Mover is in
sync with the Active Directory domain so that the CIFS server can
join the domain. Otherwise, the domain join will fail when
creating share with this security service. There is a limitation
that the time of the domains used by security-services even for
different tenants and different share networks should be in sync.
Time difference should be less than 10 minutes.
</para>
<para>
It is recommended to set the NTP server to the same public NTP
server on both the Data Mover and domains used in security
services to ensure the time is in sync everywhere.
</para>
<para>
Check the date and time on Data Mover:
</para>
<blockquote>
<para>
server_date &lt;mover_name&gt; where: mover_name = &lt;name of
the Data Mover&gt;
</para>
</blockquote>
<para>
Set the NTP server for Data Mover:
</para>
<blockquote>
<para>
server_date &lt;mover_name&gt; timesvc start ntp &lt;host&gt;
[&lt;host&gt; ...] where: mover_name = &lt;name of the Data
Mover&gt; host = &lt;IP address of the time server host&gt;
</para>
</blockquote>
<note><para>
Note: The host must be running the NTP protocol. Only 4 host
entries are allowed.
</para></note>
<orderedlist numeration="arabic">
<listitem override="4">
<para>
Configure User Mapping on the Data Mover.
</para>
</listitem>
</orderedlist>
<para>
Before creating CIFS share using VNX driver, you must select a
method of mapping Windows SIDs to UIDs and GIDs. EMC recommends
using usermapper in single protocol (CIFS) environment which is
enabled on VNX by default.
</para>
<para>
To check usermapper status, use this command syntax:
</para>
<blockquote>
<para>
server_usermapper &lt;movername&gt; where: &lt;movername&gt; =
&lt;name of the Data Mover&gt;
</para>
</blockquote>
<para>
If usermapper is not started, the following command can be used to
start the usermapper:
</para>
<blockquote>
<para>
server_usermapper &lt;movername&gt; -enable where:
&lt;movername&gt; = &lt;name of the Data Mover&gt;
</para>
</blockquote>
<para>
For multiple protocol environment, refer to
Configuring VNX User Mapping on [EMC support
site](<link xlink:href="http://support.emc.com">http://support.emc.com</link>)
for additional information.
</para>
<orderedlist numeration="arabic">
<listitem override="5">
<para>
Network Connection.
</para>
</listitem>
</orderedlist>
<para>
In the current release, the share created by VNX driver uses the
first network device (physical port on NIC) of Data Mover to
access the network.
</para>
<para>
Go to Unisphere to check the device list: Settings -&gt; Network
-&gt; Settings for File (Unified system only) -&gt; Device.
</para>
</simplesect>
<simplesect>
<title>Backend configuration</title>
<para>
The following parameters need to be configured in
/etc/manila/manila.conf for the VNX driver:
</para>
<blockquote>
<para>
emc_share_backend = vnx emc_nas_server = &lt;IP address&gt;
emc_nas_password = &lt;password&gt; emc_nas_login = &lt;user&gt;
emc_nas_server_container = &lt;Data Mover name&gt;
emc_nas_pool_name = &lt;pool name&gt; share_driver =
manila.share.drivers.emc.driver.EMCShareDriver
</para>
</blockquote>
<itemizedlist>
<listitem>
<para>
emc_share_backend is the plug-in name. Set it to
<literal>vnx</literal> for the VNX driver.
</para>
</listitem>
<listitem>
<para>
emc_nas_server is the control station IP address of the VNX
system to be managed.
</para>
</listitem>
<listitem>
<para>
emc_nas_password and emc_nas_login fields are used to provide
credentials to the VNX system. Only local users of VNX File is
supported.
</para>
</listitem>
<listitem>
<para>
emc_nas_server_container field is the name of the Data Mover
to serve the share service.
</para>
</listitem>
<listitem>
<para>
emc_nas_pool_name is the pool name user wants to create volume
from. The pools can be created using Unisphere for VNX.
</para>
</listitem>
</itemizedlist>
<para>
Restart of manila-share service is needed for the configuration
changes to take effect.
</para>
</simplesect>
<simplesect>
<title>Restrictions</title>
<para>
The VNX driver has the following restrictions:
</para>
<itemizedlist>
<listitem>
<para>
Only IP access type is supported for NFS.
</para>
</listitem>
<listitem>
<para>
Only user access type is supported for CIFS.
</para>
</listitem>
<listitem>
<para>
Only FLAT network and VLAN network are supported.
</para>
</listitem>
<listitem>
<para>
VLAN network is supported with limitations. The neutron
subnets in different VLANs that are used to create share
networks cannot have overlapped address spaces. Otherwise, VNX
may have a problem to communicate with the hosts in the VLANs.
To create shares for different VLANs with same subnet address,
use different Data Movers.
</para>
</listitem>
<listitem>
<para>
The 'Active Directory' security service is the only supported
security service type and it is required to create CIFS
shares.
</para>
</listitem>
<listitem>
<para>
Only one security service can be configured for each share
network.
</para>
</listitem>
<listitem>
<para>
Active Directory domain name of the 'active_directory'
security service should be unique even for different tenants.
</para>
</listitem>
<listitem>
<para>
The time on Data Mover and the Active Directory domains used
in security services should be in sync (time difference should
be less than 10 minutes). It is recommended to use same NTP
server on both the Data Mover and Active Directory domains.
</para>
</listitem>
<listitem>
<para>
On VNX the snapshot is stored in the SavVols. VNX system
allows the space used by SavVol to be created and extended
until the sum of the space consumed by all SavVols on the
system exceeds the default 20% of the total space available on
the system. If the 20% threshold value is reached, an alert
will be generated on VNX. Continuing to create snapshot will
cause the old snapshot to be inactivated (and the snapshot
data to be abandoned). The limit percentage value can be
changed manually by storage administrator based on the storage
needs. Administrator is recommended to configure the
notification on the SavVol usage. Refer to Using VNX SnapSure
document on [EMC support
site](<link xlink:href="http://support.emc.com">http://support.emc.com</link>)
for more information.
</para>
</listitem>
<listitem>
<para>
VNX has limitations on the overall numbers of Virtual Data
Movers, filesystems, shares, checkpoints, etc. Virtual
Data Mover(VDM) is created by the VNX driver on the VNX to
serve as the Shared File Systems service share server.
Similarly, filesystem is
created, mounted, and exported from the VDM over CIFS or NFS
protocol to serve as the Shared File Systems service share.
The VNX checkpoint serves as the Shared File Systems service
share snapshot. Refer to the
NAS Support Matrix document on [EMC support
site](<link xlink:href="http://support.emc.com">http://support.emc.com</link>)
for the limitations and configure the quotas accordingly.
</para>
</listitem>
</itemizedlist>
</simplesect>
<simplesect>
<title>Driver configuration options</title>
<para>
Configuration options specific to this driver are documented here:
<xref linkend="config_table_manila_emc"/>.
</para>
</simplesect>
</section>

206
doc/config-reference/shared-file-systems/drivers/generic-driver.xml Normal file
View File

@ -0,0 +1,206 @@
<section xml:id="generic-approach-for-share-provisioning" xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0">
<title>Generic approach for share provisioning</title>
<para>
The Shared File Systems service can be configured to
use nova VMs and cinder volumes. There are two modules that handle
them in the Shared File Systems service:</para>
<itemizedlist>
<listitem><para>
<literal>service_instance</literal> module creates VMs in nova
with predefined image called service image. This module can be used
by any driver for provisioning of service VMs to be able to
separate share resources among tenants.
</para></listitem>
<listitem><para>
'generic' module operates
with cinder volumes and VMs created by
<literal>service_instance</literal> module,
then creates shared filesystems based on volumes attached to VMs.
</para></listitem>
</itemizedlist>
<simplesect>
<title>Network configurations</title>
<para>
Each driver can handle networking in its own way, see:
<link xlink:href="https://wiki.openstack.org/wiki/manila/Networking">https://wiki.openstack.org/wiki/manila/Networking</link>.
</para>
<variablelist>
<varlistentry>
<term>
One of two possible configurations can be chosen for share
provisioning
</term>
<listitem>
<para>
using <literal>service_instance</literal> module:
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
- Service VM has one net interface from net that is connected
to public router.
</term>
<listitem>
<para>
For successful creation of share, user network should be
connected to public router too.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
- Service VM has two net interfaces, first one connected to
service network,
</term>
<listitem>
<para>
second one connected directly to user's network.
</para>
</listitem>
</varlistentry>
</variablelist>
</simplesect>
<simplesect>
<title>Requirements for service image</title>
<itemizedlist>
<listitem>
<para>
Linux based distro
</para>
</listitem>
<listitem>
<para>
NFS server
</para>
</listitem>
<listitem>
<para>
Samba server &gt;=3.2.0, that can be configured by data stored
in registry
</para>
</listitem>
<listitem>
<para>
SSH server
</para>
</listitem>
<listitem>
<para>
Two net interfaces configured to DHCP (see network approaches)
</para>
</listitem>
<listitem>
<para>
'exportfs' and 'net conf' libraries used for share actions
</para>
</listitem>
<listitem>
<variablelist>
<varlistentry>
<term>
Following files will be used, so if their paths differ one
needs to create at
</term>
<listitem>
<para>
least symlinks for them:
</para>
</listitem>
</varlistentry>
</variablelist>
<itemizedlist>
<listitem>
<para>
/etc/exports (permanent file with NFS exports)
</para>
</listitem>
<listitem>
<para>
/var/lib/nfs/etab (temporary file with NFS exports used by
'exportfs')
</para>
</listitem>
<listitem>
<para>
/etc/fstab (permanent file with mounted filesystems)
</para>
</listitem>
<listitem>
<para>
/etc/mtab (temporary file with mounted filesystems used by
'mount')
</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
</simplesect>
<simplesect>
<title>Supported shared filesystems</title>
<itemizedlist>
<listitem>
<para>
NFS (access by IP)
</para>
</listitem>
<listitem>
<para>
CIFS (access by IP)
</para>
</listitem>
</itemizedlist>
</simplesect>
<simplesect>
<title>Known restrictions</title>
<itemizedlist>
<listitem>
<para>
One of nova's configurations only allows 26 shares per server.
This limit comes from the maximum number of virtual PCI
interfaces that are used for block device attaching. There are
28 virtual PCI interfaces, in this configuration, two of them
are used for server needs and other 26 are used for attaching
block devices that are used for shares.
</para>
</listitem>
<listitem>
<para>
Juno version works only with neutron. Each share should be
created with neutron-net and neutron-subnet IDs provided via
share-network entity.
</para>
</listitem>
<listitem>
<para>
Juno version handles security group, flavor, image, keypair
for nova VM and also creates service networks, but does not
use availability zones for nova VMs and volume types for
cinder block devices.
</para>
</listitem>
<listitem>
<para>
Juno version does not use security services data provided with
share-network. These data will be just ignored.
</para>
</listitem>
<listitem>
<para>
Liberty version adds a share extend capability. Share access
will be briefly interrupted during an extend operation.
</para>
</listitem>
<listitem>
<para>
Liberty version adds a share shrink capability, but this
capability is not effective because generic driver shrinks
only filesystem size and doesn't shrink the size of cinder
volume.
</para>
</listitem>
</itemizedlist>
</simplesect>
</section>

217
doc/config-reference/shared-file-systems/drivers/glusterfs-driver.xml Normal file
View File

@ -0,0 +1,217 @@
<section xml:id="glusterfs-driver" xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0">
<title>GlusterFS driver</title>
<para>
GlusterFS driver uses GlusterFS, an open source distributed file
system, as the storage back end for serving file shares to the
Shared File Systems clients.
</para>
<simplesect>
<title>Supported shared filesystems</title>
<itemizedlist>
<listitem>
<para>
NFS (access by IP)
</para>
</listitem>
</itemizedlist>
</simplesect>
<simplesect>
<title>Supported operations</title>
<itemizedlist>
<listitem>
<para>
Create NFS share.
</para>
</listitem>
<listitem>
<para>
Delete NFS share.
</para>
</listitem>
<listitem>
<para>
Allow NFS share access.
</para>
<itemizedlist>
<listitem>
<para>
only 'rw' access
</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>
Deny NFS share access.
</para>
</listitem>
</itemizedlist>
</simplesect>
<simplesect>
<title>Requirements</title>
<itemizedlist>
<listitem>
<para>
Install glusterfs-server package, version &gt;= 3.5.x, on the
storage back end.
</para>
</listitem>
<listitem>
<para>
Install NFS-Ganesha, version &gt;=2.1, if using NFS-Ganesha as
the NFS server for the GlusterFS back end.
</para>
</listitem>
<listitem>
<para>
Install glusterfs and glusterfs-fuse package, version
&gt;=3.5.x, on the Shared File Systems service host.
</para>
</listitem>
<listitem>
<para>
Establish network connection between the Shared File Systems service
host and the storage back end.
</para>
</listitem>
</itemizedlist>
</simplesect>
<simplesect>
<title>Shared File Systems service driver configuration setting</title>
<para>
The following parameters in the Shared File Systems service's
configuration file need to be set:
</para>
<itemizedlist>
<listitem>
<para>
share_driver =
manila.share.drivers.glusterfs.GlusterfsShareDriver
</para>
</listitem>
<listitem>
<para>
If the back-end GlusterFS server runs on the Shared File Systems
service host machine,
</para>
<itemizedlist>
<listitem>
<para>
glusterfs_target =
&lt;glustervolserver&gt;:/&lt;glustervolid&gt;
</para>
</listitem>
</itemizedlist>
<para>
And if the back-end GlusterFS server runs remotely,
</para>
<itemizedlist>
<listitem>
<para>
glusterfs_target =
&lt;username&gt;@&lt;glustervolserver&gt;:/&lt;glustervolid&gt;
</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
<para>
The following configuration parameters are optional:
</para>
<itemizedlist>
<listitem>
<variablelist>
<varlistentry>
<term>
glusterfs_nfs_server_type =
</term>
<listitem>
<para>
&lt;NFS server type used by the GlusterFS
back end, Gluster or Ganesha. Gluster is the default
type&gt;
</para>
</listitem>
</varlistentry>
</variablelist>
</listitem>
<listitem>
<variablelist>
<varlistentry>
<term>
glusterfs_mount_point_base =
</term>
<listitem>
<para>
&lt;base path of GlusterFS volume mounted on the
Shared File Systems service host&gt;
</para>
</listitem>
</varlistentry>
</variablelist>
</listitem>
<listitem>
<para>
glusterfs_path_to_private_key = &lt;path to Shared File Systems
service host's private key file&gt;
</para>
</listitem>
<listitem>
<para>
glusterfs_server_password = &lt;password of remote GlusterFS
server machine&gt;
</para>
</listitem>
</itemizedlist>
</simplesect>
<simplesect>
<title>Known restrictions</title>
<itemizedlist>
<listitem>
<para>
The driver does not support network segmented multi-tenancy
model, but instead works over a flat network, where the
tenants share a network.
</para>
</listitem>
<listitem>
<para>
If NFS Ganesha is the NFS server used by the GlusterFS
back end, then the shares can be accessed by NFSv3 and v4
protocols. However, if Gluster NFS is used by the GlusterFS
back end, then the shares can only be accessed by NFSv3
protocol.
</para>
</listitem>
<listitem>
<para>
All Shared File Systems service shares, which map to
subdirectories within a
GlusterFS volume, are currently created within a single
GlusterFS volume of a GlusterFS storage pool.
</para>
</listitem>
<listitem>
<para>
The driver does not provide read-only access level for shares.
</para>
</listitem>
</itemizedlist>
</simplesect>
<!--
<simplesect>
<title>Driver options</title>
<para>The following table contains the configation options specific to this driver.</para>
<xi:include href="../../../common/tables/manila-glusterfs.xml"/>
</simplesect>
-->
<simplesect>
<title>Driver configuration options</title>
<para>
Configuration options specific to this driver are documented here:
<xref linkend="config_table_manila_glusterfs"/>.
</para>
</simplesect>
</section>

270
doc/config-reference/shared-file-systems/drivers/glusterfs-native-driver.xml Normal file
View File

@ -0,0 +1,270 @@
<section xml:id="glusterfs-native-driver" xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0">
<title>GlusterFS Native driver</title>
<para>
GlusterFS Native driver uses GlusterFS, an open source distributed
file system, as the storage back end for serving file shares to
Shared File Systems service clients.
</para>
<para>
A Shared File Systems service share is a GlusterFS volume.
This driver uses flat-network
(share-server-less) model. Instances directly talk with the
GlusterFS back end storage pool. The instances use 'glusterfs'
protocol to mount the GlusterFS shares. Access to each share is
allowed via TLS Certificates. Only the instance which has the TLS
trust established with the GlusterFS back end can mount and hence use
the share. Currently only 'rw' access is supported.
</para>
<simplesect>
<title>Network approach</title>
<para>
L3 connectivity between the storage back end and the host running
the Shared File Systems share service should exist.
</para>
</simplesect>
<simplesect>
<title>Supported shared filesystems</title>
<itemizedlist>
<listitem>
<para>
GlusterFS (access by TLS Certificates (<literal>cert</literal>
access type))
</para>
</listitem>
</itemizedlist>
</simplesect>
<simplesect>
<title>Multi-tenancy model</title>
<para>
The driver does not support network segmented multi-tenancy model.
Instead multi-tenancy is supported using tenant specific TLS
certificates.
</para>
</simplesect>
<simplesect>
<title>Supported operations</title>
<itemizedlist>
<listitem>
<para>
Create GlusterFS share.
</para>
</listitem>
<listitem>
<para>
Delete GlusterFS share.
</para>
</listitem>
<listitem>
<para>
Allow GlusterFS share access (rw).
</para>
</listitem>
<listitem>
<para>
Deny GlusterFS share access.
</para>
</listitem>
<listitem>
<para>
Create GlusterFS snapshot.
</para>
</listitem>
<listitem>
<para>
Delete GlusterFS snapshot.
</para>
</listitem>
</itemizedlist>
</simplesect>
<simplesect>
<title>Requirements</title>
<itemizedlist>
<listitem>
<para>
Install glusterfs-server package, version &gt;= 3.6.x, on the
storage back end.
</para>
</listitem>
<listitem>
<para>
Install glusterfs and glusterfs-fuse package, version
&gt;=3.6.x, on the Shared File Systems service host.
</para>
</listitem>
<listitem>
<para>
Establish network connection between the Shared File Systems
service host and the storage back end.
</para>
</listitem>
</itemizedlist>
</simplesect>
<simplesect>
<title>Shared File Systems service driver configuration setting</title>
<para>
The following parameters in the Shared File Systems service's
configuration file need to be
set:
</para>
<itemizedlist>
<listitem>
<variablelist>
<varlistentry>
<term>
share_driver =
</term>
<listitem>
<para>
manila.share.drivers.glusterfs_native.GlusterfsNativeShareDriver
</para>
</listitem>
</varlistentry>
</variablelist>
</listitem>
<listitem>
<variablelist>
<varlistentry>
<term>
glusterfs_servers = List of GlusterFS servers which
provide volumes
</term>
<listitem>
<para>
that can be used to create shares. The servers are
expected to be of distinct Gluster clusters (ie. should
not be gluster peers). Each server should be of the form
<literal>[&lt;remoteuser&gt;@]&lt;glustervolserver&gt;</literal>.
</para>
<para>
The optional <literal>&lt;remoteuser&gt;@</literal> part
of the server URI indicates SSH access for cluster
management (see related optional parameters below). If
it is not given, direct command line management is
performed (the Shared File Systems service host is
assumed to be part of the
GlusterFS cluster the server belongs to).
</para>
</listitem>
</varlistentry>
</variablelist>
</listitem>
<listitem>
<variablelist>
<varlistentry>
<term>
glusterfs_volume_pattern = Regular expression template
</term>
<listitem>
<para>
used to filter GlusterFS volumes for share creation. The
regex template can contain the #{size} parameter which
matches a number (sequence of digits) and the value
shall be interpreted as size of the volume in GB.
Examples: <literal>manila-share-volume-\d+$</literal>,
<literal>manila-share-volume-#{size}G-\d+$</literal>;
with matching volume names, respectively:
<emphasis>manila-share-volume-12</emphasis>,
<emphasis>manila-share-volume-3G-13</emphasis>&quot;. In
latter example, the number that matches
<literal>#{size}</literal>, that is, 3, is an indication
that the size of volume is 3G.
</para>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</itemizedlist>
<para>
The following configuration parameters are optional:
</para>
<itemizedlist>
<listitem>
<variablelist>
<varlistentry>
<term>
glusterfs_mount_point_base =
</term>
<listitem>
<para>
&lt;base path of GlusterFS
volume mounted on the Shared File Systems service host&gt;
</para>
</listitem>
</varlistentry>
</variablelist>
</listitem>
<listitem>
<para>
glusterfs_path_to_private_key = &lt;path to Shared File Systems
service host's private key file&gt;
</para>
</listitem>
<listitem>
<para>
glusterfs_server_password = &lt;password of remote GlusterFS
server machine&gt;
</para>
</listitem>
</itemizedlist>
</simplesect>
<simplesect>
<title>Known restrictions</title>
<itemizedlist>
<listitem>
<para>
GlusterFS volumes are not created on demand. A pre-existing
set of GlusterFS volumes should be supplied by the GlusterFS
cluster(s), conforming to the naming convention encoded by
<literal>glusterfs_volume_pattern</literal>. However, the
GlusterFS endpoint is allowed to extend this set any time (so
the Shared File Systems service and GlusterFS endpoints are
expected to communicate
volume supply/demand out-of-band).
<literal>glusterfs_volume_pattern</literal> can include a size
hint (with <literal>#{size}</literal> syntax), which, if
present, requires the GlusterFS end to indicate the size of
the shares in GB in the name. (On share creation, the
Shared File Systems service picks
volumes <emphasis>at least</emphasis> as big as the requested
one.)
</para>
</listitem>
<listitem>
<para>
Certificate setup (also known as trust setup) between instance and
storage back end is out of band of the Shared File Systems service.
</para>
</listitem>
<listitem>
<para>
Support for 'create_share_from_snapshot' is planned for
Liberty release.
</para>
</listitem>
<listitem>
<para>
For the Shared File Systems service to use GlusterFS volumes,
the name of the trashcan
directory in GlusterFS volumes must not be changed from the
default.
</para>
</listitem>
</itemizedlist>
</simplesect>
<!--
<simplesect>
<title>Driver options</title>
<para>The following table contains the configation options specific to this driver.</para>
<xi:include href="../../../common/tables/manila-glusterfs.xml"/>
</simplesect>
-->
<simplesect>
<title>Driver configuration options</title>
<para>
Configuration options specific to this driver are documented here:
<xref linkend="config_table_manila_glusterfs"/>.
</para>
</simplesect>
</section>

204
doc/config-reference/shared-file-systems/drivers/hdfs-native-driver.xml Normal file
View File

@ -0,0 +1,204 @@
<section xml:id="hdfs-native-driver" xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0">
<title>HDFS native driver</title>
<para>
HDFS native driver is a plug-in based on the Shared File Systems
service, which uses Hadoop distributed file system (HDFS), a
distributed file system designed to hold very large amounts of data,
and provide high-throughput access to the data.
</para>
<para>
A Shared File Systems service share in this driver is a subdirectory
in hdfs root
directory. Instances talk directly to the HDFS storage back end with
'hdfs' protocol. And access to each share is allowed by user based
access type, which is aligned with HDFS ACLs to support access
control of multiple users and groups.
</para>
<simplesect>
<title>Network configuration</title>
<para>
The storage back end and Shared File Systems service hosts should
be in a flat network,
otherwise, the L3 connectivity between them should exist.
</para>
</simplesect>
<simplesect>
<title>Supported shared filesystems</title>
<itemizedlist>
<listitem>
<para>
HDFS (authentication by user)
</para>
</listitem>
</itemizedlist>
</simplesect>
<simplesect>
<title>Supported operations</title>
<itemizedlist>
<listitem>
<para>
Create HDFS share.
</para>
</listitem>
<listitem>
<para>
Delete HDFS share.
</para>
</listitem>
<listitem>
<para>
Allow HDFS share access.
</para>
<itemizedlist>
<listitem>
<para>
Only support user access type.
</para>
</listitem>
</itemizedlist>
<para>
* Support level of access (ro/rw).
</para>
</listitem>
<listitem>
<para>
Deny HDFS share access.
</para>
</listitem>
<listitem>
<para>
Create snapshot.
</para>
</listitem>
<listitem>
<para>
Delete snapshot.
</para>
</listitem>
<listitem>
<para>
Create share from snapshot.
</para>
</listitem>
</itemizedlist>
</simplesect>
<simplesect>
<title>Requirements</title>
<itemizedlist>
<listitem>
<para>
Install HDFS package, version &gt;= 2.4.x, on the storage
back end.
</para>
</listitem>
<listitem>
<para>
To enable access control, the HDFS file system must have ACLs
enabled.
</para>
</listitem>
<listitem>
<para>
Establish network connection between the Shared File Systems
service host and storage back end.
</para>
</listitem>
</itemizedlist>
</simplesect>
<simplesect>
<title>Shared File Systems service driver configuration</title>
<itemizedlist>
<listitem>
<para>
share_driver =
manila.share.drivers.hdfs.hdfs_native.HDFSNativeShareDriver
</para>
</listitem>
<listitem>
<variablelist>
<varlistentry>
<term>
hdfs_namenode_ip = the IP address of the HDFS namenode,
and only single
</term>
<listitem>
<para>
namenode is supported now
</para>
</listitem>
</varlistentry>
</variablelist>
</listitem>
<listitem>
<para>
hdfs_namenode_port = the port of the HDFS namenode service
</para>
</listitem>
<listitem>
<para>
hdfs_ssh_port = HDFS namenode SSH port
</para>
</listitem>
<listitem>
<para>
hdfs_ssh_name = HDFS namenode SSH login name
</para>
</listitem>
<listitem>
<variablelist>
<varlistentry>
<term>
hdfs_ssh_pw = HDFS namenode SSH login password, this
parameter is not
</term>
<listitem>
<para>
necessary, if the following hdfs_ssh_private_key is
configured
</para>
</listitem>
</varlistentry>
</variablelist>
</listitem>
<listitem>
<para>
hdfs_ssh_private_key = Path to the HDFS namenode private key
to ssh login
</para>
</listitem>
</itemizedlist>
</simplesect>
<simplesect>
<title>Known restrictions</title>
<itemizedlist>
<listitem>
<para>
This driver does not support network segmented multi-tenancy
model. Instead multi-tenancy is supported by the tenant
specific user authentication.
</para>
</listitem>
<listitem>
<para>
Only support for single HDFS namenode in Kilo release.
</para>
</listitem>
</itemizedlist>
</simplesect>
<!--
<simplesect>
<title>Driver options</title>
<para>The following table contains the configation options specific to this driver.</para>
<xi:include href="../../../common/tables/manila-hdfs.xml"/>
</simplesect>
-->
<simplesect>
<title>Driver configuration options</title>
<para>
Configuration options specific to this driver are documented here:
<xref linkend="config_table_manila_hdfs"/>.
</para>
</simplesect>
</section>

500
doc/config-reference/shared-file-systems/drivers/hp-3par-share-driver.xml Normal file
View File

@ -0,0 +1,500 @@
<section xml:id="hp-3par-share-driver" xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0">
<title>HP 3PAR driver</title>
<para>
The HP 3PAR driver provides NFS and CIFS shared file systems
to OpenStack using HP 3PAR's File Persona capabilities.
</para>
<simplesect>
<title>Supported operations</title>
<para>
The following operations are supported with HP 3PAR File Persona:
</para>
<itemizedlist>
<listitem>
<para>
Create/delete NFS and CIFS shares.
</para>
<itemizedlist>
<listitem>
<para>
Shares are not accessible until access rules allow access.
</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>
Allow/deny NFS share access.
</para>
<itemizedlist>
<listitem>
<para>
IP access rules are required for NFS share access.
</para>
</listitem>
<listitem>
<para>
User access rules are not allowed for NFS shares.
</para>
</listitem>
<listitem>
<para>
Access level (RW/RO) is ignored.
</para>
</listitem>
<listitem>
<para>
Shares created from snapshots are always read-only.
</para>
</listitem>
<listitem>
<para>
Shares not created from snapshots are read-write (and
subject to ACLs).
</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>
Allow/deny CIFS share access.
</para>
<itemizedlist>
<listitem>
<para>
Both IP and user access rules are required for CIFS share
access.
</para>
</listitem>
<listitem>
<para>
User access requires a 3PAR local user (LDAP and AD is not
yet supported).
</para>
</listitem>
<listitem>
<para>
Access level (RW/RO) is ignored.
</para>
</listitem>
<listitem>
<para>
Shares created from snapshots are always read-only.
</para>
</listitem>
<listitem>
<para>
Shares not created from snapshots are read-write (and
subject to ACLs).
</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>
Create/delete snapshots.
</para>
</listitem>
<listitem>
<para>
Create shares from snapshots.
</para>
<itemizedlist>
<listitem>
<para>
Shares created from snapshots are always read-only.
</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
<para>
Share networks are not supported. Shares are created directly on
the 3PAR without the use of a share server or service VM. Network
connectivity is setup outside of the Shared File Systems service.
</para>
</simplesect>
<simplesect>
<title>Requirements</title>
<para>
On the system running the manila-share service:
</para>
<itemizedlist>
<listitem>
<para>
hp3parclient version 3.2.1 or newer from PyPI.
</para>
</listitem>
</itemizedlist>
<para>
On the HP 3PAR array:
</para>
<itemizedlist>
<listitem>
<para>
HP 3PAR Operating System software version 3.2.1 MU3 or higher.
</para>
</listitem>
<listitem>
<para>
A license that enables the File Persona feature.
</para>
</listitem>
<listitem>
<para>
The array class and hardware configuration must support File.
Persona
</para>
</listitem>
</itemizedlist>
</simplesect>
<simplesect>
<title>Pre-configuration on the HP 3PAR</title>
<itemizedlist>
<listitem>
<para>
HP 3PAR File Persona must be initialized and started (startfs).
</para>
</listitem>
<listitem>
<para>
A File Provisioning Group (FPG) must be created for use with
the Shared File Systems service.
</para>
</listitem>
<listitem>
<para>
A Virtual File Server (VFS) must be created for the FPG.
</para>
</listitem>
<listitem>
<para>
The VFS must be configured with an appropriate share export IP
address.
</para>
</listitem>
<listitem>
<para>
A local user in the Administrators group is needed for CIFS
shares.
</para>
</listitem>
</itemizedlist>
</simplesect>
<simplesect>
<title>Backend configuration</title>
<para>
The following parameters need to be configured in the Shared
File Systems service configuration file for the HP 3PAR driver:
</para>
<itemizedlist>
<listitem>
<para>
share_backend_name = &lt;back end name to enable&gt;
</para>
</listitem>
<listitem>
<para>
share_driver =
manila.share.drivers.hp.hp_3par_driver.HP3ParShareDriver
</para>
</listitem>
<listitem>
<para>
driver_handles_share_servers = False
</para>
</listitem>
<listitem>
<para>
hp3par_fpg = &lt;FPG to use for share creation&gt;
</para>
</listitem>
<listitem>
<para>
hp3par_share_ip_address = &lt;IP address to use for share
export location&gt;
</para>
</listitem>
<listitem>
<para>
hp3par_san_ip = &lt;IP address for SSH access to the SAN
controller&gt;
</para>
</listitem>
<listitem>
<para>
hp3par_api_url = &lt;3PAR WS API Server URL&gt;
</para>
</listitem>
<listitem>
<para>
hp3par_username = &lt;3PAR username with the 'edit' role&gt;
</para>
</listitem>
<listitem>
<para>
hp3par_password = &lt;3PAR password for the user specified in
hp3par_username&gt;
</para>
</listitem>
<listitem>
<para>
hp3par_san_login = &lt;Username for SSH access to the SAN
controller&gt;
</para>
</listitem>
<listitem>
<para>
hp3par_san_password = &lt;Password for SSH access to the SAN
controller&gt;
</para>
</listitem>
<listitem>
<para>
hp3par_debug = &lt;False or True for extra debug logging&gt;
</para>
</listitem>
</itemizedlist>
<para>
The hp3par_share_ip_address must be a valid IP address for the
configured FPG's VFS. This IP address is used in export locations
for shares that are created. Networking must be configured to
allow connectivity from clients to shares.
</para>
<para>
Restart of manila-share service is needed for the configuration
changes to take effect.
</para>
</simplesect>
<simplesect>
<title>Network approach</title>
<para>
Connectivity between the storage array (SSH/CLI and WSAPI) and the
Shared File Systems service host is required for share management.
</para>
<para>
Connectivity between the clients and the VFS is required for
mounting and using the shares. This includes:
</para>
<itemizedlist>
<listitem>
<para>
Routing from the client to the external network
</para>
</listitem>
<listitem>
<para>
Assigning the client an external IP address (e.g., a floating
IP)
</para>
</listitem>
<listitem>
<para>
Configuring the Shared File Systems service host networking
properly for IP forwarding
</para>
</listitem>
<listitem>
<para>
Configuring the VFS networking properly for client subnets
</para>
</listitem>
</itemizedlist>
</simplesect>
<simplesect>
<title>Share types</title>
<para>
When creating a share, a share type can be specified to determine
where and how the share will be created. If a share type is not
specified, the default_share_type set in the Shared File Systems
service configuration
file is used.
</para>
<para>
The Shared File Systems service requires that the share type
includes the
driver_handles_share_servers extra-spec. This ensures that the
share will be created on a back end that supports the requested
driver_handles_share_servers (share networks) capability. For the
HP 3PAR driver, this must be set to False.
</para>
<para>
Another common Shared File Systems service extra-spec used to determine
where a share
is created is share_backend_name. When this extra-spec is defined
in the share type, the share will be created on a back end with a
matching share_backend_name.
</para>
<para>
The HP 3PAR driver automatically reports capabilities based on the
FPG used for each back end. Share types with extra specs can be
created by an administrator to control which share types are
allowed to use FPGs with or without specific capabilities. The
following extra-specs are used with the capabilities filter and
the HP 3PAR driver:
</para>
<itemizedlist>
<listitem>
<para>
hp3par_flash_cache = '&lt;is&gt; True' or '&lt;is&gt; False'
</para>
</listitem>
<listitem>
<para>
thin_provisioning = '&lt;is&gt; True' or '&lt;is&gt; False'
</para>
</listitem>
<listitem>
<para>
dedupe = '&lt;is&gt; True' or '&lt;is&gt; False'
</para>
</listitem>
</itemizedlist>
<para>
hp3par_flash_cache will be reported as True for back ends that have
3PAR's Adaptive Flash Cache enabled.
</para>
<para>
thin_provisioning will be reported as True for back ends that use
thin provisioned volumes. FPGs that use fully provisioned volumes
will report False. Backends that use thin provisioning also
support the Shared File Systems service's over-subscription feature.
</para>
<para>
dedupe will be reported as True for back ends that use
deduplication technology.
</para>
<para>
Scoped extra-specs are used to influence vendor-specific
implementation details. Scoped extra-specs use a prefix followed
by a colon. For HP 3PAR these extra-specs have a prefix of hp3par.
</para>
<para>
The following HP 3PAR extra-specs are used when creating CIFS
(SMB) shares:
</para>
<itemizedlist>
<listitem>
<para>
hp3par:smb_access_based_enum = true or false
</para>
</listitem>
<listitem>
<para>
hp3par:smb_continuous_avail = true or false
</para>
</listitem>
<listitem>
<para>
hp3par:smb_cache = off, manual, optimized or auto
</para>
</listitem>
</itemizedlist>
<para>
smb_access_based_enum (Access Based Enumeration) specifies if
users can see only the files and directories to which they have
been allowed access on the shares. The default is false.
</para>
<para>
smb_continuous_avail (Continuous Availability) specifies if SMB3
continuous availability features should be enabled for this share.
If not specified, the default is true. This setting will be
ignored with hp3parclient 3.2.1 or earlier.
</para>
<para>
smb_cache specifies client-side caching for offline files. Valid
values are:
</para>
<itemizedlist>
<listitem>
<para>
`off`: The client must not cache any files from this share.
The share is configured to disallow caching.
</para>
</listitem>
<listitem>
<para>
`manual`: The client must allow only manual caching for the
files open from this share.
</para>
</listitem>
<listitem>
<para>
`optimized`: The client may cache every file that it opens
from this share. Also, the client may satisfy the file
requests from its local cache. The share is configured to
allow automatic caching of programs and documents.
</para>
</listitem>
<listitem>
<para>
`auto`: The client may cache every file that it opens from
this share. The share is configured to allow automatic caching
of documents.
</para>
</listitem>
<listitem>
<para>
If this is not specified, the default is manual.
</para>
</listitem>
</itemizedlist>
<para>
The following HP 3PAR extra-specs are used when creating NFS
shares:
</para>
<itemizedlist>
<listitem>
<para>
hp3par:nfs_options = Comma separated list of NFS export
options.
</para>
</listitem>
</itemizedlist>
<para>
The NFS export options have the following limitations:
</para>
<blockquote>
<itemizedlist>
<listitem>
<para>
ro and rw are not allowed (will be determined by the driver).
</para>
</listitem>
<listitem>
<para>
no_subtree_check and fsid are not allowed per HP 3PAR CLI
support.
</para>
</listitem>
<listitem>
<para>
(in)secure and (no_)root_squash are not allowed because the
HP 3PAR driver controls those settings.
</para>
</listitem>
</itemizedlist>
</blockquote>
<para>
All other NFS options are forwarded to the HP 3PAR as part of
share creation. The HP 3PAR will do additional validation at share
creation time. Refer to HP 3PAR CLI help for more details.
</para>
</simplesect>
<!--
<simplesect>
<title>Driver options</title>
<para>The following table contains the configation options specific to this driver.</para>
<xi:include href="../../../common/tables/manila-hp3par.xml"/>
</simplesect>
-->
<simplesect>
<title>Driver configuration options</title>
<para>
Configuration options specific to this driver are documented here:
<xref linkend="config_table_manila_hp3par"/>.
</para>
</simplesect>
</section>

253
doc/config-reference/shared-file-systems/drivers/huawei-nas-driver.xml Normal file
View File

@ -0,0 +1,253 @@
<section xml:id="huawei-driver" xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0">
<title>Huawei driver</title>
<para>
Huawei NAS driver is a plug-in based the Shared File Systems service.
The Huawei NAS driver can be used to provide functions such as the
share and snapshot for virtual machines(instances) in OpenStack.
Huawei NAS driver enables the OceanStor V3 series V300R002 storage
system to provide only network filesystems for OpenStack.
</para>
<simplesect>
<title>Requirements</title>
<itemizedlist>
<listitem>
<para>
The OceanStor V3 series V300R002 storage system.
</para>
</listitem>
<listitem>
<para>
The following licenses should be activated on V3 for File:
</para>
<itemizedlist>
<listitem>
<para>
CIFS
</para>
</listitem>
<listitem>
<para>
NFS
</para>
</listitem>
<listitem>
<para>
HyperSnap License (for snapshot)
</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
</simplesect>
<simplesect>
<title>Supported operations</title>
<para>
The following operations is supported on V3 storage:
</para>
<itemizedlist>
<listitem>
<para>
Create CIFS/NFS share.
</para>
</listitem>
<listitem>
<para>
Delete CIFS/NFS share.
</para>
</listitem>
<listitem>
<para>
Allow CIFS/NFS share access.
</para>
<itemizedlist>
<listitem>
<para>
Only IP access type is supported for NFS.
</para>
</listitem>
</itemizedlist>
<para>
* Only USER access type is supported for CIFS.
</para>
</listitem>
<listitem>
<para>
Deny CIFS/NFS share access.
</para>
</listitem>
<listitem>
<para>
Create snapshot.
</para>
</listitem>
<listitem>
<para>
Delete snapshot.
</para>
</listitem>
</itemizedlist>
</simplesect>
<simplesect>
<title>Pre-configurations on Huawei</title>
<para>
1. Create a driver configuration file. The driver configuration
file name must be the same as the manila_huawei_conf_file item in
the manila_conf configuration file.
</para>
<para>
2. Configure Product. Product indicates the storage system type.
For the OceanStor V3 series V300R002 storage systems, the driver
configuration file is as follows:
</para>
<programlisting>
&lt;?xml version='1.0' encoding='UTF-8'?&gt;
&lt;Config&gt;
&lt;Storage&gt;
&lt;Product&gt;V3&lt;/Product&gt;
&lt;LogicalPortIP&gt;x.x.x.x&lt;/LogicalPortIP&gt;
&lt;RestURL&gt;https://x.x.x.x:8088/deviceManager/rest/&lt;/RestURL&gt;
&lt;UserName&gt;xxxxxxxxx&lt;/UserName&gt;
&lt;UserPassword&gt;xxxxxxxxx&lt;/UserPassword&gt;
&lt;/Storage&gt;
&lt;Filesystem&gt;
&lt;AllocType&gt;Thin&lt;/AllocType&gt;
&lt;StoragePool&gt;xxxxxxxxx&lt;/StoragePool&gt;
&lt;WaitInterval&gt;3&lt;/WaitInterval&gt;
&lt;Timeout&gt;60&lt;/Timeout&gt;
&lt;/Filesystem&gt;
&lt;/Config&gt;
</programlisting>
<itemizedlist>
<listitem>
<para>
Product is a type of a storage product. Set it to V3.
</para>
</listitem>
<listitem>
<para>
LogicalPortIP is a IP address of the logical port.
</para>
</listitem>
<listitem>
<para>
RestURL is a access address of the REST interface.
</para>
</listitem>
<listitem>
<para>
UserName is a user name of an administrator.
</para>
</listitem>
<listitem>
<para>
UserPassword is a password of an administrator.
</para>
</listitem>
<listitem>
<para>
AllocType is a type of file system space allocation. Valid
values are Thick or Thin.
</para>
</listitem>
<listitem>
<para>
StoragePool is a name of a storage pool to be used.
</para>
</listitem>
<listitem>
<para>
WaitInterval is the interval time of querying the file system
status.
</para>
</listitem>
<listitem>
<para>
Timeout is the timeout period for wating command execution of
a device to complete.
</para>
</listitem>
</itemizedlist>
</simplesect>
<simplesect>
<title>Backend configuration</title>
<para>
1. Modify the manila.conf Shared File Systems service configuration
file and add
share_driver and manila_huawei_conf_file items. Example for
configuring a storage system:
</para>
<itemizedlist>
<listitem>
<para>
share_driver =
manila.share.drivers.huawei.huawei_nas.HuaweiNasDriver
</para>
</listitem>
<listitem>
<para>
manila_huawei_conf_file = /etc/manila/manila_huawei_conf.xml
</para>
</listitem>
<listitem>
<para>
driver_handles_share_servers = False
</para>
</listitem>
</itemizedlist>
<blockquote>
<note><para>
As far as the Shared File Systems service requires share type
for creation of shares, make sure that
used share type has extra spec
driver_handles_share_servers set to False otherwise Huawei
back end will be filtered by manila-scheduler. If you do
not provide share type with share creation request then
default share type and its extra specs will be used.
</para></note>
</blockquote>
<para>
Restart of manila-share service is needed for the configuration
changes to take effect.
</para>
</simplesect>
<simplesect>
<title>Restrictions</title>
<para>
The Huawei driver has the following restrictions:
</para>
<itemizedlist>
<listitem>
<para>
Only IP access type is supported for NFS.
</para>
</listitem>
<listitem>
<para>
Only USER access type is supported for CIFS.
</para>
</listitem>
<listitem>
<para>
Only one StoragePool can be configured in the configuration
file.
</para>
</listitem>
</itemizedlist>
</simplesect>
<!--
<simplesect>
<title>Driver options</title>
<para>The following table contains the configation options specific to this driver.</para>
<xi:include href="../../../common/tables/manila-huawei.xml"/>
</simplesect>
-->
<simplesect>
<title>Driver configuration options</title>
<para>
Configuration options specific to this driver are documented here:
<xref linkend="config_table_manila_huawei"/>.
</para>
</simplesect>
</section>

239
doc/config-reference/shared-file-systems/drivers/ibm-gpfs-driver.xml Normal file
View File

@ -0,0 +1,239 @@
<section xml:id="gpfs-driver" xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0">
<title>IBM GPFS driver</title>
<para>
GPFS driver uses IBM General Parallel File System (GPFS), a
high-performance, clustered file system, developed by IBM, as the
storage back end for serving file shares to the Shared File Systems
service clients.
</para>
<simplesect>
<title>Supported shared filesystems</title>
<itemizedlist>
<listitem>
<para>
NFS (access by IP)
</para>
</listitem>
</itemizedlist>
</simplesect>
<simplesect>
<title>Supported operations</title>
<itemizedlist>
<listitem>
<para>
Create NFS share.
</para>
</listitem>
<listitem>
<para>
Delete NFS share.
</para>
</listitem>
<listitem>
<para>
Create share snapshot.
</para>
</listitem>
<listitem>
<para>
Delete share snapshot.
</para>
</listitem>
<listitem>
<para>
Create share from a share snapshot.
</para>
</listitem>
<listitem>
<para>
Allow NFS share access.
</para>
<itemizedlist>
<listitem>
<para>
Currently only 'rw' access level is supported.
</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>
Deny NFS share access.
</para>
</listitem>
</itemizedlist>
</simplesect>
<simplesect>
<title>Requirements</title>
<itemizedlist>
<listitem>
<para>
Install GPFS with server license, version &gt;= 2.0, on the
storage back end.
</para>
</listitem>
<listitem>
<para>
Install Kernel NFS or Ganesha NFS server on the storage
back-end servers.
</para>
</listitem>
<listitem>
<para>
If using Ganesha NFS, currently NFS Ganesha v1.5 and v2.0 are
supported.
</para>
</listitem>
<listitem>
<para>
Create a GPFS cluster and create a filesystem on the cluster,
that will be used to create the Shared File Systems service shares.
</para>
</listitem>
<listitem>
<para>
Enable quotas for the GPFS file system (mmchfs -Q yes).
</para>
</listitem>
<listitem>
<para>
Establish network connection between the Shared File Systems
Service host and the storage back end.
</para>
</listitem>
</itemizedlist>
</simplesect>
<simplesect>
<title>Shared File Systems service driver configuration setting</title>
<para>
The following parameters in the Shared File Systems service
configuration file need to be set:
</para>
<itemizedlist>
<listitem>
<para>
share_driver = manila.share.drivers.ibm.gpfs.GPFSShareDriver
</para>
</listitem>
<listitem>
<para>
gpfs_share_export_ip = &lt;IP to be added to GPFS export
string&gt;
</para>
</listitem>
<listitem>
<para>
If the back-end GPFS server is not running on the Shared File
Systems service host
machine, the following options are required to SSH to the
remote GPFS back-end server:
</para>
<itemizedlist>
<listitem>
<para>
gpfs_ssh_login = &lt;GPFS server SSH login name&gt;
</para>
<para>
and one of the following settings is required to execute
commands over SSH:
</para>
</listitem>
<listitem>
<para>
gpfs_ssh_private_key = &lt;path to GPFS server SSH private
key for login&gt;
</para>
</listitem>
<listitem>
<para>
gpfs_ssh_password = &lt;GPFS server SSH login password&gt;
</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
<para>
The following configuration parameters are optional:
</para>
<itemizedlist>
<listitem>
<para>
gpfs_mount_point_base = &lt;base folder where exported shares
are located&gt;
</para>
</listitem>
<listitem>
<para>
gpfs_nfs_server_type = &lt;KNFS|GNFS&gt;
</para>
</listitem>
<listitem>
<para>
gpfs_nfs_server_list = &lt;list of the fully qualified NFS
server names&gt;
</para>
</listitem>
<listitem>
<para>
gpfs_ssh_port = &lt;ssh port number&gt;
</para>
</listitem>
<listitem>
<variablelist>
<varlistentry>
<term>
knfs_export_options = &lt;options to use when creating a
share using kernel&gt;
</term>
<listitem>
<para>
&lt;NFS server&gt;
</para>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</itemizedlist>
<para>
Restart of manila-share service is needed for the configuration
changes to take effect.
</para>
</simplesect>
<simplesect>
<title>Known restrictions</title>
<itemizedlist>
<listitem>
<para>
The driver does not support a segmented-network multi-tenancy
model but instead works over a flat network where the tenants
share a network.
</para>
</listitem>
<listitem>
<para>
While using remote GPFS node, with Ganesha NFS,
'gpfs_ssh_private_key' for remote login to the GPFS node must
be specified and there must be a passwordless authentication
already setup between the manila-share service and the remote
GPFS node.
</para>
</listitem>
</itemizedlist>
</simplesect>
<!--
<simplesect>
<title>Driver options</title>
<para>The following table contains the configation options specific to this driver.</para>
<xi:include href="../../../common/tables/manila-gpfs.xml"/>
</simplesect>
-->
<simplesect>
<title>Driver configuration options</title>
<para>
Configuration options specific to this driver are documented here:
<xref linkend="config_table_manila_gpfs"/>.
</para>
</simplesect>
</section>

96
doc/config-reference/shared-file-systems/drivers/netapp-cluster-mode-driver.xml Normal file
View File

@ -0,0 +1,96 @@
<section xml:id="netapp-clustered-data-ontap" xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0">
<title>NetApp Clustered Data ONTAP driver</title>
<para>
The Shared File Systems service can be configured to
use NetApp clustered Data ONTAP version 8.
</para>
<simplesect>
<title>Network approach</title>
<para>
L3 connectivity between the storage cluster and Shared File Systems
service host should exist, and VLAN segmentation should be configured.
</para>
<para>
The clustered Data ONTAP driver creates storage virtual machines
(SVM, previously known as vServers) as representations of the
Shared File Systems service share server interface, configures
logical interfaces (LIFs) and stores shares there.
</para>
</simplesect>
<simplesect>
<title>Supported shared filesystems</title>
<itemizedlist>
<listitem>
<para>
NFS (access by IP)
</para>
</listitem>
<listitem>
<para>
CIFS (authentication by user)
</para>
</listitem>
</itemizedlist>
</simplesect>
<simplesect>
<title>Required licenses</title>
<itemizedlist>
<listitem>
<para>
NFS
</para>
</listitem>
<listitem>
<para>
CIFS
</para>
</listitem>
<listitem>
<para>
FlexClone
</para>
</listitem>
</itemizedlist>
</simplesect>
<simplesect>
<title>Known restrictions</title>
<itemizedlist>
<listitem>
<para>
For CIFS shares an external active directory service is
required. Its data should be provided via security-service
that is attached to used share-network.
</para>
</listitem>
<listitem>
<para>
Share access rule by user for CIFS shares can be created only
for existing user in active directory.
</para>
</listitem>
<listitem>
<para>
To be able to configure clients to security services, the time
on these external security services and storage should be
synchronized. The maximum allowed clock skew is 5 minutes.
</para>
</listitem>
</itemizedlist>
</simplesect>
<!--
<simplesect>
<title>Driver options</title>
<para>The following table contains the configation options specific to this driver.</para>
<xi:include href="../../../common/tables/manila-netapp.xml"/>
</simplesect>
-->
<simplesect>
<title>Driver configuration options</title>
<para>
Configuration options specific to this driver are documented here:
<xref linkend="config_table_manila_netapp"/>.
</para>
</simplesect>
</section>

77
doc/config-reference/shared-file-systems/section_manila-log-files.xml Normal file
View File

@ -0,0 +1,77 @@
<?xml version="1.0" encoding="UTF-8"?>
<section xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink"
version="5.0"
xml:id="section_manila-logs">
<title>Log files used by Shared File Systems</title>
<para>The corresponding log file of each Shared File Systems service
is stored in the <filename>/var/log/manila/</filename>
directory of the host on which each service runs.</para>
<table rules="all">
<caption>Log files used by Shared File Systems services</caption>
<col width="35%"/>
<col width="35%"/>
<col width="30%"/>
<thead>
<tr>
<td>
Log file
</td>
<td>
Service/interface (for CentOS, Fedora, openSUSE, Red Hat
Enterprise Linux, and SUSE Linux Enterprise)
</td>
<td>
Service/interface (for Ubuntu and Debian)
</td>
</tr>
</thead>
<tbody>
<tr>
<td>
<filename>api.log</filename>
</td>
<td>
<systemitem class="service">openstack-manila-api</systemitem>
</td>
<td>
<systemitem class="service">manila-api</systemitem>
</td>
</tr>
<tr>
<td>
<filename>manila-manage.log</filename>
</td>
<td>
<systemitem class="service">manila-manage</systemitem>
</td>
<td>
<systemitem class="service">manila-manage</systemitem>
</td>
</tr>
<tr>
<td>
<filename>scheduler.log</filename>
</td>
<td>
<systemitem class="service">openstack-manila-scheduler</systemitem>
</td>
<td>
<systemitem class="service">manila-scheduler</systemitem>
</td>
</tr>
<tr>
<td>
<filename>share.log</filename>
</td>
<td>
<systemitem class="service">openstack-manila-share</systemitem>
</td>
<td>
<systemitem class="service">manila-share</systemitem>
</td>
</tr>
</tbody>
</table>
</section>

45
doc/config-reference/shared-file-systems/section_manila-misc.xml Normal file
View File

@ -0,0 +1,45 @@
<?xml version="1.0" encoding="UTF-8"?>
<section xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink"
version="5.0"
xml:id="section_manila-misc">
<title>Configuration Options</title>
<para>
These following options can be set in the <filename>manila.conf</filename> file.
</para>
<xi:include href="../../common/tables/manila-amqp.xml"/>
<xi:include href="../../common/tables/manila-api.xml"/>
<xi:include href="../../common/tables/manila-auth_token.xml"/>
<xi:include href="../../common/tables/manila-auth.xml"/>
<xi:include href="../../common/tables/manila-ca.xml"/>
<xi:include href="../../common/tables/manila-common.xml"/>
<xi:include href="../../common/tables/manila-compute.xml"/>
<xi:include href="../../common/tables/manila-cors.xml"/>
<xi:include href="../../common/tables/manila-database.xml"/>
<xi:include href="../../common/tables/manila-emc.xml"/>
<xi:include href="../../common/tables/manila-ganesha.xml"/>
<xi:include href="../../common/tables/manila-glusterfs.xml"/>
<xi:include href="../../common/tables/manila-hdfs.xml"/>
<xi:include href="../../common/tables/manila-hds_hnas.xml"/>
<xi:include href="../../common/tables/manila-hp3par.xml"/>
<xi:include href="../../common/tables/manila-huawei.xml"/>
<xi:include href="../../common/tables/manila-logging.xml"/>
<xi:include href="../../common/tables/manila-netapp.xml"/>
<xi:include href="../../common/tables/manila-qpid.xml"/>
<xi:include href="../../common/tables/manila-quobyte.xml"/>
<xi:include href="../../common/tables/manila-quota.xml"/>
<xi:include href="../../common/tables/manila-rabbitmq.xml"/>
<xi:include href="../../common/tables/manila-redis.xml"/>
<xi:include href="../../common/tables/manila-rpc.xml"/>
<xi:include href="../../common/tables/manila-san.xml"/>
<xi:include href="../../common/tables/manila-scheduler.xml"/>
<xi:include href="../../common/tables/manila-share.xml"/>
<xi:include href="../../common/tables/manila-storage.xml"/>
<xi:include href="../../common/tables/manila-winrm.xml"/>
<xi:include href="../../common/tables/manila-zeromq.xml"/>
<xi:include href="../../common/tables/manila-zfssa.xml"/>
</section>

40
doc/config-reference/shared-file-systems/section_manila-sample-configuration-files.xml Normal file
View File

@ -0,0 +1,40 @@
<?xml version="1.0" encoding="UTF-8"?><section xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink"
version="5.0"
xml:id="section_manila-sample-configuration-files">
<title>Shared File Systems sample configuration files</title>
<para>All the files in this section can be found in <systemitem>/etc/manila</systemitem>.</para>
<section xml:id="section_manila.conf">
<title>manila.conf</title>
<para>The <filename>manila.conf</filename> file is installed in
<filename>/etc/manila</filename> by default. When you manually
install the Shared File Systems service, the options in the
<filename>manila.conf</filename> file are set to default values.</para>
<para>The <filename>manila.conf</filename> file contains most
of the options to configure the Shared File Systems service.</para>
<programlisting language="ini"><xi:include parse="text" href="../../common/samples/manila.conf.sample">
<xi:fallback><xi:include parse="text" href="https://git.openstack.org/cgit/openstack/manila/plain/etc/manila/README.manila.conf"/>
</xi:fallback>
</xi:include>
</programlisting>
</section>
<section xml:id="section_manila-api-paste.ini">
<title>api-paste.ini</title>
<para>Use the <filename>api-paste.ini</filename> file to configure the Shared File Systems API service.</para>
<programlisting language="ini"><xi:include parse="text" href="https://git.openstack.org/cgit/openstack/manila/plain/etc/manila/api-paste.ini"/>
</programlisting>
</section>
<section xml:id="section_manila-policy.json">
<title>policy.json</title>
<para>The <filename>policy.json</filename> file defines additional access controls that apply to the Shared File Systems service.</para>
<programlisting language="json"><xi:include parse="text" href="https://git.openstack.org/cgit/openstack/manila/plain/etc/manila/policy.json"/></programlisting>
</section>
<section xml:id="section_manila-rootwrap.conf">
<title>rootwrap.conf</title>
<para>The <filename>rootwrap.conf</filename> file defines configuration values used by the
<command>rootwrap</command> script when the Shared File Systems service must
escalate its privileges to those of the root user.</para>
<programlisting language="ini"><xi:include parse="text" href="https://git.openstack.org/cgit/openstack/manila/plain/etc/manila/rootwrap.conf"/></programlisting>
</section>
</section>

28
doc/config-reference/shared-file-systems/section_share-drivers.xml Normal file
View File

@ -0,0 +1,28 @@
<?xml version="1.0" encoding="UTF-8"?>
<section xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink"
version="5.0"
xml:id="section_share-drivers">
<title>Share drivers</title>
<para>To use different share drivers for the <systemitem
class="service">manila-share</systemitem> service, use
the parameters described in these sections.</para>
<para>The share drivers are included in the Shared File Systems repository
(<link xlink:href="https://git.openstack.org/cgit/openstack/manila/tree/manila/share/drivers">https://git.openstack.org/cgit/openstack/manila/tree/manila/share/drivers</link>).
To set a share driver, use the <literal>share_driver</literal> flag.
For example, to use the generic reference driver:</para>
<programlisting>
share_driver=manila.share.drivers.generic.GenericShareDriver
</programlisting>
<!-- Keep this list alphabetically sorted. -->
<xi:include href="drivers/emc-isilon-driver.xml"/>
<xi:include href="drivers/emc-vnx-driver.xml"/>
<xi:include href="drivers/generic-driver.xml"/>
<xi:include href="drivers/glusterfs-driver.xml"/>
<xi:include href="drivers/glusterfs-native-driver.xml"/>
<xi:include href="drivers/hdfs-native-driver.xml"/>
<xi:include href="drivers/hp-3par-share-driver.xml"/>
<xi:include href="drivers/huawei-nas-driver.xml"/>
<xi:include href="drivers/netapp-cluster-mode-driver.xml"/>
</section>

104
doc/config-reference/shared-file-systems/section_shared-file-systems-overview.xml Normal file
View File

@ -0,0 +1,104 @@
<?xml version="1.0" encoding="UTF-8"?>
<section xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink"
version="5.0"
xml:id="section_shared-file-systems-overview">
<title>Introduction to the Shared File Systems service</title>
<para>The Shared File Systems service provides shared file systems that
Compute instances can consume.</para>
<para>The Shared File Systems service provides:</para>
<itemizedlist>
<listitem>
<para><systemitem class="service">manila-api</systemitem>. A WSGI app that authenticates
and routes requests throughout the Shared File Systems service. It supports the
OpenStack APIs.</para>
</listitem>
<listitem>
<para><systemitem class="service">manila-scheduler</systemitem>. Schedules and routes
requests to the appropriate share service. The scheduler uses configurable filters
and weighers to route requests. The Filter Scheduler is the default and enables
filters on things like Capacity, Availability Zone, Share Types, and Capabilities
as well as custom filters.</para>
</listitem>
<listitem>
<para><systemitem class="service">manila-share</systemitem>.
Manages back-end devices that provide shared file systems.
A manila-share service can run in one of two modes, with or without handling of
share servers. Share servers export file shares via share networks.
When share servers are not used, the networking requirements are handled
outside of Manila.</para>
</listitem>
</itemizedlist>
<para>The Shared File Systems service contains the following components:</para>
<itemizedlist>
<listitem>
<para><emphasis role="bold">Back-end storage devices</emphasis>. The Shared File
Services service requires some form of back-end shared file system provider
that the service is built on. The reference implementation uses the Block Storage
service (Cinder) and a service VM to provide shares. Additional drivers are
used to access shared file systems from a variety of vendor solutions.</para>
</listitem>
<listitem>
<para><emphasis role="bold">Users and tenants (projects)</emphasis>. The Shared File
Systems service can be used by many different cloud computing consumers or customers
(tenants on a shared system), using role-based access assignments. Roles control the
actions that a user is allowed to perform. In the default configuration, most
actions do not require a particular role unless they are restricted to
administrators, but this can be configured by the system administrator in the
appropriate <filename>policy.json</filename> file that maintains the rules.
A user's access to manage particular shares is limited by tenant. Guest access
to mount and use shares is secured by IP and/or user access rules.
Quotas used to control resource consumption across available hardware resources
are per tenant.</para>
<para>For tenants, quota controls are available to limit:</para>
<itemizedlist>
<listitem>
<para>The number of shares that can be created.</para>
</listitem>
<listitem>
<para>The number of gigabytes that can be provisioned for shares.</para>
</listitem>
<listitem>
<para>The number of share snapshots that can be created.</para>
</listitem>
<listitem>
<para>The number of gigabytes that can be provisioned for share snapshots.</para>
</listitem>
<listitem>
<para>The number of share networks that can be created.</para>
</listitem>
</itemizedlist>
<para>You can revise the default quota values with the Shared File Systems CLI,
so the limits placed by quotas are editable by admin users.</para>
</listitem>
<listitem>
<para><emphasis role="bold">Shares, snapshots, and share networks</emphasis>. The basic
resources offered by the Shared File Systems service are shares, snapshots
and share networks:</para>
<itemizedlist>
<listitem>
<para><emphasis role="bold">Shares</emphasis>. A share is a unit of storage
with a protocol, a size, and an access list. Shares are the basic
primitive provided by Manila. All shares exist on a
backend. Some shares are associated with share networks and share servers.
The main protocols supported are NFS and CIFS, but other protocols are
supported as well.</para>
</listitem>
<listitem>
<para><emphasis role="bold">Snapshots</emphasis>. A snapshot is a point in
time copy of a share. Snapshots can only be used to create new shares
(containing the snapshotted data). Shares cannot be deleted until all
associated snapshots are deleted.</para>
</listitem>
<listitem>
<para><emphasis role="bold">Share networks</emphasis>. A share network is a
tenant-defined object that informs Manila about the security and
network configuration for a group of shares. Share networks are only
relevant for backends that manage share servers. A share network contains
a security service and network/subnet.</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
</section>

424
tools/autogenerate-config-flagmappings/manila.flagmappings Normal file
View File

@ -0,0 +1,424 @@
api_paste_config api
api_rate_limit api
auth_strategy auth
automatic_share_server_cleanup share
backlog share
capacity_weight_multiplier scheduler
cinder_admin_auth_url storage
cinder_admin_password storage
cinder_admin_tenant_name storage
cinder_admin_username storage
cinder_api_insecure storage
cinder_ca_certificates_file storage
cinder_catalog_info storage
cinder_cross_az_attach storage
cinder_http_retries storage
cinder_volume_type storage
client_socket_timeout common
compute_api_class common
connect_share_server_to_tenant_network share
control_exchange amqp
db_backend database
db_driver database
debug logging
default_log_levels logging
default_share_type share
delete_share_server_with_last_share share
driver_handles_share_servers share
emc_nas_login emc
emc_nas_password emc
emc_nas_pool_name emc
emc_nas_root_dir emc
emc_nas_server emc
emc_nas_server_container emc
emc_nas_server_port emc
emc_nas_server_secure emc
emc_share_backend emc
enable_new_services common
enable_periodic_hooks share
enable_post_hooks share
enable_pre_hooks share
enable_v1_api api
enable_v2_api api
enabled_share_backends share
enabled_share_protocols share
executor_thread_pool_size share
fatal_deprecations logging
fatal_exception_format_errors logging
ganesha_config_dir ganesha
ganesha_config_path ganesha
ganesha_db_path ganesha
ganesha_export_dir ganesha
ganesha_export_template_dir ganesha
ganesha_service_name ganesha
glusterfs_ganesha_server_ip glusterfs
glusterfs_ganesha_server_password glusterfs
glusterfs_ganesha_server_username glusterfs
glusterfs_mount_point_base glusterfs
glusterfs_native_path_to_private_key glusterfs
glusterfs_native_server_password glusterfs
glusterfs_nfs_server_type glusterfs
glusterfs_path_to_private_key glusterfs
glusterfs_server_password glusterfs
glusterfs_servers glusterfs
glusterfs_share_layout glusterfs
glusterfs_target glusterfs
glusterfs_volume_pattern glusterfs
hdfs_namenode_ip hdfs
hdfs_namenode_port hdfs
hdfs_ssh_name hdfs
hdfs_ssh_port hdfs
hdfs_ssh_private_key hdfs
hdfs_ssh_pw hdfs
hds_hnas_cluster_admin_ip0 hds_hnas
hds_hnas_evs_id hds_hnas
hds_hnas_evs_ip hds_hnas
hds_hnas_file_system_name hds_hnas
hds_hnas_ip hds_hnas
hds_hnas_password hds_hnas
hds_hnas_ssh_private_key hds_hnas
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
instance_format logging
instance_uuid_format logging
interface_driver share
log_config_append logging
log_date_format logging
log_dir logging
log_file logging
log_format logging
logging_context_format_string logging
logging_debug_format_suffix logging
logging_default_format_string logging
logging_exception_prefix logging
manila_huawei_conf_file huawei
manila_service_keypair_name share
matchmaker_heartbeat_freq rpc
matchmaker_heartbeat_ttl rpc
max_age quota
max_gigabytes storage
max_header_line api
max_over_subscription_ratio common
max_time_to_attach share
max_time_to_build_instance share
max_time_to_create_volume share
max_time_to_extend_volume share
memcached_servers common
migration_create_delete_share_timeout share
migration_data_copy_node_ip share
migration_ignore_files share
migration_mounting_backend_ip share
migration_protocol_mount_command share
migration_readonly_support share
migration_tmp_location share
migration_wait_access_rules_timeout share
monkey_patch common
monkey_patch_modules common
my_ip common
netapp_aggregate_name_search_pattern netapp
netapp_lif_name_template netapp
netapp_login netapp
netapp_password netapp
netapp_port_name_search_pattern netapp
netapp_root_volume netapp
netapp_root_volume_aggregate netapp
netapp_server_hostname netapp
netapp_server_port netapp
netapp_storage_family netapp
netapp_trace_flags netapp
netapp_transport_type netapp
netapp_volume_name_template netapp
netapp_vserver_name_template netapp
network_config_group share
notification_driver amqp
notification_topics amqp
nova_admin_auth_url compute
nova_admin_password compute
nova_admin_tenant_name compute
nova_admin_username compute
nova_api_insecure compute
nova_api_microversion compute
nova_ca_certificates_file compute
nova_catalog_admin_info compute
nova_catalog_info compute
num_shell_tries common
os_region_name compute
osapi_max_limit api
osapi_share_base_URL api
osapi_share_ext_list api
osapi_share_extension api
osapi_share_listen api
osapi_share_listen_port api
osapi_share_workers api
ovs_integration_bridge share
path_to_private_key share
path_to_public_key share
periodic_fuzzy_delay common
periodic_hooks_interval common
periodic_interval common
pool_weight_multiplier scheduler
publish_errors logging
quobyte_api_ca quobyte
quobyte_api_password quobyte
quobyte_api_url quobyte
quobyte_api_username quobyte
quobyte_default_volume_group quobyte
quobyte_default_volume_user quobyte
quobyte_delete_shares quobyte
quobyte_volume_configuration quobyte
quota_driver quota
quota_gigabytes quota
quota_share_networks quota
quota_shares quota
quota_snapshot_gigabytes quota
quota_snapshots quota
report_interval common
reservation_expire quota
reserved_share_percentage common
root_helper share
rootwrap_config common
rpc_backend rpc
rpc_cast_timeout rpc
rpc_conn_pool_size rpc
rpc_response_timeout rpc
rpc_zmq_bind_address zeromq
rpc_zmq_contexts zeromq
rpc_zmq_host zeromq
rpc_zmq_ipc_dir zeromq
rpc_zmq_matchmaker zeromq
rpc_zmq_port zeromq
rpc_zmq_topic_backlog zeromq
scheduler_default_filters scheduler
scheduler_default_weighers scheduler
scheduler_driver scheduler
scheduler_host_manager scheduler
scheduler_json_config_location scheduler
scheduler_manager scheduler
scheduler_max_attempts scheduler
scheduler_topic scheduler
service_down_time common
service_image_name share
service_instance_flavor_id share
service_instance_name_or_id share
service_instance_name_template share
service_instance_network_helper_type share
service_instance_password share
service_instance_security_group share
service_instance_smb_config_path share
service_instance_user share
service_net_name_or_ip share
service_network_cidr share
service_network_division_mask share
service_network_name share
share_api_class api
share_backend_name share
share_driver share
share_helpers share
share_manager share
share_mount_path share
share_name_template share
share_snapshot_name_template share
share_topic rpc
share_usage_audit_period share
share_volume_fstype share
smb_template_config_path share
sql_idle_timeout common
sql_max_retries common
sql_retry_interval common
sqlite_clean_db common
sqlite_db common
sqlite_synchronous common
ssh_conn_timeout san
ssh_max_pool_conn san
ssh_min_pool_conn san
ssl_ca_file ca
ssl_cert_file ca
ssl_key_file ca
state_path common
storage_availability_zone common
suppress_post_hooks_errors share
suppress_pre_hooks_errors share
syslog_log_facility logging
tcp_keepalive common
tcp_keepalive_count common
tcp_keepalive_interval common
tcp_keepidle common
tenant_net_name_or_ip share
transport_url amqp
unmanage_remove_access_rules share
until_refresh common
unused_share_server_cleanup_interval share
use_forwarded_for common
use_scheduler_creating_share_from_snapshot share
use_stderr logging
use_syslog logging
use_syslog_rfc_format logging
verbose logging
volume_api_class api
volume_name_template api
volume_snapshot_name_template api
winrm_cert_key_pem_path winrm
winrm_cert_pem_path winrm
winrm_conn_timeout winrm
winrm_operation_timeout winrm
winrm_retry_count winrm
winrm_retry_interval winrm
winrm_use_cert_based_auth winrm
wsgi_keep_alive common
zfssa_auth_password zfssa
zfssa_auth_user zfssa
zfssa_data_ip zfssa
zfssa_host zfssa
zfssa_nas_checksum zfssa
zfssa_nas_compression zfssa
zfssa_nas_logbias zfssa
zfssa_nas_mountpoint zfssa
zfssa_nas_quota_snap zfssa
zfssa_nas_rstchown zfssa
zfssa_nas_vscan zfssa
zfssa_pool zfssa
zfssa_project zfssa
zfssa_rest_timeout zfssa
cors/allow_credentials cors
cors/allow_headers cors
cors/allow_methods cors
cors/allowed_origin cors
cors/expose_headers cors
cors/max_age cors
cors.subdomain/allow_credentials cors
cors.subdomain/allow_headers cors
cors.subdomain/allow_methods cors
cors.subdomain/allowed_origin cors
cors.subdomain/expose_headers cors
cors.subdomain/max_age cors
database/backend database
database/connection database
database/connection_debug database
database/connection_trace database
database/db_inc_retry_interval database
database/db_max_retries database
database/db_max_retry_interval database
database/db_retry_interval database
database/idle_timeout database
database/max_overflow database
database/max_pool_size database
database/max_retries database
database/min_pool_size database
database/mysql_sql_mode database
database/pool_timeout database
database/retry_interval database
database/slave_connection database
database/sqlite_db database
database/sqlite_synchronous database
database/use_db_reconnect database
keystone_authtoken/admin_password auth_token
keystone_authtoken/admin_tenant_name auth_token
keystone_authtoken/admin_token auth_token
keystone_authtoken/admin_user auth_token
keystone_authtoken/auth_admin_prefix auth_token
keystone_authtoken/auth_host auth_token
keystone_authtoken/auth_plugin auth_token
keystone_authtoken/auth_port auth_token
keystone_authtoken/auth_protocol auth_token
keystone_authtoken/auth_section auth_token
keystone_authtoken/auth_uri auth_token
keystone_authtoken/auth_version auth_token
keystone_authtoken/cache auth_token
keystone_authtoken/cafile auth_token
keystone_authtoken/certfile auth_token
keystone_authtoken/check_revocations_for_cached auth_token
keystone_authtoken/delay_auth_decision auth_token
keystone_authtoken/enforce_token_bind auth_token
keystone_authtoken/hash_algorithms auth_token
keystone_authtoken/http_connect_timeout auth_token
keystone_authtoken/http_request_max_retries auth_token
keystone_authtoken/identity_uri auth_token
keystone_authtoken/include_service_catalog auth_token
keystone_authtoken/insecure auth_token
keystone_authtoken/keyfile auth_token
keystone_authtoken/memcache_pool_conn_get_timeout auth_token
keystone_authtoken/memcache_pool_dead_retry auth_token
keystone_authtoken/memcache_pool_maxsize auth_token
keystone_authtoken/memcache_pool_socket_timeout auth_token
keystone_authtoken/memcache_pool_unused_timeout auth_token
keystone_authtoken/memcache_secret_key auth_token
keystone_authtoken/memcache_security_strategy auth_token
keystone_authtoken/memcache_use_advanced_pool auth_token
keystone_authtoken/memcached_servers auth_token
keystone_authtoken/region_name auth_token
keystone_authtoken/revocation_cache_time auth_token
keystone_authtoken/signing_dir auth_token
keystone_authtoken/token_cache_time auth_token
matchmaker_redis/host redis
matchmaker_redis/password redis
matchmaker_redis/port redis
matchmaker_ring/ringfile redis
oslo_concurrency/disable_process_locking rpc
oslo_concurrency/lock_path rpc
oslo_messaging_amqp/allow_insecure_clients rpc
oslo_messaging_amqp/broadcast_prefix rpc
oslo_messaging_amqp/container_name rpc
oslo_messaging_amqp/group_request_prefix rpc
oslo_messaging_amqp/idle_timeout rpc
oslo_messaging_amqp/server_request_prefix rpc
oslo_messaging_amqp/ssl_ca_file rpc
oslo_messaging_amqp/ssl_cert_file rpc
oslo_messaging_amqp/ssl_key_file rpc
oslo_messaging_amqp/ssl_key_password rpc
oslo_messaging_amqp/trace rpc
oslo_messaging_qpid/amqp_auto_delete qpid
oslo_messaging_qpid/amqp_durable_queues qpid
oslo_messaging_qpid/qpid_heartbeat qpid
oslo_messaging_qpid/qpid_hostname qpid
oslo_messaging_qpid/qpid_hosts qpid
oslo_messaging_qpid/qpid_password qpid
oslo_messaging_qpid/qpid_port qpid
oslo_messaging_qpid/qpid_protocol qpid
oslo_messaging_qpid/qpid_receiver_capacity qpid
oslo_messaging_qpid/qpid_sasl_mechanisms qpid
oslo_messaging_qpid/qpid_tcp_nodelay qpid
oslo_messaging_qpid/qpid_topology_version qpid
oslo_messaging_qpid/qpid_username qpid
oslo_messaging_qpid/send_single_reply qpid
oslo_messaging_rabbit/amqp_auto_delete rabbitmq
oslo_messaging_rabbit/amqp_durable_queues rabbitmq
oslo_messaging_rabbit/fake_rabbit rabbitmq
oslo_messaging_rabbit/heartbeat_rate rabbitmq
oslo_messaging_rabbit/heartbeat_timeout_threshold rabbitmq
oslo_messaging_rabbit/kombu_reconnect_delay rabbitmq
oslo_messaging_rabbit/kombu_reconnect_timeout rabbitmq
oslo_messaging_rabbit/kombu_ssl_ca_certs rabbitmq
oslo_messaging_rabbit/kombu_ssl_certfile rabbitmq
oslo_messaging_rabbit/kombu_ssl_keyfile rabbitmq
oslo_messaging_rabbit/kombu_ssl_version rabbitmq
oslo_messaging_rabbit/rabbit_ha_queues rabbitmq
oslo_messaging_rabbit/rabbit_host rabbitmq
oslo_messaging_rabbit/rabbit_hosts rabbitmq
oslo_messaging_rabbit/rabbit_login_method rabbitmq
oslo_messaging_rabbit/rabbit_max_retries rabbitmq
oslo_messaging_rabbit/rabbit_password rabbitmq
oslo_messaging_rabbit/rabbit_port rabbitmq
oslo_messaging_rabbit/rabbit_retry_backoff rabbitmq
oslo_messaging_rabbit/rabbit_retry_interval rabbitmq
oslo_messaging_rabbit/rabbit_use_ssl rabbitmq
oslo_messaging_rabbit/rabbit_userid rabbitmq
oslo_messaging_rabbit/rabbit_virtual_host rabbitmq
oslo_messaging_rabbit/send_single_reply rabbitmq
oslo_middleware/max_request_body_size api
oslo_middleware/secure_proxy_ssl_header api
oslo_policy/policy_default_rule api
oslo_policy/policy_dirs api
oslo_policy/policy_file api

32
tools/autogenerate-config-flagmappings/manila.headers Normal file
View File

@ -0,0 +1,32 @@
amqp AMQP
api API
auth Authorization
auth_token Authorization Token
ca Certificate Authority
common Common
compute Compute
cors CORS
database Database
emc EMC Share Drivers
ganesha Ganesha
glusterfs GlusterFS Share Drivers
gpfs IBM GPFS Share Driver
hdfs HDFS Share Driver
hds_hnas HDS NAS Share Driver
hp3par HP 3PAR Share Driver
huawei Huawei Share Driver
logging Logging
netapp NetApp Share Drivers
qpid QPID
quobyte Quobyte Share Driver
quota Quota
rabbitmq RabbitMQ
redis Redis
rpc RPC
san SAN
scheduler Scheduler
share Share
storage Storage
winrm WinRM
zeromq ZeroMQ
zfssa ZFSSA Share Driver