openstack/openstack-manuals
Code Issues Proposed changes

[config-ref] Update the tables for manila hnas

Browse Source 
Change-Id: Ic225441701fcb7f4b9a13e8653d1a2143921de73
This commit is contained in:
Gauvain Pocentek 2015-12-05 11:30:43 +01:00
parent 275741cbd6
commit 265f9ed049
29 changed files with 135 additions and 102 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/common/tables/manila-amqp.xml
View File

@ -47,6 +47,10 @@
<td><option>notification_topics</option> = <replaceable>notifications</replaceable></td>
<td>(ListOpt) AMQP topic used for OpenStack notifications.</td>
</tr>
<tr>
<td><option>notification_transport_url</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) A URL representing the messaging driver to use for notifications. If not set, we fall back to the same configuration used for RPC.</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>

6
doc/common/tables/manila-api.xml
View File

@ -77,7 +77,7 @@
</tr>
<tr>
<td><option>osapi_share_listen_port</option> = <replaceable>8786</replaceable></td>
<td>(IntOpt) Port for OpenStack Share API to listen on.</td>
<td>(PortOpt) Port for OpenStack Share API to listen on.</td>
</tr>
<tr>
<td><option>osapi_share_workers</option> = <replaceable>1</replaceable></td>
@ -104,7 +104,7 @@
</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>
<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>
@ -119,7 +119,7 @@
</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>
<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>

12
doc/common/tables/manila-auth_token.xml
View File

@ -59,10 +59,6 @@
<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>
@ -73,7 +69,11 @@
</tr>
<tr>
<td><option>auth_section</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Config Section from which to load plugin specific options</td>
<td>(Opt) Config Section from which to load plugin specific options</td>
</tr>
<tr>
<td><option>auth_type</option> = <replaceable>None</replaceable></td>
<td>(Opt) Authentication type to load</td>
</tr>
<tr>
<td><option>auth_uri</option> = <replaceable>None</replaceable></td>
@ -161,7 +161,7 @@
</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>
<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>

6
doc/common/tables/manila-common.xml
View File

@ -49,7 +49,7 @@
</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>
<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>
@ -103,6 +103,10 @@
<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>smb_template_config_path</option> = <replaceable>$state_path/smb.conf</replaceable></td>
<td>(StrOpt) Path to smb config.</td>
</tr>
<tr>
<td><option>sql_idle_timeout</option> = <replaceable>3600</replaceable></td>
<td>(IntOpt) Timeout before idle SQL connections are reaped.</td>

4
doc/common/tables/manila-cors.xml
View File

@ -49,7 +49,7 @@
</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>
<td>(ListOpt) 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>
@ -76,7 +76,7 @@
</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>
<td>(ListOpt) 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>

2
doc/common/tables/manila-emc.xml
View File

@ -61,7 +61,7 @@
</tr>
<tr>
<td><option>emc_nas_server_port</option> = <replaceable>8080</replaceable></td>
<td>(IntOpt) Port number for the EMC server.</td>
<td>(PortOpt) Port number for the EMC server.</td>
</tr>
<tr>
<td><option>emc_nas_server_secure</option> = <replaceable>True</replaceable></td>

2
doc/common/tables/manila-ganesha.xml
View File

@ -57,7 +57,7 @@
</tr>
<tr>
<td><option>ganesha_nfs_export_options</option> = <replaceable>maxread = 65536, prefread = 65536</replaceable></td>
<td>(StrOpt) Options to use when exporting a share using ganesha NFS server. Note that these defaults can be overridden when a share is created by passing metadata with key name export_options. Also note the complete set of default ganesha export options is specified in ganesha_utils. (GPFS only.)</td>
<td>(StrOpt) Options to use when exporting a share using ganesha NFS server. Note that these defaults can be overridden when a share is created by passing metadata with key name export_options. Also note the complete set of default ganesha export options is specified in ganesha_utils. (GPFS only.)</td>
</tr>
<tr>
<td><option>ganesha_service_name</option> = <replaceable>ganesha.nfsd</replaceable></td>

78
doc/common/tables/manila-generic.xml
View File

@ -72,40 +72,40 @@
<td>(IntOpt) Number of cinderclient retries on failed HTTP calls.</td>
</tr>
<tr>
<td><option>cinder_volume_type</option> = <replaceable>%volume_type%</replaceable></td>
<td>(StrOpt) Name or id of the Cinder volume type which will be used for all volumes created by driver.</td>
<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>connect_share_server_to_tenant_network</option> = <replaceable>False/True</replaceable></td>
<td>(BoolOpt) Attach share server directly to share network. Used only with Neutron and only applies when the option driver_handles_share_servers is set to True and one of either Generic or Windows drivers is used.</td>
<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>driver_handles_share_servers</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Required option that defines driver mode. Possible values are True/False.</td>
<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>interface_driver</option> = <replaceable>manila.network.linux.interface.OVSInterfaceDriver</replaceable></td>
<td>(StrOpt) Vif driver. Used only with Neutron and only applies when the option driver_handles_share_servers is set to True.</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. This option only applies when the option driver_handles_share_servers is set to True.</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 attachment of a Cinder volume.</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. This option only applies when the option driver_handles_share_servers is set to True.</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 creation of a Cinder volume.</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 extention of a Cinder volume.</td>
<td>(IntOpt) Maximum time to wait for extending cinder volume.</td>
</tr>
<tr>
<td><option>ovs_integration_bridge</option> = <replaceable>br-int</replaceable></td>
@ -117,71 +117,63 @@
</tr>
<tr>
<td><option>path_to_public_key</option> = <replaceable>~/.ssh/id_rsa.pub</replaceable></td>
<td>(StrOpt) Path to hosts public key. This option only applies when the option driver_handles_share_servers is set to True.</td>
<td>(StrOpt) Path to hosts public key.</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. This option only applies when the option driver_handles_share_servers is set to True.</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. This option only applies when the option driver_handles_share_servers is set to True.</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>%nova_vm_name_or_id%</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. This option only applies when the option driver_handles_share_servers is set to False.</td>
<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) Template that will be used for naming of Nova VMs that are used and service instances. This option only applies when the option driver_handles_share_servers is set to True.</td>
<td>(StrOpt) Name of service instance.</td>
</tr>
<tr>
<td><option>service_instance_network_helper_type</option> = <replaceable>neutron</replaceable></td>
<td>(StrOpt) Type of network helper for the Generic driver. Possible values are 'neutron' and 'nova'. This option only applies when the option driver_handles_share_servers is set to True.</td>
<td>(StrOpt) Allowed values are ['nova', 'neutron'].</td>
</tr>
<tr>
<td><option>service_instance_password</option> = <replaceable>%password%</replaceable></td>
<td>(StrOpt) Password for service instance user. Optional, will be used in ase SSH keys are not set up.</td>
<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. This option only applies when the option driver_handles_share_servers is set to True.</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>%username%</replaceable></td>
<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>%nova_vm_net_name_or_ip%</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. This option only applies when the option driver_handles_share_servers is set to False.</td>
<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 and only applies when the option driver_handles_share_servers is set to True.</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 and only applies when the option driver_handles_share_servers is set to True.</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 and only applies when the option driver_handles_share_servers is set to True.</td>
<td>(StrOpt) Name of manila service network. Used only with Neutron.</td>
</tr>
<tr>
<td><option>share_backend_name</option> = <replaceable>Cinder_Volumes</replaceable></td>
<td>(StrOpt) The backend name for the Generic driver.</td>
</tr>
<tr>
<td><option>share_driver</option> = <replaceable>manila.share.drivers.generic.GenericShareDriver</replaceable></td>
<td>(StrOpt) path to Generic driver.</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) List of share export helpers.</td>
<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_mount_path</option> = <replaceable>/shares</replaceable></td>
@ -189,19 +181,19 @@
</tr>
<tr>
<td><option>share_volume_fstype</option> = <replaceable>ext4</replaceable></td>
<td>(StrOpt) Filesystem type of the share volume. Possible values are 'ext4' and 'ext3'</td>
<td>(StrOpt) Filesystem type of the share volume.</td>
</tr>
<tr>
<td><option>tenant_net_name_or_ip</option> = <replaceable>%nova_vm_tenant_net_name_or_ip%</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. This option only applies when the option driver_handles_share_servers is set to False.</td>
<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>volume_name_template</option> = <replaceable>manila-share-%s</replaceable></td>
<td>(StrOpt) Name template for Cinder volumes.</td>
<td>(StrOpt) Volume name template.</td>
</tr>
<tr>
<td><option>volume_snapshot_name_template</option> = <replaceable>manila-snapshot-%s</replaceable></td>
<td>(StrOpt) Name template for Cinder snapshots..</td>
<td>(StrOpt) Volume snapshot name template.</td>
</tr>
</tbody>
</table>

2
doc/common/tables/manila-gpfs.xml
View File

@ -65,7 +65,7 @@
</tr>
<tr>
<td><option>gpfs_ssh_port</option> = <replaceable>22</replaceable></td>
<td>(IntOpt) GPFS server SSH port.</td>
<td>(PortOpt) GPFS server SSH port.</td>
</tr>
<tr>
<td><option>gpfs_ssh_private_key</option> = <replaceable>None</replaceable></td>

4
doc/common/tables/manila-hdfs.xml
View File

@ -41,7 +41,7 @@
</tr>
<tr>
<td><option>hdfs_namenode_port</option> = <replaceable>9000</replaceable></td>
<td>(IntOpt) The port of HDFS namenode service.</td>
<td>(PortOpt) The port of HDFS namenode service.</td>
</tr>
<tr>
<td><option>hdfs_ssh_name</option> = <replaceable>None</replaceable></td>
@ -49,7 +49,7 @@
</tr>
<tr>
<td><option>hdfs_ssh_port</option> = <replaceable>22</replaceable></td>
<td>(IntOpt) HDFS namenode SSH port.</td>
<td>(PortOpt) HDFS namenode SSH port.</td>
</tr>
<tr>
<td><option>hdfs_ssh_private_key</option> = <replaceable>None</replaceable></td>

10
doc/common/tables/manila-hds_hnas.xml
View File

@ -33,7 +33,7 @@
</thead>
<tbody>
<tr>
<th colspan="2">[DEFAULT]</th>
<th colspan="2">[hnas1]</th>
</tr>
<tr>
<td><option>hds_hnas_cluster_admin_ip0</option> = <replaceable>None</replaceable></td>
@ -71,6 +71,14 @@
<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>
<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>
</tbody>
</table>
</para>

2
doc/common/tables/manila-hpe3par.xml
View File

@ -69,7 +69,7 @@
</tr>
<tr>
<td><option>hpe3par_san_ssh_port</option> = <replaceable>22</replaceable></td>
<td>(IntOpt) SSH port to use with SAN</td>
<td>(PortOpt) SSH port to use with SAN</td>
</tr>
<tr>
<td><option>hpe3par_share_ip_address</option> = <replaceable></replaceable></td>

6
doc/common/tables/manila-logging.xml
View File

@ -77,7 +77,7 @@
</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. This option is ignored if log_config_append is set.</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. This option is ignored if log_config_append is set.</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>
@ -95,6 +95,10 @@
<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>logging_user_identity_format</option> = <replaceable>%(user)s %(tenant)s %(domain)s %(user_domain)s %(project_domain)s</replaceable></td>
<td>(StrOpt) Format string for user_identity field of the logging_context_format_string</td>
</tr>
<tr>
<td><option>publish_errors</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Enables or disables publication of error events.</td>

4
doc/common/tables/manila-netapp.xml
View File

@ -69,7 +69,7 @@
</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>
<td>(PortOpt) The TCP port to use for communication with the storage system or proxy server. If not specified, Data ONTAP drivers will use 80 for HTTP and 443 for HTTPS.</td>
</tr>
<tr>
<td><option>netapp_storage_family</option> = <replaceable>ontap_cluster</replaceable></td>
@ -77,7 +77,7 @@
</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>
<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>

2
doc/common/tables/manila-qpid.xml
View File

@ -81,7 +81,7 @@
</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>
<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>

4
doc/common/tables/manila-quota.xml
View File

@ -39,6 +39,10 @@
<td><option>max_age</option> = <replaceable>0</replaceable></td>
<td>(IntOpt) Number of seconds between subsequent usage refreshes.</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>
<tr>
<td><option>quota_driver</option> = <replaceable>manila.quota.DbQuotaDriver</replaceable></td>
<td>(StrOpt) Default driver to use for quota checks.</td>

2
doc/common/tables/manila-rpc.xml
View File

@ -68,7 +68,7 @@
</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>
<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>

2
doc/common/tables/manila-scheduler.xml
View File

@ -52,7 +52,7 @@
<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><option>scheduler_driver</option> = <replaceable>manila.scheduler.drivers.filter.FilterScheduler</replaceable></td>
<td>(StrOpt) Default scheduler driver to use.</td>
</tr>
<tr>

10
doc/common/tables/manila-share.xml
View File

@ -123,14 +123,6 @@
<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>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_manager</option> = <replaceable>manila.share.manager.ShareManager</replaceable></td>
<td>(StrOpt) Full class name for the share manager.</td>
@ -145,7 +137,7 @@
</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>
<td>(StrOpt) Time period to generate share usages for. Time period must be hour, day, month or year.</td>
</tr>
<tr>
<td><option>suppress_post_hooks_errors</option> = <replaceable>False</replaceable></td>

12
doc/common/tables/manila-zeromq.xml
View File

@ -43,6 +43,10 @@
<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_bind_port_retries</option> = <replaceable>100</replaceable></td>
<td>(IntOpt) Number of retries to find free port number before fail with ZMQBindError.</td>
</tr>
<tr>
<td><option>rpc_zmq_concurrency</option> = <replaceable>eventlet</replaceable></td>
<td>(StrOpt) Type of concurrency used. Either "native" or "eventlet"</td>
@ -63,6 +67,14 @@
<td><option>rpc_zmq_matchmaker</option> = <replaceable>redis</replaceable></td>
<td>(StrOpt) MatchMaker driver.</td>
</tr>
<tr>
<td><option>rpc_zmq_max_port</option> = <replaceable>65536</replaceable></td>
<td>(IntOpt) Maximal port number for random ports range.</td>
</tr>
<tr>
<td><option>rpc_zmq_min_port</option> = <replaceable>49152</replaceable></td>
<td>(IntOpt) Minimal port number for random ports range.</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>

6
doc/config-ref-rst/source/tables/manila-auth_token.rst
View File

@ -30,14 +30,14 @@
- (StrOpt) Prefix to prepend at the beginning of the path. Deprecated, use identity_uri.
* - ``auth_host`` = ``127.0.0.1``
- (StrOpt) Host providing the admin Identity API endpoint. Deprecated, use identity_uri.
* - ``auth_plugin`` = ``None``
- (StrOpt) Name of the plugin to load
* - ``auth_port`` = ``35357``
- (IntOpt) Port of the admin Identity API endpoint. Deprecated, use identity_uri.
* - ``auth_protocol`` = ``https``
- (StrOpt) Protocol of the admin Identity API endpoint (http or https). Deprecated, use identity_uri.
* - ``auth_section`` = ``None``
- (StrOpt) Config Section from which to load plugin specific options
- (Opt) Config Section from which to load plugin specific options
* - ``auth_type`` = ``None``
- (Opt) Authentication type to load
* - ``auth_uri`` = ``None``
- (StrOpt) Complete public Identity API endpoint.
* - ``auth_version`` = ``None``

2
doc/config-ref-rst/source/tables/manila-common.rst
View File

@ -52,6 +52,8 @@
- (StrOpt) Path to the rootwrap configuration file to use for running commands as root.
* - ``service_down_time`` = ``60``
- (IntOpt) Maximum time since last check-in for up service.
* - ``smb_template_config_path`` = ``$state_path/smb.conf``
- (StrOpt) Path to smb config.
* - ``sql_idle_timeout`` = ``3600``
- (IntOpt) Timeout before idle SQL connections are reaped.
* - ``sql_max_retries`` = ``10``

4
doc/config-ref-rst/source/tables/manila-generic.rst
View File

@ -86,10 +86,6 @@
- (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.
* - ``service_network_name`` = ``manila_service_network``
- (StrOpt) Name of manila service network. Used only with Neutron.
* - ``share_backend_name`` = ``None``
- (StrOpt) The backend name for a given driver implementation.
* - ``share_driver`` = ``manila.share.drivers.generic.GenericShareDriver``
- (StrOpt) Driver to use for share creation.
* - ``share_helpers`` = ``CIFS=manila.share.drivers.generic.CIFSHelper, NFS=manila.share.drivers.generic.NFSHelper``
- (ListOpt) Specify list of share export helpers.
* - ``share_mount_path`` = ``/shares``

6
doc/config-ref-rst/source/tables/manila-hds_hnas.rst
View File

@ -16,7 +16,7 @@
* - Configuration option = Default value
- Description
* - **[DEFAULT]**
* - **[hnas1]**
-
* - ``hds_hnas_cluster_admin_ip0`` = ``None``
- (StrOpt) The IP of the clusters admin node. Only set in HNAS multinode clusters.
@ -36,3 +36,7 @@
- (IntOpt) The time (in seconds) to wait for stalled HNAS jobs before aborting.
* - ``hds_hnas_user`` = ``None``
- (StrOpt) HNAS username Base64 String in order to perform tasks such as create file-systems and network interfaces.
* - ``share_backend_name`` = ``None``
- (StrOpt) The backend name for a given driver implementation.
* - ``share_driver`` = ``manila.share.drivers.generic.GenericShareDriver``
- (StrOpt) Driver to use for share creation.

2
doc/config-ref-rst/source/tables/manila-quota.rst
View File

@ -20,6 +20,8 @@
-
* - ``max_age`` = ``0``
- (IntOpt) Number of seconds between subsequent usage refreshes.
* - ``max_gigabytes`` = ``10000``
- (IntOpt) Maximum number of volume gigabytes to allow per host.
* - ``quota_driver`` = ``manila.quota.DbQuotaDriver``
- (StrOpt) Default driver to use for quota checks.
* - ``quota_gigabytes`` = ``1000``

2
doc/config-ref-rst/source/tables/manila-scheduler.rst
View File

@ -26,7 +26,7 @@
- (ListOpt) Which filter class names to use for filtering hosts when not specified in the request.
* - ``scheduler_default_weighers`` = ``CapacityWeigher``
- (ListOpt) Which weigher class names to use for weighing hosts.
* - ``scheduler_driver`` = ``manila.scheduler.filter_scheduler.FilterScheduler``
* - ``scheduler_driver`` = ``manila.scheduler.drivers.filter.FilterScheduler``
- (StrOpt) Default scheduler driver to use.
* - ``scheduler_host_manager`` = ``manila.scheduler.host_manager.HostManager``
- (StrOpt) The scheduler host manager class to use.

4
doc/config-ref-rst/source/tables/manila-share.rst
View File

@ -62,10 +62,6 @@
- (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.
* - ``root_helper`` = ``sudo``
- (StrOpt) Deprecated: command to use for running commands as root.
* - ``share_backend_name`` = ``None``
- (StrOpt) The backend name for a given driver implementation.
* - ``share_driver`` = ``manila.share.drivers.generic.GenericShareDriver``
- (StrOpt) Driver to use for share creation.
* - ``share_manager`` = ``manila.share.manager.ShareManager``
- (StrOpt) Full class name for the share manager.
* - ``share_name_template`` = ``share-%s``

26
tools/autogenerate-config-flagmappings/manila.flagmappings
View File

@ -78,15 +78,6 @@ 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
hpe3par_api_url hpe3par
@ -117,6 +108,7 @@ logging_user_identity_format logging
manila_huawei_conf_file huawei
manila_service_keypair_name generic
max_age quota
max_gigabytes quota
max_header_line api
max_over_subscription_ratio common
max_time_to_attach generic
@ -239,8 +231,6 @@ service_network_cidr generic
service_network_division_mask generic
service_network_name generic
share_api_class api
share_backend_name share generic
share_driver share generic
share_helpers generic
share_manager share
share_mount_path generic
@ -249,6 +239,7 @@ share_snapshot_name_template share
share_topic rpc
share_usage_audit_period share
share_volume_fstype generic
smb_template_config_path common
sql_idle_timeout common
sql_max_retries common
sql_retry_interval common
@ -340,16 +331,27 @@ database/slave_connection database
database/sqlite_db database
database/sqlite_synchronous database
database/use_db_reconnect database
hnas1/hds_hnas_cluster_admin_ip0 hds_hnas
hnas1/hds_hnas_evs_id hds_hnas
hnas1/hds_hnas_evs_ip hds_hnas
hnas1/hds_hnas_file_system_name hds_hnas
hnas1/hds_hnas_ip hds_hnas
hnas1/hds_hnas_password hds_hnas
hnas1/hds_hnas_ssh_private_key hds_hnas
hnas1/hds_hnas_stalled_job_timeout hds_hnas
hnas1/hds_hnas_user hds_hnas
hnas1/share_backend_name hds_hnas
hnas1/share_driver hds_hnas
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_type auth_token
keystone_authtoken/auth_uri auth_token
keystone_authtoken/auth_version auth_token
keystone_authtoken/cache auth_token

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

@ -0,0 +1,11 @@
hds_hnas_cluster_admin_ip0 hnas1
hds_hnas_evs_id hnas1
hds_hnas_evs_ip hnas1
hds_hnas_stalled_job_timeout hnas1
hds_hnas_user hnas1
hds_hnas_file_system_name hnas1
hds_hnas_ip hnas1
hds_hnas_password hnas1
hds_hnas_ssh_private_key hnas1
share_backend_name hnas1
share_driver hnas1