Include config-reference documentation for Tintri Cinder driver

Closes-Bug: #1462048

Change-Id: I7372a074f7e287bb2de77618ae5a20511a9badb6
This commit is contained in:
appsdesh 2015-06-08 15:09:21 -07:00
parent 7fb2775aba
commit 605c8ac66b
5 changed files with 100 additions and 0 deletions

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_cinder_tintri">
<caption>Description of Tintri 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>tintri_server_hostname</option> = <replaceable> None </replaceable></td>
<td>(StrOpt) Tintri VMstore management IP address</td>
</tr>
<tr>
<td><option>tintri_server_username</option> = <replaceable> None </replaceable></td>
<td>(StrOpt) Tintri VMstore username</td>
</tr>
<tr>
<td><option>tintri_server_password</option> = <replaceable> None </replaceable></td>
<td>(StrOpt) Tintri VMstore password for the user</td>
</tr>
<tr>
<td><option>tintri_api_version</option> = <replaceable> v310 </replaceable></td>
<td>(StrOpt) Tintri VMstore API version</td>
</tr>
</tbody>
</table>
</para>

View File

@ -0,0 +1,56 @@
<section xml:id="tintri-volume-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>Tintri</title>
<para>Tintri VMstore is a smart storage that sees, learns and adapts for cloud and virtualization. Tintri Cinder driver will interact with configured VMstore running Tintri OS 4.0 and above. It supports various operations using Tintri REST APIs and NFS protocol.
</para>
<para>To configure the use of a Tintri VMstore with Block
Storage, modify your <filename>cinder.conf</filename> file as
follows:</para>
<programlisting language="ini">volume_driver = cinder.volume.drivers.tintri.TintriDriver
# Mount options passed to the nfs client. See section of the
# nfs man page for details. (string value)
nfs_mount_options=vers=3,lookupcache=none
#
# Options defined in cinder.volume.drivers.tintri
#
# The hostname (or IP address) for the storage system (string
# value)
tintri_server_hostname={Tintri VMstore Management IP}
# User name for the storage system (string value)
tintri_server_username={username}
# Password for the storage system (string value)
tintri_server_password={password}
# API version for the storage system (string value)
#tintri_api_version=v310
# Following options needed for NFS configuration
# File with the list of available nfs shares (string value)
#nfs_shares_config=/etc/cinder/nfs_shares
</programlisting>
<para>Following changes are needed in /etc/cinder/nfs_shares</para>
<programlisting language="ini">
# Edit /etc/cinder/nfs_shares to add one or more Tintri VMstore mount points
# associated with already configured VMstore management IP in cinder.conf
{vmstore_data_ip}:/tintri/{submount1}
{vmstore_data_ip}:/tintri/{submount2}
</programlisting>
<para>Following changes are needed in <filename>nova.conf</filename> file:</para>
<programlisting language="ini">
# Edit /etc/nova/nova.conf
nfs_mount_options=vers=3
</programlisting>
<xi:include href="../../../common/tables/cinder-tintri.xml"/>
</section>

View File

@ -42,6 +42,7 @@
<xi:include href="drivers/sheepdog-driver.xml"/>
<xi:include href="drivers/smbfs-volume-driver.xml"/>
<xi:include href="drivers/solidfire-volume-driver.xml"/>
<xi:include href="drivers/tintri-volume-driver.xml"/>
<xi:include href="drivers/vmware-vmdk-driver.xml"/>
<xi:include href="drivers/windows-iscsi-volume-driver.xml"/>
<xi:include href="drivers/xio-volume-driver.xml"/>

View File

@ -413,6 +413,10 @@ tcp_keepalive common
tcp_keepalive_count common
tcp_keepalive_interval common
tcp_keepidle common
tintri_server_hostname tintri
tintri_server_username tintri
tintri_server_password tintri
tintri_api_version tintri
thres_avl_size_perc_start netapp_7mode_nfs netapp_cdot_nfs
thres_avl_size_perc_stop netapp_7mode_nfs netapp_cdot_nfs
transfer_api_class api

View File

@ -51,6 +51,7 @@ storage_xen Xen storage
storpool StorPool volume driver
storwize IBM Storwise driver
srb Scality REST Block storage driver
tintri Tintri volume driver
violin Violin volume driver
windows Windows
xio X-IO volume driver