[virtualization-guide] updating concepts, description and virsh reference
Chris Curran
tsagadai at fedoraproject.org
Fri Jun 18 05:10:45 UTC 2010
commit 5efc702b5cec444baede6b198f8aa38fae33236a
Author: Chris Curran <ccurran at redhat.com>
Date: Fri Jun 18 15:10:16 2010 +1000
updating concepts, description and virsh reference
en-US/Reference_virsh.xml | 138 +++++++++++++++++++++++++++++++++++-
en-US/Storage_Concepts.xml | 16 ++---
en-US/Storage_Pools_Directory.xml | 2 +-
en-US/Storage_Pools_Partitions.xml | 23 ++++---
en-US/Virtualization_Guide.xml | 6 +-
5 files changed, 160 insertions(+), 25 deletions(-)
---
diff --git a/en-US/Reference_virsh.xml b/en-US/Reference_virsh.xml
index a66590a..e0e4af5 100644
--- a/en-US/Reference_virsh.xml
+++ b/en-US/Reference_virsh.xml
@@ -330,7 +330,135 @@
</tgroup>
</table>
<para>
- These are miscellaneous <command>virsh</command> options:
+ The <command>virsh</command> commands for managing and creating storage pools:
+ </para>
+ <screen>
+ TODO
+
+ STORAGE POOL COMMANDS
+ The following commands manipulate storage pools. Libvirt has the capability to manage various storage solutions, including files, raw
+ partitions, and domain-specific formats, used to provide the storage volumes visible as devices within virtual machines. For more
+ detailed information about this feature, see the documentation at http://libvirt.org/formatstorage.html . A lot of the commands for
+ pools are similar to the ones used for domains.
+
+ find-storage-pool-sources type optional srcSpec
+ Returns XML describing all storage pools of a given type that could be found. If srcSpec is provided, it is a file that contains
+ XML to further restrict the query for pools.
+
+ find-storage-pool-sources type optional host port
+ Returns XML describing all storage pools of a given type that could be found. If host and port are provided, they control where
+ the query is performed.
+
+ pool-autostart pool-or-uuid optional --disable
+ Configure whether pool should automatically start at boot.
+
+
+ pool-build pool-or-uuid
+ Build a given pool.
+
+ pool-create file
+ Create and start a pool object from the XML file.
+
+ pool-create-as name --print-xml type optional source-host source-path source-dev source-name [target]
+ Create and start a pool object name from the raw parameters. If --print-xml is specified, then print the XML of the pool object
+ without creating the pool. Otherwise, the pool has the specified type.
+
+ pool-define file
+ Create, but do not start, a pool object from the XML file.
+
+ pool-define-as name --print-xml type optional source-host source-path source-dev source-name [target]
+ Create, but do not start, a pool object name from the raw parameters. If --print-xml is specified, then print the XML of the pool
+ object without defining the pool. Otherwise, the pool has the specified type.
+
+
+pool-destroy pool-or-uuid
+ Destroy a given pool object. Libvirt will no longer manage the storage described by the pool object, but the raw data contained in
+ the pool is not changed, and can be later recovered with pool-create.
+
+ pool-delete pool-or-uuid
+ Destroy the resources used by a given pool object. This operation is non-recoverable. The pool object will still exist after this
+ command.
+
+ pool-dumpxml pool-or-uuid
+ Returns the XML information about the pool object.
+
+ pool-edit pool-or-uuid
+ Edit the XML configuration file for a storage pool.
+
+ This is equivalent to:
+
+ virsh pool-dumpxml pool > pool.xml
+ edit pool.xml
+ virsh pool-define pool.xml
+
+ except that it does some error checking.
+ The editor used can be supplied by the $VISUAL or $EDITOR environment variables, and defaults to "vi".
+
+ pool-info pool-or-uuid
+ Returns basic information about the pool object.
+
+ pool-list optional --inactive --all
+ List pool objects known to libvirt. By default, only pools in use by active domains are listed; --inactive lists just the inactive
+ pools, and --all lists all pools.
+
+ pool-name uuid
+ Convert the uuid to a pool name.
+
+ pool-refresh pool-or-uuid
+ Refresh the list of volumes contained in pool.
+
+ pool-start pool-or-uuid
+ Start the storage pool, which is previously defined but inactive.
+
+
+</screen>
+
+<!--
+DONE
+pool-undefine pool-or-uuid
+ Undefine the configuration for an inactive pool.
+
+ pool-uuid pool
+ Returns the UUID of the named pool.-->
+
+ <table frame="all" id="tabl-Virtualization-Managing_guests_with_virsh-Storage_options">
+ <title>Storage pool commands</title>
+ <tgroup cols="2">
+ <colspec colname="column1"></colspec>
+ <colspec colname="column2"></colspec>
+ <thead>
+ <row>
+ <entry>
+ Command
+ </entry>
+ <entry>
+ Description
+ </entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>
+ <command>pool-undefine</command>
+ </entry>
+ <entry>
+ Deletes the configuration for an inactive pool.
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <command>pool-uuid</command>
+ </entry>
+ <entry>
+ Returns the UUID of the named pool.
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+
+ <para>
+ This table contains miscellaneous <command>virsh</command> commands:
</para>
<table frame="all" id="tabl-Virtualization-Managing_guests_with_virsh-Miscellaneous_options">
<title>Miscellaneous options</title>
@@ -367,6 +495,8 @@
</tbody>
</tgroup>
</table>
+
+
<formalpara id="form-Virtualization-Managing_guests_with_virsh-Connecting_to_the_hypervisor">
<title>Connecting to the hypervisor</title>
<para>
@@ -884,5 +1014,11 @@ vnet2 active yes
</para>
</listitem>
</itemizedlist>
+ <!--<formalpara id="virshpool1"><title></title><para></para></formalpara>
+ <formalpara id="virshpool2"><title></title><para></para></formalpara>
+ <formalpara id="virshpool3"><title></title><para></para></formalpara>
+ <formalpara id="virshpool4"><title></title><para></para></formalpara>
+ <formalpara id="virshpool5"><title></title><para></para></formalpara>-->
+
</chapter>
diff --git a/en-US/Storage_Concepts.xml b/en-US/Storage_Concepts.xml
index 1430e9f..21674bb 100644
--- a/en-US/Storage_Concepts.xml
+++ b/en-US/Storage_Concepts.xml
@@ -13,15 +13,11 @@
<section id="sect-Virtualization-Storage_Concepts-Storage_Pools">
<title>Storage pools</title>
<para>
- Storage pools are a collections of storage media.
- </para>
- <para>
- They hold within them storage <firstterm>volumes</firstterm>, which are the storage devices your guest virtual machines will access.
- (picture examples)
- </para>
- <para>
- Placeholder for better explanation. Probably need diagrams to aid clarity as well.
+ A <firstterm>storage pool</firstterm> is a file, directory, or storage device managed by libvirt for the purpose of providing storage to virtualized guests. Storage pools are divided into storage <firstterm>volumes</firstterm> that store virtualized guest images or are attached to virtualized guests as additional storage.
</para>
+
+ <!--TODO Image request -->
+
<!--
<para>
A storage pool is storage that can be divided up into smaller volumes or allocated directly to a guest. Volumes of a storage pool can be allocated to virtualised guests. There are two categories of storage pool available:
@@ -50,11 +46,11 @@
Volumes
</title>
<para>
- Placeholder
+ Storage pools are divided into storage volumes. Storage volumes are an abstraction of physical partitions, LVM logical volumes, file-based disk images and other storage types handled by libvirt. Storage volumes are presented to virtualized guests as local storage devices regardless of the underlying hardware.
</para>
<section>
<title>
- Referencing Volumes
+ Referencing volumes
</title>
<para>
To reference a specific volume, three approaches are possible:
diff --git a/en-US/Storage_Pools_Directory.xml b/en-US/Storage_Pools_Directory.xml
index f6c20d0..686acea 100644
--- a/en-US/Storage_Pools_Directory.xml
+++ b/en-US/Storage_Pools_Directory.xml
@@ -95,7 +95,7 @@ dr-xr-xr-x. 26 root root 4096 May 28 13:57 ..
</para>
<mediaobject>
<imageobject>
- <imagedata fileref="images/images/virt-manager_storage_pools_add_dir_step_1_name_and_type.png" format="PNG" scalefit="1" />
+ <imagedata fileref="images/virt-manager_storage_pools_add_dir_step_1_name_and_type.png" format="PNG" scalefit="1" />
</imageobject>
</mediaobject>
<para>Press the <guibutton>Forward</guibutton> button to continue.</para>
diff --git a/en-US/Storage_Pools_Partitions.xml b/en-US/Storage_Pools_Partitions.xml
index 7b25502..e7c38dc 100644
--- a/en-US/Storage_Pools_Partitions.xml
+++ b/en-US/Storage_Pools_Partitions.xml
@@ -156,7 +156,16 @@
The <parameter>device</parameter> parameter with the <parameter>path</parameter> attribute
specifies the device path of the storage device. This example uses the device <replaceable>/dev/sdb</replaceable> .
</para>
- </listitem></varlistentry>
+ </listitem>
+ <listitem>
+ <para>
+ The <replaceable>/path/to/source</replaceable> to the formatted file system. If the directory does not exist, the <command>virsh</command> command can create the directory.
+ </para>
+ <para>
+ The directory <replaceable>/guest_images</replaceable> is used in this example.
+ </para>
+ </listitem>
+ </varlistentry>
<varlistentry><term><target> <path><replaceable>/dev</replaceable></path></term>
<listitem>
<para>
@@ -165,7 +174,8 @@
<para>
For example, sdb1, sdb2, sdb3. Using <replaceable>/dev/</replaceable>, as in the example below, means volumes created from this storage pool can be accessed as <replaceable>/dev</replaceable>/sdb1, <replaceable>/dev</replaceable>/sdb2, <replaceable>/dev</replaceable>/sdb3.
</para>
- </listitem></varlistentry>
+ </listitem>
+ </varlistentry>
<varlistentry><term><format type='<replaceable>gpt</replaceable>'/></term>
<listitem>
<para>
@@ -174,14 +184,7 @@
</listitem></varlistentry>-->
</variablelist>
- <!--<listitem>
- <para>
- The <replaceable>/path/to/source</replaceable> to the formatted file system. If the directory does not exist, the <command>virsh</command> command can create the directory.
- </para>
- <para>
- The directory <replaceable>/guest_images</replaceable> is used in this example.
- </para>
- </listitem>
+ <!--
<listitem>
<para>
diff --git a/en-US/Virtualization_Guide.xml b/en-US/Virtualization_Guide.xml
index 03562df..260d69a 100644
--- a/en-US/Virtualization_Guide.xml
+++ b/en-US/Virtualization_Guide.xml
@@ -61,7 +61,7 @@
<partintro id="part-Virtualization-Administration-Administering_virtualized_systems">
<title>Administering virtualized systems</title>
<para>
- These chapters contain information for administering host and virtualized guests using tools included in Fedora.
+ This part contains chapters for administering hosts and virtualized guests using tools provided by Fedora.
</para>
</partintro>
@@ -84,7 +84,7 @@
Introduction to storage administration for virtualization
</title>
<para>
- This part of the Virtualization Guide is about the storage used in a Virtualized environment. It explains the concepts involved, storage pools and Volumes, then covers in depth how to configure and use them effectively.
+ This part contains about the storage used in a virtualized environment. The chapters explain the concepts of storage pools and volumes, detailed configuration procedures and other storage topics.
</para>
</partintro>
<xi:include href="Storage_Concepts.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
@@ -98,7 +98,7 @@
<partintro id="part-Virtualization-Virtualization_Reference_Guide-Virtualization_commands_system_tools_applications_and_additional_systems_reference">
<title>Virtualization commands, system tools, applications and additional systems reference</title>
<para>
- These chapters provide detailed descriptions of virtualization commands, system tools, and applications included in Fedora. These chapters are designed for users requiring information on advanced functionality and other features.
+ This part contains reference chapters which provide detailed descriptions of virtualization commands, system tools, and applications included in Fedora. These chapters are designed for users requiring additional information on advanced functionality and other features.
</para>
</partintro>
<xi:include href="Reference_Other_Tools.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
More information about the docs-commits
mailing list