[libvirt] [PATCH 06/10] docs: storage: Document SCSI pools

Signed-off-by: Cole Robinson <crobinso(a)redhat.com&gt; --- docs/formatstorage.html.in | 5 +++++ docs/storage.html.in | 37 +++++++++++++++++++++++++++++++++++++ 2 files changed, 42 insertions(+), 0 deletions(-) diff --git a/docs/formatstorage.html.in b/docs/formatstorage.html.in index 855d475..8f62f73 100644 --- a/docs/formatstorage.html.in +++ b/docs/formatstorage.html.in @@ -85,6 +85,11 @@ only occur once. Contains a single attribute <code>path</code> which is the fully qualified path to the block device node. <span class="since">Since 0.4.1</span></dd> + <dt><code>adapter</code></dt> + <dd>Provides the source for pools backed by SCSI adapters. May + only occur once. Contains a single attribute <code>name</code> + which is the SCSI adapter name (ex. "host1"). + <span class="since">Since 0.6.2</span></dd> <dt><code>host</code></dt> <dd>Provides the source for pools backed by storage from a remote server. Will be used in combination with a <code>directory</code> diff --git a/docs/storage.html.in b/docs/storage.html.in index a3399c6..c179945 100644 --- a/docs/storage.html.in +++ b/docs/storage.html.in @@ -25,6 +25,9 @@ libvirt. <li> <a href="#StorageBackendISCSI">iSCSI backend</a> </li> + <li> + <a href="#StorageBackendSCSI">SCSI backend</a> + </li> </ul> <h2><a name="StorageBackendDir" id="StorageBackendDir">Directory pool</a></h2> @@ -345,5 +348,39 @@ libvirt. <p> The iSCSI volume pool does not use the volume format type element. </p> + + <h2><a name="StorageBackendSCSI" id="StorageBackendSCSI">SCSI volume pools</a></h2> + <p> + This provides a pool based on a SCSI HBA. Volumes are preexisting SCSI + LUNs, and cannot be created via the libvirt APIs. Since /dev/XXX names + aren't generally stable, it is recommended to configure the pool + to use <code>/dev/disk/by-path</code> or <code>/dev/disk/by-id</code> + for the target path. These provide persistent stable naming for LUNs + <span class="since">Since 0.6.2</span></dd> + </p> + + <h3>Example pool input</h3> + <pre> + &lt;pool type="scsi"&gt; + &lt;name&gt;virtimages&lt;/name&gt; + &lt;source&gt; + &lt;adapter name="host0"/&gt; + &lt;/source&gt; + &lt;target&gt; + &lt;path&gt;/dev/disk/by-path&lt;/path&gt; + &lt;/target&gt; + &lt;/pool&gt;</pre> + + <h3>Valid pool format types</h3> + <p> + The SCSI volume pool does not use the pool format type element. + </p> + + <h3>Valid volume format types</h3> + <p> + The SCSI volume pool does not use the volume format type element. + </p> + + </body> </html> -- 1.6.6