openstack-manuals/doc/common/tables/manila-glusterfs.xml
Atsushi SAKAI 7f47c0006f Update Config Reference for manila
Updates for Liberty Release

  Mainly same as ceilometer/nova changes

Change-Id: I5aa547fdba384b08a422c001526bf7f4efa42ebb
2015-10-14 18:52:05 +09:00

67 lines
3.7 KiB
XML

<?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_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>